@mescius/spread-sheets 18.0.0 → 18.0.2

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.
@@ -12309,7 +12309,7 @@ declare module GC{
12309
12309
  * report.toggleCollapseState(0, 0);
12310
12310
  * ```
12311
12311
  */
12312
- toggleCollapseState(row: number, col: number): void;
12312
+ toggleCollapseState(row: number, col: number, targetState?: 'Collapsed' | 'Expanded', recursive?: boolean): void;
12313
12313
  /**
12314
12314
  * Generated a static worksheet(no formula, no cell binding) base on the current report sheet.
12315
12315
  * @returns {GC.Spread.Sheets.Worksheet} Return the generated worksheet.
@@ -20802,7 +20802,7 @@ declare module GC{
20802
20802
  * sheet.pivotTables.add("pivotTable_1", 'sourceData', 1, 1, layout, theme);
20803
20803
  * ```
20804
20804
  */
20805
- add(name: string, sourceData: string | any[][], row: number, col: number, layout?: GC.Spread.Pivot.PivotTableLayoutType, theme?: string | GC.Spread.Pivot.PivotTableTheme, options?: GC.Spread.Pivot.IPivotTableOption): GC.Spread.Pivot.PivotTable;
20805
+ add(name: string, sourceData: string, row: number, col: number, layout?: GC.Spread.Pivot.PivotTableLayoutType, theme?: string | GC.Spread.Pivot.PivotTableTheme, options?: GC.Spread.Pivot.IPivotTableOption): GC.Spread.Pivot.PivotTable;
20806
20806
  /**
20807
20807
  * @description Get all pivot table in current worksheet.
20808
20808
  * @return {GC.Spread.Pivot.PivotTable[]} return all pivot table in current worksheet.
@@ -30907,6 +30907,15 @@ declare module GC{
30907
30907
  * ```
30908
30908
  */
30909
30909
  toImageSrc(): string;
30910
+ /**
30911
+ * Get the chart Image src of type Base64 string.
30912
+ * @returns {Promise<string>} return the chart Image Base64 src string.
30913
+ * @example
30914
+ * ```
30915
+ * let chartImageSrc = await sheet.charts.all()[0].toImageSrcAsync();
30916
+ * ```
30917
+ */
30918
+ toImageSrcAsync(): Promise<string>;
30910
30919
  /**
30911
30920
  * Gets or sets whether apply animation to the chart.
30912
30921
  * @param {boolean} [value] whether apply animation to the chart.
@@ -48715,6 +48724,15 @@ declare module GC{
48715
48724
  * ```
48716
48725
  */
48717
48726
  toImageSrc(): string;
48727
+ /**
48728
+ * Get the shape Image src of type Base64 string.
48729
+ * @returns {Promise<string>} return the shape Image Base64 src string.
48730
+ * @example
48731
+ * ```
48732
+ * let shapeImageSrc = await sheet.shapes.all()[0].toImageSrcAsync();
48733
+ * ```
48734
+ */
48735
+ toImageSrcAsync(): Promise<string>;
48718
48736
  /**
48719
48737
  * Gets or sets the width of the shape.
48720
48738
  * @param {number | string} value The width of the shape specified by a number or formula (starts with =) can get a number value.
@@ -49160,6 +49178,7 @@ declare module GC{
49160
49178
  allowResize: (value?: boolean, shouldCallback?: boolean) => boolean | ISlicer;
49161
49179
  allowMove: (value?: boolean, shouldCallback?: boolean) => boolean | ISlicer;
49162
49180
  toImageSrc: () => string | ISlicer;
49181
+ toImageSrcAsync: () => Promise<string> | ISlicer;
49163
49182
  }
49164
49183
 
49165
49184
 
@@ -49667,6 +49686,15 @@ declare module GC{
49667
49686
  * ```
49668
49687
  */
49669
49688
  toImageSrc(): string;
49689
+ /**
49690
+ * Get the slicer Image src of type Base64 string.
49691
+ * @returns {Promise<string>} return the slicer Image Base64 src string.
49692
+ * @example
49693
+ * ```
49694
+ * let slicerImageSrc = await sheet.slicers.all()[0].toImageSrcAsync();
49695
+ * ```
49696
+ */
49697
+ toImageSrcAsync(): Promise<string>;
49670
49698
  /**
49671
49699
  * Gets or sets whether to visually distinguish the items with no data.
49672
49700
  * @param {boolean} [value] The setting for items with no data. The visuallyNoDataItems property of a slicer specifies the visual representation or handling of items with no associated data within the slicer.
@@ -50830,6 +50858,15 @@ declare module GC{
50830
50858
  * ```
50831
50859
  */
50832
50860
  toImageSrc(): string;
50861
+ /**
50862
+ * Get the slicer Image src of type Base64 string.
50863
+ * @returns {Promise<string>} return the slicer Image Base64 src string.
50864
+ * @example
50865
+ * ```
50866
+ * let slicerImageSrc = await sheet.slicers.all()[0].toImageSrcAsync();
50867
+ * ```
50868
+ */
50869
+ toImageSrcAsync(): Promise<string>;
50833
50870
  /**
50834
50871
  * Gets or sets the visuallyNoDataItems of the slicer.
50835
50872
  * @param {boolean} [value] The visuallyNoDataItems of the slicer. The visuallyNoDataItems property of a slicer specifies the visual representation or handling of items with no associated data within the slicer control.
@@ -55259,7 +55296,7 @@ declare module GC{
55259
55296
  * @param {GC.Spread.Sheets.Tables.TableColumn[]} columns The array of table column information with data fields and names. Each item is GC.Spread.Sheets.Tables.TableColumn.
55260
55297
  * @param {string} [path] The binding path for binding in the table.
55261
55298
  * @param {object | string | GC.Data.Table} [dataSource] The data source for the table.
55262
- * @returns {GC.Spread.Sheets.Tables.Table} returns the table.
55299
+ * @returns {GC.Spread.Sheets.Tables.Table | Promise<GC.Spread.Sheets.Tables.Table>} returns the table.
55263
55300
  * @example
55264
55301
  * ```
55265
55302
  * var data = {
@@ -55284,7 +55321,7 @@ declare module GC{
55284
55321
  * table.bind([tableColumn1, tableColumn2, tableColumn3, tableColumn4, tableColumn5], 'sales', data);
55285
55322
  * ```
55286
55323
  */
55287
- bind(columns: TableColumn[], path?: string, dataSource?: object | string | GC.Data.Table): GC.Spread.Sheets.Tables.Table;
55324
+ bind(columns: TableColumn[], path?: string, dataSource?: object | string | GC.Data.Table): GC.Spread.Sheets.Tables.Table | Promise<GC.Spread.Sheets.Tables.Table>;
55288
55325
  /**
55289
55326
  * Binds the columns using the specified data fields.
55290
55327
  * @param {GC.Spread.Sheets.Tables.TableColumn[]} columns The array of table column information with data fields and names. Each item is GC.Spread.Sheets.Tables.TableColumn.
@@ -55998,7 +56035,7 @@ declare module GC{
55998
56035
  * @param {object | string | GC.Data.Table} dataSource The data source for the table.
55999
56036
  * @param {GC.Spread.Sheets.Tables.TableTheme} style The style of the table.
56000
56037
  * @param {GC.Spread.Sheets.Tables.ITableOptions} [options] The initialization options of the table.
56001
- * @returns {GC.Spread.Sheets.Tables.Table} The new table instance.
56038
+ * @returns {GC.Spread.Sheets.Tables.Table | Promise<GC.Spread.Sheets.Tables.Table> | undefined} The new table instance.
56002
56039
  * @example
56003
56040
  * ```
56004
56041
  * var source = [
@@ -56010,7 +56047,7 @@ declare module GC{
56010
56047
  * activeSheet.tables.addFromDataSource("Table1", 5, 2, source, GC.Spread.Sheets.Tables.TableThemes.dark1);
56011
56048
  * ```
56012
56049
  */
56013
- addFromDataSource(name: string, row: number, column: number, dataSource: Object | string | GC.Data.Table, style: GC.Spread.Sheets.Tables.TableTheme, options?: GC.Spread.Sheets.Tables.ITableOptions): GC.Spread.Sheets.Tables.Table;
56050
+ addFromDataSource(name: string, row: number, column: number, dataSource: Object | string | GC.Data.Table, style: GC.Spread.Sheets.Tables.TableTheme, options?: GC.Spread.Sheets.Tables.ITableOptions): GC.Spread.Sheets.Tables.Table | Promise<GC.Spread.Sheets.Tables.Table>;
56014
56051
  /**
56015
56052
  * Gets all tables of the sheet.
56016
56053
  * @returns {GC.Spread.Sheets.Tables.Table[]} The GC.Spread.Sheets.Tables.Table array of table instances. The array is never null.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mescius/spread-sheets",
3
- "version": "18.0.0",
3
+ "version": "18.0.2",
4
4
  "main": "index.js",
5
5
  "description":"A Complete Microsoft Excel-like JavaScript Spreadsheet for Enterprise Applications",
6
6
  "scripts": {},