@pdftron/webviewer 11.6.0-20250629 → 11.6.0

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.
Files changed (68) hide show
  1. package/package.json +1 -1
  2. package/public/core/19.chunk.js +1 -1
  3. package/public/core/22.chunk.js +4 -4
  4. package/public/core/ExternalAnnotationMerger.chunk.js +9 -9
  5. package/public/core/ExternalPdfPartRetriever.chunk.js +3 -3
  6. package/public/core/HttpPartRetriever.chunk.js +4 -4
  7. package/public/core/LocalPartRetriever.chunk.js +2 -2
  8. package/public/core/LocalPdfPartRetriever.chunk.js +2 -2
  9. package/public/core/SelectionInfoOld.chunk.js +6 -6
  10. package/public/core/StreamingPartRetriever.chunk.js +5 -5
  11. package/public/core/WebViewerServerPartRetriever.chunk.js +23 -23
  12. package/public/core/WinRTPartRetriever.chunk.js +1 -1
  13. package/public/core/legacyOffice/WebB2XOfficeWorker.br.js.mem +0 -0
  14. package/public/core/legacyOffice/WebB2XOfficeWorker.br.mem +0 -0
  15. package/public/core/legacyOffice/WebB2XOfficeWorker.gz.js.mem +0 -0
  16. package/public/core/legacyOffice/WebB2XOfficeWorker.gz.mem +0 -0
  17. package/public/core/legacyOffice/WebB2XOfficeWorkerWasm.br.js.mem +0 -0
  18. package/public/core/legacyOffice/WebB2XOfficeWorkerWasm.br.wasm +0 -0
  19. package/public/core/legacyOffice/WebB2XOfficeWorkerWasm.gz.js.mem +0 -0
  20. package/public/core/legacyOffice/WebB2XOfficeWorkerWasm.gz.wasm +0 -0
  21. package/public/core/legacyOffice/WebB2XOfficeWorkerWasm.js +1 -1
  22. package/public/core/office/WebOfficeWorker.br.js.mem +0 -0
  23. package/public/core/office/WebOfficeWorker.br.mem +0 -0
  24. package/public/core/office/WebOfficeWorker.gz.js.mem +0 -0
  25. package/public/core/office/WebOfficeWorker.gz.mem +0 -0
  26. package/public/core/office/WebOfficeWorkerWasm.br.js.mem +0 -0
  27. package/public/core/office/WebOfficeWorkerWasm.br.wasm +0 -0
  28. package/public/core/office/WebOfficeWorkerWasm.gz.js.mem +0 -0
  29. package/public/core/office/WebOfficeWorkerWasm.gz.wasm +0 -0
  30. package/public/core/office/WebOfficeWorkerWasm.js +1 -1
  31. package/public/core/officeEditor/OfficeEditorWorkerWasm.br.js.mem +0 -0
  32. package/public/core/officeEditor/OfficeEditorWorkerWasm.br.wasm +0 -0
  33. package/public/core/officeEditor/OfficeEditorWorkerWasm.gz.js.mem +0 -0
  34. package/public/core/officeEditor/OfficeEditorWorkerWasm.gz.wasm +0 -0
  35. package/public/core/pdf/full/PDFNetC.br.js.mem +0 -0
  36. package/public/core/pdf/full/PDFNetC.br.mem +0 -0
  37. package/public/core/pdf/full/PDFNetC.gz.js.mem +0 -0
  38. package/public/core/pdf/full/PDFNetCWasm.br.js.mem +0 -0
  39. package/public/core/pdf/full/PDFNetCWasm.br.wasm +0 -0
  40. package/public/core/pdf/full/PDFNetCWasm.gz.js.mem +0 -0
  41. package/public/core/pdf/full/PDFNetCWasm.js +1 -1
  42. package/public/core/pdf/full/PDFNetThreadedWasm.br.js.mem +0 -0
  43. package/public/core/pdf/full/PDFNetThreadedWasm.br.wasm +0 -0
  44. package/public/core/pdf/full/optimized/PDFNetCWasm.br.js.mem +0 -0
  45. package/public/core/pdf/full/optimized/PDFNetCWasm.br.wasm +0 -0
  46. package/public/core/pdf/full/optimized/PDFNetCWasm.gz.js.mem +0 -0
  47. package/public/core/pdf/full/optimized/PDFNetCWasm.js +1 -1
  48. package/public/core/pdf/full/optimized/PDFNetThreadedWasm.br.js.mem +0 -0
  49. package/public/core/pdf/full/optimized/PDFNetThreadedWasm.br.wasm +0 -0
  50. package/public/core/pdf/lean/PDFNetC.br.js.mem +0 -0
  51. package/public/core/pdf/lean/PDFNetC.br.mem +0 -0
  52. package/public/core/pdf/lean/PDFNetC.gz.js.mem +0 -0
  53. package/public/core/pdf/lean/PDFNetCWasm.br.js.mem +0 -0
  54. package/public/core/pdf/lean/PDFNetCWasm.br.wasm +0 -0
  55. package/public/core/pdf/lean/PDFNetCWasm.gz.js.mem +0 -0
  56. package/public/core/pdf/lean/PDFNetCWasm.js +1 -1
  57. package/public/core/pdf/lean/PDFNetThreadedWasm.br.js.mem +0 -0
  58. package/public/core/pdf/lean/PDFNetThreadedWasm.br.wasm +0 -0
  59. package/public/core/pdf/lean/optimized/PDFNetCWasm.br.js.mem +0 -0
  60. package/public/core/pdf/lean/optimized/PDFNetCWasm.br.wasm +0 -0
  61. package/public/core/pdf/lean/optimized/PDFNetCWasm.gz.js.mem +0 -0
  62. package/public/core/pdf/lean/optimized/PDFNetCWasm.js +1 -1
  63. package/public/core/pdf/lean/optimized/PDFNetThreadedWasm.br.js.mem +0 -0
  64. package/public/core/pdf/lean/optimized/PDFNetThreadedWasm.br.wasm +0 -0
  65. package/public/core/vendors.ascii85.chunk.js +1 -1
  66. package/public/core/vendors.pako.chunk.js +22 -22
  67. package/public/core/webviewer-core.min.js +1728 -1725
  68. package/types.d.ts +431 -98
package/types.d.ts CHANGED
@@ -35596,15 +35596,6 @@ export declare namespace Core {
35596
35596
  * Contains all classes related to spreadsheet editor.
35597
35597
  */
35598
35598
  namespace SpreadsheetEditor {
35599
- /**
35600
- * A class that represents the object included when an `ActiveSheetChanged` event is fired.
35601
- */
35602
- class ActiveSheetChangedEvent {
35603
- /**
35604
- * @returns Returns current active sheet index.
35605
- */
35606
- getSheetIndex(): number;
35607
- }
35608
35599
  /**
35609
35600
  * Represents a cell in the spreadsheet editor. A cell is the fundamental component in spreadsheet document manipulation,
35610
35601
  * providing a range of methods and properties to manage the content and appearance of individual cells.
@@ -35879,28 +35870,7 @@ export declare namespace Core {
35879
35870
  */
35880
35871
  strikeout: boolean;
35881
35872
  }
35882
- namespace SpreadsheetEditorManager {
35883
- /**
35884
- * Represents the event fired when the formula bar selection position changes.
35885
- */
35886
- class FormulaBarSelectionChangedEvent {
35887
- }
35888
- /**
35889
- * Represents the event fired when the formula bar text changes.
35890
- */
35891
- class FormulaBarTextChangedEvent {
35892
- }
35893
- /**
35894
- * Represents the event fired when a formula search is performed.
35895
- */
35896
- class FormulaSearchEvent {
35897
- }
35898
- /**
35899
- * Represents the event fired when formula helper information is requested.
35900
- */
35901
- class FormulaHelpEvent {
35902
- }
35903
- }
35873
+ namespace SpreadsheetEditorManager { }
35904
35874
  /**
35905
35875
  * Encapsulates functionality for managing merged cell regions within an Spreadsheet Editor. It provides methods to add, remove, and retrieve merged cell regions.
35906
35876
  */
@@ -36022,62 +35992,6 @@ export declare namespace Core {
36022
35992
  */
36023
35993
  lastCellIndex: number;
36024
35994
  }
36025
- /**
36026
- * A class that represents the object included when a `SelectionChanged` event is fired.
36027
- */
36028
- class SelectionChangedEvent {
36029
- /**
36030
- * @returns Returns an array of one cell if the selection is a single cell, otherwise an array of two cells with
36031
- * the first cell being the top left cell and the second cell being the bottom right cell.
36032
- */
36033
- getCellRange(): Core.SpreadsheetEditor.CellRange;
36034
- /**
36035
- * @example
36036
- * const { Core } = window.getInstance();
36037
- * const spreadsheetEditorManager = Core.documentViewer.getSpreadsheetEditorManager();
36038
- * spreadsheetEditorManager.addEventListener(Core.SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED, (event) => {
36039
- * const [topLeftCell, bottomRightCell] = event.getBoundingCells();
36040
- * });
36041
- * @returns Returns an array of one cell if the selection is a single cell, otherwise an array of two cells with
36042
- * the first cell being the top left cell and the second cell being the bottom right cell.
36043
- */
36044
- getBoundingCells(): Core.SpreadsheetEditor.Cell[];
36045
- /**
36046
- * @example
36047
- * const { Core } = window.getInstance();
36048
- * const spreadsheetEditorManager = Core.documentViewer.getSpreadsheetEditorManager();
36049
- * spreadsheetEditorManager.addEventListener(Core.SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED, (event) => {
36050
- * const displayValue = event.getSelectionRangeDisplayValue();
36051
- * });
36052
- * @returns A string that contains the selected range. For single cell selection it returns a one cell value, such as 'A1'.
36053
- * For multiple cell selection, it will return for example 'A1:B2'.
36054
- */
36055
- getSelectionRangeDisplayValue(): string;
36056
- /**
36057
- * @example
36058
- * const { Core } = window.getInstance();
36059
- * const spreadsheetEditorManager = Core.documentViewer.getSpreadsheetEditorManager();
36060
- * spreadsheetEditorManager.addEventListener(Core.SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED, (event) => {
36061
- * const isMerged = event.isMerged();
36062
- * });
36063
- * @returns True if the entire selected range consists of merged cells only. Returns false if the selection contains any unmerged cells or is a mix of merged and unmerged ranges.
36064
- */
36065
- isMerged(): boolean;
36066
- /**
36067
- * Gets the clipboard object associated with the spreadsheet editor.
36068
- * @example
36069
- * const { Core } = window.getInstance();
36070
- * const spreadsheetEditorManager = Core.documentViewer.getSpreadsheetEditorManager();
36071
- * spreadsheetEditorManager.addEventListener(Core.SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED, (event) => {
36072
- * const clipboard = event.getClipboard();
36073
- * if (clipboard.canCopy()) {
36074
- * clipboard.copy();
36075
- * }
36076
- * });
36077
- * @returns Returns the clipboard object associated with the spreadsheet editor.
36078
- */
36079
- getClipboard(): Core.SpreadsheetEditor.SpreadsheetEditorClipboard;
36080
- }
36081
35995
  /**
36082
35996
  * Represents a Sheet in the spreadsheet editor that encapsulates the functionalities of a single sheet within a workbook. The creation of sheets follows a factory pattern so you must use {@link Core.SpreadsheetEditor.Workbook#createSheet Workbook.createSheet} rather than constructing directly.
36083
35997
  * @property rowsCount - Gets the number rows in a sheet.
@@ -36299,17 +36213,6 @@ export declare namespace Core {
36299
36213
  * A manager class that controls spreadsheet editing.
36300
36214
  */
36301
36215
  class SpreadsheetEditorManager extends EventHandler {
36302
- /**
36303
- * @property SELECTION_CHANGED - The event triggered when the selection in the spreadsheet editor changes.
36304
- * @property ACTIVE_SHEET_CHANGED - The event triggered when the active sheet in the spreadsheet editor changes.
36305
- */
36306
- on(event: 'Events', callback: () => void): void;
36307
- /**
36308
- * @property SELECTION_CHANGED - The event triggered when the selection in the spreadsheet editor changes.
36309
- * @property ACTIVE_SHEET_CHANGED - The event triggered when the active sheet in the spreadsheet editor changes.
36310
- */
36311
- one(event: 'Events', callback: () => void): void;
36312
- off(event?: 'Events', callback?: () => void): void;
36313
36216
  /**
36314
36217
  * Sets the current edit mode for the spreadsheet editor.
36315
36218
  * @example
@@ -36390,6 +36293,436 @@ export declare namespace Core {
36390
36293
  merge?: boolean;
36391
36294
  border?: Core.SpreadsheetEditor.Types.RangeBorderOptions;
36392
36295
  }): void;
36296
+ /**
36297
+ * The event that fires when the cell selection is changed in the editor.
36298
+ * @example
36299
+ * // getCellRange
36300
+ * const instance = WebViewer.getInstance();
36301
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36302
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36303
+ * spreadsheetEditorManager.addEventListener(
36304
+ * SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED,
36305
+ * (event) => {
36306
+ * const range = event.getCellRange();
36307
+ * }
36308
+ * );
36309
+ * @example
36310
+ * // getBoundingCells
36311
+ * const instance = WebViewer.getInstance();
36312
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36313
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36314
+ * spreadsheetEditorManager.addEventListener(
36315
+ * SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED,
36316
+ * (event) => {
36317
+ * const [topLeftCell, bottomRightCell] = event.getBoundingCells();
36318
+ * }
36319
+ * );
36320
+ * @example
36321
+ * // getSelectionRangeDisplayValue
36322
+ * const instance = WebViewer.getInstance();
36323
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36324
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36325
+ * spreadsheetEditorManager.addEventListener(
36326
+ * SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED,
36327
+ * (event) => {
36328
+ * const displayValue = event.getSelectionRangeDisplayValue();
36329
+ * }
36330
+ * );
36331
+ * @example
36332
+ * // isMerged
36333
+ * const instance = WebViewer.getInstance();
36334
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36335
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36336
+ * spreadsheetEditorManager.addEventListener(
36337
+ * SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED,
36338
+ * (event) => {
36339
+ * const isFullyMerged = event.isMerged();
36340
+ * }
36341
+ * );
36342
+ * @example
36343
+ * // getClipboard
36344
+ * const instance = WebViewer.getInstance();
36345
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36346
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36347
+ * spreadsheetEditorManager.addEventListener(
36348
+ * SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED,
36349
+ * (event) => {
36350
+ * const clipboard = event.getClipboard();
36351
+ * if (clipboard.canCopy()) {
36352
+ * clipboard.copy();
36353
+ * }
36354
+ * }
36355
+ * );
36356
+ * @param selectionChangedEventObject.getCellRange - Returns a CellRange object representing the selected cell(s).
36357
+ * @param selectionChangedEventObject.getBoundingCells - Returns an array of one or two Cells representing the top-left and bottom-right corners of the selection.
36358
+ * @param selectionChangedEventObject.getSelectionRangeDisplayValue - Returns a string representing the display value of the selected range (e.g. 'A1' or 'A1:B2').
36359
+ * @param selectionChangedEventObject.isMerged - Returns true if the entire selected range consists of merged cells only. Returns false if the selection contains any unmerged cells or is a mix of merged and unmerged ranges.
36360
+ * @param selectionChangedEventObject.getClipboard - Returns the SpreadsheetEditorClipboard object associated with the current editor instance.
36361
+ */
36362
+ on(event: 'selectionChanged', callback: (selectionChangedEventObject: {
36363
+ getCellRange: (...params: any[]) => any;
36364
+ getBoundingCells: (...params: any[]) => any;
36365
+ getSelectionRangeDisplayValue: (...params: any[]) => any;
36366
+ isMerged: (...params: any[]) => any;
36367
+ getClipboard: (...params: any[]) => any;
36368
+ }) => void): void;
36369
+ /**
36370
+ * The event that fires when the cell selection is changed in the editor.
36371
+ * @example
36372
+ * // getCellRange
36373
+ * const instance = WebViewer.getInstance();
36374
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36375
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36376
+ * spreadsheetEditorManager.addEventListener(
36377
+ * SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED,
36378
+ * (event) => {
36379
+ * const range = event.getCellRange();
36380
+ * }
36381
+ * );
36382
+ * @example
36383
+ * // getBoundingCells
36384
+ * const instance = WebViewer.getInstance();
36385
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36386
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36387
+ * spreadsheetEditorManager.addEventListener(
36388
+ * SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED,
36389
+ * (event) => {
36390
+ * const [topLeftCell, bottomRightCell] = event.getBoundingCells();
36391
+ * }
36392
+ * );
36393
+ * @example
36394
+ * // getSelectionRangeDisplayValue
36395
+ * const instance = WebViewer.getInstance();
36396
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36397
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36398
+ * spreadsheetEditorManager.addEventListener(
36399
+ * SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED,
36400
+ * (event) => {
36401
+ * const displayValue = event.getSelectionRangeDisplayValue();
36402
+ * }
36403
+ * );
36404
+ * @example
36405
+ * // isMerged
36406
+ * const instance = WebViewer.getInstance();
36407
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36408
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36409
+ * spreadsheetEditorManager.addEventListener(
36410
+ * SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED,
36411
+ * (event) => {
36412
+ * const isFullyMerged = event.isMerged();
36413
+ * }
36414
+ * );
36415
+ * @example
36416
+ * // getClipboard
36417
+ * const instance = WebViewer.getInstance();
36418
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36419
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36420
+ * spreadsheetEditorManager.addEventListener(
36421
+ * SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTION_CHANGED,
36422
+ * (event) => {
36423
+ * const clipboard = event.getClipboard();
36424
+ * if (clipboard.canCopy()) {
36425
+ * clipboard.copy();
36426
+ * }
36427
+ * }
36428
+ * );
36429
+ * @param selectionChangedEventObject.getCellRange - Returns a CellRange object representing the selected cell(s).
36430
+ * @param selectionChangedEventObject.getBoundingCells - Returns an array of one or two Cells representing the top-left and bottom-right corners of the selection.
36431
+ * @param selectionChangedEventObject.getSelectionRangeDisplayValue - Returns a string representing the display value of the selected range (e.g. 'A1' or 'A1:B2').
36432
+ * @param selectionChangedEventObject.isMerged - Returns true if the entire selected range consists of merged cells only. Returns false if the selection contains any unmerged cells or is a mix of merged and unmerged ranges.
36433
+ * @param selectionChangedEventObject.getClipboard - Returns the SpreadsheetEditorClipboard object associated with the current editor instance.
36434
+ */
36435
+ one(event: 'selectionChanged', callback: (selectionChangedEventObject: {
36436
+ getCellRange: (...params: any[]) => any;
36437
+ getBoundingCells: (...params: any[]) => any;
36438
+ getSelectionRangeDisplayValue: (...params: any[]) => any;
36439
+ isMerged: (...params: any[]) => any;
36440
+ getClipboard: (...params: any[]) => any;
36441
+ }) => void): void;
36442
+ off(event?: 'selectionChanged', callback?: (selectionChangedEventObject: {
36443
+ getCellRange: (...params: any[]) => any;
36444
+ getBoundingCells: (...params: any[]) => any;
36445
+ getSelectionRangeDisplayValue: (...params: any[]) => any;
36446
+ isMerged: (...params: any[]) => any;
36447
+ getClipboard: (...params: any[]) => any;
36448
+ }) => void): void;
36449
+ /**
36450
+ * The event that fires when the current active sheet changed.
36451
+ * @param activeSheetChangedEventObject.getSheetIndex - Returns the current active sheet index.
36452
+ */
36453
+ on(event: 'activeSheetChanged', callback: (activeSheetChangedEventObject: {
36454
+ getSheetIndex: (...params: any[]) => any;
36455
+ }) => void): void;
36456
+ /**
36457
+ * The event that fires when the current active sheet changed.
36458
+ * @param activeSheetChangedEventObject.getSheetIndex - Returns the current active sheet index.
36459
+ */
36460
+ one(event: 'activeSheetChanged', callback: (activeSheetChangedEventObject: {
36461
+ getSheetIndex: (...params: any[]) => any;
36462
+ }) => void): void;
36463
+ off(event?: 'activeSheetChanged', callback?: (activeSheetChangedEventObject: {
36464
+ getSheetIndex: (...params: any[]) => any;
36465
+ }) => void): void;
36466
+ /**
36467
+ * The event that fires when the spreadsheet document is loaded and ready to be used.
36468
+ * @example
36469
+ * const instance = WebViewer.getInstance();
36470
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36471
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36472
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.SPREADSHEET_EDITOR_READY, () => {
36473
+ * // console.log('SPREADSHEET_EDITOR_READY')
36474
+ * });
36475
+ */
36476
+ on(event: 'spreadsheetEditorReady', callback: () => void): void;
36477
+ /**
36478
+ * The event that fires when the spreadsheet document is loaded and ready to be used.
36479
+ * @example
36480
+ * const instance = WebViewer.getInstance();
36481
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36482
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36483
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.SPREADSHEET_EDITOR_READY, () => {
36484
+ * // console.log('SPREADSHEET_EDITOR_READY')
36485
+ * });
36486
+ */
36487
+ one(event: 'spreadsheetEditorReady', callback: () => void): void;
36488
+ off(event?: 'spreadsheetEditorReady', callback?: () => void): void;
36489
+ /**
36490
+ * The event that fires when the spreadsheet editor mode changed.
36491
+ * @example
36492
+ * const instance = WebViewer.getInstance();
36493
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36494
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36495
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.EDIT_MODE_CHANGED, () => {
36496
+ * // console.log('EDIT_MODE_CHANGED')
36497
+ * });
36498
+ * @param mode - The new edit mode after mode changes.
36499
+ */
36500
+ on(event: 'spreadsheetEditorEditModeChanged', callback: (mode: Core.SpreadsheetEditor.SpreadsheetEditorEditMode) => void): void;
36501
+ /**
36502
+ * The event that fires when the spreadsheet editor mode changed.
36503
+ * @example
36504
+ * const instance = WebViewer.getInstance();
36505
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36506
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36507
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.EDIT_MODE_CHANGED, () => {
36508
+ * // console.log('EDIT_MODE_CHANGED')
36509
+ * });
36510
+ * @param mode - The new edit mode after mode changes.
36511
+ */
36512
+ one(event: 'spreadsheetEditorEditModeChanged', callback: (mode: Core.SpreadsheetEditor.SpreadsheetEditorEditMode) => void): void;
36513
+ off(event?: 'spreadsheetEditorEditModeChanged', callback?: (mode: Core.SpreadsheetEditor.SpreadsheetEditorEditMode) => void): void;
36514
+ /**
36515
+ * The event that fires when the cell style of the selected range changed.
36516
+ * @example
36517
+ * const instance = WebViewer.getInstance();
36518
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36519
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36520
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTED_RANGE_STYLE_CHANGED, () => {
36521
+ * // console.log('SELECTED_RANGE_STYLE_CHANGED')
36522
+ * });
36523
+ * @param styleObject - See {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#setSelectedCellsStyle} for style object definition.
36524
+ */
36525
+ on(event: 'selectedRangeStyleChanged', callback: (styleObject: any) => void): void;
36526
+ /**
36527
+ * The event that fires when the cell style of the selected range changed.
36528
+ * @example
36529
+ * const instance = WebViewer.getInstance();
36530
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36531
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36532
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.SELECTED_RANGE_STYLE_CHANGED, () => {
36533
+ * // console.log('SELECTED_RANGE_STYLE_CHANGED')
36534
+ * });
36535
+ * @param styleObject - See {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#setSelectedCellsStyle} for style object definition.
36536
+ */
36537
+ one(event: 'selectedRangeStyleChanged', callback: (styleObject: any) => void): void;
36538
+ off(event?: 'selectedRangeStyleChanged', callback?: (styleObject: any) => void): void;
36539
+ /**
36540
+ * The event that fires when a formula is selected
36541
+ * @example
36542
+ * const instance = WebViewer.getInstance();
36543
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36544
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36545
+ * const handleFormulaBarSelectionChangedEvent = (event) => {
36546
+ * const inputPosition = event.getSelectionPosition();
36547
+ * // console.log('inputPosition', inputPosition);
36548
+ * };
36549
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_BAR_SELECTION_CHANGED, handleFormulaBarSelectionChangedEvent);
36550
+ * @param formulaBarSelectionChangedEventObject.getSelectionPosition - Returns the new selection position (0-indexed).
36551
+ */
36552
+ on(event: 'formulaBarSelectionChangedEvent', callback: (formulaBarSelectionChangedEventObject: {
36553
+ getSelectionPosition: (...params: any[]) => any;
36554
+ }) => void): void;
36555
+ /**
36556
+ * The event that fires when a formula is selected
36557
+ * @example
36558
+ * const instance = WebViewer.getInstance();
36559
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36560
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36561
+ * const handleFormulaBarSelectionChangedEvent = (event) => {
36562
+ * const inputPosition = event.getSelectionPosition();
36563
+ * // console.log('inputPosition', inputPosition);
36564
+ * };
36565
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_BAR_SELECTION_CHANGED, handleFormulaBarSelectionChangedEvent);
36566
+ * @param formulaBarSelectionChangedEventObject.getSelectionPosition - Returns the new selection position (0-indexed).
36567
+ */
36568
+ one(event: 'formulaBarSelectionChangedEvent', callback: (formulaBarSelectionChangedEventObject: {
36569
+ getSelectionPosition: (...params: any[]) => any;
36570
+ }) => void): void;
36571
+ off(event?: 'formulaBarSelectionChangedEvent', callback?: (formulaBarSelectionChangedEventObject: {
36572
+ getSelectionPosition: (...params: any[]) => any;
36573
+ }) => void): void;
36574
+ /**
36575
+ * The event that fires when the formula bar text input is changed.
36576
+ * @example
36577
+ * const instance = WebViewer.getInstance();
36578
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36579
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36580
+ * const handleFormulaBarTextChanged = (event) => {
36581
+ * const segments = event.getInfo();
36582
+ * // console.log('segments: ', segments);
36583
+ * };
36584
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_BAR_TEXT_CHANGED, handleFormulaBarTextChanged);
36585
+ * @param formulaBarTextChangedEventObject.getInfo - Returns an object containing the formula name and details.
36586
+ */
36587
+ on(event: 'formulaBarTextChangedEvent', callback: (formulaBarTextChangedEventObject: {
36588
+ getInfo: (...params: any[]) => any;
36589
+ }) => void): void;
36590
+ /**
36591
+ * The event that fires when the formula bar text input is changed.
36592
+ * @example
36593
+ * const instance = WebViewer.getInstance();
36594
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36595
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36596
+ * const handleFormulaBarTextChanged = (event) => {
36597
+ * const segments = event.getInfo();
36598
+ * // console.log('segments: ', segments);
36599
+ * };
36600
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_BAR_TEXT_CHANGED, handleFormulaBarTextChanged);
36601
+ * @param formulaBarTextChangedEventObject.getInfo - Returns an object containing the formula name and details.
36602
+ */
36603
+ one(event: 'formulaBarTextChangedEvent', callback: (formulaBarTextChangedEventObject: {
36604
+ getInfo: (...params: any[]) => any;
36605
+ }) => void): void;
36606
+ off(event?: 'formulaBarTextChangedEvent', callback?: (formulaBarTextChangedEventObject: {
36607
+ getInfo: (...params: any[]) => any;
36608
+ }) => void): void;
36609
+ /**
36610
+ * The event that fires when a search of formula is performed.
36611
+ * @example
36612
+ * const instance = WebViewer.getInstance();
36613
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36614
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36615
+ * const handleFormulaSearchEvent = (event) => {
36616
+ * const items = event.getFormulaInfoItems();
36617
+ * // console.log('items: ', items);
36618
+ * };
36619
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_SEARCH, handleFormulaBarTextChanged);
36620
+ * @param formulaSearchEventObject.getFormulaInfoItems - Returns a list of formula info items matching the formula search query.
36621
+ */
36622
+ on(event: 'formulaSearchEvent', callback: (formulaSearchEventObject: {
36623
+ getFormulaInfoItems: (...params: any[]) => any;
36624
+ }) => void): void;
36625
+ /**
36626
+ * The event that fires when a search of formula is performed.
36627
+ * @example
36628
+ * const instance = WebViewer.getInstance();
36629
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36630
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36631
+ * const handleFormulaSearchEvent = (event) => {
36632
+ * const items = event.getFormulaInfoItems();
36633
+ * // console.log('items: ', items);
36634
+ * };
36635
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_SEARCH, handleFormulaBarTextChanged);
36636
+ * @param formulaSearchEventObject.getFormulaInfoItems - Returns a list of formula info items matching the formula search query.
36637
+ */
36638
+ one(event: 'formulaSearchEvent', callback: (formulaSearchEventObject: {
36639
+ getFormulaInfoItems: (...params: any[]) => any;
36640
+ }) => void): void;
36641
+ off(event?: 'formulaSearchEvent', callback?: (formulaSearchEventObject: {
36642
+ getFormulaInfoItems: (...params: any[]) => any;
36643
+ }) => void): void;
36644
+ /**
36645
+ * The event that fires when the selection of a formula is confirmed
36646
+ * @example
36647
+ * const instance = WebViewer.getInstance();
36648
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36649
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36650
+ * const handleFormulaHelpEvent = (event) => {
36651
+ * // console.log('helpful formula info: ', event.getFormulaInfo());
36652
+ * };
36653
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_HELP, formulaHelpEvent);
36654
+ * @param formulaHelpEventObject.getFormulaInfo - Returns an object containing the formula name and description.
36655
+ */
36656
+ on(event: 'formulaHelpEvent', callback: (formulaHelpEventObject: {
36657
+ getFormulaInfo: (...params: any[]) => any;
36658
+ }) => void): void;
36659
+ /**
36660
+ * The event that fires when the selection of a formula is confirmed
36661
+ * @example
36662
+ * const instance = WebViewer.getInstance();
36663
+ * const { documentViewer, SpreadsheetEditor } = instance.Core;
36664
+ * const spreadsheetEditorManager = documentViewer.getSpreadsheetEditorManager();
36665
+ * const handleFormulaHelpEvent = (event) => {
36666
+ * // console.log('helpful formula info: ', event.getFormulaInfo());
36667
+ * };
36668
+ * spreadsheetEditorManager.addEventListener(SpreadsheetEditor.SpreadsheetEditorManager.Events.FORMULA_HELP, formulaHelpEvent);
36669
+ * @param formulaHelpEventObject.getFormulaInfo - Returns an object containing the formula name and description.
36670
+ */
36671
+ one(event: 'formulaHelpEvent', callback: (formulaHelpEventObject: {
36672
+ getFormulaInfo: (...params: any[]) => any;
36673
+ }) => void): void;
36674
+ off(event?: 'formulaHelpEvent', callback?: (formulaHelpEventObject: {
36675
+ getFormulaInfo: (...params: any[]) => any;
36676
+ }) => void): void;
36677
+ /**
36678
+ * @property SELECTION_CHANGED - {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:selectionChanged Core.SpreadsheetEditor.SpreadsheetEditorManager.selectionChanged}
36679
+ * @property ACTIVE_SHEET_CHANGED - {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:activeSheetChanged Core.SpreadsheetEditor.SpreadsheetEditorManager.activeSheetChanged}
36680
+ * @property SPREADSHEET_EDITOR_READY - {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:spreadsheetEditorReady Core.SpreadsheetEditor.SpreadsheetEditorManager.spreadsheetEditorReady}
36681
+ * @property EDIT_MODE_CHANGED - {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:spreadsheetEditorEditModeChanged Core.SpreadsheetEditor.SpreadsheetEditorManager.spreadsheetEditorEditModeChanged}
36682
+ * @property SELECTED_RANGE_STYLE_CHANGED - {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:selectedRangeStyleChanged Core.SpreadsheetEditor.SpreadsheetEditorManager.selectedRangeStyleChanged}
36683
+ * @property FORMULA_BAR_SELECTION_CHANGED - {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:formulaBarSelectionChangedEvent Core.SpreadsheetEditor.SpreadsheetEditorManager.formulaBarSelectionChangedEvent}
36684
+ * @property FORMULA_BAR_TEXT_CHANGED - {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:formulaBarTextChangedEvent Core.SpreadsheetEditor.SpreadsheetEditorManager.formulaBarTextChangedEvent}
36685
+ * @property FORMULA_SEARCH - {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:formulaSearchEvent Core.SpreadsheetEditor.SpreadsheetEditorManager.formulaSearchEvent}
36686
+ * @property FORMULA_HELP - {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:formulaHelpEvent Core.SpreadsheetEditor.SpreadsheetEditorManager.formulaHelpEvent}
36687
+ */
36688
+ static Events: {
36689
+ /**
36690
+ * {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:selectionChanged Core.SpreadsheetEditor.SpreadsheetEditorManager.selectionChanged}
36691
+ */
36692
+ SELECTION_CHANGED: string;
36693
+ /**
36694
+ * {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:activeSheetChanged Core.SpreadsheetEditor.SpreadsheetEditorManager.activeSheetChanged}
36695
+ */
36696
+ ACTIVE_SHEET_CHANGED: string;
36697
+ /**
36698
+ * {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:spreadsheetEditorReady Core.SpreadsheetEditor.SpreadsheetEditorManager.spreadsheetEditorReady}
36699
+ */
36700
+ SPREADSHEET_EDITOR_READY: string;
36701
+ /**
36702
+ * {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:spreadsheetEditorEditModeChanged Core.SpreadsheetEditor.SpreadsheetEditorManager.spreadsheetEditorEditModeChanged}
36703
+ */
36704
+ EDIT_MODE_CHANGED: string;
36705
+ /**
36706
+ * {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:selectedRangeStyleChanged Core.SpreadsheetEditor.SpreadsheetEditorManager.selectedRangeStyleChanged}
36707
+ */
36708
+ SELECTED_RANGE_STYLE_CHANGED: string;
36709
+ /**
36710
+ * {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:formulaBarSelectionChangedEvent Core.SpreadsheetEditor.SpreadsheetEditorManager.formulaBarSelectionChangedEvent}
36711
+ */
36712
+ FORMULA_BAR_SELECTION_CHANGED: string;
36713
+ /**
36714
+ * {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:formulaBarTextChangedEvent Core.SpreadsheetEditor.SpreadsheetEditorManager.formulaBarTextChangedEvent}
36715
+ */
36716
+ FORMULA_BAR_TEXT_CHANGED: string;
36717
+ /**
36718
+ * {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:formulaSearchEvent Core.SpreadsheetEditor.SpreadsheetEditorManager.formulaSearchEvent}
36719
+ */
36720
+ FORMULA_SEARCH: string;
36721
+ /**
36722
+ * {@link Core.SpreadsheetEditor.SpreadsheetEditorManager#event:formulaHelpEvent Core.SpreadsheetEditor.SpreadsheetEditorManager.formulaHelpEvent}
36723
+ */
36724
+ FORMULA_HELP: string;
36725
+ };
36393
36726
  }
36394
36727
  /**
36395
36728
  * Represents a Workbook in the spreadsheet editor that encapsulates a collection of sheets along with operations to manipulate them.