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

    Interface ContainerOptions

    Options needed for embedding a sheet into another container such as a workbook.

    interface ContainerOptions {
        beforeFromJSON?: (self: ISheet) => void;
        duplicate?: () => Promise<ISheet>;
        getIndex?: () => number | null;
        getName: () => string | null;
        getVisibility?: () => ISheet.Visibility;
        requestSelect?: (options?: ITypes.SelectOptions) => Promise<boolean>;
        setIndex?: (
            index: number,
            options?: ITransaction.OperationOptions,
        ) => boolean;
        setIndexCallback?: (callback: () => void) => void;
        setName?: (
            name: string | null,
            options?: ITransaction.OperationOptions,
        ) => void;
        setNameChangeCallback?: (callback: () => void) => void;
        setVisibility?: (
            visibility: ISheet.Visibility,
            options?: ITransaction.OperationOptions,
        ) => void;
        setVisibilityCallback?: (callback: () => void) => void;
    }
    Index
    beforeFromJSON? duplicate? getIndex? getName getVisibility? requestSelect? setIndex? setIndexCallback? setName? setNameChangeCallback? setVisibility? setVisibilityCallback?
    beforeFromJSON?: (self: ISheet) => void

    Required to be called before from JSON.

    Type Declaration

      • (self: ISheet): void

      • Parameters

        Returns void

    This is needed to ensure the contain has access to the sheet reference so that it can resolve references.

    duplicate?: () => Promise<ISheet>

    Returns a copy of the sheet provided sheet.

    getIndex?: () => number | null

    Return the current index.

    getName: () => string | null

    Callback to provide a sheet with a logical name. This is used when a sheet name property is invoked.

    Sheets don't have a name by default but as a convenience we allow for the name to be called from the sheet.

    getVisibility?: () => ISheet.Visibility

    Callback to provide a sheet with a visibility.

    Sheets don't manage this but as a convenience we allow for the visibility to be called from the sheet.

    requestSelect?: (options?: ITypes.SelectOptions) => Promise<boolean>

    Request that the sheet become the active sheet.

    Type Declaration

    In a workbook context there is only one active sheet at a time but other clients may treat this this differently.

    setIndex?: (index: number, options?: ITransaction.OperationOptions) => boolean

    Request that this moved.

    Type Declaration

    For traditional workbooks with not docking tabs this will be the tab position.

    setIndexCallback?: (callback: () => void) => void
    setName?: (name: string | null, options?: ITransaction.OperationOptions) => void
    setNameChangeCallback?: (callback: () => void) => void
    setVisibility?: (
        visibility: ISheet.Visibility,
        options?: ITransaction.OperationOptions,
    ) => void
    setVisibilityCallback?: (callback: () => void) => void

    Settings
    Member Visibility

    On This Page
    Properties