SheetXL - v0.3.20
    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;
        getName: () => string;
        getVisibility?: () => Visibility;
        requestSelect?: (options?: ITypes.SelectOptions) => Promise<boolean>;
        setPosition?: (index: number) => boolean;
    }
    Index

    Properties

    beforeFromJSON? duplicate? getIndex getName getVisibility? requestSelect? setPosition?

    Properties

    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

    Return the current index

    Type declaration

      • (): number

      • Returns number

    getName: () => string

    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?: () => 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.

    setPosition?: (index: number) => boolean

    Request that this moved.

    Type declaration

      • (index: number): boolean

      • Parameters

        • index: number

          The index to set to.

        Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Properties