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

    Interface UseAlignOptions<TPose>

    Options for useAlign.

    interface UseAlignOptions<TPose> {
        enableKeyboard?: boolean;
        geometry?: PoseProjection<TPose>;
        label?: string;
    }

    Type Parameters

    • TPose
    Index

    Properties

    enableKeyboard? geometry? label?

    Properties

    enableKeyboard?: boolean

    Auto-register the six default align actions into a surrounding <ActionsProvider>. Default true. Pass false to skip registration (e.g. you're calling align() imperatively from your own UI).

    geometry?: PoseProjection<TPose>

    Projection between TPose and bounds. Defaults to RECT_POSE_DESCRIPTOR for {x,y,width,height} poses. Pass pathPoseDescriptor for Path poses so polygon coords translate correctly.

    label?: string

    Label passed to applyOps. Default 'Align'.

    Settings

    Member Visibility

    On This Page

    Properties