@odoo/o-spreadsheet 16.0.13 → 16.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/o-spreadsheet.cjs.js +69 -31
- package/dist/o-spreadsheet.d.ts +162 -163
- package/dist/o-spreadsheet.esm.js +70 -32
- package/dist/o-spreadsheet.iife.js +69 -31
- package/dist/o-spreadsheet.iife.min.js +284 -279
- package/package.json +4 -4
package/dist/o-spreadsheet.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import * as _odoo_owl from '@odoo/owl';
|
|
|
2
2
|
import { ComponentConstructor, EventBus as EventBus$1, Component } from '@odoo/owl';
|
|
3
3
|
import { ChartConfiguration, ChartData, ChartDataSets, ChartOptions } from 'chart.js';
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
type TranslationFunction = (string: string, ...values: string[] | [{
|
|
6
6
|
[key: string]: string;
|
|
7
7
|
}]) => string;
|
|
8
8
|
/***
|
|
@@ -81,7 +81,7 @@ interface EnrichedToken extends Token {
|
|
|
81
81
|
functionContext?: FunctionContext;
|
|
82
82
|
}
|
|
83
83
|
|
|
84
|
-
|
|
84
|
+
type TokenType = "OPERATOR" | "NUMBER" | "STRING" | "BOOLEAN" | "FUNCTION" | "SYMBOL" | "SPACE" | "DEBUGGER" | "COMMA" | "LEFT_PAREN" | "RIGHT_PAREN" | "REFERENCE" | "INVALID_REFERENCE" | "UNKNOWN";
|
|
85
85
|
interface Token {
|
|
86
86
|
type: TokenType;
|
|
87
87
|
value: string;
|
|
@@ -128,7 +128,7 @@ interface ASTUnknown extends ASTBase {
|
|
|
128
128
|
type: "UNKNOWN";
|
|
129
129
|
value: string;
|
|
130
130
|
}
|
|
131
|
-
|
|
131
|
+
type AST = ASTOperation | ASTUnaryOperation | ASTFuncall | ASTNumber | ASTBoolean | ASTString | ASTReference | ASTUnknown;
|
|
132
132
|
/**
|
|
133
133
|
* Parse an expression (as a string) into an AST.
|
|
134
134
|
*/
|
|
@@ -195,7 +195,7 @@ declare class EventBus<Event extends {
|
|
|
195
195
|
*/
|
|
196
196
|
clear(): void;
|
|
197
197
|
}
|
|
198
|
-
|
|
198
|
+
type Callback = (...args: any[]) => void;
|
|
199
199
|
interface Subscription {
|
|
200
200
|
owner: any;
|
|
201
201
|
callback: Callback;
|
|
@@ -344,14 +344,14 @@ interface HeadersSelected extends SelectionEventPayload {
|
|
|
344
344
|
interface AlterZoneCorner extends SelectionEventPayload {
|
|
345
345
|
type: "AlterZoneCorner";
|
|
346
346
|
}
|
|
347
|
-
|
|
347
|
+
type SelectionEvent = Readonly<ZonesSelected | HeadersSelected | AlterZoneCorner>;
|
|
348
348
|
|
|
349
349
|
interface StreamCallbacks<Event> {
|
|
350
350
|
handleEvent: (event: Event) => void;
|
|
351
351
|
release?: () => void;
|
|
352
352
|
}
|
|
353
353
|
|
|
354
|
-
|
|
354
|
+
type StatefulStream<Event, State> = {
|
|
355
355
|
capture(owner: unknown, state: State, callbacks: StreamCallbacks<Event>): void;
|
|
356
356
|
registerAsDefault: (owner: unknown, state: State, callbacks: StreamCallbacks<Event>) => void;
|
|
357
357
|
resetDefaultAnchor: (owner: unknown, state: State) => void;
|
|
@@ -505,10 +505,10 @@ interface XLSXExport {
|
|
|
505
505
|
* Note that the alpha channel goes first! AARRGGBB
|
|
506
506
|
* e.g. "1E5010" or "331E5010"
|
|
507
507
|
*/
|
|
508
|
-
|
|
508
|
+
type XlsxHexColor = string & Alias;
|
|
509
509
|
|
|
510
|
-
|
|
511
|
-
|
|
510
|
+
type VerticalAxisPosition = "left" | "right";
|
|
511
|
+
type LegendPosition = "top" | "bottom" | "left" | "right" | "none";
|
|
512
512
|
|
|
513
513
|
interface BarChartDefinition {
|
|
514
514
|
readonly type: "bar";
|
|
@@ -521,7 +521,7 @@ interface BarChartDefinition {
|
|
|
521
521
|
readonly legendPosition: LegendPosition;
|
|
522
522
|
readonly stacked: boolean;
|
|
523
523
|
}
|
|
524
|
-
|
|
524
|
+
type BarChartRuntime = {
|
|
525
525
|
chartJsConfig: ChartConfiguration;
|
|
526
526
|
background: Color;
|
|
527
527
|
};
|
|
@@ -601,7 +601,7 @@ interface LineChartDefinition {
|
|
|
601
601
|
readonly labelsAsText: boolean;
|
|
602
602
|
readonly stacked: boolean;
|
|
603
603
|
}
|
|
604
|
-
|
|
604
|
+
type LineChartRuntime = {
|
|
605
605
|
chartJsConfig: ChartConfiguration;
|
|
606
606
|
background: Color;
|
|
607
607
|
};
|
|
@@ -615,7 +615,7 @@ interface PieChartDefinition {
|
|
|
615
615
|
readonly background?: Color;
|
|
616
616
|
readonly legendPosition: LegendPosition;
|
|
617
617
|
}
|
|
618
|
-
|
|
618
|
+
type PieChartRuntime = {
|
|
619
619
|
chartJsConfig: ChartConfiguration;
|
|
620
620
|
background: Color;
|
|
621
621
|
};
|
|
@@ -631,8 +631,8 @@ interface ScorecardChartDefinition {
|
|
|
631
631
|
readonly baselineColorUp: Color;
|
|
632
632
|
readonly baselineColorDown: Color;
|
|
633
633
|
}
|
|
634
|
-
|
|
635
|
-
|
|
634
|
+
type BaselineMode = "text" | "difference" | "percentage";
|
|
635
|
+
type BaselineArrowDirection = "neutral" | "up" | "down";
|
|
636
636
|
interface ScorecardChartRuntime {
|
|
637
637
|
readonly title: string;
|
|
638
638
|
readonly keyValue: string;
|
|
@@ -646,15 +646,15 @@ interface ScorecardChartRuntime {
|
|
|
646
646
|
readonly baselineStyle?: Style;
|
|
647
647
|
}
|
|
648
648
|
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
649
|
+
type ChartType = "line" | "bar" | "pie" | "scorecard" | "gauge";
|
|
650
|
+
type ChartDefinition = LineChartDefinition | PieChartDefinition | BarChartDefinition | ScorecardChartDefinition | GaugeChartDefinition;
|
|
651
|
+
type ChartJSRuntime = LineChartRuntime | PieChartRuntime | BarChartRuntime | GaugeChartRuntime;
|
|
652
|
+
type ChartRuntime = ChartJSRuntime | ScorecardChartRuntime;
|
|
653
653
|
interface ExcelChartDataset {
|
|
654
654
|
readonly label?: string;
|
|
655
655
|
readonly range: string;
|
|
656
656
|
}
|
|
657
|
-
|
|
657
|
+
type ExcelChartType = "line" | "bar" | "pie";
|
|
658
658
|
interface ExcelChartDefinition {
|
|
659
659
|
readonly title?: string;
|
|
660
660
|
readonly type: ExcelChartType;
|
|
@@ -705,8 +705,8 @@ interface ConditionalFormat {
|
|
|
705
705
|
interface ConditionalFormatInternal extends Omit<ConditionalFormat, "ranges"> {
|
|
706
706
|
ranges: Range[];
|
|
707
707
|
}
|
|
708
|
-
|
|
709
|
-
|
|
708
|
+
type ConditionalFormatRule = SingleColorRules | ColorScaleRule | IconSetRule;
|
|
709
|
+
type SingleColorRules = CellIsRule;
|
|
710
710
|
interface SingleColorRule {
|
|
711
711
|
style: Style;
|
|
712
712
|
}
|
|
@@ -715,18 +715,18 @@ interface CellIsRule extends SingleColorRule {
|
|
|
715
715
|
operator: ConditionalFormattingOperatorValues;
|
|
716
716
|
values: string[];
|
|
717
717
|
}
|
|
718
|
-
|
|
719
|
-
|
|
718
|
+
type ThresholdType = "value" | "number" | "percentage" | "percentile" | "formula";
|
|
719
|
+
type ColorScaleThreshold = {
|
|
720
720
|
color: number;
|
|
721
721
|
type: ThresholdType;
|
|
722
722
|
value?: string;
|
|
723
723
|
};
|
|
724
|
-
|
|
724
|
+
type ColorScaleMidPointThreshold = {
|
|
725
725
|
color: number;
|
|
726
726
|
type: Exclude<ThresholdType, "value">;
|
|
727
727
|
value: string;
|
|
728
728
|
};
|
|
729
|
-
|
|
729
|
+
type IconThreshold = {
|
|
730
730
|
type: Exclude<ThresholdType, "value">;
|
|
731
731
|
operator: "gt" | "ge";
|
|
732
732
|
value: string;
|
|
@@ -748,8 +748,8 @@ interface IconSetRule {
|
|
|
748
748
|
upperInflectionPoint: IconThreshold;
|
|
749
749
|
lowerInflectionPoint: IconThreshold;
|
|
750
750
|
}
|
|
751
|
-
|
|
752
|
-
|
|
751
|
+
type ConditionalFormattingOperatorValues = "BeginsWith" | "Between" | "ContainsText" | "IsEmpty" | "IsNotEmpty" | "EndsWith" | "Equal" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual" | "NotBetween" | "NotContains" | "NotEqual";
|
|
752
|
+
type UpDown = "up" | "down";
|
|
753
753
|
|
|
754
754
|
interface CellData {
|
|
755
755
|
content?: string;
|
|
@@ -840,7 +840,7 @@ interface ExcelFilterData {
|
|
|
840
840
|
displayBlanks?: boolean;
|
|
841
841
|
}
|
|
842
842
|
|
|
843
|
-
|
|
843
|
+
type ClientId = string;
|
|
844
844
|
interface Client {
|
|
845
845
|
id: ClientId;
|
|
846
846
|
name: string;
|
|
@@ -886,7 +886,7 @@ interface RevisionsDroppedEvent {
|
|
|
886
886
|
interface SnapshotEvent {
|
|
887
887
|
type: "snapshot";
|
|
888
888
|
}
|
|
889
|
-
|
|
889
|
+
type CollaborativeEvent = NewLocalStateUpdateEvent | UnexpectedRevisionIdEvent | RemoteRevisionReceivedEvent | RevisionAcknowledgedEvent | RevisionUndone | RevisionRedone | RevisionsDroppedEvent | SnapshotEvent | CollaborativeEventReceived;
|
|
890
890
|
|
|
891
891
|
interface AbstractMessage {
|
|
892
892
|
version: number;
|
|
@@ -940,11 +940,11 @@ interface SnapshotCreatedMessage extends AbstractMessage {
|
|
|
940
940
|
serverRevisionId: UID;
|
|
941
941
|
nextRevisionId: UID;
|
|
942
942
|
}
|
|
943
|
-
|
|
944
|
-
|
|
943
|
+
type CollaborationMessage = RevisionUndoneMessage | RevisionRedoneMessage | RemoteRevisionMessage | SnapshotMessage | SnapshotCreatedMessage | ClientMovedMessage | ClientJoinedMessage | ClientLeftMessage;
|
|
944
|
+
type StateUpdateMessage = Extract<CollaborationMessage, {
|
|
945
945
|
nextRevisionId: UID;
|
|
946
946
|
}>;
|
|
947
|
-
|
|
947
|
+
type NewMessageCallback<T = any> = (message: T) => void;
|
|
948
948
|
/**
|
|
949
949
|
* The transport service allows to communicate between multiple clients.
|
|
950
950
|
* A client can send any message to others.
|
|
@@ -1003,7 +1003,7 @@ interface NotifyUIEvent {
|
|
|
1003
1003
|
* Note that the Model can be used in a standalone way to manipulate
|
|
1004
1004
|
* programmatically a spreadsheet.
|
|
1005
1005
|
*/
|
|
1006
|
-
|
|
1006
|
+
type Mode = "normal" | "readonly" | "dashboard";
|
|
1007
1007
|
interface ModelConfig {
|
|
1008
1008
|
mode: Mode;
|
|
1009
1009
|
evalContext: EvalContext;
|
|
@@ -1221,7 +1221,7 @@ declare class BasePlugin<State = any, C = any> implements CommandHandler<C>, Val
|
|
|
1221
1221
|
checkValidations<T>(command: T, ...validations: Validation<T>[]): CommandResult | CommandResult[];
|
|
1222
1222
|
}
|
|
1223
1223
|
|
|
1224
|
-
|
|
1224
|
+
type UIActions = Pick<ModelConfig, "notifyUI">;
|
|
1225
1225
|
interface UIPluginConstructor {
|
|
1226
1226
|
new (getters: Getters, state: StateObserver, dispatch: CommandDispatcher["dispatch"], config: ModelConfig, selection: SelectionStreamProcessor): UIPlugin;
|
|
1227
1227
|
layers: LAYERS[];
|
|
@@ -1240,7 +1240,7 @@ declare class UIPlugin<State = any, C = Command> extends BasePlugin<State, C> {
|
|
|
1240
1240
|
drawGrid(ctx: GridRenderingContext, layer: LAYERS): void;
|
|
1241
1241
|
}
|
|
1242
1242
|
|
|
1243
|
-
|
|
1243
|
+
type EditionMode = "editing" | "selecting" | "inactive";
|
|
1244
1244
|
interface ComposerSelection {
|
|
1245
1245
|
start: number;
|
|
1246
1246
|
end: number;
|
|
@@ -1368,7 +1368,9 @@ declare class FindAndReplacePlugin extends UIPlugin {
|
|
|
1368
1368
|
private currentSearchRegex;
|
|
1369
1369
|
private searchOptions;
|
|
1370
1370
|
private toSearch;
|
|
1371
|
+
private isSearchDirty;
|
|
1371
1372
|
handle(cmd: Command): void;
|
|
1373
|
+
finalize(): void;
|
|
1372
1374
|
getSearchMatches(): SearchMatch[];
|
|
1373
1375
|
getCurrentSelectedMatchIndex(): number | null;
|
|
1374
1376
|
/**
|
|
@@ -1416,7 +1418,7 @@ declare class FindAndReplacePlugin extends UIPlugin {
|
|
|
1416
1418
|
drawGrid(renderingContext: GridRenderingContext): void;
|
|
1417
1419
|
}
|
|
1418
1420
|
|
|
1419
|
-
|
|
1421
|
+
type Rect = {
|
|
1420
1422
|
x: Pixel;
|
|
1421
1423
|
y: Pixel;
|
|
1422
1424
|
width: Pixel;
|
|
@@ -1437,7 +1439,7 @@ interface DOMDimension {
|
|
|
1437
1439
|
* The viewport is the visible area of a sheet.
|
|
1438
1440
|
* Column and row headers are not included in the viewport.
|
|
1439
1441
|
*/
|
|
1440
|
-
|
|
1442
|
+
type Viewport = Zone & Alias;
|
|
1441
1443
|
interface SheetScrollInfo {
|
|
1442
1444
|
/**
|
|
1443
1445
|
* The offset in the X coordinate between the viewport left side and
|
|
@@ -1482,9 +1484,9 @@ interface EdgeScrollInfo {
|
|
|
1482
1484
|
direction: ScrollDirection$1;
|
|
1483
1485
|
delay: number;
|
|
1484
1486
|
}
|
|
1485
|
-
|
|
1487
|
+
type ScrollDirection$1 = 1 | 0 | -1 | "reset";
|
|
1486
1488
|
|
|
1487
|
-
|
|
1489
|
+
type ClipboardPasteOptions = "onlyFormat" | "onlyValue";
|
|
1488
1490
|
|
|
1489
1491
|
/**
|
|
1490
1492
|
* There are two kinds of commands: CoreCommands and LocalCommands
|
|
@@ -1526,8 +1528,8 @@ interface PositionDependentCommand {
|
|
|
1526
1528
|
col: number;
|
|
1527
1529
|
row: number;
|
|
1528
1530
|
}
|
|
1529
|
-
declare const invalidateEvaluationCommands: Set<"UPDATE_CELL" | "UPDATE_CELL_POSITION" | "CLEAR_CELL" | "DELETE_CONTENT" | "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" | "CREATE_FILTER_TABLE" | "REMOVE_FILTER_TABLE" | "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" | "
|
|
1530
|
-
declare const readonlyAllowedCommands: Set<"UPDATE_CELL" | "UPDATE_CELL_POSITION" | "CLEAR_CELL" | "DELETE_CONTENT" | "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" | "CREATE_FILTER_TABLE" | "REMOVE_FILTER_TABLE" | "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" | "
|
|
1531
|
+
declare const invalidateEvaluationCommands: Set<"UPDATE_CELL" | "UPDATE_CELL_POSITION" | "CLEAR_CELL" | "DELETE_CONTENT" | "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" | "CREATE_FILTER_TABLE" | "REMOVE_FILTER_TABLE" | "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" | "SET_DECIMAL" | "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" | "UPDATE_FILTER">;
|
|
1532
|
+
declare const readonlyAllowedCommands: Set<"UPDATE_CELL" | "UPDATE_CELL_POSITION" | "CLEAR_CELL" | "DELETE_CONTENT" | "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" | "CREATE_FILTER_TABLE" | "REMOVE_FILTER_TABLE" | "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" | "SET_DECIMAL" | "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" | "UPDATE_FILTER">;
|
|
1531
1533
|
declare const coreTypes: Set<"UPDATE_CELL" | "UPDATE_CELL_POSITION" | "CLEAR_CELL" | "DELETE_CONTENT" | "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" | "CREATE_FILTER_TABLE" | "REMOVE_FILTER_TABLE">;
|
|
1532
1534
|
interface UpdateCellCommand extends PositionDependentCommand {
|
|
1533
1535
|
type: "UPDATE_CELL";
|
|
@@ -1962,9 +1964,6 @@ interface UpdateSearchCommand {
|
|
|
1962
1964
|
interface ClearSearchCommand {
|
|
1963
1965
|
type: "CLEAR_SEARCH";
|
|
1964
1966
|
}
|
|
1965
|
-
interface RefreshSearchCommand {
|
|
1966
|
-
type: "REFRESH_SEARCH";
|
|
1967
|
-
}
|
|
1968
1967
|
interface SelectSearchPreviousCommand {
|
|
1969
1968
|
type: "SELECT_SEARCH_PREVIOUS_MATCH";
|
|
1970
1969
|
}
|
|
@@ -1988,7 +1987,7 @@ interface SortCommand {
|
|
|
1988
1987
|
sortDirection: SortDirection;
|
|
1989
1988
|
sortOptions?: SortOptions;
|
|
1990
1989
|
}
|
|
1991
|
-
|
|
1990
|
+
type SortDirection = "ascending" | "descending";
|
|
1992
1991
|
interface ResizeViewportCommand {
|
|
1993
1992
|
type: "RESIZE_SHEETVIEW";
|
|
1994
1993
|
width: Pixel;
|
|
@@ -2051,7 +2050,7 @@ interface OpenCellPopoverCommand {
|
|
|
2051
2050
|
interface CloseCellPopoverCommand {
|
|
2052
2051
|
type: "CLOSE_CELL_POPOVER";
|
|
2053
2052
|
}
|
|
2054
|
-
|
|
2053
|
+
type CoreCommand =
|
|
2055
2054
|
/** CELLS */
|
|
2056
2055
|
UpdateCellCommand | UpdateCellPositionCommand | ClearCellCommand | DeleteContentCommand
|
|
2057
2056
|
/** GRID SHAPE */
|
|
@@ -2072,8 +2071,8 @@ UpdateCellCommand | UpdateCellPositionCommand | ClearCellCommand | DeleteContent
|
|
|
2072
2071
|
| CreateChartCommand | UpdateChartCommand
|
|
2073
2072
|
/** FILTERS */
|
|
2074
2073
|
| CreateFilterTableCommand | RemoveFilterTableCommand;
|
|
2075
|
-
|
|
2076
|
-
|
|
2074
|
+
type LocalCommand = RequestUndoCommand | RequestRedoCommand | UndoCommand | RedoCommand | NewInputCommand | RemoveInputCommand | UnfocusInputCommand | FocusInputCommand | AddEmptyRangeCommand | RemoveRangeCommand | ChangeRangeCommand | CopyCommand | CutCommand | PasteCommand | AutoFillCellCommand | PasteFromOSClipboardCommand | ActivatePaintFormatCommand | PasteCFCommand | AutoresizeColumnsCommand | AutoresizeRowsCommand | MoveColumnsRowsCommand | ActivateSheetCommand | PrepareExpansionCommand | StopSelectionCommand | EvaluateCellsCommand | ChangeHighlightCommand | StartChangeHighlightCommand | SetColorCommand | StopComposerSelectionCommand | StartEditionCommand | StopEditionCommand | SetCurrentContentCommand | ChangeComposerSelectionCommand | ReplaceComposerSelectionCommand | CycleEditionReferencesCommand | StartCommand | AutofillCommand | AutofillSelectCommand | ShowFormulaCommand | AutofillAutoCommand | SelectFigureCommand | UpdateSearchCommand | ClearSearchCommand | SelectSearchPreviousCommand | SelectSearchNextCommand | ReplaceSearchCommand | ReplaceAllSearchCommand | SortCommand | SetDecimalCommand | ResizeViewportCommand | SumSelectionCommand | DeleteCellCommand | InsertCellCommand | SetViewportOffsetCommand | MoveViewportDownCommand | MoveViewportUpCommand | OpenCellPopoverCommand | CloseCellPopoverCommand | ActivateNextSheetCommand | ActivatePreviousSheetCommand | UpdateFilterCommand;
|
|
2075
|
+
type Command = CoreCommand | LocalCommand;
|
|
2077
2076
|
/**
|
|
2078
2077
|
* Holds the result of a command dispatch.
|
|
2079
2078
|
* The command may have been successfully dispatched or cancelled
|
|
@@ -2093,7 +2092,7 @@ declare class DispatchResult {
|
|
|
2093
2092
|
*/
|
|
2094
2093
|
isCancelledBecause(reason: CancelledReason): boolean;
|
|
2095
2094
|
}
|
|
2096
|
-
|
|
2095
|
+
type CancelledReason = Exclude<CommandResult, CommandResult.Success>;
|
|
2097
2096
|
declare const enum CommandResult {
|
|
2098
2097
|
Success = 0,
|
|
2099
2098
|
CancelledForUnknownReason = 1,
|
|
@@ -2205,26 +2204,26 @@ interface CoreCommandDispatcher {
|
|
|
2205
2204
|
type: T;
|
|
2206
2205
|
}>>(type: T, r: Omit<C, "type">): DispatchResult;
|
|
2207
2206
|
}
|
|
2208
|
-
|
|
2209
|
-
|
|
2207
|
+
type CommandTypes = Command["type"];
|
|
2208
|
+
type CoreCommandTypes = CoreCommand["type"];
|
|
2210
2209
|
|
|
2211
2210
|
/**
|
|
2212
2211
|
* The following type is meant to be used in union with other aliases to prevent
|
|
2213
2212
|
* Intellisense from resolving it.
|
|
2214
2213
|
* See https://github.com/microsoft/TypeScript/issues/31940#issuecomment-841712377
|
|
2215
2214
|
*/
|
|
2216
|
-
|
|
2217
|
-
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2215
|
+
type Alias = {} & {};
|
|
2216
|
+
type HeaderIndex = number & Alias;
|
|
2217
|
+
type Pixel = number & Alias;
|
|
2218
|
+
type UID = string & Alias;
|
|
2219
|
+
type SetDecimalStep = 1 | -1;
|
|
2220
|
+
type FilterId = UID & Alias;
|
|
2221
|
+
type FilterTableId = UID & Alias;
|
|
2223
2222
|
/**
|
|
2224
2223
|
* CSS style color string
|
|
2225
2224
|
* e.g. "#ABC", "#AAAFFF", "rgb(30, 80, 16)"
|
|
2226
2225
|
*/
|
|
2227
|
-
|
|
2226
|
+
type Color = string & Alias;
|
|
2228
2227
|
interface RGBA {
|
|
2229
2228
|
a: number;
|
|
2230
2229
|
r: number;
|
|
@@ -2265,8 +2264,8 @@ interface ZoneDimension {
|
|
|
2265
2264
|
height: HeaderIndex;
|
|
2266
2265
|
width: HeaderIndex;
|
|
2267
2266
|
}
|
|
2268
|
-
|
|
2269
|
-
|
|
2267
|
+
type Align = "left" | "right" | "center" | undefined;
|
|
2268
|
+
type Wrapping = "overflow" | "wrap" | "clip" | undefined;
|
|
2270
2269
|
interface Style {
|
|
2271
2270
|
bold?: boolean;
|
|
2272
2271
|
italic?: boolean;
|
|
@@ -2298,35 +2297,35 @@ interface CellPosition {
|
|
|
2298
2297
|
row: HeaderIndex;
|
|
2299
2298
|
sheetId: UID;
|
|
2300
2299
|
}
|
|
2301
|
-
|
|
2302
|
-
|
|
2300
|
+
type BorderStyle = "thin" | "medium" | "thick" | "dashed" | "dotted" | "double";
|
|
2301
|
+
type BorderDescr = [BorderStyle, Color];
|
|
2303
2302
|
interface Border$1 {
|
|
2304
2303
|
top?: BorderDescr;
|
|
2305
2304
|
left?: BorderDescr;
|
|
2306
2305
|
bottom?: BorderDescr;
|
|
2307
2306
|
right?: BorderDescr;
|
|
2308
2307
|
}
|
|
2309
|
-
|
|
2310
|
-
|
|
2311
|
-
|
|
2308
|
+
type ReferenceDenormalizer = (range: Range, isMeta: boolean, functionName: string, paramNumber: number) => any | any[][];
|
|
2309
|
+
type EnsureRange = (range: Range) => any[][];
|
|
2310
|
+
type _CompiledFormula = (deps: Range[], refFn: ReferenceDenormalizer, range: EnsureRange, ctx: {}) => FormulaReturn;
|
|
2312
2311
|
interface CompiledFormula {
|
|
2313
2312
|
execute: _CompiledFormula;
|
|
2314
2313
|
tokens: Token[];
|
|
2315
2314
|
dependencies: string[];
|
|
2316
2315
|
}
|
|
2317
|
-
|
|
2318
|
-
|
|
2316
|
+
type Arg = MatrixArg | PrimitiveArg;
|
|
2317
|
+
type MatrixArg = ({
|
|
2319
2318
|
value: CellValue;
|
|
2320
2319
|
format?: Format;
|
|
2321
2320
|
} | undefined)[][];
|
|
2322
|
-
|
|
2321
|
+
type PrimitiveArg = {
|
|
2323
2322
|
value: PrimitiveArgValue;
|
|
2324
2323
|
format?: Format;
|
|
2325
2324
|
};
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
|
|
2325
|
+
type ArgValue = PrimitiveArgValue | MatrixArgValue;
|
|
2326
|
+
type MatrixArgValue = (CellValue | undefined)[][];
|
|
2327
|
+
type PrimitiveArgValue = string | number | boolean | null;
|
|
2328
|
+
type FunctionReturn = {
|
|
2330
2329
|
value: FunctionReturnValue;
|
|
2331
2330
|
format?: Format;
|
|
2332
2331
|
};
|
|
@@ -2334,7 +2333,7 @@ interface FormulaReturn extends Omit<FunctionReturn, "value"> {
|
|
|
2334
2333
|
value: FunctionReturnValue | null;
|
|
2335
2334
|
format?: Format;
|
|
2336
2335
|
}
|
|
2337
|
-
|
|
2336
|
+
type FunctionReturnValue = string | number | boolean;
|
|
2338
2337
|
interface HeaderDimensions {
|
|
2339
2338
|
start: Pixel;
|
|
2340
2339
|
size: Pixel;
|
|
@@ -2362,8 +2361,8 @@ interface PaneDivision {
|
|
|
2362
2361
|
/** Represents the number of frozen rows */
|
|
2363
2362
|
ySplit: number;
|
|
2364
2363
|
}
|
|
2365
|
-
|
|
2366
|
-
|
|
2364
|
+
type BorderCommand = "all" | "hv" | "h" | "v" | "external" | "left" | "top" | "right" | "bottom" | "clear";
|
|
2365
|
+
type BorderDescription = {
|
|
2367
2366
|
vertical?: BorderDescr;
|
|
2368
2367
|
horizontal?: BorderDescr;
|
|
2369
2368
|
} | undefined;
|
|
@@ -2373,24 +2372,24 @@ declare const enum DIRECTION {
|
|
|
2373
2372
|
LEFT = "left",
|
|
2374
2373
|
RIGHT = "right"
|
|
2375
2374
|
}
|
|
2376
|
-
|
|
2377
|
-
|
|
2375
|
+
type ChangeType = "REMOVE" | "RESIZE" | "MOVE" | "CHANGE" | "NONE";
|
|
2376
|
+
type ApplyRangeChangeResult = {
|
|
2378
2377
|
changeType: Exclude<ChangeType, "NONE">;
|
|
2379
2378
|
range: Range;
|
|
2380
2379
|
} | {
|
|
2381
2380
|
changeType: "NONE";
|
|
2382
2381
|
};
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2382
|
+
type ApplyRangeChange = (range: Range) => ApplyRangeChangeResult;
|
|
2383
|
+
type Dimension = "COL" | "ROW";
|
|
2384
|
+
type ConsecutiveIndexes = HeaderIndex[];
|
|
2386
2385
|
interface RangeProvider {
|
|
2387
2386
|
adaptRanges: (applyChange: ApplyRangeChange, sheetId?: UID) => void;
|
|
2388
2387
|
}
|
|
2389
|
-
|
|
2388
|
+
type Validation<T> = (toValidate: T) => CommandResult | CommandResult[];
|
|
2390
2389
|
/**
|
|
2391
2390
|
* Return the prop's type of a component
|
|
2392
2391
|
*/
|
|
2393
|
-
|
|
2392
|
+
type PropsOf<C> = C extends ComponentConstructor<infer Props> ? Props : never;
|
|
2394
2393
|
/**
|
|
2395
2394
|
* Container for a lazy computed value
|
|
2396
2395
|
*/
|
|
@@ -2416,7 +2415,7 @@ interface Lazy<T> {
|
|
|
2416
2415
|
interface Cloneable<T> {
|
|
2417
2416
|
clone: (args?: Partial<T>) => T;
|
|
2418
2417
|
}
|
|
2419
|
-
|
|
2418
|
+
type CSSProperties<P extends string = string> = Record<P, string>;
|
|
2420
2419
|
interface SortOptions {
|
|
2421
2420
|
/** If true sort the headers of the range along with the rest */
|
|
2422
2421
|
sortHeaders?: boolean;
|
|
@@ -2427,10 +2426,10 @@ interface MenuMouseEvent extends MouseEvent {
|
|
|
2427
2426
|
closedMenuId?: UID;
|
|
2428
2427
|
}
|
|
2429
2428
|
|
|
2430
|
-
|
|
2431
|
-
|
|
2429
|
+
type Format = string & Alias;
|
|
2430
|
+
type FormattedValue = string & Alias;
|
|
2432
2431
|
|
|
2433
|
-
|
|
2432
|
+
type Cell = ICell | FormulaCell;
|
|
2434
2433
|
interface ICell {
|
|
2435
2434
|
readonly id: UID;
|
|
2436
2435
|
/**
|
|
@@ -2492,33 +2491,33 @@ interface LinkCell$1 extends ICell {
|
|
|
2492
2491
|
*/
|
|
2493
2492
|
readonly isUrlEditable: boolean;
|
|
2494
2493
|
}
|
|
2495
|
-
|
|
2494
|
+
type CellValue = string | number | boolean;
|
|
2496
2495
|
interface CellDisplayProperties {
|
|
2497
2496
|
style?: Style;
|
|
2498
2497
|
format?: Format;
|
|
2499
2498
|
}
|
|
2500
|
-
|
|
2501
|
-
|
|
2499
|
+
type CellEvaluation = NumberEvaluation | TextEvaluation | BooleanEvaluation | EmptyEvaluation | InvalidEvaluation;
|
|
2500
|
+
type NumberEvaluation = {
|
|
2502
2501
|
readonly type: CellValueType.number;
|
|
2503
2502
|
readonly value: number;
|
|
2504
2503
|
readonly format?: Format;
|
|
2505
2504
|
};
|
|
2506
|
-
|
|
2505
|
+
type TextEvaluation = {
|
|
2507
2506
|
readonly type: CellValueType.text;
|
|
2508
2507
|
readonly value: string;
|
|
2509
2508
|
readonly format?: Format;
|
|
2510
2509
|
};
|
|
2511
|
-
|
|
2510
|
+
type BooleanEvaluation = {
|
|
2512
2511
|
readonly type: CellValueType.boolean;
|
|
2513
2512
|
readonly value: boolean;
|
|
2514
2513
|
readonly format?: Format;
|
|
2515
2514
|
};
|
|
2516
|
-
|
|
2515
|
+
type EmptyEvaluation = {
|
|
2517
2516
|
readonly type: CellValueType.empty;
|
|
2518
2517
|
readonly value: "";
|
|
2519
2518
|
readonly format?: Format;
|
|
2520
2519
|
};
|
|
2521
|
-
|
|
2520
|
+
type InvalidEvaluation = {
|
|
2522
2521
|
readonly type: CellValueType.error;
|
|
2523
2522
|
readonly value: string;
|
|
2524
2523
|
readonly error: EvaluationError;
|
|
@@ -2555,7 +2554,7 @@ interface FormulaModifier {
|
|
|
2555
2554
|
increment: number;
|
|
2556
2555
|
current: number;
|
|
2557
2556
|
}
|
|
2558
|
-
|
|
2557
|
+
type AutofillModifier = IncrementModifier | CopyModifier | FormulaModifier;
|
|
2559
2558
|
interface Tooltip {
|
|
2560
2559
|
props: any;
|
|
2561
2560
|
component?: any;
|
|
@@ -2596,9 +2595,9 @@ interface Figure {
|
|
|
2596
2595
|
height: Pixel;
|
|
2597
2596
|
tag: string;
|
|
2598
2597
|
}
|
|
2599
|
-
|
|
2598
|
+
type ResizeDirection = -1 | 0 | 1;
|
|
2600
2599
|
|
|
2601
|
-
|
|
2600
|
+
type ArgType = "ANY" | "BOOLEAN" | "NUMBER" | "STRING" | "DATE" | "RANGE" | "RANGE<BOOLEAN>" | "RANGE<NUMBER>" | "RANGE<DATE>" | "RANGE<STRING>" | "META";
|
|
2602
2601
|
interface ArgDefinition {
|
|
2603
2602
|
repeating?: boolean;
|
|
2604
2603
|
optional?: boolean;
|
|
@@ -2609,8 +2608,8 @@ interface ArgDefinition {
|
|
|
2609
2608
|
default?: boolean;
|
|
2610
2609
|
defaultValue?: any;
|
|
2611
2610
|
}
|
|
2612
|
-
|
|
2613
|
-
|
|
2611
|
+
type ComputeFunctionArg<T> = T | (() => T) | undefined;
|
|
2612
|
+
type ComputeFunction<T, R> = (this: EvalContext, ...args: ComputeFunctionArg<T>[]) => R;
|
|
2614
2613
|
interface AddFunctionDescription {
|
|
2615
2614
|
description: string;
|
|
2616
2615
|
compute: ComputeFunction<ArgValue, FunctionReturnValue>;
|
|
@@ -2626,7 +2625,7 @@ interface FunctionDescription extends AddFunctionDescription {
|
|
|
2626
2625
|
nbrArgRepeating: number;
|
|
2627
2626
|
getArgToFocus: (argPosition: number) => number;
|
|
2628
2627
|
}
|
|
2629
|
-
|
|
2628
|
+
type EvalContext = {
|
|
2630
2629
|
__lastFnCalled?: string;
|
|
2631
2630
|
__originCellXC?: () => string;
|
|
2632
2631
|
[key: string]: any;
|
|
@@ -3407,7 +3406,7 @@ declare class HeaderVisibilityPlugin extends CorePlugin {
|
|
|
3407
3406
|
exportData(data: WorkbookData, exportDefaults?: boolean): void;
|
|
3408
3407
|
}
|
|
3409
3408
|
|
|
3410
|
-
|
|
3409
|
+
type SheetMergeCellMap = Record<number, Record<number, number | undefined> | undefined>;
|
|
3411
3410
|
interface MergeState {
|
|
3412
3411
|
readonly merges: Record<UID, Record<number, Range | undefined> | undefined>;
|
|
3413
3412
|
readonly mergeCellMap: Record<UID, SheetMergeCellMap | undefined>;
|
|
@@ -4310,7 +4309,7 @@ declare class InternalViewport {
|
|
|
4310
4309
|
private adjustViewportZoneY;
|
|
4311
4310
|
}
|
|
4312
4311
|
|
|
4313
|
-
|
|
4312
|
+
type SheetViewports = {
|
|
4314
4313
|
topLeft: InternalViewport | undefined;
|
|
4315
4314
|
bottomLeft: InternalViewport | undefined;
|
|
4316
4315
|
topRight: InternalViewport | undefined;
|
|
@@ -4601,52 +4600,52 @@ declare class SheetUIPlugin extends UIPlugin {
|
|
|
4601
4600
|
* This can be generalized because the union of all indices `0 | 1 | 2 | 3 | ...`
|
|
4602
4601
|
* is actually the type `number`.
|
|
4603
4602
|
*/
|
|
4604
|
-
|
|
4603
|
+
type GetterNames<Plugin extends {
|
|
4605
4604
|
getters: readonly string[];
|
|
4606
4605
|
}> = Plugin["getters"][number];
|
|
4607
|
-
|
|
4608
|
-
|
|
4609
|
-
|
|
4610
|
-
|
|
4611
|
-
|
|
4612
|
-
|
|
4613
|
-
|
|
4614
|
-
|
|
4615
|
-
|
|
4616
|
-
|
|
4617
|
-
|
|
4606
|
+
type SheetGetters = Pick<SheetPlugin, GetterNames<typeof SheetPlugin>>;
|
|
4607
|
+
type HeaderSizeGetters = Pick<HeaderSizePlugin, GetterNames<typeof HeaderSizePlugin>>;
|
|
4608
|
+
type HeaderVisibilityGetters = Pick<HeaderVisibilityPlugin, GetterNames<typeof HeaderVisibilityPlugin>>;
|
|
4609
|
+
type CellGetters = Pick<CellPlugin, GetterNames<typeof CellPlugin>>;
|
|
4610
|
+
type MergeGetters = Pick<MergePlugin, GetterNames<typeof MergePlugin>>;
|
|
4611
|
+
type BordersGetters = Pick<BordersPlugin, GetterNames<typeof BordersPlugin>>;
|
|
4612
|
+
type ChartGetters = Pick<ChartPlugin, GetterNames<typeof ChartPlugin>>;
|
|
4613
|
+
type FigureGetters = Pick<FigurePlugin, GetterNames<typeof FigurePlugin>>;
|
|
4614
|
+
type RangeAdapterGetters = Pick<RangeAdapter, GetterNames<typeof RangeAdapter>>;
|
|
4615
|
+
type ConditionalFormatGetters = Pick<ConditionalFormatPlugin, GetterNames<typeof ConditionalFormatPlugin>>;
|
|
4616
|
+
type LocalHistoryGetters = {
|
|
4618
4617
|
canUndo: LocalHistory["canUndo"];
|
|
4619
4618
|
canRedo: LocalHistory["canRedo"];
|
|
4620
4619
|
};
|
|
4621
|
-
|
|
4622
|
-
|
|
4623
|
-
|
|
4624
|
-
|
|
4625
|
-
|
|
4626
|
-
|
|
4627
|
-
|
|
4628
|
-
|
|
4629
|
-
|
|
4630
|
-
|
|
4631
|
-
|
|
4632
|
-
|
|
4633
|
-
|
|
4634
|
-
|
|
4635
|
-
|
|
4636
|
-
|
|
4637
|
-
|
|
4638
|
-
|
|
4639
|
-
|
|
4640
|
-
|
|
4641
|
-
|
|
4642
|
-
|
|
4620
|
+
type FiltersGetters = Pick<FiltersPlugin, GetterNames<typeof FiltersPlugin>>;
|
|
4621
|
+
type CoreGetters = SheetGetters & HeaderSizeGetters & HeaderVisibilityGetters & CellGetters & MergeGetters & BordersGetters & ChartGetters & ConditionalFormatGetters & FigureGetters & RangeAdapterGetters & FiltersGetters;
|
|
4622
|
+
type AutofillGetters = Pick<AutofillPlugin, GetterNames<typeof AutofillPlugin>>;
|
|
4623
|
+
type AutomaticSumGetters = Pick<AutomaticSumPlugin, GetterNames<typeof AutomaticSumPlugin>>;
|
|
4624
|
+
type ClipboardGetters = Pick<ClipboardPlugin, GetterNames<typeof ClipboardPlugin>>;
|
|
4625
|
+
type EditionGetters = Pick<EditionPlugin, GetterNames<typeof EditionPlugin>>;
|
|
4626
|
+
type EvaluationGetters = Pick<EvaluationPlugin, GetterNames<typeof EvaluationPlugin>>;
|
|
4627
|
+
type EvaluationChartGetters = Pick<EvaluationChartPlugin, GetterNames<typeof EvaluationChartPlugin>>;
|
|
4628
|
+
type EvaluationConditionalFormatGetters = Pick<EvaluationConditionalFormatPlugin, GetterNames<typeof EvaluationConditionalFormatPlugin>>;
|
|
4629
|
+
type FindAndReplaceGetters = Pick<FindAndReplacePlugin, GetterNames<typeof FindAndReplacePlugin>>;
|
|
4630
|
+
type HeaderVisibilityIUIGetters = Pick<HeaderVisibilityUIPlugin, GetterNames<typeof HeaderVisibilityUIPlugin>>;
|
|
4631
|
+
type HighlightGetters = Pick<HighlightPlugin, GetterNames<typeof HighlightPlugin>>;
|
|
4632
|
+
type CustomColorsGetters = Pick<CustomColorsPlugin, GetterNames<typeof CustomColorsPlugin>>;
|
|
4633
|
+
type RendererGetters = Pick<RendererPlugin, GetterNames<typeof RendererPlugin>>;
|
|
4634
|
+
type SelectionGetters = Pick<GridSelectionPlugin, GetterNames<typeof GridSelectionPlugin>>;
|
|
4635
|
+
type SelectionInputGetters = Pick<SelectionInputsManagerPlugin, GetterNames<typeof SelectionInputsManagerPlugin>>;
|
|
4636
|
+
type SelectionMultiUserGetters = Pick<SelectionMultiUserPlugin, GetterNames<typeof SelectionMultiUserPlugin>>;
|
|
4637
|
+
type SortGetters = Pick<SortPlugin, GetterNames<typeof SortPlugin>>;
|
|
4638
|
+
type UIOptionsGetters = Pick<UIOptionsPlugin, GetterNames<typeof UIOptionsPlugin>>;
|
|
4639
|
+
type SheetUIGetters = Pick<SheetUIPlugin, GetterNames<typeof SheetUIPlugin>>;
|
|
4640
|
+
type ViewportGetters = Pick<SheetViewPlugin, GetterNames<typeof SheetViewPlugin>>;
|
|
4641
|
+
type SessionGetters = {
|
|
4643
4642
|
getClient: Session["getClient"];
|
|
4644
4643
|
getConnectedClients: Session["getConnectedClients"];
|
|
4645
4644
|
isFullySynchronized: Session["isFullySynchronized"];
|
|
4646
4645
|
};
|
|
4647
|
-
|
|
4648
|
-
|
|
4649
|
-
|
|
4646
|
+
type CellPopoverPluginGetters = Pick<CellPopoverPlugin, GetterNames<typeof CellPopoverPlugin>>;
|
|
4647
|
+
type FilterEvaluationGetters = Pick<FilterEvaluationPlugin, GetterNames<typeof FilterEvaluationPlugin>>;
|
|
4648
|
+
type Getters = {
|
|
4650
4649
|
isReadonly: () => boolean;
|
|
4651
4650
|
isDashboard: () => boolean;
|
|
4652
4651
|
} & LocalHistoryGetters & CoreGetters & SessionGetters & AutofillGetters & AutomaticSumGetters & ClipboardGetters & EditionGetters & EvaluationGetters & EvaluationChartGetters & EvaluationConditionalFormatGetters & FindAndReplaceGetters & HighlightGetters & CustomColorsGetters & RendererGetters & SelectionGetters & SelectionInputGetters & SelectionMultiUserGetters & SortGetters & UIOptionsGetters & SheetUIGetters & ViewportGetters & CellPopoverPluginGetters & FilterEvaluationGetters & HeaderVisibilityIUIGetters;
|
|
@@ -4665,7 +4664,7 @@ interface WorkbookHistory<Plugin> {
|
|
|
4665
4664
|
update<T extends keyof Plugin, U extends keyof NonNullable<Plugin[T]>, K extends keyof NonNullable<NonNullable<Plugin[T]>[U]>, V extends keyof NonNullable<NonNullable<NonNullable<Plugin[T]>[U]>[K]>, W extends keyof NonNullable<NonNullable<NonNullable<NonNullable<Plugin[T]>[U]>[K]>[V]>>(key1: T, key2: U, key3: K, key4: V, key5: W, val: NonNullable<NonNullable<NonNullable<NonNullable<Plugin[T]>[U]>[K]>[V]>[W]): void;
|
|
4666
4665
|
update<T extends keyof Plugin, U extends keyof NonNullable<Plugin[T]>, K extends keyof NonNullable<NonNullable<Plugin[T]>[U]>, V extends keyof NonNullable<NonNullable<NonNullable<Plugin[T]>[U]>[K]>, W extends keyof NonNullable<NonNullable<NonNullable<NonNullable<Plugin[T]>[U]>[K]>[V]>, Y extends keyof NonNullable<NonNullable<NonNullable<NonNullable<NonNullable<Plugin[T]>[U]>[K]>[V]>[W]>>(key1: T, key2: U, key3: K, key4: V, key5: W, key6: Y, val: NonNullable<NonNullable<NonNullable<NonNullable<NonNullable<Plugin[T]>[U]>[K]>[V]>[W]>[Y]): void;
|
|
4667
4666
|
}
|
|
4668
|
-
|
|
4667
|
+
type Transformation<T = unknown> = (dataToTransform: T) => T;
|
|
4669
4668
|
interface TransformationFactory<T = unknown> {
|
|
4670
4669
|
/**
|
|
4671
4670
|
* Build a transformation function to transform any operation as if the execution of
|
|
@@ -4679,11 +4678,11 @@ interface TransformationFactory<T = unknown> {
|
|
|
4679
4678
|
with: (operation: T) => Transformation<T>;
|
|
4680
4679
|
}
|
|
4681
4680
|
|
|
4682
|
-
|
|
4683
|
-
|
|
4681
|
+
type SelectionDirection = "up" | "down" | "left" | "right";
|
|
4682
|
+
type SelectionStep = number | "end";
|
|
4684
4683
|
|
|
4685
|
-
|
|
4686
|
-
|
|
4684
|
+
type CellPopoverType = "ErrorToolTip" | "LinkDisplay" | "FilterMenu" | "LinkEditor";
|
|
4685
|
+
type SizedComponentConstructor = ComponentConstructor & {
|
|
4687
4686
|
size: {
|
|
4688
4687
|
width: number;
|
|
4689
4688
|
height: number;
|
|
@@ -4693,7 +4692,7 @@ declare type SizedComponentConstructor = ComponentConstructor & {
|
|
|
4693
4692
|
* If the cell at the given position have an associated component (linkDisplay, errorTooltip, ...),
|
|
4694
4693
|
* returns the parameters to display the component
|
|
4695
4694
|
*/
|
|
4696
|
-
|
|
4695
|
+
type CellPopoverBuilder = (position: Position$1, getters: Getters) => CellPopoverComponent<SizedComponentConstructor>;
|
|
4697
4696
|
interface PopoverBuilders {
|
|
4698
4697
|
onOpen?: CellPopoverBuilder;
|
|
4699
4698
|
onHover?: CellPopoverBuilder;
|
|
@@ -4706,14 +4705,14 @@ interface ClosedCellPopover {
|
|
|
4706
4705
|
* i.e. which component class, which props and where to
|
|
4707
4706
|
* display it relative to the cell
|
|
4708
4707
|
*/
|
|
4709
|
-
|
|
4708
|
+
type OpenCellPopover<C extends ComponentConstructor> = {
|
|
4710
4709
|
isOpen: true;
|
|
4711
4710
|
Component: C;
|
|
4712
4711
|
props: PropsOf<C>;
|
|
4713
4712
|
cellCorner: "TopRight" | "BottomLeft";
|
|
4714
4713
|
};
|
|
4715
|
-
|
|
4716
|
-
|
|
4714
|
+
type CellPopoverComponent<C extends SizedComponentConstructor = SizedComponentConstructor> = ClosedCellPopover | OpenCellPopover<C>;
|
|
4715
|
+
type PositionedCellPopover<C extends SizedComponentConstructor = SizedComponentConstructor> = {
|
|
4717
4716
|
isOpen: true;
|
|
4718
4717
|
Component: C;
|
|
4719
4718
|
props: PropsOf<C>;
|
|
@@ -4779,7 +4778,7 @@ interface CellBuilder {
|
|
|
4779
4778
|
createCell: (id: UID, content: string, properties: CellDisplayProperties, sheetId: UID, getters: CoreGetters) => Cell;
|
|
4780
4779
|
}
|
|
4781
4780
|
|
|
4782
|
-
|
|
4781
|
+
type TransformationFunction<U extends CoreCommandTypes, V extends CoreCommandTypes> = (toTransform: Extract<CoreCommand, {
|
|
4783
4782
|
type: U;
|
|
4784
4783
|
}>, executed: Extract<CoreCommand, {
|
|
4785
4784
|
type: V;
|
|
@@ -4969,7 +4968,7 @@ declare class GaugeChartConfigPanel extends Component<Props$v, SpreadsheetChildE
|
|
|
4969
4968
|
updateDataRange(): void;
|
|
4970
4969
|
}
|
|
4971
4970
|
|
|
4972
|
-
|
|
4971
|
+
type GaugeMenu = "backgroundColor" | "sectionColor-lowerColor" | "sectionColor-middleColor" | "sectionColor-upperColor";
|
|
4973
4972
|
interface Props$u {
|
|
4974
4973
|
figureId: UID;
|
|
4975
4974
|
definition: GaugeChartDefinition;
|
|
@@ -5030,7 +5029,7 @@ declare class ScorecardChartConfigPanel extends Component<Props$t, SpreadsheetCh
|
|
|
5030
5029
|
updateBaselineMode(ev: any): void;
|
|
5031
5030
|
}
|
|
5032
5031
|
|
|
5033
|
-
|
|
5032
|
+
type ColorPickerId = undefined | "backgroundColor" | "baselineColorUp" | "baselineColorDown";
|
|
5034
5033
|
interface Props$s {
|
|
5035
5034
|
figureId: UID;
|
|
5036
5035
|
definition: ScorecardChartDefinition;
|
|
@@ -5105,9 +5104,9 @@ interface MenuItem {
|
|
|
5105
5104
|
icon?: string;
|
|
5106
5105
|
textColor?: Color;
|
|
5107
5106
|
}
|
|
5108
|
-
|
|
5109
|
-
|
|
5110
|
-
|
|
5107
|
+
type FullMenuItem = Required<MenuItem>;
|
|
5108
|
+
type MenuItemsBuilder = (env: SpreadsheetChildEnv) => FullMenuItem[];
|
|
5109
|
+
type menuChildren = (FullMenuItem | MenuItemsBuilder)[];
|
|
5111
5110
|
declare function createFullMenuItem(key: string, value: MenuItem): FullMenuItem;
|
|
5112
5111
|
/**
|
|
5113
5112
|
* The class Registry is extended in order to add the function addChild
|
|
@@ -5481,7 +5480,7 @@ declare class FunctionDescriptionProvider extends Component<Props$k> {
|
|
|
5481
5480
|
onMouseMove(): void;
|
|
5482
5481
|
}
|
|
5483
5482
|
|
|
5484
|
-
|
|
5483
|
+
type HtmlContent = {
|
|
5485
5484
|
value: string;
|
|
5486
5485
|
color?: Color;
|
|
5487
5486
|
class?: string;
|
|
@@ -5621,7 +5620,7 @@ declare class FilterIconsOverlay extends Component<Props$g, SpreadsheetChildEnv>
|
|
|
5621
5620
|
private isPositionVisible;
|
|
5622
5621
|
}
|
|
5623
5622
|
|
|
5624
|
-
|
|
5623
|
+
type ResizeAnchor = "top left" | "top" | "top right" | "right" | "bottom right" | "bottom" | "bottom left" | "left";
|
|
5625
5624
|
interface Props$f {
|
|
5626
5625
|
figure: Figure;
|
|
5627
5626
|
style: string;
|
|
@@ -5650,7 +5649,7 @@ declare class FigureComponent extends Component<Props$f, SpreadsheetChildEnv> {
|
|
|
5650
5649
|
onKeyDown(ev: KeyboardEvent): void;
|
|
5651
5650
|
}
|
|
5652
5651
|
|
|
5653
|
-
|
|
5652
|
+
type ContainerType = "topLeft" | "topRight" | "bottomLeft" | "bottomRight" | "dnd";
|
|
5654
5653
|
interface DndState {
|
|
5655
5654
|
figId: string | undefined;
|
|
5656
5655
|
x: Pixel;
|
|
@@ -5911,7 +5910,7 @@ declare class HeadersOverlay extends Component<any, SpreadsheetChildEnv> {
|
|
|
5911
5910
|
selectAll(): void;
|
|
5912
5911
|
}
|
|
5913
5912
|
|
|
5914
|
-
|
|
5913
|
+
type Orientation$1 = "n" | "s" | "w" | "e";
|
|
5915
5914
|
interface Props$b {
|
|
5916
5915
|
zone: Zone;
|
|
5917
5916
|
orientation: Orientation$1;
|
|
@@ -5924,7 +5923,7 @@ declare class Border extends Component<Props$b, SpreadsheetChildEnv> {
|
|
|
5924
5923
|
onMouseDown(ev: MouseEvent): void;
|
|
5925
5924
|
}
|
|
5926
5925
|
|
|
5927
|
-
|
|
5926
|
+
type Orientation = "nw" | "ne" | "sw" | "se";
|
|
5928
5927
|
interface Props$a {
|
|
5929
5928
|
zone: Zone;
|
|
5930
5929
|
color: Color;
|
|
@@ -5958,7 +5957,7 @@ declare class Highlight extends Component<Props$9, SpreadsheetChildEnv> {
|
|
|
5958
5957
|
onMoveHighlight(clientX: Pixel, clientY: Pixel): void;
|
|
5959
5958
|
}
|
|
5960
5959
|
|
|
5961
|
-
|
|
5960
|
+
type ScrollDirection = "horizontal" | "vertical";
|
|
5962
5961
|
|
|
5963
5962
|
interface Props$8 {
|
|
5964
5963
|
width: Pixel;
|
|
@@ -6046,7 +6045,7 @@ declare class VerticalScrollBar extends Component<Props$6, SpreadsheetChildEnv>
|
|
|
6046
6045
|
* - a horizontal resizer (to resize columns)
|
|
6047
6046
|
* - a vertical resizer (same, for rows)
|
|
6048
6047
|
*/
|
|
6049
|
-
|
|
6048
|
+
type ContextMenuType = "ROW" | "COL" | "CELL" | "FILTER";
|
|
6050
6049
|
interface Props$5 {
|
|
6051
6050
|
sidePanelIsOpen: boolean;
|
|
6052
6051
|
exposeFocus: (focus: () => void) => void;
|
|
@@ -6300,7 +6299,7 @@ interface FontSize {
|
|
|
6300
6299
|
px: number;
|
|
6301
6300
|
}
|
|
6302
6301
|
|
|
6303
|
-
|
|
6302
|
+
type Tool = "" | "formatTool" | "alignTool" | "textColorTool" | "fillColorTool" | "borderTool" | "fontSizeTool";
|
|
6304
6303
|
interface State {
|
|
6305
6304
|
menuState: MenuState;
|
|
6306
6305
|
activeTool: Tool;
|
|
@@ -6381,7 +6380,7 @@ declare class TopBar extends Component<Props, SpreadsheetChildEnv> {
|
|
|
6381
6380
|
removeFilter(): void;
|
|
6382
6381
|
}
|
|
6383
6382
|
|
|
6384
|
-
|
|
6383
|
+
type ComposerFocusType = "inactive" | "cellFocus" | "contentFocus";
|
|
6385
6384
|
interface SpreadsheetProps {
|
|
6386
6385
|
model: Model;
|
|
6387
6386
|
exposeSpreadsheet?: (spreadsheet: Spreadsheet) => void;
|