weasel API - v0.8.0
    Preparing search index...

    Interface AlignmentBehaviorBase

    Common options shared by the three alignment behavior factories.

    interface AlignmentBehaviorBase {
        bypassKey?: keyof ModifierState;
        getCandidates: () => readonly Guide[];
        getView?: () => View;
        setActiveGuides: (guides: readonly Guide[]) => void;
        tolerance?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bypassKey? getCandidates getView? setActiveGuides tolerance?

    Properties

    bypassKey?: keyof ModifierState

    Modifier key that bypasses snapping while held.

    getCandidates: () => readonly Guide[]

    Live candidate lines — consumer derives from current siblings + page.

    getView?: () => View

    Read the active view; required for screen-pixel tolerance.

    setActiveGuides: (guides: readonly Guide[]) => void

    Publish the currently-matched line(s). Called every onMove; cleared ([]) on a miss and on onEnd.

    tolerance?: number

    Tolerance (screen px when getView set, world units otherwise).

    Settings

    Member Visibility

    On This Page

    Properties