Interface SnapCandidate

interface SnapCandidate {
    distance: number;
    featureId: FeatureId;
    kind: SnapCandidateKind;
    position: SnapPosition;
    screenPoint: SnapScreenPoint;
    segmentIndex?: number;
    sourceId: string;
    vertexIndex?: number;
}

Index

Properties

distance featureId kind position screenPoint segmentIndex? sourceId vertexIndex?

Properties

distance

distance: number

Screen-space distance from the pointer, in pixels.

featureId

featureId: FeatureId

kind

kind: SnapCandidateKind

position

position: SnapPosition

Geographic position of the snap target.

screenPoint

screenPoint: SnapScreenPoint

Screen-space position of the snap target.

`Optional`segmentIndex

segmentIndex?: number

Ordinal of the snapped segment within the feature (edge candidates).

sourceId

sourceId: string

`Optional`vertexIndex

vertexIndex?: number

Ordinal of the snapped vertex within the feature (vertex candidates).