SheetXL - v0.3.20
    Preparing search index...

    Interface AddOptions<J>

    Options for adding a movable to the collection.

    interface AddOptions<J = any> {
        anchorType?: IAnchored.Type;
        autoSelect?: boolean | IMovable.SelectOptions;
        bounds?: Partial<Bounds>;
        description?: string;
        fromResourceId?: (resourceId: number) => IResource;
        json?: J;
        type?: string;
    }

    Type Parameters

    • J = any

    Hierarchy (View Summary)

    Index

    Properties

    anchorType? autoSelect? bounds? description? fromResourceId? json? type?

    Properties

    anchorType?: IAnchored.Type

    The behavior of how the movable resizes as the anchor/cells change.

    autoSelect?: boolean | IMovable.SelectOptions

    If unspecified no selection will occur.

    Overrides the default autoSelect to include IMovable.SelectOptions options.

    bounds?: Partial<Bounds>

    The boundary for the movable object in pixels.

    description?: string

    A human description.

    'determined by the set operation and locale'
    fromResourceId?: (resourceId: number) => IResource

    If a referenceId is provided then the movable will be linked to the resource.

    Type declaration

    json?: J

    Initial json value.

    type?: string

    The type of movable to add.

    Settings

    Member Visibility

    On This Page

    Properties