@odoo/o-spreadsheet 16.2.9 → 16.2.11
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 +76 -56
- package/dist/o-spreadsheet.d.ts +167 -166
- package/dist/o-spreadsheet.esm.js +76 -56
- package/dist/o-spreadsheet.iife.js +76 -56
- package/dist/o-spreadsheet.iife.min.js +305 -299
- package/package.json +4 -4
package/dist/o-spreadsheet.d.ts
CHANGED
|
@@ -40,7 +40,7 @@ interface EnrichedToken extends Token {
|
|
|
40
40
|
functionContext?: FunctionContext;
|
|
41
41
|
}
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
type TokenType = "OPERATOR" | "NUMBER" | "STRING" | "BOOLEAN" | "FUNCTION" | "SYMBOL" | "SPACE" | "DEBUGGER" | "COMMA" | "LEFT_PAREN" | "RIGHT_PAREN" | "REFERENCE" | "INVALID_REFERENCE" | "UNKNOWN";
|
|
44
44
|
interface Token {
|
|
45
45
|
type: TokenType;
|
|
46
46
|
value: string;
|
|
@@ -87,7 +87,7 @@ interface ASTEmpty extends ASTBase {
|
|
|
87
87
|
type: "EMPTY";
|
|
88
88
|
value: "";
|
|
89
89
|
}
|
|
90
|
-
|
|
90
|
+
type AST = ASTOperation | ASTUnaryOperation | ASTFuncall | ASTNumber | ASTBoolean | ASTString | ASTReference | ASTEmpty;
|
|
91
91
|
/**
|
|
92
92
|
* Parse an expression (as a string) into an AST.
|
|
93
93
|
*/
|
|
@@ -154,7 +154,7 @@ declare class EventBus<Event extends {
|
|
|
154
154
|
*/
|
|
155
155
|
clear(): void;
|
|
156
156
|
}
|
|
157
|
-
|
|
157
|
+
type Callback = (...args: any[]) => void;
|
|
158
158
|
interface Subscription {
|
|
159
159
|
owner: any;
|
|
160
160
|
callback: Callback;
|
|
@@ -314,7 +314,7 @@ interface HeadersSelected extends SelectionEventPayload {
|
|
|
314
314
|
interface AlterZone extends SelectionEventPayload {
|
|
315
315
|
type: "AlterZone";
|
|
316
316
|
}
|
|
317
|
-
|
|
317
|
+
type SelectionEvent = Readonly<ZonesSelected | HeadersSelected | AlterZone>;
|
|
318
318
|
|
|
319
319
|
interface StreamCallbacks<Event> {
|
|
320
320
|
handleEvent: (event: Event) => void;
|
|
@@ -323,7 +323,7 @@ interface StreamCallbacks<Event> {
|
|
|
323
323
|
release?: () => void;
|
|
324
324
|
}
|
|
325
325
|
|
|
326
|
-
|
|
326
|
+
type StatefulStream<Event, State> = {
|
|
327
327
|
capture(owner: unknown, state: State, callbacks: StreamCallbacks<Event>): void;
|
|
328
328
|
registerAsDefault: (owner: unknown, state: State, callbacks: StreamCallbacks<Event>) => void;
|
|
329
329
|
resetDefaultAnchor: (owner: unknown, state: State) => void;
|
|
@@ -348,9 +348,9 @@ interface SelectionProcessor {
|
|
|
348
348
|
loopSelection(): DispatchResult;
|
|
349
349
|
selectTableAroundSelection(): DispatchResult;
|
|
350
350
|
}
|
|
351
|
-
|
|
351
|
+
type SelectionStreamProcessor = SelectionProcessor & StatefulStream<SelectionEvent, AnchorZone>;
|
|
352
352
|
|
|
353
|
-
|
|
353
|
+
type XLSXExportFile = XLSXExportImageFile | XLSXExportXMLFile;
|
|
354
354
|
interface XLSXExportXMLFile {
|
|
355
355
|
path: string;
|
|
356
356
|
content: string;
|
|
@@ -369,10 +369,10 @@ interface XLSXExport {
|
|
|
369
369
|
* Note that the alpha channel goes first! AARRGGBB
|
|
370
370
|
* e.g. "1E5010" or "331E5010"
|
|
371
371
|
*/
|
|
372
|
-
|
|
372
|
+
type XlsxHexColor = string & Alias;
|
|
373
373
|
|
|
374
|
-
|
|
375
|
-
|
|
374
|
+
type VerticalAxisPosition = "left" | "right";
|
|
375
|
+
type LegendPosition = "top" | "bottom" | "left" | "right" | "none";
|
|
376
376
|
|
|
377
377
|
interface BarChartDefinition {
|
|
378
378
|
readonly type: "bar";
|
|
@@ -386,7 +386,7 @@ interface BarChartDefinition {
|
|
|
386
386
|
readonly stacked: boolean;
|
|
387
387
|
readonly aggregated?: boolean;
|
|
388
388
|
}
|
|
389
|
-
|
|
389
|
+
type BarChartRuntime = {
|
|
390
390
|
chartJsConfig: ChartConfiguration;
|
|
391
391
|
background: Color;
|
|
392
392
|
};
|
|
@@ -467,7 +467,7 @@ interface LineChartDefinition {
|
|
|
467
467
|
readonly stacked: boolean;
|
|
468
468
|
readonly aggregated?: boolean;
|
|
469
469
|
}
|
|
470
|
-
|
|
470
|
+
type LineChartRuntime = {
|
|
471
471
|
chartJsConfig: ChartConfiguration;
|
|
472
472
|
background: Color;
|
|
473
473
|
};
|
|
@@ -482,7 +482,7 @@ interface PieChartDefinition {
|
|
|
482
482
|
readonly legendPosition: LegendPosition;
|
|
483
483
|
readonly aggregated?: boolean;
|
|
484
484
|
}
|
|
485
|
-
|
|
485
|
+
type PieChartRuntime = {
|
|
486
486
|
chartJsConfig: ChartConfiguration;
|
|
487
487
|
background: Color;
|
|
488
488
|
};
|
|
@@ -498,8 +498,8 @@ interface ScorecardChartDefinition {
|
|
|
498
498
|
readonly baselineColorUp: Color;
|
|
499
499
|
readonly baselineColorDown: Color;
|
|
500
500
|
}
|
|
501
|
-
|
|
502
|
-
|
|
501
|
+
type BaselineMode = "text" | "difference" | "percentage";
|
|
502
|
+
type BaselineArrowDirection = "neutral" | "up" | "down";
|
|
503
503
|
interface ScorecardChartRuntime {
|
|
504
504
|
readonly title: string;
|
|
505
505
|
readonly keyValue: string;
|
|
@@ -513,15 +513,15 @@ interface ScorecardChartRuntime {
|
|
|
513
513
|
readonly baselineStyle?: Style;
|
|
514
514
|
}
|
|
515
515
|
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
516
|
+
type ChartType = "line" | "bar" | "pie" | "scorecard" | "gauge";
|
|
517
|
+
type ChartDefinition = LineChartDefinition | PieChartDefinition | BarChartDefinition | ScorecardChartDefinition | GaugeChartDefinition;
|
|
518
|
+
type ChartJSRuntime = LineChartRuntime | PieChartRuntime | BarChartRuntime | GaugeChartRuntime;
|
|
519
|
+
type ChartRuntime = ChartJSRuntime | ScorecardChartRuntime;
|
|
520
520
|
interface ExcelChartDataset {
|
|
521
521
|
readonly label?: string;
|
|
522
522
|
readonly range: string;
|
|
523
523
|
}
|
|
524
|
-
|
|
524
|
+
type ExcelChartType = "line" | "bar" | "pie";
|
|
525
525
|
interface ExcelChartDefinition {
|
|
526
526
|
readonly title?: string;
|
|
527
527
|
readonly type: ExcelChartType;
|
|
@@ -572,8 +572,8 @@ interface ConditionalFormat {
|
|
|
572
572
|
interface ConditionalFormatInternal extends Omit<ConditionalFormat, "ranges"> {
|
|
573
573
|
ranges: Range[];
|
|
574
574
|
}
|
|
575
|
-
|
|
576
|
-
|
|
575
|
+
type ConditionalFormatRule = SingleColorRules | ColorScaleRule | IconSetRule;
|
|
576
|
+
type SingleColorRules = CellIsRule;
|
|
577
577
|
interface SingleColorRule {
|
|
578
578
|
style: Style;
|
|
579
579
|
}
|
|
@@ -582,18 +582,18 @@ interface CellIsRule extends SingleColorRule {
|
|
|
582
582
|
operator: ConditionalFormattingOperatorValues;
|
|
583
583
|
values: string[];
|
|
584
584
|
}
|
|
585
|
-
|
|
586
|
-
|
|
585
|
+
type ThresholdType = "value" | "number" | "percentage" | "percentile" | "formula";
|
|
586
|
+
type ColorScaleThreshold = {
|
|
587
587
|
color: number;
|
|
588
588
|
type: ThresholdType;
|
|
589
589
|
value?: string;
|
|
590
590
|
};
|
|
591
|
-
|
|
591
|
+
type ColorScaleMidPointThreshold = {
|
|
592
592
|
color: number;
|
|
593
593
|
type: Exclude<ThresholdType, "value">;
|
|
594
594
|
value: string;
|
|
595
595
|
};
|
|
596
|
-
|
|
596
|
+
type IconThreshold = {
|
|
597
597
|
type: Exclude<ThresholdType, "value">;
|
|
598
598
|
operator: "gt" | "ge";
|
|
599
599
|
value: string;
|
|
@@ -615,8 +615,8 @@ interface IconSetRule {
|
|
|
615
615
|
upperInflectionPoint: IconThreshold;
|
|
616
616
|
lowerInflectionPoint: IconThreshold;
|
|
617
617
|
}
|
|
618
|
-
|
|
619
|
-
|
|
618
|
+
type ConditionalFormattingOperatorValues = "BeginsWith" | "Between" | "ContainsText" | "IsEmpty" | "IsNotEmpty" | "EndsWith" | "Equal" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual" | "NotBetween" | "NotContains" | "NotEqual";
|
|
619
|
+
type UpDown = "up" | "down";
|
|
620
620
|
|
|
621
621
|
interface Figure {
|
|
622
622
|
id: UID;
|
|
@@ -630,7 +630,7 @@ interface FigureSize {
|
|
|
630
630
|
width: Pixel;
|
|
631
631
|
height: Pixel;
|
|
632
632
|
}
|
|
633
|
-
|
|
633
|
+
type ResizeDirection = -1 | 0 | 1;
|
|
634
634
|
|
|
635
635
|
interface Image {
|
|
636
636
|
path: string;
|
|
@@ -724,10 +724,11 @@ interface ExcelFilterTableData {
|
|
|
724
724
|
}
|
|
725
725
|
interface ExcelFilterData {
|
|
726
726
|
colId: number;
|
|
727
|
-
|
|
727
|
+
displayedValues: string[];
|
|
728
|
+
displayBlanks?: boolean;
|
|
728
729
|
}
|
|
729
730
|
|
|
730
|
-
|
|
731
|
+
type ClientId = string;
|
|
731
732
|
interface Client {
|
|
732
733
|
id: ClientId;
|
|
733
734
|
name: string;
|
|
@@ -773,7 +774,7 @@ interface RevisionsDroppedEvent {
|
|
|
773
774
|
interface SnapshotEvent {
|
|
774
775
|
type: "snapshot";
|
|
775
776
|
}
|
|
776
|
-
|
|
777
|
+
type CollaborativeEvent = NewLocalStateUpdateEvent | UnexpectedRevisionIdEvent | RemoteRevisionReceivedEvent | RevisionAcknowledgedEvent | RevisionUndone | RevisionRedone | RevisionsDroppedEvent | SnapshotEvent | CollaborativeEventReceived;
|
|
777
778
|
|
|
778
779
|
interface AbstractMessage {
|
|
779
780
|
version: number;
|
|
@@ -827,11 +828,11 @@ interface SnapshotCreatedMessage extends AbstractMessage {
|
|
|
827
828
|
serverRevisionId: UID;
|
|
828
829
|
nextRevisionId: UID;
|
|
829
830
|
}
|
|
830
|
-
|
|
831
|
-
|
|
831
|
+
type CollaborationMessage = RevisionUndoneMessage | RevisionRedoneMessage | RemoteRevisionMessage | SnapshotMessage | SnapshotCreatedMessage | ClientMovedMessage | ClientJoinedMessage | ClientLeftMessage;
|
|
832
|
+
type StateUpdateMessage = Extract<CollaborationMessage, {
|
|
832
833
|
nextRevisionId: UID;
|
|
833
834
|
}>;
|
|
834
|
-
|
|
835
|
+
type NewMessageCallback<T = any> = (message: T) => void;
|
|
835
836
|
/**
|
|
836
837
|
* The transport service allows to communicate between multiple clients.
|
|
837
838
|
* A client can send any message to others.
|
|
@@ -861,7 +862,7 @@ interface TransportService<T = any> {
|
|
|
861
862
|
leave: (id: UID) => void;
|
|
862
863
|
}
|
|
863
864
|
|
|
864
|
-
|
|
865
|
+
type FilePath = string;
|
|
865
866
|
/**
|
|
866
867
|
* FileStore manage the transfer of file with the server.
|
|
867
868
|
*/
|
|
@@ -914,7 +915,7 @@ interface NotifyUIEvent {
|
|
|
914
915
|
* Note that the Model can be used in a standalone way to manipulate
|
|
915
916
|
* programmatically a spreadsheet.
|
|
916
917
|
*/
|
|
917
|
-
|
|
918
|
+
type Mode = "normal" | "readonly" | "dashboard";
|
|
918
919
|
interface ModelConfig {
|
|
919
920
|
readonly mode: Mode;
|
|
920
921
|
/**
|
|
@@ -1155,7 +1156,7 @@ declare class BasePlugin<State = any, C = any> implements CommandHandler<C>, Val
|
|
|
1155
1156
|
checkValidations<T>(command: T, ...validations: Validation<T>[]): CommandResult | CommandResult[];
|
|
1156
1157
|
}
|
|
1157
1158
|
|
|
1158
|
-
|
|
1159
|
+
type UIActions = Pick<ModelConfig, "notifyUI">;
|
|
1159
1160
|
interface UIPluginConfig {
|
|
1160
1161
|
readonly getters: Getters;
|
|
1161
1162
|
readonly stateObserver: StateObserver;
|
|
@@ -1211,7 +1212,9 @@ declare class FindAndReplacePlugin extends UIPlugin {
|
|
|
1211
1212
|
private currentSearchRegex;
|
|
1212
1213
|
private searchOptions;
|
|
1213
1214
|
private toSearch;
|
|
1215
|
+
private isSearchDirty;
|
|
1214
1216
|
handle(cmd: Command): void;
|
|
1217
|
+
finalize(): void;
|
|
1215
1218
|
getSearchMatches(): SearchMatch[];
|
|
1216
1219
|
getCurrentSelectedMatchIndex(): number | null;
|
|
1217
1220
|
/**
|
|
@@ -1255,7 +1258,7 @@ declare class FindAndReplacePlugin extends UIPlugin {
|
|
|
1255
1258
|
drawGrid(renderingContext: GridRenderingContext): void;
|
|
1256
1259
|
}
|
|
1257
1260
|
|
|
1258
|
-
|
|
1261
|
+
type EditionMode = "editing" | "selecting" | "inactive";
|
|
1259
1262
|
interface ComposerSelection {
|
|
1260
1263
|
start: number;
|
|
1261
1264
|
end: number;
|
|
@@ -1369,12 +1372,12 @@ interface DOMDimension {
|
|
|
1369
1372
|
width: Pixel;
|
|
1370
1373
|
height: Pixel;
|
|
1371
1374
|
}
|
|
1372
|
-
|
|
1375
|
+
type Rect = DOMCoordinates & DOMDimension;
|
|
1373
1376
|
/**
|
|
1374
1377
|
* The viewport is the visible area of a sheet.
|
|
1375
1378
|
* Column and row headers are not included in the viewport.
|
|
1376
1379
|
*/
|
|
1377
|
-
|
|
1380
|
+
type Viewport = Zone & Alias;
|
|
1378
1381
|
interface SheetScrollInfo {
|
|
1379
1382
|
/**
|
|
1380
1383
|
* The offset in the X coordinate between the viewport left side and
|
|
@@ -1419,16 +1422,16 @@ interface EdgeScrollInfo {
|
|
|
1419
1422
|
direction: ScrollDirection$1;
|
|
1420
1423
|
delay: number;
|
|
1421
1424
|
}
|
|
1422
|
-
|
|
1425
|
+
type ScrollDirection$1 = 1 | 0 | -1 | "reset";
|
|
1423
1426
|
|
|
1424
1427
|
declare enum ClipboardMIMEType {
|
|
1425
1428
|
PlainText = "text/plain",
|
|
1426
1429
|
Html = "text/html"
|
|
1427
1430
|
}
|
|
1428
|
-
|
|
1431
|
+
type ClipboardContent = {
|
|
1429
1432
|
[type in ClipboardMIMEType]?: string;
|
|
1430
1433
|
};
|
|
1431
|
-
|
|
1434
|
+
type ClipboardPasteOptions = "onlyFormat" | "onlyValue";
|
|
1432
1435
|
|
|
1433
1436
|
/**
|
|
1434
1437
|
* There are two kinds of commands: CoreCommands and LocalCommands
|
|
@@ -1470,8 +1473,8 @@ interface PositionDependentCommand {
|
|
|
1470
1473
|
col: number;
|
|
1471
1474
|
row: number;
|
|
1472
1475
|
}
|
|
1473
|
-
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_IMAGE" | "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" | "CLEAN_CLIPBOARD_HIGHLIGHT" | "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" | "
|
|
1474
|
-
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_IMAGE" | "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" | "CLEAN_CLIPBOARD_HIGHLIGHT" | "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" | "
|
|
1476
|
+
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_IMAGE" | "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" | "CLEAN_CLIPBOARD_HIGHLIGHT" | "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">;
|
|
1477
|
+
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_IMAGE" | "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" | "CLEAN_CLIPBOARD_HIGHLIGHT" | "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">;
|
|
1475
1478
|
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_IMAGE" | "CREATE_FILTER_TABLE" | "REMOVE_FILTER_TABLE">;
|
|
1476
1479
|
interface UpdateCellCommand extends PositionDependentCommand {
|
|
1477
1480
|
type: "UPDATE_CELL";
|
|
@@ -1916,9 +1919,6 @@ interface UpdateSearchCommand {
|
|
|
1916
1919
|
interface ClearSearchCommand {
|
|
1917
1920
|
type: "CLEAR_SEARCH";
|
|
1918
1921
|
}
|
|
1919
|
-
interface RefreshSearchCommand {
|
|
1920
|
-
type: "REFRESH_SEARCH";
|
|
1921
|
-
}
|
|
1922
1922
|
interface SelectSearchPreviousCommand {
|
|
1923
1923
|
type: "SELECT_SEARCH_PREVIOUS_MATCH";
|
|
1924
1924
|
}
|
|
@@ -1942,7 +1942,7 @@ interface SortCommand {
|
|
|
1942
1942
|
sortDirection: SortDirection;
|
|
1943
1943
|
sortOptions?: SortOptions;
|
|
1944
1944
|
}
|
|
1945
|
-
|
|
1945
|
+
type SortDirection = "ascending" | "descending";
|
|
1946
1946
|
interface ResizeViewportCommand {
|
|
1947
1947
|
type: "RESIZE_SHEETVIEW";
|
|
1948
1948
|
width: Pixel;
|
|
@@ -2005,7 +2005,7 @@ interface OpenCellPopoverCommand {
|
|
|
2005
2005
|
interface CloseCellPopoverCommand {
|
|
2006
2006
|
type: "CLOSE_CELL_POPOVER";
|
|
2007
2007
|
}
|
|
2008
|
-
|
|
2008
|
+
type CoreCommand =
|
|
2009
2009
|
/** CELLS */
|
|
2010
2010
|
UpdateCellCommand | UpdateCellPositionCommand | ClearCellCommand | DeleteContentCommand
|
|
2011
2011
|
/** GRID SHAPE */
|
|
@@ -2028,8 +2028,8 @@ UpdateCellCommand | UpdateCellPositionCommand | ClearCellCommand | DeleteContent
|
|
|
2028
2028
|
| CreateImageOverCommand
|
|
2029
2029
|
/** FILTERS */
|
|
2030
2030
|
| CreateFilterTableCommand | RemoveFilterTableCommand;
|
|
2031
|
-
|
|
2032
|
-
|
|
2031
|
+
type LocalCommand = RequestUndoCommand | RequestRedoCommand | UndoCommand | RedoCommand | NewInputCommand | RemoveInputCommand | UnfocusInputCommand | FocusInputCommand | AddEmptyRangeCommand | RemoveRangeCommand | ChangeRangeCommand | CopyCommand | CutCommand | PasteCommand | CleanClipBoardHighlightCommand | 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;
|
|
2032
|
+
type Command = CoreCommand | LocalCommand;
|
|
2033
2033
|
/**
|
|
2034
2034
|
* Holds the result of a command dispatch.
|
|
2035
2035
|
* The command may have been successfully dispatched or cancelled
|
|
@@ -2049,7 +2049,7 @@ declare class DispatchResult {
|
|
|
2049
2049
|
*/
|
|
2050
2050
|
isCancelledBecause(reason: CancelledReason): boolean;
|
|
2051
2051
|
}
|
|
2052
|
-
|
|
2052
|
+
type CancelledReason = Exclude<CommandResult, CommandResult.Success>;
|
|
2053
2053
|
declare const enum CommandResult {
|
|
2054
2054
|
Success = 0,
|
|
2055
2055
|
CancelledForUnknownReason = 1,
|
|
@@ -2162,26 +2162,26 @@ interface CoreCommandDispatcher {
|
|
|
2162
2162
|
type: T;
|
|
2163
2163
|
}>>(type: T, r: Omit<C, "type">): DispatchResult;
|
|
2164
2164
|
}
|
|
2165
|
-
|
|
2166
|
-
|
|
2165
|
+
type CommandTypes = Command["type"];
|
|
2166
|
+
type CoreCommandTypes = CoreCommand["type"];
|
|
2167
2167
|
|
|
2168
2168
|
/**
|
|
2169
2169
|
* The following type is meant to be used in union with other aliases to prevent
|
|
2170
2170
|
* Intellisense from resolving it.
|
|
2171
2171
|
* See https://github.com/microsoft/TypeScript/issues/31940#issuecomment-841712377
|
|
2172
2172
|
*/
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
|
|
2179
|
-
|
|
2173
|
+
type Alias = {} & {};
|
|
2174
|
+
type HeaderIndex = number & Alias;
|
|
2175
|
+
type Pixel = number & Alias;
|
|
2176
|
+
type UID = string & Alias;
|
|
2177
|
+
type SetDecimalStep = 1 | -1;
|
|
2178
|
+
type FilterId = UID & Alias;
|
|
2179
|
+
type FilterTableId = UID & Alias;
|
|
2180
2180
|
/**
|
|
2181
2181
|
* CSS style color string
|
|
2182
2182
|
* e.g. "#ABC", "#AAAFFF", "rgb(30, 80, 16)"
|
|
2183
2183
|
*/
|
|
2184
|
-
|
|
2184
|
+
type Color = string & Alias;
|
|
2185
2185
|
interface RGBA {
|
|
2186
2186
|
a: number;
|
|
2187
2187
|
r: number;
|
|
@@ -2223,9 +2223,9 @@ interface ZoneDimension {
|
|
|
2223
2223
|
numberOfRows: HeaderIndex;
|
|
2224
2224
|
numberOfCols: HeaderIndex;
|
|
2225
2225
|
}
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
|
|
2226
|
+
type Align = "left" | "right" | "center" | undefined;
|
|
2227
|
+
type VerticalAlign = "top" | "middle" | "bottom" | undefined;
|
|
2228
|
+
type Wrapping = "overflow" | "wrap" | "clip" | undefined;
|
|
2229
2229
|
interface Style {
|
|
2230
2230
|
bold?: boolean;
|
|
2231
2231
|
italic?: boolean;
|
|
@@ -2258,35 +2258,35 @@ interface CellPosition {
|
|
|
2258
2258
|
row: HeaderIndex;
|
|
2259
2259
|
sheetId: UID;
|
|
2260
2260
|
}
|
|
2261
|
-
|
|
2262
|
-
|
|
2261
|
+
type BorderStyle = "thin" | "medium" | "thick" | "dashed" | "dotted" | "double";
|
|
2262
|
+
type BorderDescr = [BorderStyle, Color];
|
|
2263
2263
|
interface Border$1 {
|
|
2264
2264
|
top?: BorderDescr;
|
|
2265
2265
|
left?: BorderDescr;
|
|
2266
2266
|
bottom?: BorderDescr;
|
|
2267
2267
|
right?: BorderDescr;
|
|
2268
2268
|
}
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2269
|
+
type ReferenceDenormalizer = (range: Range, isMeta: boolean, functionName: string, paramNumber: number) => any | any[][];
|
|
2270
|
+
type EnsureRange = (range: Range) => any[][];
|
|
2271
|
+
type _CompiledFormula = (deps: Range[], refFn: ReferenceDenormalizer, range: EnsureRange, ctx: {}) => FormulaReturn;
|
|
2272
2272
|
interface CompiledFormula {
|
|
2273
2273
|
execute: _CompiledFormula;
|
|
2274
2274
|
tokens: Token[];
|
|
2275
2275
|
dependencies: string[];
|
|
2276
2276
|
}
|
|
2277
|
-
|
|
2278
|
-
|
|
2277
|
+
type Arg = MatrixArg | PrimitiveArg;
|
|
2278
|
+
type MatrixArg = ({
|
|
2279
2279
|
value: CellValue;
|
|
2280
2280
|
format?: Format;
|
|
2281
2281
|
} | undefined)[][];
|
|
2282
|
-
|
|
2282
|
+
type PrimitiveArg = {
|
|
2283
2283
|
value: PrimitiveArgValue;
|
|
2284
2284
|
format?: Format;
|
|
2285
2285
|
};
|
|
2286
|
-
|
|
2287
|
-
|
|
2288
|
-
|
|
2289
|
-
|
|
2286
|
+
type ArgValue = PrimitiveArgValue | MatrixArgValue;
|
|
2287
|
+
type MatrixArgValue = (CellValue | undefined)[][];
|
|
2288
|
+
type PrimitiveArgValue = string | number | boolean | null;
|
|
2289
|
+
type FunctionReturn = {
|
|
2290
2290
|
value: FunctionReturnValue;
|
|
2291
2291
|
format?: Format;
|
|
2292
2292
|
};
|
|
@@ -2294,7 +2294,7 @@ interface FormulaReturn extends Omit<FunctionReturn, "value"> {
|
|
|
2294
2294
|
value: FunctionReturnValue | null;
|
|
2295
2295
|
format?: Format;
|
|
2296
2296
|
}
|
|
2297
|
-
|
|
2297
|
+
type FunctionReturnValue = string | number | boolean;
|
|
2298
2298
|
interface HeaderDimensions {
|
|
2299
2299
|
start: Pixel;
|
|
2300
2300
|
size: Pixel;
|
|
@@ -2322,8 +2322,8 @@ interface PaneDivision {
|
|
|
2322
2322
|
/** Represents the number of frozen rows */
|
|
2323
2323
|
ySplit: number;
|
|
2324
2324
|
}
|
|
2325
|
-
|
|
2326
|
-
|
|
2325
|
+
type BorderCommand = "all" | "hv" | "h" | "v" | "external" | "left" | "top" | "right" | "bottom" | "clear";
|
|
2326
|
+
type BorderDescription = {
|
|
2327
2327
|
vertical?: BorderDescr;
|
|
2328
2328
|
horizontal?: BorderDescr;
|
|
2329
2329
|
} | undefined;
|
|
@@ -2333,24 +2333,24 @@ declare const enum DIRECTION {
|
|
|
2333
2333
|
LEFT = "left",
|
|
2334
2334
|
RIGHT = "right"
|
|
2335
2335
|
}
|
|
2336
|
-
|
|
2337
|
-
|
|
2336
|
+
type ChangeType = "REMOVE" | "RESIZE" | "MOVE" | "CHANGE" | "NONE";
|
|
2337
|
+
type ApplyRangeChangeResult = {
|
|
2338
2338
|
changeType: Exclude<ChangeType, "NONE">;
|
|
2339
2339
|
range: Range;
|
|
2340
2340
|
} | {
|
|
2341
2341
|
changeType: "NONE";
|
|
2342
2342
|
};
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
|
|
2343
|
+
type ApplyRangeChange = (range: Range) => ApplyRangeChangeResult;
|
|
2344
|
+
type Dimension = "COL" | "ROW";
|
|
2345
|
+
type ConsecutiveIndexes = HeaderIndex[];
|
|
2346
2346
|
interface RangeProvider {
|
|
2347
2347
|
adaptRanges: (applyChange: ApplyRangeChange, sheetId?: UID) => void;
|
|
2348
2348
|
}
|
|
2349
|
-
|
|
2349
|
+
type Validation<T> = (toValidate: T) => CommandResult | CommandResult[];
|
|
2350
2350
|
/**
|
|
2351
2351
|
* Return the prop's type of a component
|
|
2352
2352
|
*/
|
|
2353
|
-
|
|
2353
|
+
type PropsOf<C> = C extends ComponentConstructor<infer Props> ? Props : never;
|
|
2354
2354
|
/**
|
|
2355
2355
|
* Container for a lazy computed value
|
|
2356
2356
|
*/
|
|
@@ -2376,7 +2376,7 @@ interface Lazy<T> {
|
|
|
2376
2376
|
interface Cloneable<T> {
|
|
2377
2377
|
clone: (args?: Partial<T>) => T;
|
|
2378
2378
|
}
|
|
2379
|
-
|
|
2379
|
+
type CSSProperties<P extends string = string> = Record<P, string | undefined>;
|
|
2380
2380
|
interface SortOptions {
|
|
2381
2381
|
/** If true sort the headers of the range along with the rest */
|
|
2382
2382
|
sortHeaders?: boolean;
|
|
@@ -2387,8 +2387,8 @@ interface MenuMouseEvent extends MouseEvent {
|
|
|
2387
2387
|
closedMenuId?: UID;
|
|
2388
2388
|
}
|
|
2389
2389
|
|
|
2390
|
-
|
|
2391
|
-
|
|
2390
|
+
type Format = string & Alias;
|
|
2391
|
+
type FormattedValue = string & Alias;
|
|
2392
2392
|
|
|
2393
2393
|
interface CellAttributes {
|
|
2394
2394
|
readonly id: UID;
|
|
@@ -2407,7 +2407,7 @@ interface FormulaCell extends CellAttributes {
|
|
|
2407
2407
|
readonly compiledFormula: CompiledFormula;
|
|
2408
2408
|
readonly dependencies: Range[];
|
|
2409
2409
|
}
|
|
2410
|
-
|
|
2410
|
+
type Cell = LiteralCell | FormulaCell;
|
|
2411
2411
|
interface EvaluatedCellProperties {
|
|
2412
2412
|
readonly format?: Format;
|
|
2413
2413
|
/**
|
|
@@ -2421,8 +2421,8 @@ interface EvaluatedCellProperties {
|
|
|
2421
2421
|
readonly isAutoSummable: boolean;
|
|
2422
2422
|
readonly link?: Link;
|
|
2423
2423
|
}
|
|
2424
|
-
|
|
2425
|
-
|
|
2424
|
+
type CellValue = string | number | boolean;
|
|
2425
|
+
type EvaluatedCell = NumberCell | TextCell | BooleanCell | EmptyCell | ErrorCell;
|
|
2426
2426
|
interface NumberCell extends EvaluatedCellProperties {
|
|
2427
2427
|
readonly type: CellValueType.number;
|
|
2428
2428
|
readonly value: number;
|
|
@@ -2482,7 +2482,7 @@ interface FormulaModifier {
|
|
|
2482
2482
|
increment: number;
|
|
2483
2483
|
current: number;
|
|
2484
2484
|
}
|
|
2485
|
-
|
|
2485
|
+
type AutofillModifier = IncrementModifier | AlphanumericIncrementModifier | CopyModifier | FormulaModifier;
|
|
2486
2486
|
interface Tooltip {
|
|
2487
2487
|
props: any;
|
|
2488
2488
|
component?: any;
|
|
@@ -2523,7 +2523,7 @@ interface Currency {
|
|
|
2523
2523
|
position: "before" | "after";
|
|
2524
2524
|
}
|
|
2525
2525
|
|
|
2526
|
-
|
|
2526
|
+
type ClipboardReadResult = {
|
|
2527
2527
|
status: "ok";
|
|
2528
2528
|
content: string;
|
|
2529
2529
|
} | {
|
|
@@ -2535,7 +2535,7 @@ interface ClipboardInterface {
|
|
|
2535
2535
|
readText(): Promise<ClipboardReadResult>;
|
|
2536
2536
|
}
|
|
2537
2537
|
|
|
2538
|
-
|
|
2538
|
+
type TranslationFunction = (string: string, ...values: string[] | [{
|
|
2539
2539
|
[key: string]: string;
|
|
2540
2540
|
}]) => string;
|
|
2541
2541
|
/***
|
|
@@ -2570,7 +2570,7 @@ interface SpreadsheetChildEnv extends SpreadsheetEnv {
|
|
|
2570
2570
|
loadCurrencies?: () => Promise<Currency[]>;
|
|
2571
2571
|
}
|
|
2572
2572
|
|
|
2573
|
-
|
|
2573
|
+
type ArgType = "ANY" | "BOOLEAN" | "NUMBER" | "STRING" | "DATE" | "RANGE" | "RANGE<BOOLEAN>" | "RANGE<NUMBER>" | "RANGE<DATE>" | "RANGE<STRING>" | "META";
|
|
2574
2574
|
interface ArgDefinition {
|
|
2575
2575
|
repeating?: boolean;
|
|
2576
2576
|
optional?: boolean;
|
|
@@ -2581,8 +2581,8 @@ interface ArgDefinition {
|
|
|
2581
2581
|
default?: boolean;
|
|
2582
2582
|
defaultValue?: any;
|
|
2583
2583
|
}
|
|
2584
|
-
|
|
2585
|
-
|
|
2584
|
+
type ComputeFunctionArg<T> = T | (() => T) | undefined;
|
|
2585
|
+
type ComputeFunction<T, R> = (this: EvalContext, ...args: ComputeFunctionArg<T>[]) => R;
|
|
2586
2586
|
interface AddFunctionDescription {
|
|
2587
2587
|
description: string;
|
|
2588
2588
|
compute: ComputeFunction<ArgValue, FunctionReturnValue>;
|
|
@@ -2599,7 +2599,7 @@ interface FunctionDescription extends AddFunctionDescription {
|
|
|
2599
2599
|
nbrArgRepeating: number;
|
|
2600
2600
|
getArgToFocus: (argPosition: number) => number;
|
|
2601
2601
|
}
|
|
2602
|
-
|
|
2602
|
+
type EvalContext = {
|
|
2603
2603
|
__lastFnCalled?: string;
|
|
2604
2604
|
__originCellXC?: () => string;
|
|
2605
2605
|
[key: string]: any;
|
|
@@ -3432,7 +3432,7 @@ declare class ImagePlugin extends CorePlugin<ImageState> implements ImageState {
|
|
|
3432
3432
|
private getAllImages;
|
|
3433
3433
|
}
|
|
3434
3434
|
|
|
3435
|
-
|
|
3435
|
+
type SheetMergeCellMap = Record<number, Record<number, number | undefined> | undefined>;
|
|
3436
3436
|
interface MergeState {
|
|
3437
3437
|
readonly merges: Record<UID, Record<number, Range | undefined> | undefined>;
|
|
3438
3438
|
readonly mergeCellMap: Record<UID, SheetMergeCellMap | undefined>;
|
|
@@ -3881,7 +3881,7 @@ declare class InternalViewport {
|
|
|
3881
3881
|
private adjustViewportZoneY;
|
|
3882
3882
|
}
|
|
3883
3883
|
|
|
3884
|
-
|
|
3884
|
+
type SheetViewports = {
|
|
3885
3885
|
topLeft: InternalViewport | undefined;
|
|
3886
3886
|
bottomLeft: InternalViewport | undefined;
|
|
3887
3887
|
topRight: InternalViewport | undefined;
|
|
@@ -4639,53 +4639,53 @@ declare class GridSelectionPlugin extends UIPlugin {
|
|
|
4639
4639
|
* This can be generalized because the union of all indices `0 | 1 | 2 | 3 | ...`
|
|
4640
4640
|
* is actually the type `number`.
|
|
4641
4641
|
*/
|
|
4642
|
-
|
|
4642
|
+
type GetterNames<Plugin extends {
|
|
4643
4643
|
getters: readonly string[];
|
|
4644
4644
|
}> = Plugin["getters"][number];
|
|
4645
|
-
|
|
4646
|
-
|
|
4647
|
-
|
|
4648
|
-
|
|
4649
|
-
|
|
4650
|
-
|
|
4651
|
-
|
|
4652
|
-
|
|
4653
|
-
|
|
4654
|
-
|
|
4655
|
-
|
|
4656
|
-
|
|
4645
|
+
type SheetGetters = Pick<SheetPlugin, GetterNames<typeof SheetPlugin>>;
|
|
4646
|
+
type HeaderSizeGetters = Pick<HeaderSizePlugin, GetterNames<typeof HeaderSizePlugin>>;
|
|
4647
|
+
type HeaderVisibilityGetters = Pick<HeaderVisibilityPlugin, GetterNames<typeof HeaderVisibilityPlugin>>;
|
|
4648
|
+
type CellGetters = Pick<CellPlugin, GetterNames<typeof CellPlugin>>;
|
|
4649
|
+
type MergeGetters = Pick<MergePlugin, GetterNames<typeof MergePlugin>>;
|
|
4650
|
+
type BordersGetters = Pick<BordersPlugin, GetterNames<typeof BordersPlugin>>;
|
|
4651
|
+
type ChartGetters = Pick<ChartPlugin, GetterNames<typeof ChartPlugin>>;
|
|
4652
|
+
type ImageGetters = Pick<ImagePlugin, GetterNames<typeof ImagePlugin>>;
|
|
4653
|
+
type FigureGetters = Pick<FigurePlugin, GetterNames<typeof FigurePlugin>>;
|
|
4654
|
+
type RangeAdapterGetters = Pick<RangeAdapter, GetterNames<typeof RangeAdapter>>;
|
|
4655
|
+
type ConditionalFormatGetters = Pick<ConditionalFormatPlugin, GetterNames<typeof ConditionalFormatPlugin>>;
|
|
4656
|
+
type LocalHistoryGetters = {
|
|
4657
4657
|
canUndo: LocalHistory["canUndo"];
|
|
4658
4658
|
canRedo: LocalHistory["canRedo"];
|
|
4659
4659
|
};
|
|
4660
|
-
|
|
4661
|
-
|
|
4662
|
-
|
|
4663
|
-
|
|
4664
|
-
|
|
4665
|
-
|
|
4666
|
-
|
|
4667
|
-
|
|
4668
|
-
|
|
4669
|
-
|
|
4670
|
-
|
|
4671
|
-
|
|
4672
|
-
|
|
4673
|
-
|
|
4674
|
-
|
|
4675
|
-
|
|
4676
|
-
|
|
4677
|
-
|
|
4678
|
-
|
|
4679
|
-
|
|
4680
|
-
|
|
4681
|
-
|
|
4660
|
+
type FiltersGetters = Pick<FiltersPlugin, GetterNames<typeof FiltersPlugin>>;
|
|
4661
|
+
type CoreGetters = SheetGetters & HeaderSizeGetters & HeaderVisibilityGetters & CellGetters & MergeGetters & BordersGetters & ChartGetters & ImageGetters & ConditionalFormatGetters & FigureGetters & RangeAdapterGetters & FiltersGetters;
|
|
4662
|
+
type AutofillGetters = Pick<AutofillPlugin, GetterNames<typeof AutofillPlugin>>;
|
|
4663
|
+
type AutomaticSumGetters = Pick<AutomaticSumPlugin, GetterNames<typeof AutomaticSumPlugin>>;
|
|
4664
|
+
type ClipboardGetters = Pick<ClipboardPlugin, GetterNames<typeof ClipboardPlugin>>;
|
|
4665
|
+
type EditionGetters = Pick<EditionPlugin, GetterNames<typeof EditionPlugin>>;
|
|
4666
|
+
type EvaluationGetters = Pick<EvaluationPlugin, GetterNames<typeof EvaluationPlugin>>;
|
|
4667
|
+
type EvaluationChartGetters = Pick<EvaluationChartPlugin, GetterNames<typeof EvaluationChartPlugin>>;
|
|
4668
|
+
type EvaluationConditionalFormatGetters = Pick<EvaluationConditionalFormatPlugin, GetterNames<typeof EvaluationConditionalFormatPlugin>>;
|
|
4669
|
+
type FindAndReplaceGetters = Pick<FindAndReplacePlugin, GetterNames<typeof FindAndReplacePlugin>>;
|
|
4670
|
+
type HeaderVisibilityIUIGetters = Pick<HeaderVisibilityUIPlugin, GetterNames<typeof HeaderVisibilityUIPlugin>>;
|
|
4671
|
+
type HighlightGetters = Pick<HighlightPlugin, GetterNames<typeof HighlightPlugin>>;
|
|
4672
|
+
type CustomColorsGetters = Pick<CustomColorsPlugin, GetterNames<typeof CustomColorsPlugin>>;
|
|
4673
|
+
type RendererGetters = Pick<RendererPlugin, GetterNames<typeof RendererPlugin>>;
|
|
4674
|
+
type SelectionGetters = Pick<GridSelectionPlugin, GetterNames<typeof GridSelectionPlugin>>;
|
|
4675
|
+
type SelectionInputGetters = Pick<SelectionInputsManagerPlugin, GetterNames<typeof SelectionInputsManagerPlugin>>;
|
|
4676
|
+
type SelectionMultiUserGetters = Pick<SelectionMultiUserPlugin, GetterNames<typeof SelectionMultiUserPlugin>>;
|
|
4677
|
+
type SortGetters = Pick<SortPlugin, GetterNames<typeof SortPlugin>>;
|
|
4678
|
+
type UIOptionsGetters = Pick<UIOptionsPlugin, GetterNames<typeof UIOptionsPlugin>>;
|
|
4679
|
+
type SheetUIGetters = Pick<SheetUIPlugin, GetterNames<typeof SheetUIPlugin>>;
|
|
4680
|
+
type ViewportGetters = Pick<SheetViewPlugin, GetterNames<typeof SheetViewPlugin>>;
|
|
4681
|
+
type SessionGetters = {
|
|
4682
4682
|
getClient: Session["getClient"];
|
|
4683
4683
|
getConnectedClients: Session["getConnectedClients"];
|
|
4684
4684
|
isFullySynchronized: Session["isFullySynchronized"];
|
|
4685
4685
|
};
|
|
4686
|
-
|
|
4687
|
-
|
|
4688
|
-
|
|
4686
|
+
type CellPopoverPluginGetters = Pick<CellPopoverPlugin, GetterNames<typeof CellPopoverPlugin>>;
|
|
4687
|
+
type FilterEvaluationGetters = Pick<FilterEvaluationPlugin, GetterNames<typeof FilterEvaluationPlugin>>;
|
|
4688
|
+
type Getters = {
|
|
4689
4689
|
isReadonly: () => boolean;
|
|
4690
4690
|
isDashboard: () => boolean;
|
|
4691
4691
|
} & LocalHistoryGetters & CoreGetters & SessionGetters & AutofillGetters & AutomaticSumGetters & ClipboardGetters & EditionGetters & EvaluationGetters & EvaluationChartGetters & EvaluationConditionalFormatGetters & FindAndReplaceGetters & HighlightGetters & CustomColorsGetters & RendererGetters & SelectionGetters & SelectionInputGetters & SelectionMultiUserGetters & SortGetters & UIOptionsGetters & SheetUIGetters & ViewportGetters & CellPopoverPluginGetters & FilterEvaluationGetters & HeaderVisibilityIUIGetters;
|
|
@@ -4704,7 +4704,7 @@ interface WorkbookHistory<Plugin> {
|
|
|
4704
4704
|
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;
|
|
4705
4705
|
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;
|
|
4706
4706
|
}
|
|
4707
|
-
|
|
4707
|
+
type Transformation<T = unknown> = (dataToTransform: T) => T;
|
|
4708
4708
|
interface TransformationFactory<T = unknown> {
|
|
4709
4709
|
/**
|
|
4710
4710
|
* Build a transformation function to transform any operation as if the execution of
|
|
@@ -4718,12 +4718,12 @@ interface TransformationFactory<T = unknown> {
|
|
|
4718
4718
|
with: (operation: T) => Transformation<T>;
|
|
4719
4719
|
}
|
|
4720
4720
|
|
|
4721
|
-
|
|
4722
|
-
|
|
4721
|
+
type SelectionDirection = "up" | "down" | "left" | "right";
|
|
4722
|
+
type SelectionStep = number | "end";
|
|
4723
4723
|
|
|
4724
|
-
|
|
4725
|
-
|
|
4726
|
-
|
|
4724
|
+
type CellPopoverType = "ErrorToolTip" | "LinkDisplay" | "FilterMenu" | "LinkEditor";
|
|
4725
|
+
type PopoverPropsPosition = "TopRight" | "BottomLeft";
|
|
4726
|
+
type MaxSizedComponentConstructor = ComponentConstructor & {
|
|
4727
4727
|
maxSize?: {
|
|
4728
4728
|
maxWidth?: number;
|
|
4729
4729
|
maxHeight?: number;
|
|
@@ -4733,7 +4733,7 @@ declare type MaxSizedComponentConstructor = ComponentConstructor & {
|
|
|
4733
4733
|
* If the cell at the given position have an associated component (linkDisplay, errorTooltip, ...),
|
|
4734
4734
|
* returns the parameters to display the component
|
|
4735
4735
|
*/
|
|
4736
|
-
|
|
4736
|
+
type CellPopoverBuilder = (position: CellPosition, getters: Getters) => CellPopoverComponent<MaxSizedComponentConstructor>;
|
|
4737
4737
|
interface PopoverBuilders {
|
|
4738
4738
|
onOpen?: CellPopoverBuilder;
|
|
4739
4739
|
onHover?: CellPopoverBuilder;
|
|
@@ -4746,14 +4746,14 @@ interface ClosedCellPopover {
|
|
|
4746
4746
|
* i.e. which component class, which props and where to
|
|
4747
4747
|
* display it relative to the cell
|
|
4748
4748
|
*/
|
|
4749
|
-
|
|
4749
|
+
type OpenCellPopover<C extends ComponentConstructor> = {
|
|
4750
4750
|
isOpen: true;
|
|
4751
4751
|
Component: C;
|
|
4752
4752
|
props: PropsOf<C>;
|
|
4753
4753
|
cellCorner: PopoverPropsPosition;
|
|
4754
4754
|
};
|
|
4755
|
-
|
|
4756
|
-
|
|
4755
|
+
type CellPopoverComponent<C extends MaxSizedComponentConstructor = MaxSizedComponentConstructor> = ClosedCellPopover | OpenCellPopover<C>;
|
|
4756
|
+
type PositionedCellPopover<C extends MaxSizedComponentConstructor = MaxSizedComponentConstructor> = {
|
|
4757
4757
|
isOpen: true;
|
|
4758
4758
|
Component: C;
|
|
4759
4759
|
props: PropsOf<C>;
|
|
@@ -4822,7 +4822,7 @@ interface LinkSpec {
|
|
|
4822
4822
|
declare function urlRepresentation(link: Link, getters: Getters): string;
|
|
4823
4823
|
declare function openLink(link: Link, env: SpreadsheetChildEnv): void;
|
|
4824
4824
|
|
|
4825
|
-
|
|
4825
|
+
type TransformationFunction<U extends CoreCommandTypes, V extends CoreCommandTypes> = (toTransform: Extract<CoreCommand, {
|
|
4826
4826
|
type: U;
|
|
4827
4827
|
}>, executed: Extract<CoreCommand, {
|
|
4828
4828
|
type: V;
|
|
@@ -5100,7 +5100,7 @@ declare class GaugeChartConfigPanel extends Component<Props$x, SpreadsheetChildE
|
|
|
5100
5100
|
updateDataRange(): void;
|
|
5101
5101
|
}
|
|
5102
5102
|
|
|
5103
|
-
|
|
5103
|
+
type GaugeMenu = "backgroundColor" | "sectionColor-lowerColor" | "sectionColor-middleColor" | "sectionColor-upperColor";
|
|
5104
5104
|
interface Props$w {
|
|
5105
5105
|
figureId: UID;
|
|
5106
5106
|
definition: GaugeChartDefinition;
|
|
@@ -5161,7 +5161,7 @@ declare class ScorecardChartConfigPanel extends Component<Props$v, SpreadsheetCh
|
|
|
5161
5161
|
updateBaselineMode(ev: any): void;
|
|
5162
5162
|
}
|
|
5163
5163
|
|
|
5164
|
-
|
|
5164
|
+
type ColorPickerId = undefined | "backgroundColor" | "baselineColorUp" | "baselineColorDown";
|
|
5165
5165
|
interface Props$u {
|
|
5166
5166
|
figureId: UID;
|
|
5167
5167
|
definition: ScorecardChartDefinition;
|
|
@@ -5233,8 +5233,8 @@ interface MenuItem {
|
|
|
5233
5233
|
textColor?: string;
|
|
5234
5234
|
icon?: string;
|
|
5235
5235
|
}
|
|
5236
|
-
|
|
5237
|
-
|
|
5236
|
+
type MenuItemsBuilder = (env: SpreadsheetChildEnv) => MenuItemSpec[];
|
|
5237
|
+
type MenuChildren = (MenuItemSpec | MenuItemsBuilder)[];
|
|
5238
5238
|
/**
|
|
5239
5239
|
* The class Registry is extended in order to add the function addChild
|
|
5240
5240
|
*
|
|
@@ -5394,7 +5394,7 @@ declare class Menu extends Component<Props$r, SpreadsheetChildEnv> {
|
|
|
5394
5394
|
onMouseOver(menu: MenuItem, position: Pixel): void;
|
|
5395
5395
|
}
|
|
5396
5396
|
|
|
5397
|
-
|
|
5397
|
+
type ResizeAnchor = "top left" | "top" | "top right" | "right" | "bottom right" | "bottom" | "bottom left" | "left";
|
|
5398
5398
|
interface Props$q {
|
|
5399
5399
|
figure: Figure;
|
|
5400
5400
|
style: string;
|
|
@@ -5677,7 +5677,7 @@ declare class FilterIconsOverlay extends Component<Props$j, SpreadsheetChildEnv>
|
|
|
5677
5677
|
private isPositionVisible;
|
|
5678
5678
|
}
|
|
5679
5679
|
|
|
5680
|
-
|
|
5680
|
+
type ContainerType = "topLeft" | "topRight" | "bottomLeft" | "bottomRight" | "dnd";
|
|
5681
5681
|
interface DndState {
|
|
5682
5682
|
figId: string | undefined;
|
|
5683
5683
|
x: Pixel;
|
|
@@ -5824,7 +5824,7 @@ declare class GridPopover extends Component<Props$g, SpreadsheetChildEnv> {
|
|
|
5824
5824
|
get cellPopover(): PositionedCellPopover | ClosedCellPopover;
|
|
5825
5825
|
}
|
|
5826
5826
|
|
|
5827
|
-
|
|
5827
|
+
type ScrollDirection = "horizontal" | "vertical";
|
|
5828
5828
|
|
|
5829
5829
|
interface Props$f {
|
|
5830
5830
|
width: Pixel;
|
|
@@ -6033,7 +6033,7 @@ declare class FunctionDescriptionProvider extends Component<Props$9> {
|
|
|
6033
6033
|
onMouseMove(): void;
|
|
6034
6034
|
}
|
|
6035
6035
|
|
|
6036
|
-
|
|
6036
|
+
type HtmlContent = {
|
|
6037
6037
|
value: string;
|
|
6038
6038
|
color?: Color;
|
|
6039
6039
|
class?: string;
|
|
@@ -6147,6 +6147,7 @@ interface State$1 {
|
|
|
6147
6147
|
interface Props$7 {
|
|
6148
6148
|
onToggle: () => void;
|
|
6149
6149
|
dropdownStyle: string;
|
|
6150
|
+
class: string;
|
|
6150
6151
|
}
|
|
6151
6152
|
declare class FontSizeEditor extends Component<Props$7, SpreadsheetChildEnv> {
|
|
6152
6153
|
static template: string;
|
|
@@ -6167,7 +6168,7 @@ declare class FontSizeEditor extends Component<Props$7, SpreadsheetChildEnv> {
|
|
|
6167
6168
|
onInputKeydown(ev: KeyboardEvent): void;
|
|
6168
6169
|
}
|
|
6169
6170
|
|
|
6170
|
-
|
|
6171
|
+
type Tool = "" | "formatTool" | "alignTool" | "textColorTool" | "fillColorTool" | "borderTool";
|
|
6171
6172
|
interface State {
|
|
6172
6173
|
menuState: MenuState;
|
|
6173
6174
|
activeTool: Tool;
|
|
@@ -6249,7 +6250,7 @@ declare class TopBar extends Component<Props$6, SpreadsheetChildEnv> {
|
|
|
6249
6250
|
removeFilter(): void;
|
|
6250
6251
|
}
|
|
6251
6252
|
|
|
6252
|
-
|
|
6253
|
+
type ComposerFocusType = "inactive" | "cellFocus" | "contentFocus";
|
|
6253
6254
|
interface SpreadsheetProps {
|
|
6254
6255
|
model: Model;
|
|
6255
6256
|
}
|
|
@@ -6440,7 +6441,7 @@ declare class HeadersOverlay extends Component<any, SpreadsheetChildEnv> {
|
|
|
6440
6441
|
selectAll(): void;
|
|
6441
6442
|
}
|
|
6442
6443
|
|
|
6443
|
-
|
|
6444
|
+
type Orientation$1 = "n" | "s" | "w" | "e";
|
|
6444
6445
|
interface Props$4 {
|
|
6445
6446
|
zone: Zone;
|
|
6446
6447
|
orientation: Orientation$1;
|
|
@@ -6453,7 +6454,7 @@ declare class Border extends Component<Props$4, SpreadsheetChildEnv> {
|
|
|
6453
6454
|
onMouseDown(ev: MouseEvent): void;
|
|
6454
6455
|
}
|
|
6455
6456
|
|
|
6456
|
-
|
|
6457
|
+
type Orientation = "nw" | "ne" | "sw" | "se";
|
|
6457
6458
|
interface Props$3 {
|
|
6458
6459
|
zone: Zone;
|
|
6459
6460
|
color: Color;
|
|
@@ -6497,7 +6498,7 @@ declare class Highlight extends Component<Props$2, SpreadsheetChildEnv> {
|
|
|
6497
6498
|
* - a horizontal resizer (to resize columns)
|
|
6498
6499
|
* - a vertical resizer (same, for rows)
|
|
6499
6500
|
*/
|
|
6500
|
-
|
|
6501
|
+
type ContextMenuType = "ROW" | "COL" | "CELL" | "FILTER";
|
|
6501
6502
|
interface Props$1 {
|
|
6502
6503
|
sidePanelIsOpen: boolean;
|
|
6503
6504
|
exposeFocus: (focus: () => void) => void;
|