Interface useSheetCommandsOptions

interface useSheetCommandsOptions {
    bodyStyle?: GridSurfaceStyle;
    cellSelection?: CellSelection;
    commandDependencies?: CommandMap;
    commandTarget: CommandTarget | (() => CommandTarget);
    commandsCopyPaste?: CommandMap;
    getViewport?: (() => ScrollableViewport);
    notifier?: Notifier;
    onGoto?: ((location) => Promise<IWorkbookRange>);
    onRepeatCommandChange?: ((command) => void);
    onStartEdit?: ((event) => void);
    sheetModel: ISheetModel;
}

Index

Properties

bodyStyle? cellSelection? commandDependencies? commandTarget commandsCopyPaste? getViewport? notifier? onGoto? onRepeatCommandChange? onStartEdit? sheetModel

Properties

`Optional` bodyStyle

bodyStyle?: GridSurfaceStyle

`Optional` cellSelection

cellSelection?: CellSelection

If this is supplied then the sheet models selection is not used..

`Optional` commandDependencies

commandDependencies?: CommandMap

commandTarget

commandTarget: CommandTarget | (() => CommandTarget)

Type declaration

- (): CommandTarget
- Returns CommandTarget

`Optional` commandsCopyPaste

commandsCopyPaste?: CommandMap

`Optional` getViewport

getViewport?: (() => ScrollableViewport)

Returns the current viewport

Type declaration

- (): ScrollableViewport
- Returns ScrollableViewport

Returns

Re

`Optional` notifier

notifier?: Notifier

`Optional` onGoto

onGoto?: ((location) => Promise<IWorkbookRange>)

Type declaration

- (location): Promise<IWorkbookRange>
- Parameters
  - location: SheetCellCoordsAddress | ISheetRange | GotoOptions
  Returns Promise<IWorkbookRange>

`Optional` onRepeatCommandChange

onRepeatCommandChange?: ((command) => void)

Notify that there is a new repeatable command

Type declaration

- (command): void
- Parameters
  - command: ICommand<any, any>
  Returns void

`Optional` onStartEdit

onStartEdit?: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: Partial<StartEditEvent>
  Returns void

sheetModel

sheetModel: ISheetModel