Interface Events

Events for ISheet.

interface Events {
    onBeforeDelete(source: ISheet): void;
    onBeforeLoad(source: ISheet, json: ISheet.JSON): void;
    onBeforeSave(source: ISheet): void | Promise<void>;
    onClose(source: ISheet): void;
    onDelete(source: ISheet): void;
    onFreezeSplitChange(source: ISheet): void;
    onInvalidated(source: ISheet): void;
    onLayoutChange(source: ISheet): void;
    onLoad(source: ISheet): void;
    onMergesChange(source: ISheet): void;
    onMovablesChange(source: ISheet): void;
    onMovableSelectionChange(source: ISheet): void;
    onNameChange(source: ISheet): void;
    onProtectionChange(source: ISheet): void;
    onRequestFocus(source: ISheet): Promise<boolean>;
    onRequestScrollIntoView(
        source: ISheet,
        options: ScrollToOptions,
    ): Promise<boolean>;
    onSave(source: ISheet, json: ISheet.JSON): void;
    onSelectionChange(source: ISheet): void;
    onSpillsChange(source: ISheet): void;
    onStyleChange(source: ISheet): void;
    onTabColorChange(source: ISheet): void;
    onTablesChange(source: ISheet): void;
    onTopLeftChange(source: ISheet): void;
    onUsedRangeChange(source: ISheet): void;
    onViewChange(source: ISheet): void;
    onViewChange(source: ISheet): void;
    onVisibilityChange(source: ISheet): void;
}

Methods

`Optional`onBeforeDelete

onBeforeDelete(source: ISheet): void
Called before delete. If any exception is thrown the exception will be returned to the client and delete will be aborted.
Parameters
- source: ISheet
Returns void

`Optional`onBeforeLoad

onBeforeLoad(source: ISheet, json: ISheet.JSON): void
Called before load. If any exception is thrown this exception will be returned to the client and delete will fail.
Parameters
- source: ISheet
- json: ISheet.JSON
Returns void

`Optional`onBeforeSave

onBeforeSave(source: ISheet): void | Promise<void>
Called before load. If any exception is thrown this exception will be returned to the client and delete will be aborted.
Parameters
- source: ISheet
Returns void | Promise<void>

`Optional`onClose

onClose(source: ISheet): void
Called when the sheet is closed.
Parameters
- source: ISheet
Returns void

`Optional`onDelete

onDelete(source: ISheet): void
Called when the sheet is deleted.
Parameters
- source: ISheet
Returns void

`Optional`onFreezeSplitChange

onFreezeSplitChange(source: ISheet): void
Called when freeze or split settings have changed.
Parameters
- source: ISheet
Returns void
Remarks
This is a delegated event from the ISheetView.

`Optional`onInvalidated

onInvalidated(source: ISheet): void
Called when the state has been updated due to a undo/redo and a rerender is required.
Parameters
- source: ISheet
Returns void

`Optional`onLayoutChange

onLayoutChange(source: ISheet): void
Called when the sizes of the cells change.
Parameters
- source: ISheet
Returns void
Remarks
- This can be be due to row/column sizes changes or changing the max rows columns.
- Zoom and viewport do not change the underlying layout.

`Optional`onLoad

onLoad(source: ISheet): void
Called after load.
Parameters
- source: ISheet
Returns void

`Optional`onMergesChange

onMergesChange(source: ISheet): void
Called when any merges are added or removed.
Parameters
- source: ISheet
Returns void

`Optional`onMovablesChange

onMovablesChange(source: ISheet): void
Called when any movables are added or removed.
Parameters
- source: ISheet
Returns void

`Optional`onMovableSelectionChange

onMovableSelectionChange(source: ISheet): void
Called when the movable selection changes.
Parameters
- source: ISheet
Returns void
Remarks
This is a delegated event from the ISheetView.

`Optional`onNameChange

onNameChange(source: ISheet): void
Called when the name changes.
Parameters
- source: ISheet
Returns void

`Optional`onProtectionChange

onProtectionChange(source: ISheet): void
Called on any protection changes.
Parameters
- source: ISheet
Returns void

`Optional`onRequestFocus

onRequestFocus(source: ISheet): Promise<boolean>
Request that the sheet become focused.
Parameters
- source: ISheet
Returns Promise<boolean>
A promise indicating if the focus was honored.

Remarks
This should only be handled by one consumer.

`Optional`onRequestScrollIntoView

onRequestScrollIntoView(
source: ISheet,
options: ScrollToOptions,
): Promise<boolean>
Request that the sheet become focused.
Parameters
- source: ISheet
- options: ScrollToOptions
Returns Promise<boolean>
A promise indicating if the focus was honored.

Remarks
This should only be handled by one consumer.

`Optional`onSave

onSave(source: ISheet, json: ISheet.JSON): void
Called after save.
Parameters
- source: ISheet
- json: ISheet.JSON
Returns void

`Optional`onSelectionChange

onSelectionChange(source: ISheet): void
Called when the selection changes.
Parameters
- source: ISheet
Returns void
Remarks
This is a delegated event from the ISheetView.

`Optional`onSpillsChange

onSpillsChange(source: ISheet): void
Called if any spills occur.
Parameters
- source: ISheet
Returns void

`Optional`onStyleChange

onStyleChange(source: ISheet): void
Convenience method that listens to all changes on the style.
Parameters
- source: ISheet
Returns void

`Optional`onTabColorChange

onTabColorChange(source: ISheet): void
Called when the sheet tab color changes.
Parameters
- source: ISheet
Returns void

`Optional`onTablesChange

onTablesChange(source: ISheet): void
Called when any table are added or removed.
Parameters
- source: ISheet
Returns void

`Optional`onTopLeftChange

onTopLeftChange(source: ISheet): void
Called when the topLeft changes.
Parameters
- source: ISheet
Returns void
Remarks
This is a delegated event from the ISheetView.

`Optional`onUsedRangeChange

onUsedRangeChange(source: ISheet): void
Called when the UsedRange bounds changes.
Parameters
- source: ISheet
Returns void
Remarks
Useful when interested in knowing when the bounds of the area that is being used within the sheet changes; for example this is used by the scrollbars to adjust the size.

See
ISheet.getUsedRange

`Optional`onViewChange

onViewChange(source: ISheet): void
Called when the ISheetView changes.

This is not called when individual properties on the view change.
Parameters
- source: ISheet
Returns void
onViewChange(source: ISheet): void
Called when the view changes.
Parameters
- source: ISheet
Returns void

`Optional`onVisibilityChange

onVisibilityChange(source: ISheet): void
Called when the visibility changes..
Parameters
- source: ISheet
Returns void

Interface Events

Index

Methods

Methods

OptionalonBeforeDelete

Parameters

Returns void

OptionalonBeforeLoad

Parameters

Returns void

OptionalonBeforeSave

Parameters

Returns void | Promise<void>

OptionalonClose

Parameters

Returns void

OptionalonDelete

Parameters

Returns void

OptionalonFreezeSplitChange

Parameters

Returns void

Remarks

OptionalonInvalidated

Parameters

Returns void

OptionalonLayoutChange

Parameters

Returns void

Remarks

OptionalonLoad

Parameters

Returns void

OptionalonMergesChange

Parameters

Returns void

OptionalonMovablesChange

Parameters

Returns void

OptionalonMovableSelectionChange

Parameters

Returns void

Remarks

OptionalonNameChange

Parameters

Returns void

OptionalonProtectionChange

Parameters

Returns void

OptionalonRequestFocus

Parameters

Returns Promise<boolean>

Remarks

OptionalonRequestScrollIntoView

Parameters

Returns Promise<boolean>

Remarks

OptionalonSave

Parameters

Returns void

OptionalonSelectionChange

Parameters

Returns void

Remarks

OptionalonSpillsChange

Parameters

Returns void

OptionalonStyleChange

Parameters

Returns void

OptionalonTabColorChange

Parameters

Returns void

OptionalonTablesChange

Parameters

Returns void

OptionalonTopLeftChange

Parameters

Returns void

Remarks

`Optional`onBeforeDelete

`Optional`onBeforeLoad

`Optional`onBeforeSave

`Optional`onClose

`Optional`onDelete

`Optional`onFreezeSplitChange

`Optional`onInvalidated

`Optional`onLayoutChange

`Optional`onLoad

`Optional`onMergesChange

`Optional`onMovablesChange

`Optional`onMovableSelectionChange

`Optional`onNameChange

`Optional`onProtectionChange

`Optional`onRequestFocus

`Optional`onRequestScrollIntoView

`Optional`onSave

`Optional`onSelectionChange

`Optional`onSpillsChange

`Optional`onStyleChange

`Optional`onTabColorChange

`Optional`onTablesChange

`Optional`onTopLeftChange

`Optional`onUsedRangeChange

`Optional`onViewChange

`Optional`onVisibilityChange