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

    Interface CreateOptions

    What a movable's content is given when created.

    interface CreateOptions {
        beginPersistResource: () => IResourceCollection.IPersistScope<
            IResource.JSON,
        >;
        defaultLockAspectRatio?: boolean;
        description?: string
        | null;
        fromResourceId?: (resourceId: number) => IResource;
        getMovable?: () => IMovable | null;
        getRange: (address: string) => ICellRange | null;
        getStyles?: () => IStyleCollection | null;
        holdFormulas: (getExpressions: () => readonly string[]) => HeldFormulas;
        json?: any;
        name?: string | null;
        transactions?: IStore;
        type: string;
        deleteFromContainer?(options?: ITransaction.OperationOptions): void;
        isReadOnly?(): boolean;
        setContainerReadOnlyCallback?(callback: ReadOnlyCallback): void;
    }

    Hierarchy (View Summary)

    Index
    beginPersistResource defaultLockAspectRatio? description? fromResourceId? getMovable? getRange getStyles? holdFormulas json? name? transactions? type
    deleteFromContainer? isReadOnly? setContainerReadOnlyCallback?
    beginPersistResource: () => IResourceCollection.IPersistScope<IResource.JSON>

    Useful for load/save/copying.

    defaultLockAspectRatio?: boolean

    Allow for the default lock aspect ratio to be overwritten.

    description?: string | null

    The alternative text.

    fromResourceId?: (resourceId: number) => IResource

    Returns an IResource from the resourceId or null if not found.

    getMovable?: () => IMovable | null

    Returns the movable that places the content. Not provided for content that has none.

    getRange: (address: string) => ICellRange | null

    Resolves an address against the workbook the content lives in.

    getStyles?: () => IStyleCollection | null

    Returns the styles the content's theme references resolve against. Not provided for content outside a workbook.

    holdFormulas: (getExpressions: () => readonly string[]) => HeldFormulas

    Hands formulas to the calculation engine so they follow structural edits.

    json?: any

    The content's JSON, as saved.

    name?: string | null

    The name. Content that a movable places is given one when this is empty.

    transactions?: IStore

    A transaction store that can be used to undo/redo changes to the model.

    type: string

    The content's type, as registered.

    • Notify if the readonly has been updated from the container.

      Parameters

      • callback: ReadOnlyCallback

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods