SheetXL - v1.0.2
    Preparing search index...

    Interface ConstructorOptions<J>

    interface ConstructorOptions<J> {
        addWatch?: AddWatch;
        description?: string | null;
        getMovable?: () => IMovable | null;
        getRange?: (address: string) => ICellRange | null;
        getStyles?: () => IStyleCollection | null;
        json?: J;
        name?: string | null;
        transactions?: IStore;
        type?: string;
        deleteFromContainer?(options?: ITransaction.OperationOptions): void;
        isReadOnly?(): boolean;
        setContainerReadOnlyCallback?(callback: ReadOnlyCallback): void;
    }

    Type Parameters

    • J

    Hierarchy (View Summary)

    Index
    addWatch? description? getMovable? getRange? getStyles? json? name? transactions? type?
    deleteFromContainer? isReadOnly? setContainerReadOnlyCallback?
    addWatch?: AddWatch

    Hands a formula the content names to the calculation engine, which keeps its references on the cells they name through inserts, deletes, cuts, sheet renames and undo, and calls back with the formula each time its text changes. The same contract as ICellRanges.addWatch without the range: a content has no location its formulas are evaluated over, only its anchor.

    Not provided for content outside a workbook; its references then read as set.

    description?: string | null

    The alternative text.

    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. Not provided for content outside a workbook.

    getStyles?: () => IStyleCollection | null

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

    json?: J

    JSON state to load.

    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 type of the model.

    • If the item is readonly.

      Returns boolean

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

      Parameters

      • callback: ReadOnlyCallback

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods