@progress/kendo-react-chart-wizard 12.0.2-develop.1 → 12.0.2-develop.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.
Files changed (4) hide show
  1. package/index.d.mts +63 -24
  2. package/index.d.ts +63 -24
  3. package/package.json +14 -14
  4. package/types/export.mjs +4 -4
package/index.d.mts CHANGED
@@ -43,11 +43,11 @@ export { ChartWizardDataRow }
43
43
  export { ChartWizardDefaultState }
44
44
 
45
45
  /**
46
- * Represents the `ref` object of the `ChartWizard` component.
46
+ * Represents the `ref` object of the ChartWizard component.
47
47
  **/
48
48
  export declare interface ChartWizardHandle {
49
49
  /**
50
- * The Chart instance.
50
+ * Gets the Chart instance.
51
51
  */
52
52
  chart: Chart | null;
53
53
  /**
@@ -65,27 +65,27 @@ export { ChartWizardLegend }
65
65
  */
66
66
  export declare interface ChartWizardProps {
67
67
  /**
68
- * The data to be visualized in the ChartWizard component.
68
+ * Specifies the data you want to display in the ChartWizard component.
69
69
  */
70
70
  data?: ChartWizardDataRow[];
71
71
  /**
72
- * The event that will be fired when the ChartWizard component is closed.
72
+ * Fires when you close the ChartWizard component.
73
73
  */
74
74
  onClose?: () => void;
75
75
  /**
76
- * Fires when the Chart is about to be exported. Can be prevented.
76
+ * Fires when the Chart exports. You can prevent this action.
77
77
  */
78
78
  onExport?: (event: ExportEvent) => void;
79
79
  /**
80
- * The export options for the ChartWizard component.
80
+ * Sets the export options for the ChartWizard component.
81
81
  */
82
82
  exportOptions?: ExportOptions;
83
83
  /**
84
- * The default state of the ChartWizard component.
84
+ * Sets the default state of the ChartWizard component.
85
85
  */
86
86
  defaultState?: ChartWizardDefaultState;
87
87
  /**
88
- * The component that will be used to render the ChartWizard window.
88
+ * Sets the component that renders the ChartWizard window.
89
89
  */
90
90
  window?: React.ComponentType<WindowProps>;
91
91
  /**
@@ -93,7 +93,7 @@ export declare interface ChartWizardProps {
93
93
  */
94
94
  onStateChange?: (state: ChartWizardState) => void;
95
95
  /**
96
- * The state of the ChartWizard component.
96
+ * Controls the state of the ChartWizard component.
97
97
  */
98
98
  state?: ChartWizardState;
99
99
  }
@@ -113,10 +113,10 @@ export { ChartWizardTitle }
113
113
  export { ChartWizardValueAxisItem }
114
114
 
115
115
  /**
116
- * Create a state object from the provided data and series type.
116
+ * Creates a state object from the provided data and series type.
117
117
  *
118
- * @param data - The data to be visualized in the ChartWizard component.
119
- * @param seriesType - The series type of the ChartWizard component.
118
+ * @param data - Specifies the data you want to display in the ChartWizard component.
119
+ * @param seriesType - Sets the series type of the ChartWizard component.
120
120
  * @returns The state object.
121
121
  */
122
122
  export declare const createState: (data: ChartWizardDataRow[], seriesType: ChartWizardSeriesType) => ChartWizardState;
@@ -126,60 +126,99 @@ export { DataColumn }
126
126
  export { DataRow }
127
127
 
128
128
  /**
129
- * Arguments for the `export` event on the Chart Wizard.
129
+ * Provides arguments for the `export` event on the Chart Wizard.
130
130
  */
131
131
  export declare class ExportEvent extends PreventableEvent {
132
132
  /**
133
- * The export options on the Chart Wizard.
133
+ * Gets the export options on the Chart Wizard.
134
134
  */
135
135
  exportOptions: ExportOptions;
136
136
  /**
137
- * The current Chart chart instance to be exported.
137
+ * Gets the current Chart chart instance you want to export.
138
138
  */
139
139
  chart: Chart;
140
140
  constructor(chart: Chart, exportOptions: ExportOptions);
141
141
  }
142
142
 
143
143
  /**
144
- * The export options for the Chart Wizard.
144
+ * Sets the export options for the Chart Wizard.
145
145
  */
146
146
  export declare interface ExportOptions {
147
+ /**
148
+ * Sets the filename for exported files.
149
+ *
150
+ * @default 'chart'
151
+ */
147
152
  fileName?: string;
153
+ /**
154
+ * Configures PDF export options.
155
+ *
156
+ * @default { paperSize: 'A4', margin: '1cm' }
157
+ */
148
158
  pdf?: PDFOptions;
159
+ /**
160
+ * Configures image export options.
161
+ *
162
+ * @default { width: 800, height: 600 }
163
+ */
149
164
  image?: ImageExportOptions;
150
165
  }
151
166
 
152
167
  /**
153
- * Maps the Grid selectedState to a more general DataRows type to be displayed in the Chart Wizard.
168
+ * Maps the Grid selectedState to a more general DataRows type you can display in the Chart Wizard.
154
169
  *
155
170
  * The selectedKeys can be either row keys or cell keys.
156
171
  *
157
- * @returns DataRow array that can be passed to getWizardDataFromDataRows in order to bind the Chart Wizard.
172
+ * @returns DataRow array that you can pass to `getWizardDataFromDataRows` to bind the Chart Wizard.
158
173
  */
159
174
  export declare function getGridSelectedRows(args: {
175
+ /**
176
+ * Specifies the Grid handle instance.
177
+ */
160
178
  grid: GridHandle | null;
179
+ /**
180
+ * Sets the data array from the Grid.
181
+ */
161
182
  data: any[];
183
+ /**
184
+ * Configures the current selection state.
185
+ */
162
186
  selectedState: {
163
187
  [id: string]: boolean | number[];
164
188
  };
189
+ /**
190
+ * Sets the key property for identifying data items.
191
+ */
165
192
  dataItemKey: string;
166
193
  }): DataRow[];
167
194
 
168
195
  export declare const getWizardDataFromDataRows: (dataRows: DataRow[]) => ChartWizardDataRow[];
169
196
 
170
197
  /**
171
- * Maps the Grid selectedState to data to be displayed in the Chart Wizard.
198
+ * Maps the Grid selectedState to data you can display in the Chart Wizard.
172
199
  *
173
200
  * Supports both row and cell selection.
174
201
  *
175
- * @returns collection that can be used as Chart Wizard.
202
+ * @returns A collection that you can use as Chart Wizard data.
176
203
  */
177
204
  export declare const getWizardDataFromGridSelection: (args: {
205
+ /**
206
+ * Specifies the Grid handle instance.
207
+ */
178
208
  grid: GridHandle | null;
209
+ /**
210
+ * Sets the data array from the Grid.
211
+ */
179
212
  data: any[];
213
+ /**
214
+ * Configures the current selection state.
215
+ */
180
216
  selectedState: {
181
217
  [id: string]: boolean | number[];
182
218
  };
219
+ /**
220
+ * Sets the key property for identifying data items.
221
+ */
183
222
  dataItemKey: string;
184
223
  }) => ChartWizardDataRow[];
185
224
 
@@ -189,14 +228,14 @@ export declare const getWizardDataFromGridSelection: (args: {
189
228
  declare abstract class PreventableEvent {
190
229
  private prevented;
191
230
  /**
192
- * Prevents the default action for a specified event.
193
- * In this way, the source component suppresses the built-in behavior that follows the event.
231
+ * Prevents the default action for a specific event.
232
+ * This action stops the source component from executing its built-in behavior that follows the event.
194
233
  */
195
234
  preventDefault(): void;
196
235
  /**
197
- * Returns `true` if the event was prevented by any of its subscribers.
236
+ * Returns `true` if any of the event subscribers prevented the event.
198
237
  *
199
- * @returns - Returns `true` if the default action was prevented.
238
+ * @returns - Returns `true` if you prevented the default action.
200
239
  * Otherwise, returns `false`.
201
240
  */
202
241
  isDefaultPrevented(): boolean;
package/index.d.ts CHANGED
@@ -43,11 +43,11 @@ export { ChartWizardDataRow }
43
43
  export { ChartWizardDefaultState }
44
44
 
45
45
  /**
46
- * Represents the `ref` object of the `ChartWizard` component.
46
+ * Represents the `ref` object of the ChartWizard component.
47
47
  **/
48
48
  export declare interface ChartWizardHandle {
49
49
  /**
50
- * The Chart instance.
50
+ * Gets the Chart instance.
51
51
  */
52
52
  chart: Chart | null;
53
53
  /**
@@ -65,27 +65,27 @@ export { ChartWizardLegend }
65
65
  */
66
66
  export declare interface ChartWizardProps {
67
67
  /**
68
- * The data to be visualized in the ChartWizard component.
68
+ * Specifies the data you want to display in the ChartWizard component.
69
69
  */
70
70
  data?: ChartWizardDataRow[];
71
71
  /**
72
- * The event that will be fired when the ChartWizard component is closed.
72
+ * Fires when you close the ChartWizard component.
73
73
  */
74
74
  onClose?: () => void;
75
75
  /**
76
- * Fires when the Chart is about to be exported. Can be prevented.
76
+ * Fires when the Chart exports. You can prevent this action.
77
77
  */
78
78
  onExport?: (event: ExportEvent) => void;
79
79
  /**
80
- * The export options for the ChartWizard component.
80
+ * Sets the export options for the ChartWizard component.
81
81
  */
82
82
  exportOptions?: ExportOptions;
83
83
  /**
84
- * The default state of the ChartWizard component.
84
+ * Sets the default state of the ChartWizard component.
85
85
  */
86
86
  defaultState?: ChartWizardDefaultState;
87
87
  /**
88
- * The component that will be used to render the ChartWizard window.
88
+ * Sets the component that renders the ChartWizard window.
89
89
  */
90
90
  window?: React.ComponentType<WindowProps>;
91
91
  /**
@@ -93,7 +93,7 @@ export declare interface ChartWizardProps {
93
93
  */
94
94
  onStateChange?: (state: ChartWizardState) => void;
95
95
  /**
96
- * The state of the ChartWizard component.
96
+ * Controls the state of the ChartWizard component.
97
97
  */
98
98
  state?: ChartWizardState;
99
99
  }
@@ -113,10 +113,10 @@ export { ChartWizardTitle }
113
113
  export { ChartWizardValueAxisItem }
114
114
 
115
115
  /**
116
- * Create a state object from the provided data and series type.
116
+ * Creates a state object from the provided data and series type.
117
117
  *
118
- * @param data - The data to be visualized in the ChartWizard component.
119
- * @param seriesType - The series type of the ChartWizard component.
118
+ * @param data - Specifies the data you want to display in the ChartWizard component.
119
+ * @param seriesType - Sets the series type of the ChartWizard component.
120
120
  * @returns The state object.
121
121
  */
122
122
  export declare const createState: (data: ChartWizardDataRow[], seriesType: ChartWizardSeriesType) => ChartWizardState;
@@ -126,60 +126,99 @@ export { DataColumn }
126
126
  export { DataRow }
127
127
 
128
128
  /**
129
- * Arguments for the `export` event on the Chart Wizard.
129
+ * Provides arguments for the `export` event on the Chart Wizard.
130
130
  */
131
131
  export declare class ExportEvent extends PreventableEvent {
132
132
  /**
133
- * The export options on the Chart Wizard.
133
+ * Gets the export options on the Chart Wizard.
134
134
  */
135
135
  exportOptions: ExportOptions;
136
136
  /**
137
- * The current Chart chart instance to be exported.
137
+ * Gets the current Chart chart instance you want to export.
138
138
  */
139
139
  chart: Chart;
140
140
  constructor(chart: Chart, exportOptions: ExportOptions);
141
141
  }
142
142
 
143
143
  /**
144
- * The export options for the Chart Wizard.
144
+ * Sets the export options for the Chart Wizard.
145
145
  */
146
146
  export declare interface ExportOptions {
147
+ /**
148
+ * Sets the filename for exported files.
149
+ *
150
+ * @default 'chart'
151
+ */
147
152
  fileName?: string;
153
+ /**
154
+ * Configures PDF export options.
155
+ *
156
+ * @default { paperSize: 'A4', margin: '1cm' }
157
+ */
148
158
  pdf?: PDFOptions;
159
+ /**
160
+ * Configures image export options.
161
+ *
162
+ * @default { width: 800, height: 600 }
163
+ */
149
164
  image?: ImageExportOptions;
150
165
  }
151
166
 
152
167
  /**
153
- * Maps the Grid selectedState to a more general DataRows type to be displayed in the Chart Wizard.
168
+ * Maps the Grid selectedState to a more general DataRows type you can display in the Chart Wizard.
154
169
  *
155
170
  * The selectedKeys can be either row keys or cell keys.
156
171
  *
157
- * @returns DataRow array that can be passed to getWizardDataFromDataRows in order to bind the Chart Wizard.
172
+ * @returns DataRow array that you can pass to `getWizardDataFromDataRows` to bind the Chart Wizard.
158
173
  */
159
174
  export declare function getGridSelectedRows(args: {
175
+ /**
176
+ * Specifies the Grid handle instance.
177
+ */
160
178
  grid: GridHandle | null;
179
+ /**
180
+ * Sets the data array from the Grid.
181
+ */
161
182
  data: any[];
183
+ /**
184
+ * Configures the current selection state.
185
+ */
162
186
  selectedState: {
163
187
  [id: string]: boolean | number[];
164
188
  };
189
+ /**
190
+ * Sets the key property for identifying data items.
191
+ */
165
192
  dataItemKey: string;
166
193
  }): DataRow[];
167
194
 
168
195
  export declare const getWizardDataFromDataRows: (dataRows: DataRow[]) => ChartWizardDataRow[];
169
196
 
170
197
  /**
171
- * Maps the Grid selectedState to data to be displayed in the Chart Wizard.
198
+ * Maps the Grid selectedState to data you can display in the Chart Wizard.
172
199
  *
173
200
  * Supports both row and cell selection.
174
201
  *
175
- * @returns collection that can be used as Chart Wizard.
202
+ * @returns A collection that you can use as Chart Wizard data.
176
203
  */
177
204
  export declare const getWizardDataFromGridSelection: (args: {
205
+ /**
206
+ * Specifies the Grid handle instance.
207
+ */
178
208
  grid: GridHandle | null;
209
+ /**
210
+ * Sets the data array from the Grid.
211
+ */
179
212
  data: any[];
213
+ /**
214
+ * Configures the current selection state.
215
+ */
180
216
  selectedState: {
181
217
  [id: string]: boolean | number[];
182
218
  };
219
+ /**
220
+ * Sets the key property for identifying data items.
221
+ */
183
222
  dataItemKey: string;
184
223
  }) => ChartWizardDataRow[];
185
224
 
@@ -189,14 +228,14 @@ export declare const getWizardDataFromGridSelection: (args: {
189
228
  declare abstract class PreventableEvent {
190
229
  private prevented;
191
230
  /**
192
- * Prevents the default action for a specified event.
193
- * In this way, the source component suppresses the built-in behavior that follows the event.
231
+ * Prevents the default action for a specific event.
232
+ * This action stops the source component from executing its built-in behavior that follows the event.
194
233
  */
195
234
  preventDefault(): void;
196
235
  /**
197
- * Returns `true` if the event was prevented by any of its subscribers.
236
+ * Returns `true` if any of the event subscribers prevented the event.
198
237
  *
199
- * @returns - Returns `true` if the default action was prevented.
238
+ * @returns - Returns `true` if you prevented the default action.
200
239
  * Otherwise, returns `false`.
201
240
  */
202
241
  isDefaultPrevented(): boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-react-chart-wizard",
3
- "version": "12.0.2-develop.1",
3
+ "version": "12.0.2-develop.2",
4
4
  "description": "React Chart Wizard lets you create a chart using data from a Grid, another data-bound component, or an external source",
5
5
  "author": "Progress",
6
6
  "license": "SEE LICENSE IN LICENSE.md",
@@ -21,19 +21,19 @@
21
21
  "@progress/kendo-drawing": "^1.21.2",
22
22
  "@progress/kendo-file-saver": "^1.0.1",
23
23
  "@progress/kendo-licensing": "^1.7.0",
24
- "@progress/kendo-react-animation": "12.0.2-develop.1",
25
- "@progress/kendo-react-buttons": "12.0.2-develop.1",
26
- "@progress/kendo-react-charts": "12.0.2-develop.1",
27
- "@progress/kendo-react-common": "12.0.2-develop.1",
28
- "@progress/kendo-react-dialogs": "12.0.2-develop.1",
29
- "@progress/kendo-react-form": "12.0.2-develop.1",
30
- "@progress/kendo-react-dropdowns": "12.0.2-develop.1",
31
- "@progress/kendo-react-grid": "12.0.2-develop.1",
32
- "@progress/kendo-react-inputs": "12.0.2-develop.1",
33
- "@progress/kendo-react-intl": "12.0.2-develop.1",
34
- "@progress/kendo-react-labels": "12.0.2-develop.1",
35
- "@progress/kendo-react-layout": "12.0.2-develop.1",
36
- "@progress/kendo-react-popup": "12.0.2-develop.1",
24
+ "@progress/kendo-react-animation": "12.0.2-develop.2",
25
+ "@progress/kendo-react-buttons": "12.0.2-develop.2",
26
+ "@progress/kendo-react-charts": "12.0.2-develop.2",
27
+ "@progress/kendo-react-common": "12.0.2-develop.2",
28
+ "@progress/kendo-react-dialogs": "12.0.2-develop.2",
29
+ "@progress/kendo-react-form": "12.0.2-develop.2",
30
+ "@progress/kendo-react-dropdowns": "12.0.2-develop.2",
31
+ "@progress/kendo-react-grid": "12.0.2-develop.2",
32
+ "@progress/kendo-react-inputs": "12.0.2-develop.2",
33
+ "@progress/kendo-react-intl": "12.0.2-develop.2",
34
+ "@progress/kendo-react-labels": "12.0.2-develop.2",
35
+ "@progress/kendo-react-layout": "12.0.2-develop.2",
36
+ "@progress/kendo-react-popup": "12.0.2-develop.2",
37
37
  "@progress/kendo-svg-icons": "^4.0.0",
38
38
  "react": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
39
39
  "react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc"
package/types/export.mjs CHANGED
@@ -11,16 +11,16 @@ class s {
11
11
  }
12
12
  /* eslint-disable max-len */
13
13
  /**
14
- * Prevents the default action for a specified event.
15
- * In this way, the source component suppresses the built-in behavior that follows the event.
14
+ * Prevents the default action for a specific event.
15
+ * This action stops the source component from executing its built-in behavior that follows the event.
16
16
  */
17
17
  preventDefault() {
18
18
  this.prevented = !0;
19
19
  }
20
20
  /**
21
- * Returns `true` if the event was prevented by any of its subscribers.
21
+ * Returns `true` if any of the event subscribers prevented the event.
22
22
  *
23
- * @returns - Returns `true` if the default action was prevented.
23
+ * @returns - Returns `true` if you prevented the default action.
24
24
  * Otherwise, returns `false`.
25
25
  */
26
26
  isDefaultPrevented() {