Interface SnappingConfig

interface SnappingConfig {
    enabled: boolean;
    kinds: readonly SnapCandidateKind[];
    sources: Readonly<Record<string, boolean | SnapSourceOptions>>;
    tolerance: number;
}

Properties

enabled: boolean

Master switch.

kinds: readonly SnapCandidateKind[]

Candidate kinds resolved by default. feature adds whole-feature (feature-body) candidates: inside a polygon the pointer itself is a zero-distance candidate; otherwise the nearest point on the feature.

sources: Readonly<Record<string, boolean | SnapSourceOptions>>

Per-source enablement keyed by source id. Missing sources default to enabled with the global kinds. false disables a source.

tolerance: number

Snap tolerance in screen pixels (candidates at exactly the tolerance still snap).