Interface ISheetXL

Interface for the SheetXL module that allows for simple javascript integration.

interface ISheetXL {
    attachWorkbook(
        selector: string | InitializationOptions,
        props?: StandaloneWorkbookProps,
    ): Promise<IWorkbookElement & Attached<StandaloneWorkbookProps>>;
    initialize(options: InitializationOptions): Promise<void>;
}

Index

Methods

attachWorkbook initialize

Methods

attachWorkbook

attachWorkbook(
selector: string | InitializationOptions,
props?: StandaloneWorkbookProps,
): Promise<IWorkbookElement & Attached<StandaloneWorkbookProps>>
Creates a SheetXL workbook component and attaches it to a DOM element.
Parameters
- selector: string | InitializationOptions
  | InitializationOptions. The CSS selector of the DOM element to attach to (e.g., "#sheetxl").
- Optionalprops: StandaloneWorkbookProps
  Optional properties to pass to the SheetXL React component.
Returns Promise<IWorkbookElement & Attached<StandaloneWorkbookProps>>
A promise that resolves to a function that, when called, will detach the SheetXL React component from the DOM element.

initialize

initialize(options: InitializationOptions): Promise<void>
Initializes the SheetXL runtime with the provided options.
Parameters
- options: InitializationOptions
  The initialization options.
Returns Promise<void>
Remarks
This does not need to be explicity called as create methods can also accept this. If this is called more than once all subsequent calls will be ignored.