SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface MovableLayerProps

    interface MovableLayerProps {
        disabled?: boolean;
        disableDrag?: boolean;
        disableResize?: boolean;
        movables: IMovableCollection;
        movablesView: IMovableSelection;
        onFirstRender?: () => void;
        onFocus?: () => void;
        onUnFocus?: () => void;
        ref?: Ref<IMovableLayerElement>;
        renderDirections?: string[];
        renderMovable: (props: MovableElementProps) => ReactElement;
        renderTip?: (gesture: MovableGesture) => ReactNode;
    }

    Hierarchy

    • HTMLAttributes<HTMLDivElement>
      • MovableLayerProps
    Index
    disabled? disableDrag? disableResize? movables movablesView onFirstRender? onFocus? onUnFocus? ref? renderDirections? renderMovable renderTip?
    disabled?: boolean

    If disabled then movable selection will not be allowed and frames will be passed disabled.

    false
    disableDrag?: boolean

    If disabled then unable to move.

    false
    disableResize?: boolean

    If disabled then unable to resize.

    false
    movables: IMovableCollection

    The container to retrieve movable objects

    movablesView: IMovableSelection

    The container view to retrieve selection information about the movables.

    onFirstRender?: () => void

    Called after the first render of a movable.

    onFocus?: () => void

    Called when the final movable is unselected.

    onUnFocus?: () => void

    Called when the final movable is unselected.

    ref?: Ref<IMovableLayerElement>

    Forwards the ref to the underlying element.

    renderDirections?: string[]

    Provider the anchor element to render.

    renderMovable: (props: MovableElementProps) => ReactElement

    Callback to render the movable.

    Type Declaration

    renderTip?: (gesture: MovableGesture) => ReactNode

    Render a readout while a frame is moved, resized or rotated — a GestureTip under the frame. Return an empty node for none.

    Settings
    Member Visibility

    On This Page
    Properties