diff --git a/.prettierignore b/.prettierignore index 0fe666d16f..b000333750 100644 --- a/.prettierignore +++ b/.prettierignore @@ -13,7 +13,6 @@ build/ .npmrc coverage/ logs/ -doc/tsdoc tests/**/__snapshots__ tests/**/xlsx_demo_data # Ignore all PNG files: diff --git a/doc/tsdoc/.nojekyll b/doc/tsdoc/.nojekyll deleted file mode 100644 index e2ac6616ad..0000000000 --- a/doc/tsdoc/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/doc/tsdoc/README.md b/doc/tsdoc/README.md deleted file mode 100644 index 681d707bc5..0000000000 --- a/doc/tsdoc/README.md +++ /dev/null @@ -1,414 +0,0 @@ -o-spreadsheet API - -# o-spreadsheet API - -## Table of contents - -### Enumerations - -- [CommandResult](enums/CommandResult.md) - -### Classes - -- [AbstractChart](classes/AbstractChart.md) -- [CorePlugin](classes/CorePlugin.md) -- [DispatchResult](classes/DispatchResult.md) -- [EvaluationError](classes/EvaluationError.md) -- [Model](classes/Model.md) -- [Registry](classes/Registry.md) -- [Revision](classes/Revision.md) -- [Spreadsheet](classes/Spreadsheet.md) -- [UIPlugin](classes/UIPlugin.md) - -### Interfaces - -- [Client](interfaces/Client.md) -- [ClientJoinedMessage](interfaces/ClientJoinedMessage.md) -- [ClientLeftMessage](interfaces/ClientLeftMessage.md) -- [ClientMovedMessage](interfaces/ClientMovedMessage.md) -- [RemoteRevisionMessage](interfaces/RemoteRevisionMessage.md) -- [RevisionRedoneMessage](interfaces/RevisionRedoneMessage.md) -- [RevisionUndoneMessage](interfaces/RevisionUndoneMessage.md) -- [TransportService](interfaces/TransportService.md) - -### Type aliases - -- [CancelledReason](README.md#cancelledreason) -- [CollaborationMessage](README.md#collaborationmessage) - -### Variables - -- [DATETIME\_FORMAT](README.md#datetime_format) -- [SPREADSHEET\_DIMENSIONS](README.md#spreadsheet_dimensions) -- [\_\_info\_\_](README.md#__info__) -- [cellTypes](README.md#celltypes) -- [components](README.md#components) -- [coreTypes](README.md#coretypes) -- [functionCache](README.md#functioncache) -- [helpers](README.md#helpers) -- [invalidateEvaluationCommands](README.md#invalidateevaluationcommands) -- [readonlyAllowedCommands](README.md#readonlyallowedcommands) -- [registries](README.md#registries) - -### Functions - -- [astToFormula](README.md#asttoformula) -- [compile](README.md#compile) -- [convertAstNodes](README.md#convertastnodes) -- [findCellInNewZone](README.md#findcellinnewzone) -- [load](README.md#load) -- [parse](README.md#parse) -- [setTranslationMethod](README.md#settranslationmethod) -- [tokenize](README.md#tokenize) - -## Type aliases - -### CancelledReason - -Ƭ **CancelledReason**: `Exclude`<[`CommandResult`](enums/CommandResult.md), [`Success`](enums/CommandResult.md#success)\> - -___ - -### CollaborationMessage - -Ƭ **CollaborationMessage**: [`RevisionUndoneMessage`](interfaces/RevisionUndoneMessage.md) \| [`RevisionRedoneMessage`](interfaces/RevisionRedoneMessage.md) \| [`RemoteRevisionMessage`](interfaces/RemoteRevisionMessage.md) \| `SnapshotMessage` \| `SnapshotCreatedMessage` \| [`ClientMovedMessage`](interfaces/ClientMovedMessage.md) \| [`ClientJoinedMessage`](interfaces/ClientJoinedMessage.md) \| [`ClientLeftMessage`](interfaces/ClientLeftMessage.md) - -## Variables - -### DATETIME\_FORMAT - -• **DATETIME\_FORMAT**: `RegExp` - -___ - -### SPREADSHEET\_DIMENSIONS - -• **SPREADSHEET\_DIMENSIONS**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `BOTTOMBAR_HEIGHT` | `number` | -| `DEFAULT_CELL_HEIGHT` | `number` | -| `DEFAULT_CELL_WIDTH` | `number` | -| `HEADER_HEIGHT` | `number` | -| `HEADER_WIDTH` | `number` | -| `MIN_COL_WIDTH` | `number` | -| `MIN_ROW_HEIGHT` | `number` | -| `SCROLLBAR_WIDTH` | `number` | -| `TOPBAR_HEIGHT` | `number` | - -___ - -### \_\_info\_\_ - -• **\_\_info\_\_**: `Object` = `{}` - -We export here all entities that needs to be accessed publicly by Odoo. - -Note that the __info__ key is actually completed by the build process (see -the rollup.config.js file) - -___ - -### cellTypes - -• **cellTypes**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `LinkCell` | typeof `LinkCell` | - -___ - -### components - -• **components**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `BarConfigPanel` | typeof `BarConfigPanel` | -| `ChartFigure` | typeof `ChartFigure` | -| `ChartJsComponent` | typeof `ChartJsComponent` | -| `ChartPanel` | typeof `ChartPanel` | -| `GaugeChartConfigPanel` | typeof `GaugeChartConfigPanel` | -| `GaugeChartDesignPanel` | typeof `GaugeChartDesignPanel` | -| `Grid` | typeof `Grid` | -| `GridOverlay` | typeof `GridOverlay` | -| `LineBarPieConfigPanel` | typeof `LineBarPieConfigPanel` | -| `LineBarPieDesignPanel` | typeof `LineBarPieDesignPanel` | -| `LineConfigPanel` | typeof `LineConfigPanel` | -| `ScorecardChart` | typeof `ScorecardChart` | -| `ScorecardChartConfigPanel` | typeof `ScorecardChartConfigPanel` | -| `ScorecardChartDesignPanel` | typeof `ScorecardChartDesignPanel` | - -___ - -### coreTypes - -• **coreTypes**: `Set`<``"UPDATE_CELL"`` \| ``"UPDATE_CELL_POSITION"`` \| ``"CLEAR_CELL"`` \| ``"DELETE_CONTENT"`` \| ``"SET_DECIMAL"`` \| ``"ADD_COLUMNS_ROWS"`` \| ``"REMOVE_COLUMNS_ROWS"`` \| ``"RESIZE_COLUMNS_ROWS"`` \| ``"HIDE_COLUMNS_ROWS"`` \| ``"UNHIDE_COLUMNS_ROWS"`` \| ``"SET_GRID_LINES_VISIBILITY"`` \| ``"FREEZE_COLUMNS"`` \| ``"FREEZE_ROWS"`` \| ``"UNFREEZE_COLUMNS_ROWS"`` \| ``"UNFREEZE_COLUMNS"`` \| ``"UNFREEZE_ROWS"`` \| ``"ADD_MERGE"`` \| ``"REMOVE_MERGE"`` \| ``"CREATE_SHEET"`` \| ``"DELETE_SHEET"`` \| ``"DUPLICATE_SHEET"`` \| ``"MOVE_SHEET"`` \| ``"RENAME_SHEET"`` \| ``"HIDE_SHEET"`` \| ``"SHOW_SHEET"`` \| ``"MOVE_RANGES"`` \| ``"ADD_CONDITIONAL_FORMAT"`` \| ``"REMOVE_CONDITIONAL_FORMAT"`` \| ``"MOVE_CONDITIONAL_FORMAT"`` \| ``"CREATE_FIGURE"`` \| ``"DELETE_FIGURE"`` \| ``"UPDATE_FIGURE"`` \| ``"SET_FORMATTING"`` \| ``"CLEAR_FORMATTING"`` \| ``"SET_BORDER"`` \| ``"CREATE_CHART"`` \| ``"UPDATE_CHART"``\> - -___ - -### functionCache - -• **functionCache**: `Object` = `{}` - -#### Index signature - -▪ [key: `string`]: `Omit`<`CompiledFormula`, ``"dependencies"`` \| ``"tokens"``\> - -___ - -### helpers - -• **helpers**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `CellErrorLevel` | typeof `CellErrorLevel` | -| `ChartColors` | typeof `ChartColors` | -| `EvaluationError` | typeof [`EvaluationError`](classes/EvaluationError.md) | -| `UuidGenerator` | typeof `UuidGenerator` | -| `args` | (`strings`: `string`) => `ArgDefinition`[] | -| `chartFontColor` | (`backgroundColor`: `undefined` \| `Color`) => `Color` | -| `colorToRGBA` | (`color`: `Color`) => `RGBA` | -| `computeTextWidth` | (`context`: `CanvasRenderingContext2D`, `text`: `string`, `style`: `Style`) => `number` | -| `createEmptyWorkbookData` | (`sheetName`: `string`) => `WorkbookData` | -| `createFullMenuItem` | (`key`: `string`, `value`: `MenuItem`) => `FullMenuItem` | -| `formatValue` | (`value`: `CellValue`, `format?`: `Format`) => `FormattedValue` | -| `getDefaultChartJsRuntime` | (`chart`: [`AbstractChart`](classes/AbstractChart.md), `labels`: `string`[], `fontColor`: `Color`) => `ChartConfiguration` | -| `getFillingMode` | (`index`: `number`) => ``"origin"`` \| `number` | -| `getMenuChildren` | (`node`: `Required`<`MenuItem`\>, `env`: `SpreadsheetChildEnv`) => `FullMenuItem`[] | -| `isMarkdownLink` | (`str`: `string`) => `boolean` | -| `markdownLink` | (`label`: `string`, `url`: `string`) => `string` | -| `numberToLetters` | (`n`: `number`) => `string` | -| `parseMarkdownLink` | (`str`: `string`) => `Link` | -| `positionToZone` | (`position`: `Position`) => { `bottom`: `HeaderIndex` ; `left`: `HeaderIndex` ; `right`: `HeaderIndex` ; `top`: `HeaderIndex` } | -| `rgbaToHex` | (`rgba`: `RGBA`) => `Color` | -| `toBoolean` | (`value`: `undefined` \| ``null`` \| `string` \| `number` \| `boolean`) => `boolean` | -| `toCartesian` | (`xc`: `string`) => `Position` | -| `toJsDate` | (`value`: `undefined` \| ``null`` \| `string` \| `number` \| `boolean`) => `Date` | -| `toNumber` | (`value`: `undefined` \| ``null`` \| `string` \| `number` \| `boolean`) => `number` | -| `toString` | (`value`: `undefined` \| ``null`` \| `string` \| `number` \| `boolean`) => `string` | -| `toXC` | (`col`: `HeaderIndex`, `row`: `HeaderIndex`, `rangePart`: `RangePart`) => `string` | -| `toZone` | (`xc`: `string`) => `Zone` | - -___ - -### invalidateEvaluationCommands - -• **invalidateEvaluationCommands**: `Set`<``"UPDATE_CELL"`` \| ``"UPDATE_CELL_POSITION"`` \| ``"CLEAR_CELL"`` \| ``"DELETE_CONTENT"`` \| ``"SET_DECIMAL"`` \| ``"ADD_COLUMNS_ROWS"`` \| ``"REMOVE_COLUMNS_ROWS"`` \| ``"RESIZE_COLUMNS_ROWS"`` \| ``"HIDE_COLUMNS_ROWS"`` \| ``"UNHIDE_COLUMNS_ROWS"`` \| ``"SET_GRID_LINES_VISIBILITY"`` \| ``"FREEZE_COLUMNS"`` \| ``"FREEZE_ROWS"`` \| ``"UNFREEZE_COLUMNS_ROWS"`` \| ``"UNFREEZE_COLUMNS"`` \| ``"UNFREEZE_ROWS"`` \| ``"ADD_MERGE"`` \| ``"REMOVE_MERGE"`` \| ``"CREATE_SHEET"`` \| ``"DELETE_SHEET"`` \| ``"DUPLICATE_SHEET"`` \| ``"MOVE_SHEET"`` \| ``"RENAME_SHEET"`` \| ``"HIDE_SHEET"`` \| ``"SHOW_SHEET"`` \| ``"MOVE_RANGES"`` \| ``"ADD_CONDITIONAL_FORMAT"`` \| ``"REMOVE_CONDITIONAL_FORMAT"`` \| ``"MOVE_CONDITIONAL_FORMAT"`` \| ``"CREATE_FIGURE"`` \| ``"DELETE_FIGURE"`` \| ``"UPDATE_FIGURE"`` \| ``"SET_FORMATTING"`` \| ``"CLEAR_FORMATTING"`` \| ``"SET_BORDER"`` \| ``"CREATE_CHART"`` \| ``"UPDATE_CHART"`` \| ``"REQUEST_UNDO"`` \| ``"REQUEST_REDO"`` \| ``"UNDO"`` \| ``"REDO"`` \| ``"ENABLE_NEW_SELECTION_INPUT"`` \| ``"DISABLE_SELECTION_INPUT"`` \| ``"UNFOCUS_SELECTION_INPUT"`` \| ``"FOCUS_RANGE"`` \| ``"ADD_EMPTY_RANGE"`` \| ``"REMOVE_RANGE"`` \| ``"CHANGE_RANGE"`` \| ``"COPY"`` \| ``"CUT"`` \| ``"PASTE"`` \| ``"AUTOFILL_CELL"`` \| ``"PASTE_FROM_OS_CLIPBOARD"`` \| ``"ACTIVATE_PAINT_FORMAT"`` \| ``"PASTE_CONDITIONAL_FORMAT"`` \| ``"AUTORESIZE_COLUMNS"`` \| ``"AUTORESIZE_ROWS"`` \| ``"MOVE_COLUMNS_ROWS"`` \| ``"ACTIVATE_SHEET"`` \| ``"PREPARE_SELECTION_INPUT_EXPANSION"`` \| ``"STOP_SELECTION_INPUT"`` \| ``"EVALUATE_CELLS"`` \| ``"CHANGE_HIGHLIGHT"`` \| ``"START_CHANGE_HIGHLIGHT"`` \| ``"SET_HIGHLIGHT_COLOR"`` \| ``"STOP_COMPOSER_RANGE_SELECTION"`` \| ``"START_EDITION"`` \| ``"STOP_EDITION"`` \| ``"SET_CURRENT_CONTENT"`` \| ``"CHANGE_COMPOSER_CURSOR_SELECTION"`` \| ``"REPLACE_COMPOSER_CURSOR_SELECTION"`` \| ``"CYCLE_EDITION_REFERENCES"`` \| ``"START"`` \| ``"AUTOFILL"`` \| ``"AUTOFILL_SELECT"`` \| ``"SET_FORMULA_VISIBILITY"`` \| ``"AUTOFILL_AUTO"`` \| ``"SELECT_FIGURE"`` \| ``"UPDATE_SEARCH"`` \| ``"CLEAR_SEARCH"`` \| ``"SELECT_SEARCH_PREVIOUS_MATCH"`` \| ``"SELECT_SEARCH_NEXT_MATCH"`` \| ``"REPLACE_SEARCH"`` \| ``"REPLACE_ALL_SEARCH"`` \| ``"SORT_CELLS"`` \| ``"RESIZE_SHEETVIEW"`` \| ``"SUM_SELECTION"`` \| ``"DELETE_CELL"`` \| ``"INSERT_CELL"`` \| ``"SET_VIEWPORT_OFFSET"`` \| ``"SHIFT_VIEWPORT_DOWN"`` \| ``"SHIFT_VIEWPORT_UP"`` \| ``"OPEN_CELL_POPOVER"`` \| ``"CLOSE_CELL_POPOVER"`` \| ``"ACTIVATE_NEXT_SHEET"`` \| ``"ACTIVATE_PREVIOUS_SHEET"``\> - -___ - -### readonlyAllowedCommands - -• **readonlyAllowedCommands**: `Set`<``"UPDATE_CELL"`` \| ``"UPDATE_CELL_POSITION"`` \| ``"CLEAR_CELL"`` \| ``"DELETE_CONTENT"`` \| ``"SET_DECIMAL"`` \| ``"ADD_COLUMNS_ROWS"`` \| ``"REMOVE_COLUMNS_ROWS"`` \| ``"RESIZE_COLUMNS_ROWS"`` \| ``"HIDE_COLUMNS_ROWS"`` \| ``"UNHIDE_COLUMNS_ROWS"`` \| ``"SET_GRID_LINES_VISIBILITY"`` \| ``"FREEZE_COLUMNS"`` \| ``"FREEZE_ROWS"`` \| ``"UNFREEZE_COLUMNS_ROWS"`` \| ``"UNFREEZE_COLUMNS"`` \| ``"UNFREEZE_ROWS"`` \| ``"ADD_MERGE"`` \| ``"REMOVE_MERGE"`` \| ``"CREATE_SHEET"`` \| ``"DELETE_SHEET"`` \| ``"DUPLICATE_SHEET"`` \| ``"MOVE_SHEET"`` \| ``"RENAME_SHEET"`` \| ``"HIDE_SHEET"`` \| ``"SHOW_SHEET"`` \| ``"MOVE_RANGES"`` \| ``"ADD_CONDITIONAL_FORMAT"`` \| ``"REMOVE_CONDITIONAL_FORMAT"`` \| ``"MOVE_CONDITIONAL_FORMAT"`` \| ``"CREATE_FIGURE"`` \| ``"DELETE_FIGURE"`` \| ``"UPDATE_FIGURE"`` \| ``"SET_FORMATTING"`` \| ``"CLEAR_FORMATTING"`` \| ``"SET_BORDER"`` \| ``"CREATE_CHART"`` \| ``"UPDATE_CHART"`` \| ``"REQUEST_UNDO"`` \| ``"REQUEST_REDO"`` \| ``"UNDO"`` \| ``"REDO"`` \| ``"ENABLE_NEW_SELECTION_INPUT"`` \| ``"DISABLE_SELECTION_INPUT"`` \| ``"UNFOCUS_SELECTION_INPUT"`` \| ``"FOCUS_RANGE"`` \| ``"ADD_EMPTY_RANGE"`` \| ``"REMOVE_RANGE"`` \| ``"CHANGE_RANGE"`` \| ``"COPY"`` \| ``"CUT"`` \| ``"PASTE"`` \| ``"AUTOFILL_CELL"`` \| ``"PASTE_FROM_OS_CLIPBOARD"`` \| ``"ACTIVATE_PAINT_FORMAT"`` \| ``"PASTE_CONDITIONAL_FORMAT"`` \| ``"AUTORESIZE_COLUMNS"`` \| ``"AUTORESIZE_ROWS"`` \| ``"MOVE_COLUMNS_ROWS"`` \| ``"ACTIVATE_SHEET"`` \| ``"PREPARE_SELECTION_INPUT_EXPANSION"`` \| ``"STOP_SELECTION_INPUT"`` \| ``"EVALUATE_CELLS"`` \| ``"CHANGE_HIGHLIGHT"`` \| ``"START_CHANGE_HIGHLIGHT"`` \| ``"SET_HIGHLIGHT_COLOR"`` \| ``"STOP_COMPOSER_RANGE_SELECTION"`` \| ``"START_EDITION"`` \| ``"STOP_EDITION"`` \| ``"SET_CURRENT_CONTENT"`` \| ``"CHANGE_COMPOSER_CURSOR_SELECTION"`` \| ``"REPLACE_COMPOSER_CURSOR_SELECTION"`` \| ``"CYCLE_EDITION_REFERENCES"`` \| ``"START"`` \| ``"AUTOFILL"`` \| ``"AUTOFILL_SELECT"`` \| ``"SET_FORMULA_VISIBILITY"`` \| ``"AUTOFILL_AUTO"`` \| ``"SELECT_FIGURE"`` \| ``"UPDATE_SEARCH"`` \| ``"CLEAR_SEARCH"`` \| ``"SELECT_SEARCH_PREVIOUS_MATCH"`` \| ``"SELECT_SEARCH_NEXT_MATCH"`` \| ``"REPLACE_SEARCH"`` \| ``"REPLACE_ALL_SEARCH"`` \| ``"SORT_CELLS"`` \| ``"RESIZE_SHEETVIEW"`` \| ``"SUM_SELECTION"`` \| ``"DELETE_CELL"`` \| ``"INSERT_CELL"`` \| ``"SET_VIEWPORT_OFFSET"`` \| ``"SHIFT_VIEWPORT_DOWN"`` \| ``"SHIFT_VIEWPORT_UP"`` \| ``"OPEN_CELL_POPOVER"`` \| ``"CLOSE_CELL_POPOVER"`` \| ``"ACTIVATE_NEXT_SHEET"`` \| ``"ACTIVATE_PREVIOUS_SHEET"``\> - -___ - -### registries - -• **registries**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `autofillModifiersRegistry` | [`Registry`](classes/Registry.md)<`AutofillModifierImplementation`\> | -| `autofillRulesRegistry` | [`Registry`](classes/Registry.md)<`AutofillRule`\> | -| `cellMenuRegistry` | `MenuItemRegistry` | -| `cellPopoverRegistry` | [`Registry`](classes/Registry.md)<`PopoverBuilders`\> | -| `cellRegistry` | [`Registry`](classes/Registry.md)<`CellBuilder`\> | -| `chartComponentRegistry` | [`Registry`](classes/Registry.md)<`fn`\> | -| `chartRegistry` | [`Registry`](classes/Registry.md)<`ChartBuilder`\> | -| `chartSidePanelComponentRegistry` | [`Registry`](classes/Registry.md)<`ChartSidePanel`\> | -| `clickableCellRegistry` | [`Registry`](classes/Registry.md)<`CellClickableItem`\> | -| `colMenuRegistry` | `MenuItemRegistry` | -| `corePluginRegistry` | [`Registry`](classes/Registry.md)<`CorePluginConstructor`\> | -| `figureRegistry` | [`Registry`](classes/Registry.md)<`FigureContent`\> | -| `functionRegistry` | `FunctionRegistry` | -| `inverseCommandRegistry` | [`Registry`](classes/Registry.md)<`InverseFunction`\> | -| `linkMenuRegistry` | `MenuItemRegistry` | -| `otRegistry` | `OTRegistry` | -| `rowMenuRegistry` | `MenuItemRegistry` | -| `sheetMenuRegistry` | `MenuItemRegistry` | -| `sidePanelRegistry` | [`Registry`](classes/Registry.md)<`SidePanelContent`\> | -| `topbarComponentRegistry` | `TopBarComponentRegistry` | -| `topbarMenuRegistry` | `MenuItemRegistry` | -| `uiPluginRegistry` | [`Registry`](classes/Registry.md)<`UIPluginConstructor`\> | - -## Functions - -### astToFormula - -▸ **astToFormula**(`ast`): `string` - -Converts an ast formula to the corresponding string - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ast` | `AST` | - -#### Returns - -`string` - -___ - -### compile - -▸ **compile**(`formula`): `CompiledFormula` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `formula` | `string` | - -#### Returns - -`CompiledFormula` - -___ - -### convertAstNodes - -▸ **convertAstNodes**<`T`\>(`ast`, `type`, `fn`): `any` - -Allows to visit all nodes of an AST and apply a mapping function -to nodes of a specific type. -Useful if you want to convert some part of a formula. - -e.g. -```ts -convertAstNodes(ast, "FUNCALL", convertFormulaToExcel) - -function convertFormulaToExcel(ast: ASTFuncall) { - // ... - return modifiedAst -} -``` - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends ``"BIN_OPERATION"`` \| ``"UNARY_OPERATION"`` \| ``"FUNCALL"`` \| ``"NUMBER"`` \| ``"BOOLEAN"`` \| ``"STRING"`` \| ``"REFERENCE"`` \| ``"UNKNOWN"`` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ast` | `AST` | -| `type` | `T` | -| `fn` | (`ast`: `Extract`<`ASTOperation`, `Object`\> \| `Extract`<`ASTUnaryOperation`, `Object`\> \| `Extract`<`ASTFuncall`, `Object`\> \| `Extract`<`ASTNumber`, `Object`\> \| `Extract`<`ASTBoolean`, `Object`\> \| `Extract`<`ASTString`, `Object`\> \| `Extract`<`ASTReference`, `Object`\> \| `Extract`<`ASTUnknown`, `Object`\>) => `AST` | - -#### Returns - -`any` - -___ - -### findCellInNewZone - -▸ **findCellInNewZone**(`oldZone`, `currentZone`): `Position` - -This function will compare the modifications of selection to determine -a cell that is part of the new zone and not the previous one. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `oldZone` | `Zone` | -| `currentZone` | `Zone` | - -#### Returns - -`Position` - -___ - -### load - -▸ **load**(`data?`, `verboseImport?`): `WorkbookData` - -This function tries to load anything that could look like a valid -workbookData object. It applies any migrations, if needed, and return a -current, complete workbookData object. - -It also ensures that there is at least one sheet. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data?` | `any` | -| `verboseImport?` | `boolean` | - -#### Returns - -`WorkbookData` - -___ - -### parse - -▸ **parse**(`str`): `AST` - -Parse an expression (as a string) into an AST. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `str` | `string` | - -#### Returns - -`AST` - -___ - -### setTranslationMethod - -▸ **setTranslationMethod**(`tfn`): `void` - -Allow to inject a translation function from outside o-spreadsheet. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tfn` | `TranslationFunction` | the function that will do the translation | - -#### Returns - -`void` - -___ - -### tokenize - -▸ **tokenize**(`str`): `Token`[] - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `str` | `string` | - -#### Returns - -`Token`[] diff --git a/doc/tsdoc/classes/AbstractChart.md b/doc/tsdoc/classes/AbstractChart.md deleted file mode 100644 index daeb8a724b..0000000000 --- a/doc/tsdoc/classes/AbstractChart.md +++ /dev/null @@ -1,221 +0,0 @@ -[o-spreadsheet API](../README.md) / AbstractChart - -# Class: AbstractChart - -AbstractChart is the class from which every Chart should inherit. -The role of this class is to maintain the state of each chart. - -## Table of contents - -### Constructors - -- [constructor](AbstractChart.md#constructor) - -### Properties - -- [getters](AbstractChart.md#getters) -- [sheetId](AbstractChart.md#sheetid) -- [title](AbstractChart.md#title) -- [type](AbstractChart.md#type) - -### Methods - -- [copyForSheetId](AbstractChart.md#copyforsheetid) -- [copyInSheetId](AbstractChart.md#copyinsheetid) -- [getContextCreation](AbstractChart.md#getcontextcreation) -- [getDefinition](AbstractChart.md#getdefinition) -- [getDefinitionForExcel](AbstractChart.md#getdefinitionforexcel) -- [updateRanges](AbstractChart.md#updateranges) -- [getDefinitionFromContextCreation](AbstractChart.md#getdefinitionfromcontextcreation) -- [transformDefinition](AbstractChart.md#transformdefinition) -- [validateChartDefinition](AbstractChart.md#validatechartdefinition) - -## Constructors - -### constructor - -• **new AbstractChart**(`definition`, `sheetId`, `getters`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `definition` | `ChartDefinition` | -| `sheetId` | `UID` | -| `getters` | `CoreGetters` | - -## Properties - -### getters - -• `Protected` `Readonly` **getters**: `CoreGetters` - -___ - -### sheetId - -• `Readonly` **sheetId**: `UID` - -___ - -### title - -• `Readonly` **title**: `string` - -___ - -### type - -• `Readonly` `Abstract` **type**: `ChartType` - -## Methods - -### copyForSheetId - -▸ `Abstract` **copyForSheetId**(`sheetId`): [`AbstractChart`](AbstractChart.md) - -Get a copy a the chart adapted to the given sheetId. -The ranges that are in the same sheet as the chart will be adapted to the given sheetId. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sheetId` | `UID` | - -#### Returns - -[`AbstractChart`](AbstractChart.md) - -___ - -### copyInSheetId - -▸ `Abstract` **copyInSheetId**(`sheetId`): [`AbstractChart`](AbstractChart.md) - -Get a copy a the chart in the given sheetId. -The ranges of the chart will stay the same as the copied chart. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `sheetId` | `UID` | - -#### Returns - -[`AbstractChart`](AbstractChart.md) - -___ - -### getContextCreation - -▸ `Abstract` **getContextCreation**(): `ChartCreationContext` - -Extract the ChartCreationContext of the chart - -#### Returns - -`ChartCreationContext` - -___ - -### getDefinition - -▸ `Abstract` **getDefinition**(): `ChartDefinition` - -Get the definition of the chart - -#### Returns - -`ChartDefinition` - -___ - -### getDefinitionForExcel - -▸ `Abstract` **getDefinitionForExcel**(): `undefined` \| `ExcelChartDefinition` - -Get the definition of the chart that will be used for excel export. -If the chart is not supported by Excel, this function returns undefined. - -#### Returns - -`undefined` \| `ExcelChartDefinition` - -___ - -### updateRanges - -▸ `Abstract` **updateRanges**(`applyChange`): [`AbstractChart`](AbstractChart.md) - -This function should be used to update all the ranges of the chart after -a grid change (add/remove col/row, rename sheet, ...) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `applyChange` | `ApplyRangeChange` | - -#### Returns - -[`AbstractChart`](AbstractChart.md) - -___ - -### getDefinitionFromContextCreation - -▸ `Static` **getDefinitionFromContextCreation**(`context`): `ChartDefinition` - -Get an empty definition based on the given context - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | `ChartCreationContext` | - -#### Returns - -`ChartDefinition` - -___ - -### transformDefinition - -▸ `Static` **transformDefinition**(`definition`, `executed`): `ChartDefinition` - -Get a new chart definition transformed with the executed command. This -functions will be called during operational transform process - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `definition` | `ChartDefinition` | -| `executed` | `AddColumnsRowsCommand` \| `RemoveColumnsRowsCommand` | - -#### Returns - -`ChartDefinition` - -___ - -### validateChartDefinition - -▸ `Static` **validateChartDefinition**(`validator`, `definition`): [`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] - -Validate the chart definition given as arguments. This function will be -called from allowDispatch function - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `validator` | `Validator` | -| `definition` | `ChartDefinition` | - -#### Returns - -[`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] diff --git a/doc/tsdoc/classes/CorePlugin.md b/doc/tsdoc/classes/CorePlugin.md deleted file mode 100644 index 3ec38a8dce..0000000000 --- a/doc/tsdoc/classes/CorePlugin.md +++ /dev/null @@ -1,431 +0,0 @@ -[o-spreadsheet API](../README.md) / CorePlugin - -# Class: CorePlugin - -Core plugins handle spreadsheet data. -They are responsible to import, export and maintain the spreadsheet -persisted state. -They should not be concerned about UI parts or transient state. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `State` | `any` | -| `C` | `CoreCommand` | - -## Hierarchy - -- `BasePlugin`<`State`, `C`\> - - ↳ **`CorePlugin`** - -## Implements - -- `RangeProvider` - -## Table of contents - -### Constructors - -- [constructor](CorePlugin.md#constructor) - -### Properties - -- [dispatch](CorePlugin.md#dispatch) -- [getters](CorePlugin.md#getters) -- [history](CorePlugin.md#history) -- [range](CorePlugin.md#range) -- [uuidGenerator](CorePlugin.md#uuidgenerator) -- [getters](CorePlugin.md#getters) - -### Methods - -- [adaptRanges](CorePlugin.md#adaptranges) -- [allowDispatch](CorePlugin.md#allowdispatch) -- [batchValidations](CorePlugin.md#batchvalidations) -- [beforeHandle](CorePlugin.md#beforehandle) -- [chainValidations](CorePlugin.md#chainvalidations) -- [checkValidations](CorePlugin.md#checkvalidations) -- [export](CorePlugin.md#export) -- [exportForExcel](CorePlugin.md#exportforexcel) -- [finalize](CorePlugin.md#finalize) -- [handle](CorePlugin.md#handle) -- [import](CorePlugin.md#import) - -## Constructors - -### constructor - -• **new CorePlugin**<`State`, `C`\>(`getters`, `stateObserver`, `range`, `dispatch`, `config`, `uuidGenerator`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `State` | `any` | -| `C` | `CoreCommand` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `getters` | `CoreGetters` | -| `stateObserver` | `StateObserver` | -| `range` | `RangeAdapter` | -| `dispatch` | (`type`: {} extends `Omit`<`C`, ``"type"``\> ? `T` : `never`) => [`DispatchResult`](DispatchResult.md)(`type`: `T`, `r`: `Omit`<`C`, ``"type"``\>) => [`DispatchResult`](DispatchResult.md) | -| `config` | `ModelConfig` | -| `uuidGenerator` | `UuidGenerator` | - -#### Overrides - -BasePlugin<State, C\>.constructor - -## Properties - -### dispatch - -• `Protected` **dispatch**: (`type`: {} extends `Omit`<`C`, ``"type"``\> ? `T` : `never`) => [`DispatchResult`](DispatchResult.md)(`type`: `T`, `r`: `Omit`<`C`, ``"type"``\>) => [`DispatchResult`](DispatchResult.md) - -#### Type declaration - -▸ <`T`, `C`\>(`type`): [`DispatchResult`](DispatchResult.md) - -##### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends ``"UPDATE_CELL"`` \| ``"UPDATE_CELL_POSITION"`` \| ``"CLEAR_CELL"`` \| ``"DELETE_CONTENT"`` \| ``"SET_DECIMAL"`` \| ``"ADD_COLUMNS_ROWS"`` \| ``"REMOVE_COLUMNS_ROWS"`` \| ``"RESIZE_COLUMNS_ROWS"`` \| ``"HIDE_COLUMNS_ROWS"`` \| ``"UNHIDE_COLUMNS_ROWS"`` \| ``"SET_GRID_LINES_VISIBILITY"`` \| ``"FREEZE_COLUMNS"`` \| ``"FREEZE_ROWS"`` \| ``"UNFREEZE_COLUMNS_ROWS"`` \| ``"UNFREEZE_COLUMNS"`` \| ``"UNFREEZE_ROWS"`` \| ``"ADD_MERGE"`` \| ``"REMOVE_MERGE"`` \| ``"CREATE_SHEET"`` \| ``"DELETE_SHEET"`` \| ``"DUPLICATE_SHEET"`` \| ``"MOVE_SHEET"`` \| ``"RENAME_SHEET"`` \| ``"HIDE_SHEET"`` \| ``"SHOW_SHEET"`` \| ``"MOVE_RANGES"`` \| ``"ADD_CONDITIONAL_FORMAT"`` \| ``"REMOVE_CONDITIONAL_FORMAT"`` \| ``"MOVE_CONDITIONAL_FORMAT"`` \| ``"CREATE_FIGURE"`` \| ``"DELETE_FIGURE"`` \| ``"UPDATE_FIGURE"`` \| ``"SET_FORMATTING"`` \| ``"CLEAR_FORMATTING"`` \| ``"SET_BORDER"`` \| ``"CREATE_CHART"`` \| ``"UPDATE_CHART"`` | -| `C` | extends { `type`: `T` } & `UpdateCellCommand` \| { `type`: `T` } & `UpdateCellPositionCommand` \| { `type`: `T` } & `ClearCellCommand` \| { `type`: `T` } & `DeleteContentCommand` \| { `type`: `T` } & `SetDecimalCommand` \| { `type`: `T` } & `AddColumnsRowsCommand` \| { `type`: `T` } & `RemoveColumnsRowsCommand` \| { `type`: `T` } & `ResizeColumnsRowsCommand` \| { `type`: `T` } & `HideColumnsRowsCommand` \| { `type`: `T` } & `UnhideColumnsRowsCommand` \| { `type`: `T` } & `SetGridLinesVisibilityCommand` \| { `type`: `T` } & `FreezeColumnsCommand` \| { `type`: `T` } & `FreezeRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsCommand` \| { `type`: `T` } & `UnfreezeRowsCommand` \| { `type`: `T` } & `AddMergeCommand` \| { `type`: `T` } & `RemoveMergeCommand` \| { `type`: `T` } & `CreateSheetCommand` \| { `type`: `T` } & `DeleteSheetCommand` \| { `type`: `T` } & `DuplicateSheetCommand` \| { `type`: `T` } & `MoveSheetCommand` \| { `type`: `T` } & `RenameSheetCommand` \| { `type`: `T` } & `HideSheetCommand` \| { `type`: `T` } & `ShowSheetCommand` \| { `type`: `T` } & `MoveRangeCommand` \| { `type`: `T` } & `AddConditionalFormatCommand` \| { `type`: `T` } & `RemoveConditionalFormatCommand` \| { `type`: `T` } & `MoveConditionalFormatCommand` \| { `type`: `T` } & `CreateFigureCommand` \| { `type`: `T` } & `DeleteFigureCommand` \| { `type`: `T` } & `UpdateFigureCommand` \| { `type`: `T` } & `SetFormattingCommand` \| { `type`: `T` } & `ClearFormattingCommand` \| { `type`: `T` } & `SetBorderCommand` \| { `type`: `T` } & `CreateChartCommand` \| { `type`: `T` } & `UpdateChartCommand` | - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | {} extends `Omit`<`C`, ``"type"``\> ? `T` : `never` | - -##### Returns - -[`DispatchResult`](DispatchResult.md) - -▸ <`T`, `C`\>(`type`, `r`): [`DispatchResult`](DispatchResult.md) - -##### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends ``"UPDATE_CELL"`` \| ``"UPDATE_CELL_POSITION"`` \| ``"CLEAR_CELL"`` \| ``"DELETE_CONTENT"`` \| ``"SET_DECIMAL"`` \| ``"ADD_COLUMNS_ROWS"`` \| ``"REMOVE_COLUMNS_ROWS"`` \| ``"RESIZE_COLUMNS_ROWS"`` \| ``"HIDE_COLUMNS_ROWS"`` \| ``"UNHIDE_COLUMNS_ROWS"`` \| ``"SET_GRID_LINES_VISIBILITY"`` \| ``"FREEZE_COLUMNS"`` \| ``"FREEZE_ROWS"`` \| ``"UNFREEZE_COLUMNS_ROWS"`` \| ``"UNFREEZE_COLUMNS"`` \| ``"UNFREEZE_ROWS"`` \| ``"ADD_MERGE"`` \| ``"REMOVE_MERGE"`` \| ``"CREATE_SHEET"`` \| ``"DELETE_SHEET"`` \| ``"DUPLICATE_SHEET"`` \| ``"MOVE_SHEET"`` \| ``"RENAME_SHEET"`` \| ``"HIDE_SHEET"`` \| ``"SHOW_SHEET"`` \| ``"MOVE_RANGES"`` \| ``"ADD_CONDITIONAL_FORMAT"`` \| ``"REMOVE_CONDITIONAL_FORMAT"`` \| ``"MOVE_CONDITIONAL_FORMAT"`` \| ``"CREATE_FIGURE"`` \| ``"DELETE_FIGURE"`` \| ``"UPDATE_FIGURE"`` \| ``"SET_FORMATTING"`` \| ``"CLEAR_FORMATTING"`` \| ``"SET_BORDER"`` \| ``"CREATE_CHART"`` \| ``"UPDATE_CHART"`` | -| `C` | extends { `type`: `T` } & `UpdateCellCommand` \| { `type`: `T` } & `UpdateCellPositionCommand` \| { `type`: `T` } & `ClearCellCommand` \| { `type`: `T` } & `DeleteContentCommand` \| { `type`: `T` } & `SetDecimalCommand` \| { `type`: `T` } & `AddColumnsRowsCommand` \| { `type`: `T` } & `RemoveColumnsRowsCommand` \| { `type`: `T` } & `ResizeColumnsRowsCommand` \| { `type`: `T` } & `HideColumnsRowsCommand` \| { `type`: `T` } & `UnhideColumnsRowsCommand` \| { `type`: `T` } & `SetGridLinesVisibilityCommand` \| { `type`: `T` } & `FreezeColumnsCommand` \| { `type`: `T` } & `FreezeRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsCommand` \| { `type`: `T` } & `UnfreezeRowsCommand` \| { `type`: `T` } & `AddMergeCommand` \| { `type`: `T` } & `RemoveMergeCommand` \| { `type`: `T` } & `CreateSheetCommand` \| { `type`: `T` } & `DeleteSheetCommand` \| { `type`: `T` } & `DuplicateSheetCommand` \| { `type`: `T` } & `MoveSheetCommand` \| { `type`: `T` } & `RenameSheetCommand` \| { `type`: `T` } & `HideSheetCommand` \| { `type`: `T` } & `ShowSheetCommand` \| { `type`: `T` } & `MoveRangeCommand` \| { `type`: `T` } & `AddConditionalFormatCommand` \| { `type`: `T` } & `RemoveConditionalFormatCommand` \| { `type`: `T` } & `MoveConditionalFormatCommand` \| { `type`: `T` } & `CreateFigureCommand` \| { `type`: `T` } & `DeleteFigureCommand` \| { `type`: `T` } & `UpdateFigureCommand` \| { `type`: `T` } & `SetFormattingCommand` \| { `type`: `T` } & `ClearFormattingCommand` \| { `type`: `T` } & `SetBorderCommand` \| { `type`: `T` } & `CreateChartCommand` \| { `type`: `T` } & `UpdateChartCommand` | - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `T` | -| `r` | `Omit`<`C`, ``"type"``\> | - -##### Returns - -[`DispatchResult`](DispatchResult.md) - -#### Inherited from - -BasePlugin.dispatch - -___ - -### getters - -• `Protected` **getters**: `CoreGetters` - -___ - -### history - -• `Protected` **history**: `WorkbookHistory`<`State`\> - -#### Inherited from - -BasePlugin.history - -___ - -### range - -• `Protected` **range**: `RangeAdapter` - -___ - -### uuidGenerator - -• `Protected` **uuidGenerator**: `UuidGenerator` - -___ - -### getters - -▪ `Static` **getters**: readonly `string`[] = `[]` - -#### Inherited from - -BasePlugin.getters - -## Methods - -### adaptRanges - -▸ **adaptRanges**(`applyChange`, `sheetId?`): `void` - -This method can be implemented in any plugin, to loop over the plugin's data structure and adapt the plugin's ranges. -To adapt them, the implementation of the function must have a perfect knowledge of the data structure, thus -implementing the loops over it makes sense in the plugin itself. -When calling the method applyChange, the range will be adapted if necessary, then a copy will be returned along with -the type of change that occurred. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `applyChange` | `ApplyRangeChange` | a function that, when called, will adapt the range according to the change on the grid | -| `sheetId?` | `UID` | an optional sheetId to adapt either range of that sheet specifically, or ranges pointing to that sheet | - -#### Returns - -`void` - -#### Implementation of - -RangeProvider.adaptRanges - -___ - -### allowDispatch - -▸ **allowDispatch**(`command`): [`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] - -Before a command is accepted, the model will ask each plugin if the command -is allowed. If all of then return true, then we can proceed. Otherwise, -the command is cancelled. - -There should not be any side effects in this method. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `command` | `C` | - -#### Returns - -[`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] - -#### Inherited from - -BasePlugin.allowDispatch - -___ - -### batchValidations - -▸ **batchValidations**<`T`\>(...`validations`): `Validation`<`T`\> - -Combine multiple validation functions into a single function -returning the list of result of every validation. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...validations` | `Validation`<`T`\>[] | - -#### Returns - -`Validation`<`T`\> - -#### Inherited from - -BasePlugin.batchValidations - -___ - -### beforeHandle - -▸ **beforeHandle**(`command`): `void` - -This method is useful when a plugin need to perform some action before a -command is handled in another plugin. This should only be used if it is not -possible to do the work in the handle method. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `command` | `C` | - -#### Returns - -`void` - -#### Inherited from - -BasePlugin.beforeHandle - -___ - -### chainValidations - -▸ **chainValidations**<`T`\>(...`validations`): `Validation`<`T`\> - -Combine multiple validation functions. Every validation is executed one after -the other. As soon as one validation fails, it stops and the cancelled reason -is returned. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...validations` | `Validation`<`T`\>[] | - -#### Returns - -`Validation`<`T`\> - -#### Inherited from - -BasePlugin.chainValidations - -___ - -### checkValidations - -▸ **checkValidations**<`T`\>(`command`, ...`validations`): [`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `command` | `T` | -| `...validations` | `Validation`<`T`\>[] | - -#### Returns - -[`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] - -#### Inherited from - -BasePlugin.checkValidations - -___ - -### export - -▸ **export**(`data`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `WorkbookData` | - -#### Returns - -`void` - -___ - -### exportForExcel - -▸ **exportForExcel**(`data`): `void` - -Export for excel should be available for all plugins, even for the UI. -In some case, we need to export evaluated value, which is available from -UI plugin only. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `ExcelWorkbookData` | - -#### Returns - -`void` - -#### Inherited from - -BasePlugin.exportForExcel - -___ - -### finalize - -▸ **finalize**(): `void` - -Sometimes, it is useful to perform some work after a command (and all its -subcommands) has been completely handled. For example, when we paste -multiple cells, we only want to reevaluate the cell values once at the end. - -#### Returns - -`void` - -#### Inherited from - -BasePlugin.finalize - -___ - -### handle - -▸ **handle**(`command`): `void` - -This is the standard place to handle any command. Most of the plugin -command handling work should take place here. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `command` | `C` | - -#### Returns - -`void` - -#### Inherited from - -BasePlugin.handle - -___ - -### import - -▸ **import**(`data`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `WorkbookData` | - -#### Returns - -`void` diff --git a/doc/tsdoc/classes/DispatchResult.md b/doc/tsdoc/classes/DispatchResult.md deleted file mode 100644 index 9bfee07ecf..0000000000 --- a/doc/tsdoc/classes/DispatchResult.md +++ /dev/null @@ -1,85 +0,0 @@ -[o-spreadsheet API](../README.md) / DispatchResult - -# Class: DispatchResult - -Holds the result of a command dispatch. -The command may have been successfully dispatched or cancelled -for one or more reasons. - -## Table of contents - -### Constructors - -- [constructor](DispatchResult.md#constructor) - -### Properties - -- [reasons](DispatchResult.md#reasons) - -### Accessors - -- [isSuccessful](DispatchResult.md#issuccessful) -- [Success](DispatchResult.md#success) - -### Methods - -- [isCancelledBecause](DispatchResult.md#iscancelledbecause) - -## Constructors - -### constructor - -• **new DispatchResult**(`results?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `results` | [`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] | `[]` | - -## Properties - -### reasons - -• `Readonly` **reasons**: [`CancelledReason`](../README.md#cancelledreason)[] - -## Accessors - -### isSuccessful - -• `get` **isSuccessful**(): `boolean` - -#### Returns - -`boolean` - -___ - -### Success - -• `Static` `get` **Success**(): [`DispatchResult`](DispatchResult.md) - -Static helper which returns a successful DispatchResult - -#### Returns - -[`DispatchResult`](DispatchResult.md) - -## Methods - -### isCancelledBecause - -▸ **isCancelledBecause**(`reason`): `boolean` - -Check if the dispatch has been cancelled because of -the given reason. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `reason` | [`CancelledReason`](../README.md#cancelledreason) | - -#### Returns - -`boolean` diff --git a/doc/tsdoc/classes/EvaluationError.md b/doc/tsdoc/classes/EvaluationError.md deleted file mode 100644 index 2b9abc79cf..0000000000 --- a/doc/tsdoc/classes/EvaluationError.md +++ /dev/null @@ -1,50 +0,0 @@ -[o-spreadsheet API](../README.md) / EvaluationError - -# Class: EvaluationError - -## Hierarchy - -- `Error` - - ↳ **`EvaluationError`** - -## Table of contents - -### Constructors - -- [constructor](EvaluationError.md#constructor) - -### Properties - -- [errorType](EvaluationError.md#errortype) -- [logLevel](EvaluationError.md#loglevel) - -## Constructors - -### constructor - -• **new EvaluationError**(`errorType`, `message`, `logLevel?`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `errorType` | `string` | -| `message` | `string` | -| `logLevel` | `number` | - -#### Overrides - -Error.constructor - -## Properties - -### errorType - -• `Readonly` **errorType**: `string` - -___ - -### logLevel - -• `Readonly` **logLevel**: `number` diff --git a/doc/tsdoc/classes/Model.md b/doc/tsdoc/classes/Model.md deleted file mode 100644 index 17ee682350..0000000000 --- a/doc/tsdoc/classes/Model.md +++ /dev/null @@ -1,393 +0,0 @@ -[o-spreadsheet API](../README.md) / Model - -# Class: Model - -## Hierarchy - -- `EventBus`<`any`\> - - ↳ **`Model`** - -## Implements - -- `CommandDispatcher` - -## Table of contents - -### Constructors - -- [constructor](Model.md#constructor) - -### Properties - -- [dispatch](Model.md#dispatch) -- [getters](Model.md#getters) -- [selection](Model.md#selection) -- [subscriptions](Model.md#subscriptions) -- [uuidGenerator](Model.md#uuidgenerator) - -### Accessors - -- [handlers](Model.md#handlers) - -### Methods - -- [clear](Model.md#clear) -- [drawGrid](Model.md#drawgrid) -- [exportData](Model.md#exportdata) -- [exportXLSX](Model.md#exportxlsx) -- [joinSession](Model.md#joinsession) -- [leaveSession](Model.md#leavesession) -- [off](Model.md#off) -- [on](Model.md#on) -- [trigger](Model.md#trigger) -- [updateMode](Model.md#updatemode) - -## Constructors - -### constructor - -• **new Model**(`data?`, `config?`, `stateUpdateMessages?`, `uuidGenerator?`, `verboseImport?`) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `data` | `any` | `{}` | -| `config` | `Partial`<`ModelConfig`\> | `{}` | -| `stateUpdateMessages` | `StateUpdateMessage`[] | `[]` | -| `uuidGenerator` | `UuidGenerator` | `undefined` | -| `verboseImport` | `boolean` | `true` | - -#### Overrides - -EventBus<any\>.constructor - -## Properties - -### dispatch - -• **dispatch**: (`type`: {} extends `Omit`<`C`, ``"type"``\> ? `T` : `never`) => [`DispatchResult`](DispatchResult.md)(`type`: `T`, `r`: `Omit`<`C`, ``"type"``\>) => [`DispatchResult`](DispatchResult.md) - -#### Type declaration - -▸ <`T`, `C`\>(`type`): [`DispatchResult`](DispatchResult.md) - -The dispatch method is the only entry point to manipulate data in the model. -This is through this method that commands are dispatched most of the time -recursively until no plugin want to react anymore. - -CoreCommands dispatched from this function are saved in the history. - -Small technical detail: it is defined as an arrow function. There are two -reasons for this: -1. this means that the dispatch method can be "detached" from the model, - which is done when it is put in the environment (see the Spreadsheet - component) -2. This allows us to define its type by using the interface CommandDispatcher - -##### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends ``"UPDATE_CELL"`` \| ``"UPDATE_CELL_POSITION"`` \| ``"CLEAR_CELL"`` \| ``"DELETE_CONTENT"`` \| ``"SET_DECIMAL"`` \| ``"ADD_COLUMNS_ROWS"`` \| ``"REMOVE_COLUMNS_ROWS"`` \| ``"RESIZE_COLUMNS_ROWS"`` \| ``"HIDE_COLUMNS_ROWS"`` \| ``"UNHIDE_COLUMNS_ROWS"`` \| ``"SET_GRID_LINES_VISIBILITY"`` \| ``"FREEZE_COLUMNS"`` \| ``"FREEZE_ROWS"`` \| ``"UNFREEZE_COLUMNS_ROWS"`` \| ``"UNFREEZE_COLUMNS"`` \| ``"UNFREEZE_ROWS"`` \| ``"ADD_MERGE"`` \| ``"REMOVE_MERGE"`` \| ``"CREATE_SHEET"`` \| ``"DELETE_SHEET"`` \| ``"DUPLICATE_SHEET"`` \| ``"MOVE_SHEET"`` \| ``"RENAME_SHEET"`` \| ``"HIDE_SHEET"`` \| ``"SHOW_SHEET"`` \| ``"MOVE_RANGES"`` \| ``"ADD_CONDITIONAL_FORMAT"`` \| ``"REMOVE_CONDITIONAL_FORMAT"`` \| ``"MOVE_CONDITIONAL_FORMAT"`` \| ``"CREATE_FIGURE"`` \| ``"DELETE_FIGURE"`` \| ``"UPDATE_FIGURE"`` \| ``"SET_FORMATTING"`` \| ``"CLEAR_FORMATTING"`` \| ``"SET_BORDER"`` \| ``"CREATE_CHART"`` \| ``"UPDATE_CHART"`` \| ``"REQUEST_UNDO"`` \| ``"REQUEST_REDO"`` \| ``"UNDO"`` \| ``"REDO"`` \| ``"ENABLE_NEW_SELECTION_INPUT"`` \| ``"DISABLE_SELECTION_INPUT"`` \| ``"UNFOCUS_SELECTION_INPUT"`` \| ``"FOCUS_RANGE"`` \| ``"ADD_EMPTY_RANGE"`` \| ``"REMOVE_RANGE"`` \| ``"CHANGE_RANGE"`` \| ``"COPY"`` \| ``"CUT"`` \| ``"PASTE"`` \| ``"AUTOFILL_CELL"`` \| ``"PASTE_FROM_OS_CLIPBOARD"`` \| ``"ACTIVATE_PAINT_FORMAT"`` \| ``"PASTE_CONDITIONAL_FORMAT"`` \| ``"AUTORESIZE_COLUMNS"`` \| ``"AUTORESIZE_ROWS"`` \| ``"MOVE_COLUMNS_ROWS"`` \| ``"ACTIVATE_SHEET"`` \| ``"PREPARE_SELECTION_INPUT_EXPANSION"`` \| ``"STOP_SELECTION_INPUT"`` \| ``"EVALUATE_CELLS"`` \| ``"CHANGE_HIGHLIGHT"`` \| ``"START_CHANGE_HIGHLIGHT"`` \| ``"SET_HIGHLIGHT_COLOR"`` \| ``"STOP_COMPOSER_RANGE_SELECTION"`` \| ``"START_EDITION"`` \| ``"STOP_EDITION"`` \| ``"SET_CURRENT_CONTENT"`` \| ``"CHANGE_COMPOSER_CURSOR_SELECTION"`` \| ``"REPLACE_COMPOSER_CURSOR_SELECTION"`` \| ``"CYCLE_EDITION_REFERENCES"`` \| ``"START"`` \| ``"AUTOFILL"`` \| ``"AUTOFILL_SELECT"`` \| ``"SET_FORMULA_VISIBILITY"`` \| ``"AUTOFILL_AUTO"`` \| ``"SELECT_FIGURE"`` \| ``"UPDATE_SEARCH"`` \| ``"CLEAR_SEARCH"`` \| ``"SELECT_SEARCH_PREVIOUS_MATCH"`` \| ``"SELECT_SEARCH_NEXT_MATCH"`` \| ``"REPLACE_SEARCH"`` \| ``"REPLACE_ALL_SEARCH"`` \| ``"SORT_CELLS"`` \| ``"RESIZE_SHEETVIEW"`` \| ``"SUM_SELECTION"`` \| ``"DELETE_CELL"`` \| ``"INSERT_CELL"`` \| ``"SET_VIEWPORT_OFFSET"`` \| ``"SHIFT_VIEWPORT_DOWN"`` \| ``"SHIFT_VIEWPORT_UP"`` \| ``"OPEN_CELL_POPOVER"`` \| ``"CLOSE_CELL_POPOVER"`` \| ``"ACTIVATE_NEXT_SHEET"`` \| ``"ACTIVATE_PREVIOUS_SHEET"`` | -| `C` | extends { `type`: `T` } & `UpdateCellCommand` \| { `type`: `T` } & `UpdateCellPositionCommand` \| { `type`: `T` } & `ClearCellCommand` \| { `type`: `T` } & `DeleteContentCommand` \| { `type`: `T` } & `SetDecimalCommand` \| { `type`: `T` } & `AddColumnsRowsCommand` \| { `type`: `T` } & `RemoveColumnsRowsCommand` \| { `type`: `T` } & `ResizeColumnsRowsCommand` \| { `type`: `T` } & `HideColumnsRowsCommand` \| { `type`: `T` } & `UnhideColumnsRowsCommand` \| { `type`: `T` } & `SetGridLinesVisibilityCommand` \| { `type`: `T` } & `FreezeColumnsCommand` \| { `type`: `T` } & `FreezeRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsCommand` \| { `type`: `T` } & `UnfreezeRowsCommand` \| { `type`: `T` } & `AddMergeCommand` \| { `type`: `T` } & `RemoveMergeCommand` \| { `type`: `T` } & `CreateSheetCommand` \| { `type`: `T` } & `DeleteSheetCommand` \| { `type`: `T` } & `DuplicateSheetCommand` \| { `type`: `T` } & `MoveSheetCommand` \| { `type`: `T` } & `RenameSheetCommand` \| { `type`: `T` } & `HideSheetCommand` \| { `type`: `T` } & `ShowSheetCommand` \| { `type`: `T` } & `MoveRangeCommand` \| { `type`: `T` } & `AddConditionalFormatCommand` \| { `type`: `T` } & `RemoveConditionalFormatCommand` \| { `type`: `T` } & `MoveConditionalFormatCommand` \| { `type`: `T` } & `CreateFigureCommand` \| { `type`: `T` } & `DeleteFigureCommand` \| { `type`: `T` } & `UpdateFigureCommand` \| { `type`: `T` } & `SetFormattingCommand` \| { `type`: `T` } & `ClearFormattingCommand` \| { `type`: `T` } & `SetBorderCommand` \| { `type`: `T` } & `CreateChartCommand` \| { `type`: `T` } & `UpdateChartCommand` \| { `type`: `T` } & `RequestUndoCommand` \| { `type`: `T` } & `RequestRedoCommand` \| { `type`: `T` } & `UndoCommand` \| { `type`: `T` } & `RedoCommand` \| { `type`: `T` } & `NewInputCommand` \| { `type`: `T` } & `RemoveInputCommand` \| { `type`: `T` } & `UnfocusInputCommand` \| { `type`: `T` } & `FocusInputCommand` \| { `type`: `T` } & `AddEmptyRangeCommand` \| { `type`: `T` } & `RemoveRangeCommand` \| { `type`: `T` } & `ChangeRangeCommand` \| { `type`: `T` } & `CopyCommand` \| { `type`: `T` } & `CutCommand` \| { `type`: `T` } & `PasteCommand` \| { `type`: `T` } & `AutoFillCellCommand` \| { `type`: `T` } & `PasteFromOSClipboardCommand` \| { `type`: `T` } & `ActivatePaintFormatCommand` \| { `type`: `T` } & `PasteCFCommand` \| { `type`: `T` } & `AutoresizeColumnsCommand` \| { `type`: `T` } & `AutoresizeRowsCommand` \| { `type`: `T` } & `MoveColumnsRowsCommand` \| { `type`: `T` } & `ActivateSheetCommand` \| { `type`: `T` } & `PrepareExpansionCommand` \| { `type`: `T` } & `StopSelectionCommand` \| { `type`: `T` } & `EvaluateCellsCommand` \| { `type`: `T` } & `ChangeHighlightCommand` \| { `type`: `T` } & `StartChangeHighlightCommand` \| { `type`: `T` } & `SetColorCommand` \| { `type`: `T` } & `StopComposerSelectionCommand` \| { `type`: `T` } & `StartEditionCommand` \| { `type`: `T` } & `StopEditionCommand` \| { `type`: `T` } & `SetCurrentContentCommand` \| { `type`: `T` } & `ChangeComposerSelectionCommand` \| { `type`: `T` } & `ReplaceComposerSelectionCommand` \| { `type`: `T` } & `CycleEditionReferencesCommand` \| { `type`: `T` } & `StartCommand` \| { `type`: `T` } & `AutofillCommand` \| { `type`: `T` } & `AutofillSelectCommand` \| { `type`: `T` } & `ShowFormulaCommand` \| { `type`: `T` } & `AutofillAutoCommand` \| { `type`: `T` } & `SelectFigureCommand` \| { `type`: `T` } & `UpdateSearchCommand` \| { `type`: `T` } & `RefreshSearchCommand` \| { `type`: `T` } & `ClearSearchCommand` \| { `type`: `T` } & `SelectSearchPreviousCommand` \| { `type`: `T` } & `SelectSearchNextCommand` \| { `type`: `T` } & `ReplaceSearchCommand` \| { `type`: `T` } & `ReplaceAllSearchCommand` \| { `type`: `T` } & `SortCommand` \| { `type`: `T` } & `ResizeViewportCommand` \| { `type`: `T` } & `SumSelectionCommand` \| { `type`: `T` } & `DeleteCellCommand` \| { `type`: `T` } & `InsertCellCommand` \| { `type`: `T` } & `SetViewportOffsetCommand` \| { `type`: `T` } & `MoveViewportDownCommand` \| { `type`: `T` } & `MoveViewportUpCommand` \| { `type`: `T` } & `OpenCellPopoverCommand` \| { `type`: `T` } & `CloseCellPopoverCommand` \| { `type`: `T` } & `ActivateNextSheetCommand` \| { `type`: `T` } & `ActivatePreviousSheetCommand` | - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | {} extends `Omit`<`C`, ``"type"``\> ? `T` : `never` | - -##### Returns - -[`DispatchResult`](DispatchResult.md) - -▸ <`T`, `C`\>(`type`, `r`): [`DispatchResult`](DispatchResult.md) - -The dispatch method is the only entry point to manipulate data in the model. -This is through this method that commands are dispatched most of the time -recursively until no plugin want to react anymore. - -CoreCommands dispatched from this function are saved in the history. - -Small technical detail: it is defined as an arrow function. There are two -reasons for this: -1. this means that the dispatch method can be "detached" from the model, - which is done when it is put in the environment (see the Spreadsheet - component) -2. This allows us to define its type by using the interface CommandDispatcher - -##### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends ``"UPDATE_CELL"`` \| ``"UPDATE_CELL_POSITION"`` \| ``"CLEAR_CELL"`` \| ``"DELETE_CONTENT"`` \| ``"SET_DECIMAL"`` \| ``"ADD_COLUMNS_ROWS"`` \| ``"REMOVE_COLUMNS_ROWS"`` \| ``"RESIZE_COLUMNS_ROWS"`` \| ``"HIDE_COLUMNS_ROWS"`` \| ``"UNHIDE_COLUMNS_ROWS"`` \| ``"SET_GRID_LINES_VISIBILITY"`` \| ``"FREEZE_COLUMNS"`` \| ``"FREEZE_ROWS"`` \| ``"UNFREEZE_COLUMNS_ROWS"`` \| ``"UNFREEZE_COLUMNS"`` \| ``"UNFREEZE_ROWS"`` \| ``"ADD_MERGE"`` \| ``"REMOVE_MERGE"`` \| ``"CREATE_SHEET"`` \| ``"DELETE_SHEET"`` \| ``"DUPLICATE_SHEET"`` \| ``"MOVE_SHEET"`` \| ``"RENAME_SHEET"`` \| ``"HIDE_SHEET"`` \| ``"SHOW_SHEET"`` \| ``"MOVE_RANGES"`` \| ``"ADD_CONDITIONAL_FORMAT"`` \| ``"REMOVE_CONDITIONAL_FORMAT"`` \| ``"MOVE_CONDITIONAL_FORMAT"`` \| ``"CREATE_FIGURE"`` \| ``"DELETE_FIGURE"`` \| ``"UPDATE_FIGURE"`` \| ``"SET_FORMATTING"`` \| ``"CLEAR_FORMATTING"`` \| ``"SET_BORDER"`` \| ``"CREATE_CHART"`` \| ``"UPDATE_CHART"`` \| ``"REQUEST_UNDO"`` \| ``"REQUEST_REDO"`` \| ``"UNDO"`` \| ``"REDO"`` \| ``"ENABLE_NEW_SELECTION_INPUT"`` \| ``"DISABLE_SELECTION_INPUT"`` \| ``"UNFOCUS_SELECTION_INPUT"`` \| ``"FOCUS_RANGE"`` \| ``"ADD_EMPTY_RANGE"`` \| ``"REMOVE_RANGE"`` \| ``"CHANGE_RANGE"`` \| ``"COPY"`` \| ``"CUT"`` \| ``"PASTE"`` \| ``"AUTOFILL_CELL"`` \| ``"PASTE_FROM_OS_CLIPBOARD"`` \| ``"ACTIVATE_PAINT_FORMAT"`` \| ``"PASTE_CONDITIONAL_FORMAT"`` \| ``"AUTORESIZE_COLUMNS"`` \| ``"AUTORESIZE_ROWS"`` \| ``"MOVE_COLUMNS_ROWS"`` \| ``"ACTIVATE_SHEET"`` \| ``"PREPARE_SELECTION_INPUT_EXPANSION"`` \| ``"STOP_SELECTION_INPUT"`` \| ``"EVALUATE_CELLS"`` \| ``"CHANGE_HIGHLIGHT"`` \| ``"START_CHANGE_HIGHLIGHT"`` \| ``"SET_HIGHLIGHT_COLOR"`` \| ``"STOP_COMPOSER_RANGE_SELECTION"`` \| ``"START_EDITION"`` \| ``"STOP_EDITION"`` \| ``"SET_CURRENT_CONTENT"`` \| ``"CHANGE_COMPOSER_CURSOR_SELECTION"`` \| ``"REPLACE_COMPOSER_CURSOR_SELECTION"`` \| ``"CYCLE_EDITION_REFERENCES"`` \| ``"START"`` \| ``"AUTOFILL"`` \| ``"AUTOFILL_SELECT"`` \| ``"SET_FORMULA_VISIBILITY"`` \| ``"AUTOFILL_AUTO"`` \| ``"SELECT_FIGURE"`` \| ``"UPDATE_SEARCH"`` \| ``"CLEAR_SEARCH"`` \| ``"SELECT_SEARCH_PREVIOUS_MATCH"`` \| ``"SELECT_SEARCH_NEXT_MATCH"`` \| ``"REPLACE_SEARCH"`` \| ``"REPLACE_ALL_SEARCH"`` \| ``"SORT_CELLS"`` \| ``"RESIZE_SHEETVIEW"`` \| ``"SUM_SELECTION"`` \| ``"DELETE_CELL"`` \| ``"INSERT_CELL"`` \| ``"SET_VIEWPORT_OFFSET"`` \| ``"SHIFT_VIEWPORT_DOWN"`` \| ``"SHIFT_VIEWPORT_UP"`` \| ``"OPEN_CELL_POPOVER"`` \| ``"CLOSE_CELL_POPOVER"`` \| ``"ACTIVATE_NEXT_SHEET"`` \| ``"ACTIVATE_PREVIOUS_SHEET"`` | -| `C` | extends { `type`: `T` } & `UpdateCellCommand` \| { `type`: `T` } & `UpdateCellPositionCommand` \| { `type`: `T` } & `ClearCellCommand` \| { `type`: `T` } & `DeleteContentCommand` \| { `type`: `T` } & `SetDecimalCommand` \| { `type`: `T` } & `AddColumnsRowsCommand` \| { `type`: `T` } & `RemoveColumnsRowsCommand` \| { `type`: `T` } & `ResizeColumnsRowsCommand` \| { `type`: `T` } & `HideColumnsRowsCommand` \| { `type`: `T` } & `UnhideColumnsRowsCommand` \| { `type`: `T` } & `SetGridLinesVisibilityCommand` \| { `type`: `T` } & `FreezeColumnsCommand` \| { `type`: `T` } & `FreezeRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsCommand` \| { `type`: `T` } & `UnfreezeRowsCommand` \| { `type`: `T` } & `AddMergeCommand` \| { `type`: `T` } & `RemoveMergeCommand` \| { `type`: `T` } & `CreateSheetCommand` \| { `type`: `T` } & `DeleteSheetCommand` \| { `type`: `T` } & `DuplicateSheetCommand` \| { `type`: `T` } & `MoveSheetCommand` \| { `type`: `T` } & `RenameSheetCommand` \| { `type`: `T` } & `HideSheetCommand` \| { `type`: `T` } & `ShowSheetCommand` \| { `type`: `T` } & `MoveRangeCommand` \| { `type`: `T` } & `AddConditionalFormatCommand` \| { `type`: `T` } & `RemoveConditionalFormatCommand` \| { `type`: `T` } & `MoveConditionalFormatCommand` \| { `type`: `T` } & `CreateFigureCommand` \| { `type`: `T` } & `DeleteFigureCommand` \| { `type`: `T` } & `UpdateFigureCommand` \| { `type`: `T` } & `SetFormattingCommand` \| { `type`: `T` } & `ClearFormattingCommand` \| { `type`: `T` } & `SetBorderCommand` \| { `type`: `T` } & `CreateChartCommand` \| { `type`: `T` } & `UpdateChartCommand` \| { `type`: `T` } & `RequestUndoCommand` \| { `type`: `T` } & `RequestRedoCommand` \| { `type`: `T` } & `UndoCommand` \| { `type`: `T` } & `RedoCommand` \| { `type`: `T` } & `NewInputCommand` \| { `type`: `T` } & `RemoveInputCommand` \| { `type`: `T` } & `UnfocusInputCommand` \| { `type`: `T` } & `FocusInputCommand` \| { `type`: `T` } & `AddEmptyRangeCommand` \| { `type`: `T` } & `RemoveRangeCommand` \| { `type`: `T` } & `ChangeRangeCommand` \| { `type`: `T` } & `CopyCommand` \| { `type`: `T` } & `CutCommand` \| { `type`: `T` } & `PasteCommand` \| { `type`: `T` } & `AutoFillCellCommand` \| { `type`: `T` } & `PasteFromOSClipboardCommand` \| { `type`: `T` } & `ActivatePaintFormatCommand` \| { `type`: `T` } & `PasteCFCommand` \| { `type`: `T` } & `AutoresizeColumnsCommand` \| { `type`: `T` } & `AutoresizeRowsCommand` \| { `type`: `T` } & `MoveColumnsRowsCommand` \| { `type`: `T` } & `ActivateSheetCommand` \| { `type`: `T` } & `PrepareExpansionCommand` \| { `type`: `T` } & `StopSelectionCommand` \| { `type`: `T` } & `EvaluateCellsCommand` \| { `type`: `T` } & `ChangeHighlightCommand` \| { `type`: `T` } & `StartChangeHighlightCommand` \| { `type`: `T` } & `SetColorCommand` \| { `type`: `T` } & `StopComposerSelectionCommand` \| { `type`: `T` } & `StartEditionCommand` \| { `type`: `T` } & `StopEditionCommand` \| { `type`: `T` } & `SetCurrentContentCommand` \| { `type`: `T` } & `ChangeComposerSelectionCommand` \| { `type`: `T` } & `ReplaceComposerSelectionCommand` \| { `type`: `T` } & `CycleEditionReferencesCommand` \| { `type`: `T` } & `StartCommand` \| { `type`: `T` } & `AutofillCommand` \| { `type`: `T` } & `AutofillSelectCommand` \| { `type`: `T` } & `ShowFormulaCommand` \| { `type`: `T` } & `AutofillAutoCommand` \| { `type`: `T` } & `SelectFigureCommand` \| { `type`: `T` } & `UpdateSearchCommand` \| { `type`: `T` } & `RefreshSearchCommand` \| { `type`: `T` } & `ClearSearchCommand` \| { `type`: `T` } & `SelectSearchPreviousCommand` \| { `type`: `T` } & `SelectSearchNextCommand` \| { `type`: `T` } & `ReplaceSearchCommand` \| { `type`: `T` } & `ReplaceAllSearchCommand` \| { `type`: `T` } & `SortCommand` \| { `type`: `T` } & `ResizeViewportCommand` \| { `type`: `T` } & `SumSelectionCommand` \| { `type`: `T` } & `DeleteCellCommand` \| { `type`: `T` } & `InsertCellCommand` \| { `type`: `T` } & `SetViewportOffsetCommand` \| { `type`: `T` } & `MoveViewportDownCommand` \| { `type`: `T` } & `MoveViewportUpCommand` \| { `type`: `T` } & `OpenCellPopoverCommand` \| { `type`: `T` } & `CloseCellPopoverCommand` \| { `type`: `T` } & `ActivateNextSheetCommand` \| { `type`: `T` } & `ActivatePreviousSheetCommand` | - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `T` | -| `r` | `Omit`<`C`, ``"type"``\> | - -##### Returns - -[`DispatchResult`](DispatchResult.md) - -#### Implementation of - -CommandDispatcher.dispatch - -___ - -### getters - -• **getters**: `Getters` - -Getters are the main way the rest of the UI read data from the model. Also, -it is shared between all plugins, so they can also communicate with each -other. - -___ - -### selection - -• `Readonly` **selection**: `SelectionStreamProcessor` - -___ - -### subscriptions - -• **subscriptions**: `Object` = `{}` - -#### Index signature - -▪ [eventType: `string`]: `Subscription`[] - -#### Inherited from - -EventBus.subscriptions - -___ - -### uuidGenerator - -• **uuidGenerator**: `UuidGenerator` - -## Accessors - -### handlers - -• `get` **handlers**(): `CommandHandler`<`Command`\>[] - -#### Returns - -`CommandHandler`<`Command`\>[] - -## Methods - -### clear - -▸ **clear**(): `void` - -Remove all subscriptions. - -#### Returns - -`void` - -#### Inherited from - -EventBus.clear - -___ - -### drawGrid - -▸ **drawGrid**(`context`): `void` - -When the Grid component is ready (= mounted), it has a reference to its -canvas and need to draw the grid on it. This is then done by calling this -method, which will dispatch the call to all registered plugins. - -Note that nothing prevent multiple grid components from calling this method -each, or one grid component calling it multiple times with a different -context. This is probably the way we should do if we want to be able to -freeze a part of the grid (so, we would need to render different zones) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `context` | `GridRenderingContext` | - -#### Returns - -`void` - -___ - -### exportData - -▸ **exportData**(): `WorkbookData` - -As the name of this method strongly implies, it is useful when we need to -export date out of the model. - -#### Returns - -`WorkbookData` - -___ - -### exportXLSX - -▸ **exportXLSX**(): `XLSXExport` - -Exports the current model data into a list of serialized XML files -to be zipped together as an *.xlsx file. - -We need to trigger a cell revaluation on every sheet and ensure that even -async functions are evaluated. -This prove to be necessary if the client did not trigger that evaluation in the first place -(e.g. open a document with several sheet and click on download before visiting each sheet) - -#### Returns - -`XLSXExport` - -___ - -### joinSession - -▸ **joinSession**(): `void` - -#### Returns - -`void` - -___ - -### leaveSession - -▸ **leaveSession**(): `void` - -#### Returns - -`void` - -___ - -### off - -▸ **off**<`T`\>(`eventType`, `owner`): `void` - -Remove a listener - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `eventType` | `T` | -| `owner` | `any` | - -#### Returns - -`void` - -#### Inherited from - -EventBus.off - -___ - -### on - -▸ **on**<`T`, `E`\>(`type`, `owner`, `callback`): `void` - -Add a listener for the 'eventType' events. - -Note that the 'owner' of this event can be anything, but will more likely -be a component or a class. The idea is that the callback will be called with -the proper owner bound. - -Also, the owner should be kind of unique. This will be used to remove the -listener. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `any` | -| `E` | extends `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `T` | -| `owner` | `any` | -| `callback` | (`r`: `Omit`<`E`, ``"type"``\>) => `void` | - -#### Returns - -`void` - -#### Inherited from - -EventBus.on - -___ - -### trigger - -▸ **trigger**<`T`, `E`\>(`type`, `payload?`): `void` - -Emit an event of type 'eventType'. Any extra arguments will be passed to -the listeners callback. - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends `any` | -| `E` | extends `any` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `T` | -| `payload?` | `Omit`<`E`, ``"type"``\> | - -#### Returns - -`void` - -#### Inherited from - -EventBus.trigger - -___ - -### updateMode - -▸ **updateMode**(`mode`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `mode` | `Mode` | - -#### Returns - -`void` diff --git a/doc/tsdoc/classes/Registry.md b/doc/tsdoc/classes/Registry.md deleted file mode 100644 index e1e2ef889c..0000000000 --- a/doc/tsdoc/classes/Registry.md +++ /dev/null @@ -1,142 +0,0 @@ -[o-spreadsheet API](../README.md) / Registry - -# Class: Registry - -Registry - -The Registry class is basically just a mapping from a string key to an object. -It is really not much more than an object. It is however useful for the -following reasons: - -1. it let us react and execute code when someone add something to the registry - (for example, the FunctionRegistry subclass this for this purpose) -2. it throws an error when the get operation fails -3. it provides a chained API to add items to the registry. - -## Type parameters - -| Name | -| :------ | -| `T` | - -## Table of contents - -### Constructors - -- [constructor](Registry.md#constructor) - -### Properties - -- [content](Registry.md#content) - -### Methods - -- [add](Registry.md#add) -- [get](Registry.md#get) -- [getAll](Registry.md#getall) -- [getKeys](Registry.md#getkeys) -- [remove](Registry.md#remove) - -## Constructors - -### constructor - -• **new Registry**<`T`\>() - -#### Type parameters - -| Name | -| :------ | -| `T` | - -## Properties - -### content - -• **content**: `Object` = `{}` - -#### Index signature - -▪ [key: `string`]: `T` - -## Methods - -### add - -▸ **add**(`key`, `value`): [`Registry`](Registry.md)<`T`\> - -Add an item to the registry - -Note that this also returns the registry, so another add method call can -be chained - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | -| `value` | `T` | - -#### Returns - -[`Registry`](Registry.md)<`T`\> - -___ - -### get - -▸ **get**(`key`): `T` - -Get an item from the registry - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`T` - -___ - -### getAll - -▸ **getAll**(): `T`[] - -Get a list of all elements in the registry - -#### Returns - -`T`[] - -___ - -### getKeys - -▸ **getKeys**(): `string`[] - -Get a list of all keys in the registry - -#### Returns - -`string`[] - -___ - -### remove - -▸ **remove**(`key`): `void` - -Remove an item from the registry - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `key` | `string` | - -#### Returns - -`void` diff --git a/doc/tsdoc/classes/Revision.md b/doc/tsdoc/classes/Revision.md deleted file mode 100644 index a605be59f9..0000000000 --- a/doc/tsdoc/classes/Revision.md +++ /dev/null @@ -1,106 +0,0 @@ -[o-spreadsheet API](../README.md) / Revision - -# Class: Revision - -## Implements - -- `RevisionData` - -## Table of contents - -### Constructors - -- [constructor](Revision.md#constructor) - -### Properties - -- [clientId](Revision.md#clientid) -- [id](Revision.md#id) - -### Accessors - -- [changes](Revision.md#changes) -- [commands](Revision.md#commands) - -### Methods - -- [setChanges](Revision.md#setchanges) - -## Constructors - -### constructor - -• **new Revision**(`id`, `clientId`, `commands`, `changes?`) - -A revision represents a whole client action (Create a sheet, merge a Zone, Undo, ...). -A revision contains the following information: - - id: ID of the revision - - commands: CoreCommands that are linked to the action, and should be - dispatched in other clients - - clientId: Client who initiated the action - - changes: List of changes applied on the state. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `UID` | -| `clientId` | `string` | -| `commands` | readonly `CoreCommand`[] | -| `changes?` | readonly `HistoryChange`[] | - -## Properties - -### clientId - -• `Readonly` **clientId**: `string` - -#### Implementation of - -RevisionData.clientId - -___ - -### id - -• `Readonly` **id**: `UID` - -#### Implementation of - -RevisionData.id - -## Accessors - -### changes - -• `get` **changes**(): readonly `HistoryChange`[] - -#### Returns - -readonly `HistoryChange`[] - -___ - -### commands - -• `get` **commands**(): readonly `CoreCommand`[] - -#### Returns - -readonly `CoreCommand`[] - -## Methods - -### setChanges - -▸ **setChanges**(`changes`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `changes` | readonly `HistoryChange`[] | - -#### Returns - -`void` diff --git a/doc/tsdoc/classes/Spreadsheet.md b/doc/tsdoc/classes/Spreadsheet.md deleted file mode 100644 index 2a30942999..0000000000 --- a/doc/tsdoc/classes/Spreadsheet.md +++ /dev/null @@ -1,292 +0,0 @@ -[o-spreadsheet API](../README.md) / Spreadsheet - -# Class: Spreadsheet - -## Hierarchy - -- `Component`<`SpreadsheetProps`, `SpreadsheetChildEnv`\> - - ↳ **`Spreadsheet`** - -## Table of contents - -### Constructors - -- [constructor](Spreadsheet.md#constructor) - -### Properties - -- [composer](Spreadsheet.md#composer) -- [model](Spreadsheet.md#model) -- [sidePanel](Spreadsheet.md#sidepanel) -- [\_t](Spreadsheet.md#_t) -- [components](Spreadsheet.md#components) -- [template](Spreadsheet.md#template) - -### Accessors - -- [focusGridComposer](Spreadsheet.md#focusgridcomposer) -- [focusTopBarComposer](Spreadsheet.md#focustopbarcomposer) - -### Methods - -- [closeSidePanel](Spreadsheet.md#closesidepanel) -- [focusGrid](Spreadsheet.md#focusgrid) -- [getStyle](Spreadsheet.md#getstyle) -- [onGridComposerCellFocused](Spreadsheet.md#ongridcomposercellfocused) -- [onGridComposerContentFocused](Spreadsheet.md#ongridcomposercontentfocused) -- [onKeydown](Spreadsheet.md#onkeydown) -- [onTopBarComposerFocused](Spreadsheet.md#ontopbarcomposerfocused) -- [openSidePanel](Spreadsheet.md#opensidepanel) -- [save](Spreadsheet.md#save) -- [setup](Spreadsheet.md#setup) -- [toggleSidePanel](Spreadsheet.md#togglesidepanel) - -## Constructors - -### constructor - -• **new Spreadsheet**(`props`, `env`, `node`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `props` | `SpreadsheetProps` | -| `env` | `SpreadsheetChildEnv` | -| `node` | `ComponentNode`<`any`, `any`\> | - -#### Inherited from - -Component.constructor - -## Properties - -### composer - -• **composer**: `ComposerState` - -___ - -### model - -• **model**: [`Model`](Model.md) - -___ - -### sidePanel - -• **sidePanel**: `SidePanelState` - -___ - -### \_t - -▪ `Static` **\_t**: (`s`: `string`) => `string` - -#### Type declaration - -▸ (`s`): `string` - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `s` | `string` | - -##### Returns - -`string` - -___ - -### components - -▪ `Static` **components**: `Object` - -#### Type declaration - -| Name | Type | -| :------ | :------ | -| `BottomBar` | typeof `BottomBar` | -| `Grid` | typeof `Grid` | -| `SidePanel` | typeof `SidePanel` | -| `SpreadsheetDashboard` | typeof `SpreadsheetDashboard` | -| `TopBar` | typeof `TopBar` | - -___ - -### template - -▪ `Static` **template**: `string` = `"o-spreadsheet-Spreadsheet"` - -#### Overrides - -Component.template - -## Accessors - -### focusGridComposer - -• `get` **focusGridComposer**(): `ComposerFocusType` - -#### Returns - -`ComposerFocusType` - -___ - -### focusTopBarComposer - -• `get` **focusTopBarComposer**(): `Omit`<`ComposerFocusType`, ``"cellFocus"``\> - -#### Returns - -`Omit`<`ComposerFocusType`, ``"cellFocus"``\> - -## Methods - -### closeSidePanel - -▸ **closeSidePanel**(): `void` - -#### Returns - -`void` - -___ - -### focusGrid - -▸ **focusGrid**(): `void` - -#### Returns - -`void` - -___ - -### getStyle - -▸ **getStyle**(): `string` - -#### Returns - -`string` - -___ - -### onGridComposerCellFocused - -▸ **onGridComposerCellFocused**(`content?`, `selection?`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `content?` | `string` | -| `selection?` | `ComposerSelection` | - -#### Returns - -`void` - -___ - -### onGridComposerContentFocused - -▸ **onGridComposerContentFocused**(): `void` - -#### Returns - -`void` - -___ - -### onKeydown - -▸ **onKeydown**(`ev`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ev` | `KeyboardEvent` | - -#### Returns - -`void` - -___ - -### onTopBarComposerFocused - -▸ **onTopBarComposerFocused**(`selection`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `selection` | `ComposerSelection` | - -#### Returns - -`void` - -___ - -### openSidePanel - -▸ **openSidePanel**(`panel`, `panelProps`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `panel` | `string` | -| `panelProps` | `any` | - -#### Returns - -`void` - -___ - -### save - -▸ **save**(): `void` - -#### Returns - -`void` - -___ - -### setup - -▸ **setup**(): `void` - -#### Returns - -`void` - -#### Overrides - -Component.setup - -___ - -### toggleSidePanel - -▸ **toggleSidePanel**(`panel`, `panelProps`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `panel` | `string` | -| `panelProps` | `any` | - -#### Returns - -`void` diff --git a/doc/tsdoc/classes/UIPlugin.md b/doc/tsdoc/classes/UIPlugin.md deleted file mode 100644 index d3dce0c334..0000000000 --- a/doc/tsdoc/classes/UIPlugin.md +++ /dev/null @@ -1,387 +0,0 @@ -[o-spreadsheet API](../README.md) / UIPlugin - -# Class: UIPlugin - -UI plugins handle any transient data required to display a spreadsheet. -They can draw on the grid canvas. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `State` | `any` | -| `C` | `Command` | - -## Hierarchy - -- `BasePlugin`<`State`, `C`\> - - ↳ **`UIPlugin`** - -## Table of contents - -### Constructors - -- [constructor](UIPlugin.md#constructor) - -### Properties - -- [dispatch](UIPlugin.md#dispatch) -- [getters](UIPlugin.md#getters) -- [history](UIPlugin.md#history) -- [selection](UIPlugin.md#selection) -- [ui](UIPlugin.md#ui) -- [getters](UIPlugin.md#getters) -- [layers](UIPlugin.md#layers) - -### Methods - -- [allowDispatch](UIPlugin.md#allowdispatch) -- [batchValidations](UIPlugin.md#batchvalidations) -- [beforeHandle](UIPlugin.md#beforehandle) -- [chainValidations](UIPlugin.md#chainvalidations) -- [checkValidations](UIPlugin.md#checkvalidations) -- [drawGrid](UIPlugin.md#drawgrid) -- [exportForExcel](UIPlugin.md#exportforexcel) -- [finalize](UIPlugin.md#finalize) -- [handle](UIPlugin.md#handle) - -## Constructors - -### constructor - -• **new UIPlugin**<`State`, `C`\>(`getters`, `state`, `dispatch`, `config`, `selection`) - -#### Type parameters - -| Name | Type | -| :------ | :------ | -| `State` | `any` | -| `C` | `Command` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `getters` | `Getters` | -| `state` | `StateObserver` | -| `dispatch` | (`type`: {} extends `Omit`<`C`, ``"type"``\> ? `T` : `never`) => [`DispatchResult`](DispatchResult.md)(`type`: `T`, `r`: `Omit`<`C`, ``"type"``\>) => [`DispatchResult`](DispatchResult.md) | -| `config` | `ModelConfig` | -| `selection` | `SelectionStreamProcessor` | - -#### Overrides - -BasePlugin<State, C\>.constructor - -## Properties - -### dispatch - -• `Protected` **dispatch**: (`type`: {} extends `Omit`<`C`, ``"type"``\> ? `T` : `never`) => [`DispatchResult`](DispatchResult.md)(`type`: `T`, `r`: `Omit`<`C`, ``"type"``\>) => [`DispatchResult`](DispatchResult.md) - -#### Type declaration - -▸ <`T`, `C`\>(`type`): [`DispatchResult`](DispatchResult.md) - -##### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends ``"UPDATE_CELL"`` \| ``"UPDATE_CELL_POSITION"`` \| ``"CLEAR_CELL"`` \| ``"DELETE_CONTENT"`` \| ``"SET_DECIMAL"`` \| ``"ADD_COLUMNS_ROWS"`` \| ``"REMOVE_COLUMNS_ROWS"`` \| ``"RESIZE_COLUMNS_ROWS"`` \| ``"HIDE_COLUMNS_ROWS"`` \| ``"UNHIDE_COLUMNS_ROWS"`` \| ``"SET_GRID_LINES_VISIBILITY"`` \| ``"FREEZE_COLUMNS"`` \| ``"FREEZE_ROWS"`` \| ``"UNFREEZE_COLUMNS_ROWS"`` \| ``"UNFREEZE_COLUMNS"`` \| ``"UNFREEZE_ROWS"`` \| ``"ADD_MERGE"`` \| ``"REMOVE_MERGE"`` \| ``"CREATE_SHEET"`` \| ``"DELETE_SHEET"`` \| ``"DUPLICATE_SHEET"`` \| ``"MOVE_SHEET"`` \| ``"RENAME_SHEET"`` \| ``"HIDE_SHEET"`` \| ``"SHOW_SHEET"`` \| ``"MOVE_RANGES"`` \| ``"ADD_CONDITIONAL_FORMAT"`` \| ``"REMOVE_CONDITIONAL_FORMAT"`` \| ``"MOVE_CONDITIONAL_FORMAT"`` \| ``"CREATE_FIGURE"`` \| ``"DELETE_FIGURE"`` \| ``"UPDATE_FIGURE"`` \| ``"SET_FORMATTING"`` \| ``"CLEAR_FORMATTING"`` \| ``"SET_BORDER"`` \| ``"CREATE_CHART"`` \| ``"UPDATE_CHART"`` \| ``"REQUEST_UNDO"`` \| ``"REQUEST_REDO"`` \| ``"UNDO"`` \| ``"REDO"`` \| ``"ENABLE_NEW_SELECTION_INPUT"`` \| ``"DISABLE_SELECTION_INPUT"`` \| ``"UNFOCUS_SELECTION_INPUT"`` \| ``"FOCUS_RANGE"`` \| ``"ADD_EMPTY_RANGE"`` \| ``"REMOVE_RANGE"`` \| ``"CHANGE_RANGE"`` \| ``"COPY"`` \| ``"CUT"`` \| ``"PASTE"`` \| ``"AUTOFILL_CELL"`` \| ``"PASTE_FROM_OS_CLIPBOARD"`` \| ``"ACTIVATE_PAINT_FORMAT"`` \| ``"PASTE_CONDITIONAL_FORMAT"`` \| ``"AUTORESIZE_COLUMNS"`` \| ``"AUTORESIZE_ROWS"`` \| ``"MOVE_COLUMNS_ROWS"`` \| ``"ACTIVATE_SHEET"`` \| ``"PREPARE_SELECTION_INPUT_EXPANSION"`` \| ``"STOP_SELECTION_INPUT"`` \| ``"EVALUATE_CELLS"`` \| ``"CHANGE_HIGHLIGHT"`` \| ``"START_CHANGE_HIGHLIGHT"`` \| ``"SET_HIGHLIGHT_COLOR"`` \| ``"STOP_COMPOSER_RANGE_SELECTION"`` \| ``"START_EDITION"`` \| ``"STOP_EDITION"`` \| ``"SET_CURRENT_CONTENT"`` \| ``"CHANGE_COMPOSER_CURSOR_SELECTION"`` \| ``"REPLACE_COMPOSER_CURSOR_SELECTION"`` \| ``"CYCLE_EDITION_REFERENCES"`` \| ``"START"`` \| ``"AUTOFILL"`` \| ``"AUTOFILL_SELECT"`` \| ``"SET_FORMULA_VISIBILITY"`` \| ``"AUTOFILL_AUTO"`` \| ``"SELECT_FIGURE"`` \| ``"UPDATE_SEARCH"`` \| ``"CLEAR_SEARCH"`` \| ``"SELECT_SEARCH_PREVIOUS_MATCH"`` \| ``"SELECT_SEARCH_NEXT_MATCH"`` \| ``"REPLACE_SEARCH"`` \| ``"REPLACE_ALL_SEARCH"`` \| ``"SORT_CELLS"`` \| ``"RESIZE_SHEETVIEW"`` \| ``"SUM_SELECTION"`` \| ``"DELETE_CELL"`` \| ``"INSERT_CELL"`` \| ``"SET_VIEWPORT_OFFSET"`` \| ``"SHIFT_VIEWPORT_DOWN"`` \| ``"SHIFT_VIEWPORT_UP"`` \| ``"OPEN_CELL_POPOVER"`` \| ``"CLOSE_CELL_POPOVER"`` \| ``"ACTIVATE_NEXT_SHEET"`` \| ``"ACTIVATE_PREVIOUS_SHEET"`` | -| `C` | extends { `type`: `T` } & `UpdateCellCommand` \| { `type`: `T` } & `UpdateCellPositionCommand` \| { `type`: `T` } & `ClearCellCommand` \| { `type`: `T` } & `DeleteContentCommand` \| { `type`: `T` } & `SetDecimalCommand` \| { `type`: `T` } & `AddColumnsRowsCommand` \| { `type`: `T` } & `RemoveColumnsRowsCommand` \| { `type`: `T` } & `ResizeColumnsRowsCommand` \| { `type`: `T` } & `HideColumnsRowsCommand` \| { `type`: `T` } & `UnhideColumnsRowsCommand` \| { `type`: `T` } & `SetGridLinesVisibilityCommand` \| { `type`: `T` } & `FreezeColumnsCommand` \| { `type`: `T` } & `FreezeRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsCommand` \| { `type`: `T` } & `UnfreezeRowsCommand` \| { `type`: `T` } & `AddMergeCommand` \| { `type`: `T` } & `RemoveMergeCommand` \| { `type`: `T` } & `CreateSheetCommand` \| { `type`: `T` } & `DeleteSheetCommand` \| { `type`: `T` } & `DuplicateSheetCommand` \| { `type`: `T` } & `MoveSheetCommand` \| { `type`: `T` } & `RenameSheetCommand` \| { `type`: `T` } & `HideSheetCommand` \| { `type`: `T` } & `ShowSheetCommand` \| { `type`: `T` } & `MoveRangeCommand` \| { `type`: `T` } & `AddConditionalFormatCommand` \| { `type`: `T` } & `RemoveConditionalFormatCommand` \| { `type`: `T` } & `MoveConditionalFormatCommand` \| { `type`: `T` } & `CreateFigureCommand` \| { `type`: `T` } & `DeleteFigureCommand` \| { `type`: `T` } & `UpdateFigureCommand` \| { `type`: `T` } & `SetFormattingCommand` \| { `type`: `T` } & `ClearFormattingCommand` \| { `type`: `T` } & `SetBorderCommand` \| { `type`: `T` } & `CreateChartCommand` \| { `type`: `T` } & `UpdateChartCommand` \| { `type`: `T` } & `RequestUndoCommand` \| { `type`: `T` } & `RequestRedoCommand` \| { `type`: `T` } & `UndoCommand` \| { `type`: `T` } & `RedoCommand` \| { `type`: `T` } & `NewInputCommand` \| { `type`: `T` } & `RemoveInputCommand` \| { `type`: `T` } & `UnfocusInputCommand` \| { `type`: `T` } & `FocusInputCommand` \| { `type`: `T` } & `AddEmptyRangeCommand` \| { `type`: `T` } & `RemoveRangeCommand` \| { `type`: `T` } & `ChangeRangeCommand` \| { `type`: `T` } & `CopyCommand` \| { `type`: `T` } & `CutCommand` \| { `type`: `T` } & `PasteCommand` \| { `type`: `T` } & `AutoFillCellCommand` \| { `type`: `T` } & `PasteFromOSClipboardCommand` \| { `type`: `T` } & `ActivatePaintFormatCommand` \| { `type`: `T` } & `PasteCFCommand` \| { `type`: `T` } & `AutoresizeColumnsCommand` \| { `type`: `T` } & `AutoresizeRowsCommand` \| { `type`: `T` } & `MoveColumnsRowsCommand` \| { `type`: `T` } & `ActivateSheetCommand` \| { `type`: `T` } & `PrepareExpansionCommand` \| { `type`: `T` } & `StopSelectionCommand` \| { `type`: `T` } & `EvaluateCellsCommand` \| { `type`: `T` } & `ChangeHighlightCommand` \| { `type`: `T` } & `StartChangeHighlightCommand` \| { `type`: `T` } & `SetColorCommand` \| { `type`: `T` } & `StopComposerSelectionCommand` \| { `type`: `T` } & `StartEditionCommand` \| { `type`: `T` } & `StopEditionCommand` \| { `type`: `T` } & `SetCurrentContentCommand` \| { `type`: `T` } & `ChangeComposerSelectionCommand` \| { `type`: `T` } & `ReplaceComposerSelectionCommand` \| { `type`: `T` } & `CycleEditionReferencesCommand` \| { `type`: `T` } & `StartCommand` \| { `type`: `T` } & `AutofillCommand` \| { `type`: `T` } & `AutofillSelectCommand` \| { `type`: `T` } & `ShowFormulaCommand` \| { `type`: `T` } & `AutofillAutoCommand` \| { `type`: `T` } & `SelectFigureCommand` \| { `type`: `T` } & `UpdateSearchCommand` \| { `type`: `T` } & `RefreshSearchCommand` \| { `type`: `T` } & `ClearSearchCommand` \| { `type`: `T` } & `SelectSearchPreviousCommand` \| { `type`: `T` } & `SelectSearchNextCommand` \| { `type`: `T` } & `ReplaceSearchCommand` \| { `type`: `T` } & `ReplaceAllSearchCommand` \| { `type`: `T` } & `SortCommand` \| { `type`: `T` } & `ResizeViewportCommand` \| { `type`: `T` } & `SumSelectionCommand` \| { `type`: `T` } & `DeleteCellCommand` \| { `type`: `T` } & `InsertCellCommand` \| { `type`: `T` } & `SetViewportOffsetCommand` \| { `type`: `T` } & `MoveViewportDownCommand` \| { `type`: `T` } & `MoveViewportUpCommand` \| { `type`: `T` } & `OpenCellPopoverCommand` \| { `type`: `T` } & `CloseCellPopoverCommand` \| { `type`: `T` } & `ActivateNextSheetCommand` \| { `type`: `T` } & `ActivatePreviousSheetCommand` | - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | {} extends `Omit`<`C`, ``"type"``\> ? `T` : `never` | - -##### Returns - -[`DispatchResult`](DispatchResult.md) - -▸ <`T`, `C`\>(`type`, `r`): [`DispatchResult`](DispatchResult.md) - -##### Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | extends ``"UPDATE_CELL"`` \| ``"UPDATE_CELL_POSITION"`` \| ``"CLEAR_CELL"`` \| ``"DELETE_CONTENT"`` \| ``"SET_DECIMAL"`` \| ``"ADD_COLUMNS_ROWS"`` \| ``"REMOVE_COLUMNS_ROWS"`` \| ``"RESIZE_COLUMNS_ROWS"`` \| ``"HIDE_COLUMNS_ROWS"`` \| ``"UNHIDE_COLUMNS_ROWS"`` \| ``"SET_GRID_LINES_VISIBILITY"`` \| ``"FREEZE_COLUMNS"`` \| ``"FREEZE_ROWS"`` \| ``"UNFREEZE_COLUMNS_ROWS"`` \| ``"UNFREEZE_COLUMNS"`` \| ``"UNFREEZE_ROWS"`` \| ``"ADD_MERGE"`` \| ``"REMOVE_MERGE"`` \| ``"CREATE_SHEET"`` \| ``"DELETE_SHEET"`` \| ``"DUPLICATE_SHEET"`` \| ``"MOVE_SHEET"`` \| ``"RENAME_SHEET"`` \| ``"HIDE_SHEET"`` \| ``"SHOW_SHEET"`` \| ``"MOVE_RANGES"`` \| ``"ADD_CONDITIONAL_FORMAT"`` \| ``"REMOVE_CONDITIONAL_FORMAT"`` \| ``"MOVE_CONDITIONAL_FORMAT"`` \| ``"CREATE_FIGURE"`` \| ``"DELETE_FIGURE"`` \| ``"UPDATE_FIGURE"`` \| ``"SET_FORMATTING"`` \| ``"CLEAR_FORMATTING"`` \| ``"SET_BORDER"`` \| ``"CREATE_CHART"`` \| ``"UPDATE_CHART"`` \| ``"REQUEST_UNDO"`` \| ``"REQUEST_REDO"`` \| ``"UNDO"`` \| ``"REDO"`` \| ``"ENABLE_NEW_SELECTION_INPUT"`` \| ``"DISABLE_SELECTION_INPUT"`` \| ``"UNFOCUS_SELECTION_INPUT"`` \| ``"FOCUS_RANGE"`` \| ``"ADD_EMPTY_RANGE"`` \| ``"REMOVE_RANGE"`` \| ``"CHANGE_RANGE"`` \| ``"COPY"`` \| ``"CUT"`` \| ``"PASTE"`` \| ``"AUTOFILL_CELL"`` \| ``"PASTE_FROM_OS_CLIPBOARD"`` \| ``"ACTIVATE_PAINT_FORMAT"`` \| ``"PASTE_CONDITIONAL_FORMAT"`` \| ``"AUTORESIZE_COLUMNS"`` \| ``"AUTORESIZE_ROWS"`` \| ``"MOVE_COLUMNS_ROWS"`` \| ``"ACTIVATE_SHEET"`` \| ``"PREPARE_SELECTION_INPUT_EXPANSION"`` \| ``"STOP_SELECTION_INPUT"`` \| ``"EVALUATE_CELLS"`` \| ``"CHANGE_HIGHLIGHT"`` \| ``"START_CHANGE_HIGHLIGHT"`` \| ``"SET_HIGHLIGHT_COLOR"`` \| ``"STOP_COMPOSER_RANGE_SELECTION"`` \| ``"START_EDITION"`` \| ``"STOP_EDITION"`` \| ``"SET_CURRENT_CONTENT"`` \| ``"CHANGE_COMPOSER_CURSOR_SELECTION"`` \| ``"REPLACE_COMPOSER_CURSOR_SELECTION"`` \| ``"CYCLE_EDITION_REFERENCES"`` \| ``"START"`` \| ``"AUTOFILL"`` \| ``"AUTOFILL_SELECT"`` \| ``"SET_FORMULA_VISIBILITY"`` \| ``"AUTOFILL_AUTO"`` \| ``"SELECT_FIGURE"`` \| ``"UPDATE_SEARCH"`` \| ``"CLEAR_SEARCH"`` \| ``"SELECT_SEARCH_PREVIOUS_MATCH"`` \| ``"SELECT_SEARCH_NEXT_MATCH"`` \| ``"REPLACE_SEARCH"`` \| ``"REPLACE_ALL_SEARCH"`` \| ``"SORT_CELLS"`` \| ``"RESIZE_SHEETVIEW"`` \| ``"SUM_SELECTION"`` \| ``"DELETE_CELL"`` \| ``"INSERT_CELL"`` \| ``"SET_VIEWPORT_OFFSET"`` \| ``"SHIFT_VIEWPORT_DOWN"`` \| ``"SHIFT_VIEWPORT_UP"`` \| ``"OPEN_CELL_POPOVER"`` \| ``"CLOSE_CELL_POPOVER"`` \| ``"ACTIVATE_NEXT_SHEET"`` \| ``"ACTIVATE_PREVIOUS_SHEET"`` | -| `C` | extends { `type`: `T` } & `UpdateCellCommand` \| { `type`: `T` } & `UpdateCellPositionCommand` \| { `type`: `T` } & `ClearCellCommand` \| { `type`: `T` } & `DeleteContentCommand` \| { `type`: `T` } & `SetDecimalCommand` \| { `type`: `T` } & `AddColumnsRowsCommand` \| { `type`: `T` } & `RemoveColumnsRowsCommand` \| { `type`: `T` } & `ResizeColumnsRowsCommand` \| { `type`: `T` } & `HideColumnsRowsCommand` \| { `type`: `T` } & `UnhideColumnsRowsCommand` \| { `type`: `T` } & `SetGridLinesVisibilityCommand` \| { `type`: `T` } & `FreezeColumnsCommand` \| { `type`: `T` } & `FreezeRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsRowsCommand` \| { `type`: `T` } & `UnfreezeColumnsCommand` \| { `type`: `T` } & `UnfreezeRowsCommand` \| { `type`: `T` } & `AddMergeCommand` \| { `type`: `T` } & `RemoveMergeCommand` \| { `type`: `T` } & `CreateSheetCommand` \| { `type`: `T` } & `DeleteSheetCommand` \| { `type`: `T` } & `DuplicateSheetCommand` \| { `type`: `T` } & `MoveSheetCommand` \| { `type`: `T` } & `RenameSheetCommand` \| { `type`: `T` } & `HideSheetCommand` \| { `type`: `T` } & `ShowSheetCommand` \| { `type`: `T` } & `MoveRangeCommand` \| { `type`: `T` } & `AddConditionalFormatCommand` \| { `type`: `T` } & `RemoveConditionalFormatCommand` \| { `type`: `T` } & `MoveConditionalFormatCommand` \| { `type`: `T` } & `CreateFigureCommand` \| { `type`: `T` } & `DeleteFigureCommand` \| { `type`: `T` } & `UpdateFigureCommand` \| { `type`: `T` } & `SetFormattingCommand` \| { `type`: `T` } & `ClearFormattingCommand` \| { `type`: `T` } & `SetBorderCommand` \| { `type`: `T` } & `CreateChartCommand` \| { `type`: `T` } & `UpdateChartCommand` \| { `type`: `T` } & `RequestUndoCommand` \| { `type`: `T` } & `RequestRedoCommand` \| { `type`: `T` } & `UndoCommand` \| { `type`: `T` } & `RedoCommand` \| { `type`: `T` } & `NewInputCommand` \| { `type`: `T` } & `RemoveInputCommand` \| { `type`: `T` } & `UnfocusInputCommand` \| { `type`: `T` } & `FocusInputCommand` \| { `type`: `T` } & `AddEmptyRangeCommand` \| { `type`: `T` } & `RemoveRangeCommand` \| { `type`: `T` } & `ChangeRangeCommand` \| { `type`: `T` } & `CopyCommand` \| { `type`: `T` } & `CutCommand` \| { `type`: `T` } & `PasteCommand` \| { `type`: `T` } & `AutoFillCellCommand` \| { `type`: `T` } & `PasteFromOSClipboardCommand` \| { `type`: `T` } & `ActivatePaintFormatCommand` \| { `type`: `T` } & `PasteCFCommand` \| { `type`: `T` } & `AutoresizeColumnsCommand` \| { `type`: `T` } & `AutoresizeRowsCommand` \| { `type`: `T` } & `MoveColumnsRowsCommand` \| { `type`: `T` } & `ActivateSheetCommand` \| { `type`: `T` } & `PrepareExpansionCommand` \| { `type`: `T` } & `StopSelectionCommand` \| { `type`: `T` } & `EvaluateCellsCommand` \| { `type`: `T` } & `ChangeHighlightCommand` \| { `type`: `T` } & `StartChangeHighlightCommand` \| { `type`: `T` } & `SetColorCommand` \| { `type`: `T` } & `StopComposerSelectionCommand` \| { `type`: `T` } & `StartEditionCommand` \| { `type`: `T` } & `StopEditionCommand` \| { `type`: `T` } & `SetCurrentContentCommand` \| { `type`: `T` } & `ChangeComposerSelectionCommand` \| { `type`: `T` } & `ReplaceComposerSelectionCommand` \| { `type`: `T` } & `CycleEditionReferencesCommand` \| { `type`: `T` } & `StartCommand` \| { `type`: `T` } & `AutofillCommand` \| { `type`: `T` } & `AutofillSelectCommand` \| { `type`: `T` } & `ShowFormulaCommand` \| { `type`: `T` } & `AutofillAutoCommand` \| { `type`: `T` } & `SelectFigureCommand` \| { `type`: `T` } & `UpdateSearchCommand` \| { `type`: `T` } & `RefreshSearchCommand` \| { `type`: `T` } & `ClearSearchCommand` \| { `type`: `T` } & `SelectSearchPreviousCommand` \| { `type`: `T` } & `SelectSearchNextCommand` \| { `type`: `T` } & `ReplaceSearchCommand` \| { `type`: `T` } & `ReplaceAllSearchCommand` \| { `type`: `T` } & `SortCommand` \| { `type`: `T` } & `ResizeViewportCommand` \| { `type`: `T` } & `SumSelectionCommand` \| { `type`: `T` } & `DeleteCellCommand` \| { `type`: `T` } & `InsertCellCommand` \| { `type`: `T` } & `SetViewportOffsetCommand` \| { `type`: `T` } & `MoveViewportDownCommand` \| { `type`: `T` } & `MoveViewportUpCommand` \| { `type`: `T` } & `OpenCellPopoverCommand` \| { `type`: `T` } & `CloseCellPopoverCommand` \| { `type`: `T` } & `ActivateNextSheetCommand` \| { `type`: `T` } & `ActivatePreviousSheetCommand` | - -##### Parameters - -| Name | Type | -| :------ | :------ | -| `type` | `T` | -| `r` | `Omit`<`C`, ``"type"``\> | - -##### Returns - -[`DispatchResult`](DispatchResult.md) - -#### Inherited from - -BasePlugin.dispatch - -___ - -### getters - -• `Protected` **getters**: `Getters` - -___ - -### history - -• `Protected` **history**: `WorkbookHistory`<`State`\> - -#### Inherited from - -BasePlugin.history - -___ - -### selection - -• `Protected` **selection**: `SelectionStreamProcessor` - -___ - -### ui - -• `Protected` **ui**: `UIActions` - -___ - -### getters - -▪ `Static` **getters**: readonly `string`[] = `[]` - -#### Inherited from - -BasePlugin.getters - -___ - -### layers - -▪ `Static` **layers**: `LAYERS`[] = `[]` - -## Methods - -### allowDispatch - -▸ **allowDispatch**(`command`): [`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] - -Before a command is accepted, the model will ask each plugin if the command -is allowed. If all of then return true, then we can proceed. Otherwise, -the command is cancelled. - -There should not be any side effects in this method. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `command` | `C` | - -#### Returns - -[`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] - -#### Inherited from - -BasePlugin.allowDispatch - -___ - -### batchValidations - -▸ **batchValidations**<`T`\>(...`validations`): `Validation`<`T`\> - -Combine multiple validation functions into a single function -returning the list of result of every validation. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...validations` | `Validation`<`T`\>[] | - -#### Returns - -`Validation`<`T`\> - -#### Inherited from - -BasePlugin.batchValidations - -___ - -### beforeHandle - -▸ **beforeHandle**(`command`): `void` - -This method is useful when a plugin need to perform some action before a -command is handled in another plugin. This should only be used if it is not -possible to do the work in the handle method. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `command` | `C` | - -#### Returns - -`void` - -#### Inherited from - -BasePlugin.beforeHandle - -___ - -### chainValidations - -▸ **chainValidations**<`T`\>(...`validations`): `Validation`<`T`\> - -Combine multiple validation functions. Every validation is executed one after -the other. As soon as one validation fails, it stops and the cancelled reason -is returned. - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...validations` | `Validation`<`T`\>[] | - -#### Returns - -`Validation`<`T`\> - -#### Inherited from - -BasePlugin.chainValidations - -___ - -### checkValidations - -▸ **checkValidations**<`T`\>(`command`, ...`validations`): [`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] - -#### Type parameters - -| Name | -| :------ | -| `T` | - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `command` | `T` | -| `...validations` | `Validation`<`T`\>[] | - -#### Returns - -[`CommandResult`](../enums/CommandResult.md) \| [`CommandResult`](../enums/CommandResult.md)[] - -#### Inherited from - -BasePlugin.checkValidations - -___ - -### drawGrid - -▸ **drawGrid**(`ctx`, `layer`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `ctx` | `GridRenderingContext` | -| `layer` | `LAYERS` | - -#### Returns - -`void` - -___ - -### exportForExcel - -▸ **exportForExcel**(`data`): `void` - -Export for excel should be available for all plugins, even for the UI. -In some case, we need to export evaluated value, which is available from -UI plugin only. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `data` | `ExcelWorkbookData` | - -#### Returns - -`void` - -#### Inherited from - -BasePlugin.exportForExcel - -___ - -### finalize - -▸ **finalize**(): `void` - -Sometimes, it is useful to perform some work after a command (and all its -subcommands) has been completely handled. For example, when we paste -multiple cells, we only want to reevaluate the cell values once at the end. - -#### Returns - -`void` - -#### Inherited from - -BasePlugin.finalize - -___ - -### handle - -▸ **handle**(`command`): `void` - -This is the standard place to handle any command. Most of the plugin -command handling work should take place here. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `command` | `C` | - -#### Returns - -`void` - -#### Inherited from - -BasePlugin.handle diff --git a/doc/tsdoc/enums/CommandResult.md b/doc/tsdoc/enums/CommandResult.md deleted file mode 100644 index b4b7700d03..0000000000 --- a/doc/tsdoc/enums/CommandResult.md +++ /dev/null @@ -1,526 +0,0 @@ -[o-spreadsheet API](../README.md) / CommandResult - -# Enumeration: CommandResult - -## Table of contents - -### Enumeration members - -- [CancelledForUnknownReason](CommandResult.md#cancelledforunknownreason) -- [CellIsMerged](CommandResult.md#cellismerged) -- [DuplicatedSheetName](CommandResult.md#duplicatedsheetname) -- [EmptyClipboard](CommandResult.md#emptyclipboard) -- [EmptyGaugeRangeMax](CommandResult.md#emptygaugerangemax) -- [EmptyGaugeRangeMin](CommandResult.md#emptygaugerangemin) -- [EmptyRange](CommandResult.md#emptyrange) -- [EmptyRedoStack](CommandResult.md#emptyredostack) -- [EmptyTarget](CommandResult.md#emptytarget) -- [EmptyUndoStack](CommandResult.md#emptyundostack) -- [FigureDoesNotExist](CommandResult.md#figuredoesnotexist) -- [FirstArgMissing](CommandResult.md#firstargmissing) -- [ForbiddenCharactersInSheetName](CommandResult.md#forbiddencharactersinsheetname) -- [FrozenPaneOverlap](CommandResult.md#frozenpaneoverlap) -- [GaugeLowerBiggerThanUpper](CommandResult.md#gaugelowerbiggerthanupper) -- [GaugeLowerInflectionPointNaN](CommandResult.md#gaugelowerinflectionpointnan) -- [GaugeRangeMaxNaN](CommandResult.md#gaugerangemaxnan) -- [GaugeRangeMinBiggerThanRangeMax](CommandResult.md#gaugerangeminbiggerthanrangemax) -- [GaugeRangeMinNaN](CommandResult.md#gaugerangeminnan) -- [GaugeUpperInflectionPointNaN](CommandResult.md#gaugeupperinflectionpointnan) -- [InputAlreadyFocused](CommandResult.md#inputalreadyfocused) -- [InvalidAnchorZone](CommandResult.md#invalidanchorzone) -- [InvalidAutofillSelection](CommandResult.md#invalidautofillselection) -- [InvalidCellPopover](CommandResult.md#invalidcellpopover) -- [InvalidChartDefinition](CommandResult.md#invalidchartdefinition) -- [InvalidConditionalFormatId](CommandResult.md#invalidconditionalformatid) -- [InvalidDataSet](CommandResult.md#invaliddataset) -- [InvalidFreezeQuantity](CommandResult.md#invalidfreezequantity) -- [InvalidGaugeDataRange](CommandResult.md#invalidgaugedatarange) -- [InvalidLabelRange](CommandResult.md#invalidlabelrange) -- [InvalidRange](CommandResult.md#invalidrange) -- [InvalidScorecardBaseline](CommandResult.md#invalidscorecardbaseline) -- [InvalidScorecardKeyValue](CommandResult.md#invalidscorecardkeyvalue) -- [InvalidScrollingDirection](CommandResult.md#invalidscrollingdirection) -- [InvalidSheetId](CommandResult.md#invalidsheetid) -- [InvalidSortZone](CommandResult.md#invalidsortzone) -- [InvalidViewportSize](CommandResult.md#invalidviewportsize) -- [InvalidZones](CommandResult.md#invalidzones) -- [LowerBiggerThanUpper](CommandResult.md#lowerbiggerthanupper) -- [MaxInvalidFormula](CommandResult.md#maxinvalidformula) -- [MaxNaN](CommandResult.md#maxnan) -- [MaximumRangesReached](CommandResult.md#maximumrangesreached) -- [MergeIsDestructive](CommandResult.md#mergeisdestructive) -- [MergeOverlap](CommandResult.md#mergeoverlap) -- [MidBiggerThanMax](CommandResult.md#midbiggerthanmax) -- [MidInvalidFormula](CommandResult.md#midinvalidformula) -- [MidNaN](CommandResult.md#midnan) -- [MinBiggerThanMax](CommandResult.md#minbiggerthanmax) -- [MinBiggerThanMid](CommandResult.md#minbiggerthanmid) -- [MinInvalidFormula](CommandResult.md#mininvalidformula) -- [MinNaN](CommandResult.md#minnan) -- [MissingSheetName](CommandResult.md#missingsheetname) -- [NotEnoughElements](CommandResult.md#notenoughelements) -- [NotEnoughSheets](CommandResult.md#notenoughsheets) -- [Readonly](CommandResult.md#readonly) -- [SecondArgMissing](CommandResult.md#secondargmissing) -- [SelectionOutOfBound](CommandResult.md#selectionoutofbound) -- [Success](CommandResult.md#success) -- [TargetOutOfSheet](CommandResult.md#targetoutofsheet) -- [TooManyHiddenElements](CommandResult.md#toomanyhiddenelements) -- [ValueLowerInflectionNaN](CommandResult.md#valuelowerinflectionnan) -- [ValueLowerInvalidFormula](CommandResult.md#valuelowerinvalidformula) -- [ValueUpperInflectionNaN](CommandResult.md#valueupperinflectionnan) -- [ValueUpperInvalidFormula](CommandResult.md#valueupperinvalidformula) -- [ValuesNotChanged](CommandResult.md#valuesnotchanged) -- [WaitingSessionConfirmation](CommandResult.md#waitingsessionconfirmation) -- [WillRemoveExistingMerge](CommandResult.md#willremoveexistingmerge) -- [WrongComposerSelection](CommandResult.md#wrongcomposerselection) -- [WrongCutSelection](CommandResult.md#wrongcutselection) -- [WrongFigurePasteOption](CommandResult.md#wrongfigurepasteoption) -- [WrongPasteOption](CommandResult.md#wrongpasteoption) -- [WrongPasteSelection](CommandResult.md#wrongpasteselection) -- [WrongSheetMove](CommandResult.md#wrongsheetmove) -- [WrongSheetPosition](CommandResult.md#wrongsheetposition) - -## Enumeration members - -### CancelledForUnknownReason - -• **CancelledForUnknownReason** = `1` - -___ - -### CellIsMerged - -• **CellIsMerged** = `4` - -___ - -### DuplicatedSheetName - -• **DuplicatedSheetName** = `10` - -___ - -### EmptyClipboard - -• **EmptyClipboard** = `21` - -___ - -### EmptyGaugeRangeMax - -• **EmptyGaugeRangeMax** = `36` - -___ - -### EmptyGaugeRangeMin - -• **EmptyGaugeRangeMin** = `34` - -___ - -### EmptyRange - -• **EmptyRange** = `22` - -___ - -### EmptyRedoStack - -• **EmptyRedoStack** = `6` - -___ - -### EmptyTarget - -• **EmptyTarget** = `70` - -___ - -### EmptyUndoStack - -• **EmptyUndoStack** = `5` - -___ - -### FigureDoesNotExist - -• **FigureDoesNotExist** = `67` - -___ - -### FirstArgMissing - -• **FirstArgMissing** = `48` - -___ - -### ForbiddenCharactersInSheetName - -• **ForbiddenCharactersInSheetName** = `11` - -___ - -### FrozenPaneOverlap - -• **FrozenPaneOverlap** = `72` - -___ - -### GaugeLowerBiggerThanUpper - -• **GaugeLowerBiggerThanUpper** = `41` - -___ - -### GaugeLowerInflectionPointNaN - -• **GaugeLowerInflectionPointNaN** = `39` - -___ - -### GaugeRangeMaxNaN - -• **GaugeRangeMaxNaN** = `37` - -___ - -### GaugeRangeMinBiggerThanRangeMax - -• **GaugeRangeMinBiggerThanRangeMax** = `38` - -___ - -### GaugeRangeMinNaN - -• **GaugeRangeMinNaN** = `35` - -___ - -### GaugeUpperInflectionPointNaN - -• **GaugeUpperInflectionPointNaN** = `40` - -___ - -### InputAlreadyFocused - -• **InputAlreadyFocused** = `26` - -___ - -### InvalidAnchorZone - -• **InvalidAnchorZone** = `14` - -___ - -### InvalidAutofillSelection - -• **InvalidAutofillSelection** = `42` - -___ - -### InvalidCellPopover - -• **InvalidCellPopover** = `69` - -___ - -### InvalidChartDefinition - -• **InvalidChartDefinition** = `28` - -___ - -### InvalidConditionalFormatId - -• **InvalidConditionalFormatId** = `68` - -___ - -### InvalidDataSet - -• **InvalidDataSet** = `29` - -___ - -### InvalidFreezeQuantity - -• **InvalidFreezeQuantity** = `71` - -___ - -### InvalidGaugeDataRange - -• **InvalidGaugeDataRange** = `33` - -___ - -### InvalidLabelRange - -• **InvalidLabelRange** = `30` - -___ - -### InvalidRange - -• **InvalidRange** = `23` - -___ - -### InvalidScorecardBaseline - -• **InvalidScorecardBaseline** = `32` - -___ - -### InvalidScorecardKeyValue - -• **InvalidScorecardKeyValue** = `31` - -___ - -### InvalidScrollingDirection - -• **InvalidScrollingDirection** = `66` - -___ - -### InvalidSheetId - -• **InvalidSheetId** = `25` - -___ - -### InvalidSortZone - -• **InvalidSortZone** = `60` - -___ - -### InvalidViewportSize - -• **InvalidViewportSize** = `65` - -___ - -### InvalidZones - -• **InvalidZones** = `24` - -___ - -### LowerBiggerThanUpper - -• **LowerBiggerThanUpper** = `45` - -___ - -### MaxInvalidFormula - -• **MaxInvalidFormula** = `57` - -___ - -### MaxNaN - -• **MaxNaN** = `52` - -___ - -### MaximumRangesReached - -• **MaximumRangesReached** = `27` - -___ - -### MergeIsDestructive - -• **MergeIsDestructive** = `3` - -___ - -### MergeOverlap - -• **MergeOverlap** = `62` - -___ - -### MidBiggerThanMax - -• **MidBiggerThanMax** = `46` - -___ - -### MidInvalidFormula - -• **MidInvalidFormula** = `56` - -___ - -### MidNaN - -• **MidNaN** = `51` - -___ - -### MinBiggerThanMax - -• **MinBiggerThanMax** = `44` - -___ - -### MinBiggerThanMid - -• **MinBiggerThanMid** = `47` - -___ - -### MinInvalidFormula - -• **MinInvalidFormula** = `55` - -___ - -### MinNaN - -• **MinNaN** = `50` - -___ - -### MissingSheetName - -• **MissingSheetName** = `9` - -___ - -### NotEnoughElements - -• **NotEnoughElements** = `7` - -___ - -### NotEnoughSheets - -• **NotEnoughSheets** = `8` - -___ - -### Readonly - -• **Readonly** = `64` - -___ - -### SecondArgMissing - -• **SecondArgMissing** = `49` - -___ - -### SelectionOutOfBound - -• **SelectionOutOfBound** = `15` - -___ - -### Success - -• **Success** = `0` - -___ - -### TargetOutOfSheet - -• **TargetOutOfSheet** = `16` - -___ - -### TooManyHiddenElements - -• **TooManyHiddenElements** = `63` - -___ - -### ValueLowerInflectionNaN - -• **ValueLowerInflectionNaN** = `54` - -___ - -### ValueLowerInvalidFormula - -• **ValueLowerInvalidFormula** = `59` - -___ - -### ValueUpperInflectionNaN - -• **ValueUpperInflectionNaN** = `53` - -___ - -### ValueUpperInvalidFormula - -• **ValueUpperInvalidFormula** = `58` - -___ - -### ValuesNotChanged - -• **ValuesNotChanged** = `73` - -___ - -### WaitingSessionConfirmation - -• **WaitingSessionConfirmation** = `61` - -___ - -### WillRemoveExistingMerge - -• **WillRemoveExistingMerge** = `2` - -___ - -### WrongComposerSelection - -• **WrongComposerSelection** = `43` - -___ - -### WrongCutSelection - -• **WrongCutSelection** = `17` - -___ - -### WrongFigurePasteOption - -• **WrongFigurePasteOption** = `20` - -___ - -### WrongPasteOption - -• **WrongPasteOption** = `19` - -___ - -### WrongPasteSelection - -• **WrongPasteSelection** = `18` - -___ - -### WrongSheetMove - -• **WrongSheetMove** = `12` - -___ - -### WrongSheetPosition - -• **WrongSheetPosition** = `13` diff --git a/doc/tsdoc/interfaces/Client.md b/doc/tsdoc/interfaces/Client.md deleted file mode 100644 index f4511c3166..0000000000 --- a/doc/tsdoc/interfaces/Client.md +++ /dev/null @@ -1,29 +0,0 @@ -[o-spreadsheet API](../README.md) / Client - -# Interface: Client - -## Table of contents - -### Properties - -- [id](Client.md#id) -- [name](Client.md#name) -- [position](Client.md#position) - -## Properties - -### id - -• **id**: `string` - -___ - -### name - -• **name**: `string` - -___ - -### position - -• `Optional` **position**: `ClientPosition` diff --git a/doc/tsdoc/interfaces/ClientJoinedMessage.md b/doc/tsdoc/interfaces/ClientJoinedMessage.md deleted file mode 100644 index 8f4d6a3037..0000000000 --- a/doc/tsdoc/interfaces/ClientJoinedMessage.md +++ /dev/null @@ -1,39 +0,0 @@ -[o-spreadsheet API](../README.md) / ClientJoinedMessage - -# Interface: ClientJoinedMessage - -## Hierarchy - -- `AbstractMessage` - - ↳ **`ClientJoinedMessage`** - -## Table of contents - -### Properties - -- [client](ClientJoinedMessage.md#client) -- [type](ClientJoinedMessage.md#type) -- [version](ClientJoinedMessage.md#version) - -## Properties - -### client - -• **client**: `Required`<[`Client`](Client.md)\> - -___ - -### type - -• **type**: ``"CLIENT_JOINED"`` - -___ - -### version - -• **version**: `number` - -#### Inherited from - -AbstractMessage.version diff --git a/doc/tsdoc/interfaces/ClientLeftMessage.md b/doc/tsdoc/interfaces/ClientLeftMessage.md deleted file mode 100644 index f7ba21647e..0000000000 --- a/doc/tsdoc/interfaces/ClientLeftMessage.md +++ /dev/null @@ -1,39 +0,0 @@ -[o-spreadsheet API](../README.md) / ClientLeftMessage - -# Interface: ClientLeftMessage - -## Hierarchy - -- `AbstractMessage` - - ↳ **`ClientLeftMessage`** - -## Table of contents - -### Properties - -- [clientId](ClientLeftMessage.md#clientid) -- [type](ClientLeftMessage.md#type) -- [version](ClientLeftMessage.md#version) - -## Properties - -### clientId - -• **clientId**: `string` - -___ - -### type - -• **type**: ``"CLIENT_LEFT"`` - -___ - -### version - -• **version**: `number` - -#### Inherited from - -AbstractMessage.version diff --git a/doc/tsdoc/interfaces/ClientMovedMessage.md b/doc/tsdoc/interfaces/ClientMovedMessage.md deleted file mode 100644 index a684c9cb72..0000000000 --- a/doc/tsdoc/interfaces/ClientMovedMessage.md +++ /dev/null @@ -1,39 +0,0 @@ -[o-spreadsheet API](../README.md) / ClientMovedMessage - -# Interface: ClientMovedMessage - -## Hierarchy - -- `AbstractMessage` - - ↳ **`ClientMovedMessage`** - -## Table of contents - -### Properties - -- [client](ClientMovedMessage.md#client) -- [type](ClientMovedMessage.md#type) -- [version](ClientMovedMessage.md#version) - -## Properties - -### client - -• **client**: `Required`<[`Client`](Client.md)\> - -___ - -### type - -• **type**: ``"CLIENT_MOVED"`` - -___ - -### version - -• **version**: `number` - -#### Inherited from - -AbstractMessage.version diff --git a/doc/tsdoc/interfaces/RemoteRevisionMessage.md b/doc/tsdoc/interfaces/RemoteRevisionMessage.md deleted file mode 100644 index b1edef0578..0000000000 --- a/doc/tsdoc/interfaces/RemoteRevisionMessage.md +++ /dev/null @@ -1,60 +0,0 @@ -[o-spreadsheet API](../README.md) / RemoteRevisionMessage - -# Interface: RemoteRevisionMessage - -## Hierarchy - -- `AbstractMessage` - - ↳ **`RemoteRevisionMessage`** - -## Table of contents - -### Properties - -- [clientId](RemoteRevisionMessage.md#clientid) -- [commands](RemoteRevisionMessage.md#commands) -- [nextRevisionId](RemoteRevisionMessage.md#nextrevisionid) -- [serverRevisionId](RemoteRevisionMessage.md#serverrevisionid) -- [type](RemoteRevisionMessage.md#type) -- [version](RemoteRevisionMessage.md#version) - -## Properties - -### clientId - -• **clientId**: `string` - -___ - -### commands - -• **commands**: readonly `CoreCommand`[] - -___ - -### nextRevisionId - -• **nextRevisionId**: `UID` - -___ - -### serverRevisionId - -• **serverRevisionId**: `UID` - -___ - -### type - -• **type**: ``"REMOTE_REVISION"`` - -___ - -### version - -• **version**: `number` - -#### Inherited from - -AbstractMessage.version diff --git a/doc/tsdoc/interfaces/RevisionRedoneMessage.md b/doc/tsdoc/interfaces/RevisionRedoneMessage.md deleted file mode 100644 index 26dfb50fdf..0000000000 --- a/doc/tsdoc/interfaces/RevisionRedoneMessage.md +++ /dev/null @@ -1,53 +0,0 @@ -[o-spreadsheet API](../README.md) / RevisionRedoneMessage - -# Interface: RevisionRedoneMessage - -## Hierarchy - -- `AbstractMessage` - - ↳ **`RevisionRedoneMessage`** - -## Table of contents - -### Properties - -- [nextRevisionId](RevisionRedoneMessage.md#nextrevisionid) -- [redoneRevisionId](RevisionRedoneMessage.md#redonerevisionid) -- [serverRevisionId](RevisionRedoneMessage.md#serverrevisionid) -- [type](RevisionRedoneMessage.md#type) -- [version](RevisionRedoneMessage.md#version) - -## Properties - -### nextRevisionId - -• **nextRevisionId**: `UID` - -___ - -### redoneRevisionId - -• **redoneRevisionId**: `UID` - -___ - -### serverRevisionId - -• **serverRevisionId**: `UID` - -___ - -### type - -• **type**: ``"REVISION_REDONE"`` - -___ - -### version - -• **version**: `number` - -#### Inherited from - -AbstractMessage.version diff --git a/doc/tsdoc/interfaces/RevisionUndoneMessage.md b/doc/tsdoc/interfaces/RevisionUndoneMessage.md deleted file mode 100644 index e56855361c..0000000000 --- a/doc/tsdoc/interfaces/RevisionUndoneMessage.md +++ /dev/null @@ -1,53 +0,0 @@ -[o-spreadsheet API](../README.md) / RevisionUndoneMessage - -# Interface: RevisionUndoneMessage - -## Hierarchy - -- `AbstractMessage` - - ↳ **`RevisionUndoneMessage`** - -## Table of contents - -### Properties - -- [nextRevisionId](RevisionUndoneMessage.md#nextrevisionid) -- [serverRevisionId](RevisionUndoneMessage.md#serverrevisionid) -- [type](RevisionUndoneMessage.md#type) -- [undoneRevisionId](RevisionUndoneMessage.md#undonerevisionid) -- [version](RevisionUndoneMessage.md#version) - -## Properties - -### nextRevisionId - -• **nextRevisionId**: `UID` - -___ - -### serverRevisionId - -• **serverRevisionId**: `UID` - -___ - -### type - -• **type**: ``"REVISION_UNDONE"`` - -___ - -### undoneRevisionId - -• **undoneRevisionId**: `UID` - -___ - -### version - -• **version**: `number` - -#### Inherited from - -AbstractMessage.version diff --git a/doc/tsdoc/interfaces/TransportService.md b/doc/tsdoc/interfaces/TransportService.md deleted file mode 100644 index ba20e4ce23..0000000000 --- a/doc/tsdoc/interfaces/TransportService.md +++ /dev/null @@ -1,85 +0,0 @@ -[o-spreadsheet API](../README.md) / TransportService - -# Interface: TransportService - -The transport service allows to communicate between multiple clients. -A client can send any message to others. -The service will handle all networking details internally. - -## Type parameters - -| Name | Type | -| :------ | :------ | -| `T` | `any` | - -## Table of contents - -### Methods - -- [leave](TransportService.md#leave) -- [onNewMessage](TransportService.md#onnewmessage) -- [sendMessage](TransportService.md#sendmessage) - -## Methods - -### leave - -▸ **leave**(`id`): `void` - -Unregister a callback linked to the given id - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `UID` | - -#### Returns - -`void` - -___ - -### onNewMessage - -▸ **onNewMessage**(`id`, `callback`): `void` - -Register a callback function which will be called each time -a new message is received. -The new message is given to the callback. - -```js -transportService.onNewMessage(id, (message) => { - // ... handle the new message -}) -``` -The `id` is used to unregister this callback when the session is closed. - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `id` | `UID` | -| `callback` | `NewMessageCallback`<`T`\> | - -#### Returns - -`void` - -___ - -### sendMessage - -▸ **sendMessage**(`message`): `void` - -Send a message to all clients - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `message` | `T` | - -#### Returns - -`void` diff --git a/package-lock.json b/package-lock.json index f8c1295c2c..26d9b02263 100644 --- a/package-lock.json +++ b/package-lock.json @@ -49,8 +49,6 @@ "rollup": "^3.28.0", "rollup-plugin-dts": "^5.3.1", "rollup-plugin-typescript2": "^0.35.0", - "typedoc": "0.25.12", - "typedoc-plugin-markdown": "3.17.1", "typescript": "^5.4.3", "xml-formatter": "^2.4.0" } @@ -1967,12 +1965,6 @@ "node": ">=8" } }, - "node_modules/ansi-sequence-parser": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.1.tgz", - "integrity": "sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==", - "dev": true - }, "node_modules/ansi-styles": { "version": "3.2.1", "dev": true, @@ -4495,34 +4487,6 @@ "dev": true, "license": "ISC" }, - "node_modules/handlebars": { - "version": "4.7.7", - "dev": true, - "license": "MIT", - "dependencies": { - "minimist": "^1.2.5", - "neo-async": "^2.6.0", - "source-map": "^0.6.1", - "wordwrap": "^1.0.0" - }, - "bin": { - "handlebars": "bin/handlebars" - }, - "engines": { - "node": ">=0.4.7" - }, - "optionalDependencies": { - "uglify-js": "^3.1.4" - } - }, - "node_modules/handlebars/node_modules/source-map": { - "version": "0.6.1", - "dev": true, - "license": "BSD-3-Clause", - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/has": { "version": "1.0.3", "dev": true, @@ -7915,11 +7879,6 @@ "node": ">=10" } }, - "node_modules/lunr": { - "version": "2.3.9", - "dev": true, - "license": "MIT" - }, "node_modules/luxon": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/luxon/-/luxon-3.3.0.tgz", @@ -7992,17 +7951,6 @@ "node": ">=0.10.0" } }, - "node_modules/marked": { - "version": "4.3.0", - "dev": true, - "license": "MIT", - "bin": { - "marked": "bin/marked.js" - }, - "engines": { - "node": ">= 12" - } - }, "node_modules/media-typer": { "version": "0.3.0", "dev": true, @@ -8363,11 +8311,6 @@ "node": ">= 0.6" } }, - "node_modules/neo-async": { - "version": "2.6.2", - "dev": true, - "license": "MIT" - }, "node_modules/nice-try": { "version": "1.0.5", "dev": true, @@ -9729,18 +9672,6 @@ "dev": true, "license": "MIT" }, - "node_modules/shiki": { - "version": "0.14.7", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", - "integrity": "sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==", - "dev": true, - "dependencies": { - "ansi-sequence-parser": "^1.1.0", - "jsonc-parser": "^3.2.0", - "vscode-oniguruma": "^1.7.0", - "vscode-textmate": "^8.0.0" - } - }, "node_modules/side-channel": { "version": "1.0.4", "dev": true, @@ -10610,63 +10541,6 @@ "node": ">= 0.6" } }, - "node_modules/typedoc": { - "version": "0.25.12", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.12.tgz", - "integrity": "sha512-F+qhkK2VoTweDXd1c42GS/By2DvI2uDF4/EpG424dTexSHdtCH52C6IcAvMA6jR3DzAWZjHpUOW+E02kyPNUNw==", - "dev": true, - "dependencies": { - "lunr": "^2.3.9", - "marked": "^4.3.0", - "minimatch": "^9.0.3", - "shiki": "^0.14.7" - }, - "bin": { - "typedoc": "bin/typedoc" - }, - "engines": { - "node": ">= 16" - }, - "peerDependencies": { - "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x" - } - }, - "node_modules/typedoc-plugin-markdown": { - "version": "3.17.1", - "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.17.1.tgz", - "integrity": "sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==", - "dev": true, - "dependencies": { - "handlebars": "^4.7.7" - }, - "peerDependencies": { - "typedoc": ">=0.24.0" - } - }, - "node_modules/typedoc/node_modules/brace-expansion": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", - "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", - "dev": true, - "dependencies": { - "balanced-match": "^1.0.0" - } - }, - "node_modules/typedoc/node_modules/minimatch": { - "version": "9.0.4", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.4.tgz", - "integrity": "sha512-KqWh+VchfxcMNRAJjj2tnsSJdNbHsVgnkBhTNrW7AjVo6OvLtxw8zfT9oLw1JSohlFzJ8jCoTgaoXvJ+kHt6fw==", - "dev": true, - "dependencies": { - "brace-expansion": "^2.0.1" - }, - "engines": { - "node": ">=16 || 14 >=14.17" - }, - "funding": { - "url": "https://github.com/sponsors/isaacs" - } - }, "node_modules/typescript": { "version": "5.4.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.3.tgz", @@ -10680,18 +10554,6 @@ "node": ">=14.17" } }, - "node_modules/uglify-js": { - "version": "3.14.5", - "dev": true, - "license": "BSD-2-Clause", - "optional": true, - "bin": { - "uglifyjs": "bin/uglifyjs" - }, - "engines": { - "node": ">=0.8.0" - } - }, "node_modules/uid-safe": { "version": "2.1.5", "dev": true, @@ -10891,18 +10753,6 @@ "node": ">= 0.8" } }, - "node_modules/vscode-oniguruma": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", - "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", - "dev": true - }, - "node_modules/vscode-textmate": { - "version": "8.0.0", - "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", - "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", - "dev": true - }, "node_modules/w3c-xmlserializer": { "version": "4.0.0", "dev": true, @@ -11027,11 +10877,6 @@ "node": ">=0.10.0" } }, - "node_modules/wordwrap": { - "version": "1.0.0", - "dev": true, - "license": "MIT" - }, "node_modules/wrap-ansi": { "version": "7.0.0", "dev": true, diff --git a/package.json b/package.json index 3ad2ddf205..80940d30c0 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,6 @@ "build:bundleXml": "node tools/bundle_xml/main.cjs", "buildDev": "npm-run-all build:js build:bundleJsDev \"build:bundleXml -- --outDir build\"", "build": "npm-run-all build:js build:bundleJs \"build:bundleXml -- --outDir build\"", - "doc": "typedoc", "precommit": "npm run prettier && npm run doc", "test": "tsc --noEmit --project tsconfig.jest.json && jest", "test:watch": "jest --watch", @@ -90,8 +89,6 @@ "rollup": "^3.28.0", "rollup-plugin-dts": "^5.3.1", "rollup-plugin-typescript2": "^0.35.0", - "typedoc": "0.25.12", - "typedoc-plugin-markdown": "3.17.1", "typescript": "^5.4.3", "xml-formatter": "^2.4.0" }, diff --git a/tsconfig.jest.json b/tsconfig.jest.json index 024608bd06..47e7269e38 100644 --- a/tsconfig.jest.json +++ b/tsconfig.jest.json @@ -20,15 +20,5 @@ "strictBindCallApply": true }, "include": ["src", "tests"], - "typedocOptions": { - "entryPoints": ["src/index.ts"], - "out": "doc/tsdoc", - "name": "o-spreadsheet API", - "readme": "none", - "excludePrivate": true, - "hideGenerator": true, - "disableSources": true, - "excludeExternals": true - }, "files": ["global.d.ts"] } diff --git a/tsconfig.json b/tsconfig.json index c227122ed7..81cdc34018 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -20,15 +20,5 @@ "sourceMap": true, "strictBindCallApply": true }, - "include": ["src"], - "typedocOptions": { - "entryPoints": ["src/index.ts"], - "out": "doc/tsdoc", - "name": "o-spreadsheet API", - "readme": "none", - "excludePrivate": true, - "hideGenerator": true, - "disableSources": true, - "excludeExternals": true - } + "include": ["src"] }