Interface ISheetModelOptions

Optional values passed to a sheet

interface ISheetModelOptions {
    getName?: ((model) => string);
    isDate1904System?: boolean;
    maxColumns?: number;
    maxRows?: number;
    onBeforeDelete?: ((model) => void);
    sharedResources?: ISharedResourceCollection;
    sheetStyle?: ISheetStyle;
    transactionStore?: TransactionStore;
    uid?: string;
}

Hierarchy (view full)

Properties

getName? isDate1904System? maxColumns? maxRows? onBeforeDelete? sharedResources? sheetStyle? transactionStore? uid?

Properties

Optional getName

getName?: ((model) => string)

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

Type declaration

    • (model): string

    • Parameters

      Returns string

Remarks

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

Optional isDate1904System

isDate1904System?: boolean

Determine if dates should be 1904 instead of 1900 based

Default Value

false

Optional maxColumns

maxColumns?: number

Set the maxRow size

Default Value

16384

Optional maxRows

maxRows?: number

Set the maxRow size

Default Value

1048576

Optional onBeforeDelete

onBeforeDelete?: ((model) => void)

Callback for delete before the sheet is deleted. If this throws an error then the delete will be aborted.

Type declaration

Optional sharedResources

sharedResources?: ISharedResourceCollection

collection of shared resources. If not provided then workbook will create it's own.

Optional sheetStyle

sheetStyle?: ISheetStyle

collection of shared styles. If not provided then workbook will create it's own.

Optional transactionStore

transactionStore?: TransactionStore

The store for all state changes. This is provided to enable versioning, undo/redo, distributed editing, etc.

Default Value

internal

Optional uid

uid?: string

A unique identifier used for identifying this sheet during operations (i.e. copy/paste). This must be unique for all in-memory instances of a sheet.

Note - it is not saved as part of the persisted model

See

SheetJSON.

Param: uid

unique identifier for in memory operations. If not provided a default one will be used.

Settings

Member Visibility

Theme

On This Page

getNameisDate1904SystemmaxColumnsmaxRowsonBeforeDeletesharedResourcessheetStyletransactionStoreuid