Interface SnapOptions

Optional tuning knobs used by snap/match calculations.

interface SnapOptions {
    threshold?: number | Partial<Record<SnapAxis, number>>;
    render_threshold?: number | Partial<Record<SnapAxis, number>>;
    snap_threshold?: number | Partial<Record<SnapAxis, number>>;
    preferDeltaSign?: Partial<Record<SnapAxis, number>>;
}

Properties

threshold?: number | Partial<Record<SnapAxis, number>>

Snap threshold as a scalar or per-axis values. Matches farther than this threshold are ignored.

render_threshold?: number | Partial<Record<SnapAxis, number>>

Threshold used when deciding which guides are rendered. Defaults to threshold when omitted.

snap_threshold?: number | Partial<Record<SnapAxis, number>>

Threshold used when deciding which deltas are snapped on pointer-up. Defaults to threshold when omitted.

preferDeltaSign?: Partial<Record<SnapAxis, number>>

Preferred drag direction per axis for tie-break ranking. Positive values bias positive deltas, negative values bias negative deltas.