@progress/kendo-angular-chart-wizard 19.1.1-develop.2 → 19.1.2-develop.1

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.
@@ -16,33 +16,35 @@ import * as i0 from "@angular/core";
16
16
  /**
17
17
  * Represents the Kendo UI for Angular Chart Wizard component.
18
18
  *
19
+ * Use this component to create and configure charts with a guided interface.
20
+ *
19
21
  * @example
20
22
  * ```html
21
- * <kendo-chartwizard [data]="data"></kendo-chartwizard>
23
+ * <kendo-chartwizard [data]="data"></kendo-chartwizard>
22
24
  * ```
23
25
  */
24
26
  export declare class ChartWizardComponent implements OnChanges, OnDestroy {
25
27
  private localization;
26
28
  stateService: StateService;
27
29
  /**
28
- * The data to display in the Chart Wizard.
30
+ * Sets the data for the Chart Wizard.
29
31
  */
30
32
  data: ChartWizardDataRow[];
31
33
  /**
32
- * Sets the default state of the Chart Wizard.
34
+ * Sets the initial state for the Chart Wizard.
33
35
  */
34
36
  defaultState: ChartWizardInitialState;
35
37
  /**
36
- * The Chart Wizard export options.
38
+ * Sets the export options for the Chart Wizard.
37
39
  */
38
40
  exportOptions: ExportOptions;
39
41
  /**
40
- * Specifies if the configuration pane is initially collapsed.
42
+ * Specifies whether the configuration pane is collapsed by default.
41
43
  * @default false
42
44
  */
43
45
  collapsedConfigurationPane: boolean;
44
46
  /**
45
- * The settings of the window.
47
+ * Sets the window settings for the Chart Wizard.
46
48
  */
47
49
  windowSettings: WindowSettings;
48
50
  /**
@@ -58,11 +60,11 @@ export declare class ChartWizardComponent implements OnChanges, OnDestroy {
58
60
  */
59
61
  exportDropdownItems: any[];
60
62
  /**
61
- * Fires when the Chart Wizard Window is to be close.
63
+ * Fires when the Chart Wizard window closes.
62
64
  */
63
65
  close: EventEmitter<any>;
64
66
  /**
65
- * Fires when the Chart is about to be exported. The event is preventable.
67
+ * Fires before the chart is exported. Prevent the default to cancel export.
66
68
  */
67
69
  export: EventEmitter<ExportEvent>;
68
70
  get dir(): string;
@@ -9,9 +9,22 @@ import * as i3 from "./localization/custom-messages.component";
9
9
  /**
10
10
  * A [module](link:site.data.urls.angular['ngmoduleapi']) that includes the Chart Wizard component and directives.
11
11
  *
12
- * Imports the ChartWizardModule into your application
13
- * [root module](link:site.data.urls.angular['ngmodules']#angular-modularity) or any other sub-module
14
- * that will use the Chart Wizard component.
12
+ * Use this module to add ChartWizard features to your NgModule-based Angular application.
13
+ *
14
+ * @example
15
+ * ```typescript
16
+ * import { ChartWizardModule } from '@progress/kendo-angular-chart-wizard';
17
+ * import { NgModule } from '@angular/core';
18
+ * import { BrowserModule } from '@angular/platform-browser';
19
+ * import { AppComponent } from './app.component';
20
+ *
21
+ * @NgModule({
22
+ * declarations: [AppComponent],
23
+ * imports: [BrowserModule, ChartWizardModule],
24
+ * bootstrap: [AppComponent]
25
+ * })
26
+ * export class AppModule {}
27
+ * ```
15
28
  */
16
29
  export declare class ChartWizardModule {
17
30
  static ɵfac: i0.ɵɵFactoryDeclaration<ChartWizardModule, never>;
@@ -5,12 +5,31 @@
5
5
  import { ImageExportOptions } from "@progress/kendo-drawing";
6
6
  import { PDFOptions } from "@progress/kendo-drawing/pdf";
7
7
  /**
8
- * The Chart Wizard ExportOptions Interface.
8
+ * Represents the export options for the Chart Wizard.
9
9
  *
10
+ * Use this interface to configure file name, PDF, and image export settings.
11
+ *
12
+ * @example
13
+ * ```typescript
14
+ * const options: ExportOptions = {
15
+ * fileName: 'chart-export',
16
+ * pdf: { paperSize: 'A4' },
17
+ * image: { width: 800, height: 600 }
18
+ * };
19
+ * ```
10
20
  */
11
21
  export interface ExportOptions {
22
+ /**
23
+ * Sets the name of the exported file.
24
+ */
12
25
  fileName?: string;
26
+ /**
27
+ * Configures the PDF export options.
28
+ */
13
29
  pdf?: PDFOptions;
30
+ /**
31
+ * Configures the image export options.
32
+ */
14
33
  image?: ImageExportOptions;
15
34
  }
16
35
  /**
@@ -4,31 +4,43 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { WindowState } from '@progress/kendo-angular-dialog';
6
6
  /**
7
- * The window settings of the Chart Wizard.
7
+ * Represents the window settings for the Chart Wizard.
8
+ *
9
+ * Use this interface to set the size, state, and modality of the Chart Wizard window.
10
+ *
11
+ * @example
12
+ * ```typescript
13
+ * const settings: WindowSettings = {
14
+ * width: 600,
15
+ * height: 400,
16
+ * state: 'default',
17
+ * modal: true
18
+ * };
19
+ * ```
8
20
  */
9
21
  export interface WindowSettings {
10
22
  /**
11
- * Specifies the width of the Window. The width property has to be set in pixels.
23
+ * Sets the width of the window in pixels.
12
24
  */
13
25
  width?: number;
14
26
  /**
15
- * Specifies the height of the Window. The height property has to be set in pixels.
27
+ * Sets the height of the window in pixels.
16
28
  */
17
29
  height?: number;
18
30
  /**
19
- * Specifies the min-width of the Window. The min-width property has to be set in pixels.
31
+ * Sets the minimum width of the window in pixels.
20
32
  */
21
33
  minWidth?: number;
22
34
  /**
23
- * Specifies the min-height of the Window. The min-height property has to be set in pixels.
35
+ * Sets the minimum height of the window in pixels.
24
36
  */
25
37
  minHeight?: number;
26
38
  /**
27
- * Specifies the initial state of the Window.
39
+ * Sets the initial state of the window.
28
40
  */
29
41
  state?: WindowState;
30
42
  /**
31
- * Specifies the modality of the Window.
43
+ * Specifies if the window is modal.
32
44
  */
33
45
  modal?: boolean;
34
46
  }
package/directives.d.ts CHANGED
@@ -6,6 +6,25 @@ import { ChartWizardComponent } from "./chart-wizard.component";
6
6
  import { ChartWizardGridBindingDirective } from "./grid-integration/grid-chart-wizard.directive";
7
7
  import { CustomMessagesComponent } from "./localization/custom-messages.component";
8
8
  /**
9
- * Utility array that contains all `@progress/kendo-angular-chart-wizard` related components and directives.
9
+ * Represents the Kendo UI Chart Wizard utility array that contains all components and directives from the `@progress/kendo-angular-chart-wizard` package.
10
+ *
11
+ * Use this array to import all Chart Wizard-related components and directives into your standalone Angular component.
12
+ *
13
+ * @example
14
+ * ```typescript
15
+ * import { Component } from '@angular/core';
16
+ * import { KENDO_CHARTWIZARD } from '@progress/kendo-angular-chart-wizard';
17
+ *
18
+ * @Component({
19
+ * selector: 'app-my-component',
20
+ * standalone: true,
21
+ * imports: [KENDO_CHARTWIZARD],
22
+ * template: `
23
+ * <kendo-chart-wizard>
24
+ * </kendo-chart-wizard>
25
+ * `
26
+ * })
27
+ * export class MyComponent { }
28
+ * ```
10
29
  */
11
30
  export declare const KENDO_CHARTWIZARD: readonly [typeof ChartWizardComponent, typeof ChartWizardGridBindingDirective, typeof CustomMessagesComponent];
@@ -17,10 +17,6 @@ import { exportPDF } from '@progress/kendo-drawing';
17
17
  import { ChartWizardPropertyPaneDataTabComponent } from './property-pane/data-tab.component';
18
18
  import { ChartWizardPropertyPaneChartTabComponent } from './property-pane/chart-tab.component';
19
19
  import { LegendComponent } from '@progress/kendo-angular-charts';
20
- import { YAxisItemComponent } from '@progress/kendo-angular-charts';
21
- import { YAxisComponent } from '@progress/kendo-angular-charts';
22
- import { XAxisItemComponent } from '@progress/kendo-angular-charts';
23
- import { XAxisComponent } from '@progress/kendo-angular-charts';
24
20
  import { SeriesItemComponent } from '@progress/kendo-angular-charts';
25
21
  import { SeriesComponent } from '@progress/kendo-angular-charts';
26
22
  import { ValueAxisItemComponent } from '@progress/kendo-angular-charts';
@@ -47,33 +43,35 @@ import * as i2 from "./state.service";
47
43
  /**
48
44
  * Represents the Kendo UI for Angular Chart Wizard component.
49
45
  *
46
+ * Use this component to create and configure charts with a guided interface.
47
+ *
50
48
  * @example
51
49
  * ```html
52
- * <kendo-chartwizard [data]="data"></kendo-chartwizard>
50
+ * <kendo-chartwizard [data]="data"></kendo-chartwizard>
53
51
  * ```
54
52
  */
55
53
  export class ChartWizardComponent {
56
54
  localization;
57
55
  stateService;
58
56
  /**
59
- * The data to display in the Chart Wizard.
57
+ * Sets the data for the Chart Wizard.
60
58
  */
61
59
  data;
62
60
  /**
63
- * Sets the default state of the Chart Wizard.
61
+ * Sets the initial state for the Chart Wizard.
64
62
  */
65
63
  defaultState;
66
64
  /**
67
- * The Chart Wizard export options.
65
+ * Sets the export options for the Chart Wizard.
68
66
  */
69
67
  exportOptions;
70
68
  /**
71
- * Specifies if the configuration pane is initially collapsed.
69
+ * Specifies whether the configuration pane is collapsed by default.
72
70
  * @default false
73
71
  */
74
72
  collapsedConfigurationPane = false;
75
73
  /**
76
- * The settings of the window.
74
+ * Sets the window settings for the Chart Wizard.
77
75
  */
78
76
  windowSettings = {};
79
77
  /**
@@ -89,11 +87,11 @@ export class ChartWizardComponent {
89
87
  */
90
88
  exportDropdownItems = [];
91
89
  /**
92
- * Fires when the Chart Wizard Window is to be close.
90
+ * Fires when the Chart Wizard window closes.
93
91
  */
94
92
  close = new EventEmitter();
95
93
  /**
96
- * Fires when the Chart is about to be exported. The event is preventable.
94
+ * Fires before the chart is exported. Prevent the default to cancel export.
97
95
  */
98
96
  export = new EventEmitter();
99
97
  get dir() {
@@ -1173,10 +1171,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1173
1171
  ValueAxisItemComponent,
1174
1172
  SeriesComponent,
1175
1173
  SeriesItemComponent,
1176
- XAxisComponent,
1177
- XAxisItemComponent,
1178
- YAxisComponent,
1179
- YAxisItemComponent,
1180
1174
  LegendComponent,
1181
1175
  TabStripComponent,
1182
1176
  TabStripTabComponent,
@@ -17,9 +17,22 @@ import * as i3 from "./localization/custom-messages.component";
17
17
  /**
18
18
  * A [module](link:site.data.urls.angular['ngmoduleapi']) that includes the Chart Wizard component and directives.
19
19
  *
20
- * Imports the ChartWizardModule into your application
21
- * [root module](link:site.data.urls.angular['ngmodules']#angular-modularity) or any other sub-module
22
- * that will use the Chart Wizard component.
20
+ * Use this module to add ChartWizard features to your NgModule-based Angular application.
21
+ *
22
+ * @example
23
+ * ```typescript
24
+ * import { ChartWizardModule } from '@progress/kendo-angular-chart-wizard';
25
+ * import { NgModule } from '@angular/core';
26
+ * import { BrowserModule } from '@angular/platform-browser';
27
+ * import { AppComponent } from './app.component';
28
+ *
29
+ * @NgModule({
30
+ * declarations: [AppComponent],
31
+ * imports: [BrowserModule, ChartWizardModule],
32
+ * bootstrap: [AppComponent]
33
+ * })
34
+ * export class AppModule {}
35
+ * ```
23
36
  */
24
37
  export class ChartWizardModule {
25
38
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: ChartWizardModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -6,7 +6,26 @@ import { ChartWizardComponent } from "./chart-wizard.component";
6
6
  import { ChartWizardGridBindingDirective } from "./grid-integration/grid-chart-wizard.directive";
7
7
  import { CustomMessagesComponent } from "./localization/custom-messages.component";
8
8
  /**
9
- * Utility array that contains all `@progress/kendo-angular-chart-wizard` related components and directives.
9
+ * Represents the Kendo UI Chart Wizard utility array that contains all components and directives from the `@progress/kendo-angular-chart-wizard` package.
10
+ *
11
+ * Use this array to import all Chart Wizard-related components and directives into your standalone Angular component.
12
+ *
13
+ * @example
14
+ * ```typescript
15
+ * import { Component } from '@angular/core';
16
+ * import { KENDO_CHARTWIZARD } from '@progress/kendo-angular-chart-wizard';
17
+ *
18
+ * @Component({
19
+ * selector: 'app-my-component',
20
+ * standalone: true,
21
+ * imports: [KENDO_CHARTWIZARD],
22
+ * template: `
23
+ * <kendo-chart-wizard>
24
+ * </kendo-chart-wizard>
25
+ * `
26
+ * })
27
+ * export class MyComponent { }
28
+ * ```
10
29
  */
11
30
  export const KENDO_CHARTWIZARD = [
12
31
  ChartWizardComponent,
@@ -4,15 +4,26 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { PreventableEvent } from './preventable-event';
6
6
  /**
7
- * Arguments for the `export` event on the Chart Wizard.
7
+ * Represents the arguments for the `export` event in the Chart Wizard.
8
+ *
9
+ * Use this event to customize the export process or prevent it.
10
+ *
11
+ * @example
12
+ * ```typescript
13
+ * exportEventHandler(event: ExportEvent): void {
14
+ * if (event.exportOptions.fileName === 'restricted') {
15
+ * event.preventDefault();
16
+ * }
17
+ * }
18
+ * ```
8
19
  */
9
20
  export class ExportEvent extends PreventableEvent {
10
21
  /**
11
- * The export options on the Chart Wizard.
22
+ * Defines the export options for the Chart Wizard.
12
23
  */
13
24
  exportOptions;
14
25
  /**
15
- * The current Chart chart instance to be exported.
26
+ * Provides the current `ChartComponent` instance to export.
16
27
  */
17
28
  chart;
18
29
  /**
@@ -5,11 +5,11 @@
5
5
  import { getter } from "@progress/kendo-common";
6
6
  import { isPresent } from "@progress/kendo-angular-common";
7
7
  /**
8
- * Maps the Grid selectedKeys to a more general DataRows type to be displayed in the Chart Wizard.
8
+ * Maps the Grid `selectedKeys` to a general `DataRows` type for the Chart Wizard.
9
9
  *
10
- * The selectedKeys can be either row keys or cell keys.
10
+ * The `selectedKeys` can be row keys or cell keys.
11
11
  *
12
- * @returns DataRow array that can be passed to getWizardDataFromDataRows in order to bind the Chart Wizard.
12
+ * @returns Returns a `DataRow[]` that you can pass to `getWizardDataFromDataRows` to bind the Chart Wizard.
13
13
  */
14
14
  export function getGridSelectedRows(args) {
15
15
  const { grid, data, selectedKeys, selectionKey, columnKey } = args;
@@ -8,19 +8,28 @@ import { getWizardDataFromGridSelection } from "./get-wizard-data-from-grid-sele
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "@progress/kendo-angular-grid";
10
10
  /**
11
- * A directive which binds the Chart Wizard from the selection state of the Grid
12
- * ([see example](slug:grid_integration_with_chart).
11
+ * Binds the Chart Wizard to the selection state of the Grid ([see example](slug:grid_integration_with_chart)).
12
+ *
13
+ * @example
14
+ * ```typescript
15
+ * <kendo-grid
16
+ * [kendoGridBinding]="data"
17
+ * [kendoGridSelectBy]="'id'"
18
+ * kendoChartWizardGridBinding
19
+ * [(chartWizardData)]="wizardData">
20
+ * </kendo-grid>
21
+ * ```
13
22
  */
14
23
  export class ChartWizardGridBindingDirective {
15
24
  grid;
16
25
  /**
17
- * Defines the collection that will store the Chart Wizard data.
26
+ * Stores the Chart Wizard data.
18
27
  *
19
28
  * @default []
20
29
  */
21
30
  chartWizardData = [];
22
31
  /**
23
- * Fires when the `chartWizardData` collection has been updated.
32
+ * Emits when the `chartWizardData` collection updates.
24
33
  */
25
34
  chartWizardDataChange = new EventEmitter();
26
35
  /**
@@ -8,14 +8,15 @@ import { Messages } from './messages';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "@progress/kendo-angular-l10n";
10
10
  /**
11
- * Custom component messages override default component messages.
11
+ * Represents the custom messages component for Chart Wizard.
12
+ *
13
+ * Use this component to override the default messages of the Chart Wizard.
14
+ *
12
15
  * @example
13
16
  * ```html
14
- * <kendo-chartwizard [data]="data">
15
- * <kendo-chartwizard-messages
16
- * windowTitle="Title"
17
- * ></kendo-chartwizard-messages>
18
- * </kendo-chartwizard>
17
+ * <kendo-chartwizard>
18
+ * <kendo-chartwizard-messages windowTitle="Custom Title"></kendo-chartwizard-messages>
19
+ * </kendo-chartwizard>
19
20
  * ```
20
21
  */
21
22
  export class CustomMessagesComponent extends Messages {
@@ -10,7 +10,7 @@ export const packageMetadata = {
10
10
  productName: 'Kendo UI for Angular',
11
11
  productCode: 'KENDOUIANGULAR',
12
12
  productCodes: ['KENDOUIANGULAR'],
13
- publishDate: 1749196936,
14
- version: '19.1.1-develop.2',
13
+ publishDate: 1749804515,
14
+ version: '19.1.2-develop.1',
15
15
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/?utm_medium=product&utm_source=kendoangular&utm_campaign=kendo-ui-angular-purchase-license-keys-warning',
16
16
  };
@@ -6,15 +6,26 @@ import { ChartComponent } from '@progress/kendo-angular-charts';
6
6
  import { PreventableEvent } from './preventable-event';
7
7
  import { ExportOptions } from '../common/models';
8
8
  /**
9
- * Arguments for the `export` event on the Chart Wizard.
9
+ * Represents the arguments for the `export` event in the Chart Wizard.
10
+ *
11
+ * Use this event to customize the export process or prevent it.
12
+ *
13
+ * @example
14
+ * ```typescript
15
+ * exportEventHandler(event: ExportEvent): void {
16
+ * if (event.exportOptions.fileName === 'restricted') {
17
+ * event.preventDefault();
18
+ * }
19
+ * }
20
+ * ```
10
21
  */
11
22
  export declare class ExportEvent extends PreventableEvent {
12
23
  /**
13
- * The export options on the Chart Wizard.
24
+ * Defines the export options for the Chart Wizard.
14
25
  */
15
26
  exportOptions: ExportOptions;
16
27
  /**
17
- * The current Chart chart instance to be exported.
28
+ * Provides the current `ChartComponent` instance to export.
18
29
  */
19
30
  chart: ChartComponent;
20
31
  /**
@@ -11,7 +11,7 @@ import { validatePackage } from '@progress/kendo-licensing';
11
11
  import { Subscription } from 'rxjs';
12
12
  import { ChartWizardCommon } from '@progress/kendo-charts';
13
13
  import { trashIcon, plusIcon, exportIcon, chartBarClusteredIcon, chartBarStackedIcon, chartBarStacked100Icon, chartPieIcon, chartColumnClusteredIcon, chartColumnStackedIcon, chartColumnStacked100Icon, chartLineIcon, chartLineStackedIcon, chartLineStacked100Icon, chartScatterIcon, filePdfIcon, fileIcon, fileImageIcon } from '@progress/kendo-svg-icons';
14
- import { ChartComponent, TitleComponent, SubtitleComponent, ChartAreaComponent, CategoryAxisComponent, CategoryAxisItemComponent, ValueAxisComponent, ValueAxisItemComponent, SeriesComponent, SeriesItemComponent, LegendComponent, XAxisComponent, XAxisItemComponent, YAxisComponent, YAxisItemComponent, ThemeService } from '@progress/kendo-angular-charts';
14
+ import { ChartComponent, TitleComponent, SubtitleComponent, ChartAreaComponent, CategoryAxisComponent, CategoryAxisItemComponent, ValueAxisComponent, ValueAxisItemComponent, SeriesComponent, SeriesItemComponent, LegendComponent, ThemeService } from '@progress/kendo-angular-charts';
15
15
  import { saveAs } from '@progress/kendo-file-saver';
16
16
  import { exportPDF } from '@progress/kendo-drawing';
17
17
  import * as i2 from '@angular/forms';
@@ -37,8 +37,8 @@ const packageMetadata = {
37
37
  productName: 'Kendo UI for Angular',
38
38
  productCode: 'KENDOUIANGULAR',
39
39
  productCodes: ['KENDOUIANGULAR'],
40
- publishDate: 1749196936,
41
- version: '19.1.1-develop.2',
40
+ publishDate: 1749804515,
41
+ version: '19.1.2-develop.1',
42
42
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/?utm_medium=product&utm_source=kendoangular&utm_campaign=kendo-ui-angular-purchase-license-keys-warning',
43
43
  };
44
44
 
@@ -754,15 +754,26 @@ class PreventableEvent {
754
754
  }
755
755
 
756
756
  /**
757
- * Arguments for the `export` event on the Chart Wizard.
757
+ * Represents the arguments for the `export` event in the Chart Wizard.
758
+ *
759
+ * Use this event to customize the export process or prevent it.
760
+ *
761
+ * @example
762
+ * ```typescript
763
+ * exportEventHandler(event: ExportEvent): void {
764
+ * if (event.exportOptions.fileName === 'restricted') {
765
+ * event.preventDefault();
766
+ * }
767
+ * }
768
+ * ```
758
769
  */
759
770
  class ExportEvent extends PreventableEvent {
760
771
  /**
761
- * The export options on the Chart Wizard.
772
+ * Defines the export options for the Chart Wizard.
762
773
  */
763
774
  exportOptions;
764
775
  /**
765
- * The current Chart chart instance to be exported.
776
+ * Provides the current `ChartComponent` instance to export.
766
777
  */
767
778
  chart;
768
779
  /**
@@ -2735,33 +2746,35 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2735
2746
  /**
2736
2747
  * Represents the Kendo UI for Angular Chart Wizard component.
2737
2748
  *
2749
+ * Use this component to create and configure charts with a guided interface.
2750
+ *
2738
2751
  * @example
2739
2752
  * ```html
2740
- * <kendo-chartwizard [data]="data"></kendo-chartwizard>
2753
+ * <kendo-chartwizard [data]="data"></kendo-chartwizard>
2741
2754
  * ```
2742
2755
  */
2743
2756
  class ChartWizardComponent {
2744
2757
  localization;
2745
2758
  stateService;
2746
2759
  /**
2747
- * The data to display in the Chart Wizard.
2760
+ * Sets the data for the Chart Wizard.
2748
2761
  */
2749
2762
  data;
2750
2763
  /**
2751
- * Sets the default state of the Chart Wizard.
2764
+ * Sets the initial state for the Chart Wizard.
2752
2765
  */
2753
2766
  defaultState;
2754
2767
  /**
2755
- * The Chart Wizard export options.
2768
+ * Sets the export options for the Chart Wizard.
2756
2769
  */
2757
2770
  exportOptions;
2758
2771
  /**
2759
- * Specifies if the configuration pane is initially collapsed.
2772
+ * Specifies whether the configuration pane is collapsed by default.
2760
2773
  * @default false
2761
2774
  */
2762
2775
  collapsedConfigurationPane = false;
2763
2776
  /**
2764
- * The settings of the window.
2777
+ * Sets the window settings for the Chart Wizard.
2765
2778
  */
2766
2779
  windowSettings = {};
2767
2780
  /**
@@ -2777,11 +2790,11 @@ class ChartWizardComponent {
2777
2790
  */
2778
2791
  exportDropdownItems = [];
2779
2792
  /**
2780
- * Fires when the Chart Wizard Window is to be close.
2793
+ * Fires when the Chart Wizard window closes.
2781
2794
  */
2782
2795
  close = new EventEmitter();
2783
2796
  /**
2784
- * Fires when the Chart is about to be exported. The event is preventable.
2797
+ * Fires before the chart is exported. Prevent the default to cancel export.
2785
2798
  */
2786
2799
  export = new EventEmitter();
2787
2800
  get dir() {
@@ -3861,10 +3874,6 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3861
3874
  ValueAxisItemComponent,
3862
3875
  SeriesComponent,
3863
3876
  SeriesItemComponent,
3864
- XAxisComponent,
3865
- XAxisItemComponent,
3866
- YAxisComponent,
3867
- YAxisItemComponent,
3868
3877
  LegendComponent,
3869
3878
  TabStripComponent,
3870
3879
  TabStripTabComponent,
@@ -3907,11 +3916,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3907
3916
  const getWizardDataFromDataRows = ChartWizardCommon.getWizardDataFromDataRows;
3908
3917
 
3909
3918
  /**
3910
- * Maps the Grid selectedKeys to a more general DataRows type to be displayed in the Chart Wizard.
3919
+ * Maps the Grid `selectedKeys` to a general `DataRows` type for the Chart Wizard.
3911
3920
  *
3912
- * The selectedKeys can be either row keys or cell keys.
3921
+ * The `selectedKeys` can be row keys or cell keys.
3913
3922
  *
3914
- * @returns DataRow array that can be passed to getWizardDataFromDataRows in order to bind the Chart Wizard.
3923
+ * @returns Returns a `DataRow[]` that you can pass to `getWizardDataFromDataRows` to bind the Chart Wizard.
3915
3924
  */
3916
3925
  function getGridSelectedRows(args) {
3917
3926
  const { grid, data, selectedKeys, selectionKey, columnKey } = args;
@@ -3960,19 +3969,28 @@ function getGridSelectedRows(args) {
3960
3969
  const getWizardDataFromGridSelection = (args) => getWizardDataFromDataRows(getGridSelectedRows(args));
3961
3970
 
3962
3971
  /**
3963
- * A directive which binds the Chart Wizard from the selection state of the Grid
3964
- * ([see example](slug:grid_integration_with_chart).
3972
+ * Binds the Chart Wizard to the selection state of the Grid ([see example](slug:grid_integration_with_chart)).
3973
+ *
3974
+ * @example
3975
+ * ```typescript
3976
+ * <kendo-grid
3977
+ * [kendoGridBinding]="data"
3978
+ * [kendoGridSelectBy]="'id'"
3979
+ * kendoChartWizardGridBinding
3980
+ * [(chartWizardData)]="wizardData">
3981
+ * </kendo-grid>
3982
+ * ```
3965
3983
  */
3966
3984
  class ChartWizardGridBindingDirective {
3967
3985
  grid;
3968
3986
  /**
3969
- * Defines the collection that will store the Chart Wizard data.
3987
+ * Stores the Chart Wizard data.
3970
3988
  *
3971
3989
  * @default []
3972
3990
  */
3973
3991
  chartWizardData = [];
3974
3992
  /**
3975
- * Fires when the `chartWizardData` collection has been updated.
3993
+ * Emits when the `chartWizardData` collection updates.
3976
3994
  */
3977
3995
  chartWizardDataChange = new EventEmitter();
3978
3996
  /**
@@ -4036,14 +4054,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4036
4054
  }] } });
4037
4055
 
4038
4056
  /**
4039
- * Custom component messages override default component messages.
4057
+ * Represents the custom messages component for Chart Wizard.
4058
+ *
4059
+ * Use this component to override the default messages of the Chart Wizard.
4060
+ *
4040
4061
  * @example
4041
4062
  * ```html
4042
- * <kendo-chartwizard [data]="data">
4043
- * <kendo-chartwizard-messages
4044
- * windowTitle="Title"
4045
- * ></kendo-chartwizard-messages>
4046
- * </kendo-chartwizard>
4063
+ * <kendo-chartwizard>
4064
+ * <kendo-chartwizard-messages windowTitle="Custom Title"></kendo-chartwizard-messages>
4065
+ * </kendo-chartwizard>
4047
4066
  * ```
4048
4067
  */
4049
4068
  class CustomMessagesComponent extends Messages {
@@ -4079,7 +4098,26 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4079
4098
  }], ctorParameters: function () { return [{ type: i1.LocalizationService }]; } });
4080
4099
 
4081
4100
  /**
4082
- * Utility array that contains all `@progress/kendo-angular-chart-wizard` related components and directives.
4101
+ * Represents the Kendo UI Chart Wizard utility array that contains all components and directives from the `@progress/kendo-angular-chart-wizard` package.
4102
+ *
4103
+ * Use this array to import all Chart Wizard-related components and directives into your standalone Angular component.
4104
+ *
4105
+ * @example
4106
+ * ```typescript
4107
+ * import { Component } from '@angular/core';
4108
+ * import { KENDO_CHARTWIZARD } from '@progress/kendo-angular-chart-wizard';
4109
+ *
4110
+ * @Component({
4111
+ * selector: 'app-my-component',
4112
+ * standalone: true,
4113
+ * imports: [KENDO_CHARTWIZARD],
4114
+ * template: `
4115
+ * <kendo-chart-wizard>
4116
+ * </kendo-chart-wizard>
4117
+ * `
4118
+ * })
4119
+ * export class MyComponent { }
4120
+ * ```
4083
4121
  */
4084
4122
  const KENDO_CHARTWIZARD = [
4085
4123
  ChartWizardComponent,
@@ -4091,9 +4129,22 @@ const KENDO_CHARTWIZARD = [
4091
4129
  /**
4092
4130
  * A [module](link:site.data.urls.angular['ngmoduleapi']) that includes the Chart Wizard component and directives.
4093
4131
  *
4094
- * Imports the ChartWizardModule into your application
4095
- * [root module](link:site.data.urls.angular['ngmodules']#angular-modularity) or any other sub-module
4096
- * that will use the Chart Wizard component.
4132
+ * Use this module to add ChartWizard features to your NgModule-based Angular application.
4133
+ *
4134
+ * @example
4135
+ * ```typescript
4136
+ * import { ChartWizardModule } from '@progress/kendo-angular-chart-wizard';
4137
+ * import { NgModule } from '@angular/core';
4138
+ * import { BrowserModule } from '@angular/platform-browser';
4139
+ * import { AppComponent } from './app.component';
4140
+ *
4141
+ * @NgModule({
4142
+ * declarations: [AppComponent],
4143
+ * imports: [BrowserModule, ChartWizardModule],
4144
+ * bootstrap: [AppComponent]
4145
+ * })
4146
+ * export class AppModule {}
4147
+ * ```
4097
4148
  */
4098
4149
  class ChartWizardModule {
4099
4150
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: ChartWizardModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
@@ -5,11 +5,11 @@
5
5
  import { GridComponent } from "@progress/kendo-angular-grid";
6
6
  import { DataRow } from "../common";
7
7
  /**
8
- * Maps the Grid selectedKeys to a more general DataRows type to be displayed in the Chart Wizard.
8
+ * Maps the Grid `selectedKeys` to a general `DataRows` type for the Chart Wizard.
9
9
  *
10
- * The selectedKeys can be either row keys or cell keys.
10
+ * The `selectedKeys` can be row keys or cell keys.
11
11
  *
12
- * @returns DataRow array that can be passed to getWizardDataFromDataRows in order to bind the Chart Wizard.
12
+ * @returns Returns a `DataRow[]` that you can pass to `getWizardDataFromDataRows` to bind the Chart Wizard.
13
13
  */
14
14
  export declare function getGridSelectedRows(args: {
15
15
  grid: GridComponent;
@@ -7,19 +7,28 @@ import { GridComponent, RowArgs } from "@progress/kendo-angular-grid";
7
7
  import { ChartWizardDataRow } from "../chart-wizard-state";
8
8
  import * as i0 from "@angular/core";
9
9
  /**
10
- * A directive which binds the Chart Wizard from the selection state of the Grid
11
- * ([see example](slug:grid_integration_with_chart).
10
+ * Binds the Chart Wizard to the selection state of the Grid ([see example](slug:grid_integration_with_chart)).
11
+ *
12
+ * @example
13
+ * ```typescript
14
+ * <kendo-grid
15
+ * [kendoGridBinding]="data"
16
+ * [kendoGridSelectBy]="'id'"
17
+ * kendoChartWizardGridBinding
18
+ * [(chartWizardData)]="wizardData">
19
+ * </kendo-grid>
20
+ * ```
12
21
  */
13
22
  export declare class ChartWizardGridBindingDirective implements OnInit {
14
23
  protected grid: GridComponent;
15
24
  /**
16
- * Defines the collection that will store the Chart Wizard data.
25
+ * Stores the Chart Wizard data.
17
26
  *
18
27
  * @default []
19
28
  */
20
29
  chartWizardData: ChartWizardDataRow[];
21
30
  /**
22
- * Fires when the `chartWizardData` collection has been updated.
31
+ * Emits when the `chartWizardData` collection updates.
23
32
  */
24
33
  chartWizardDataChange: EventEmitter<ChartWizardDataRow[]>;
25
34
  /**
@@ -6,14 +6,15 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
6
6
  import { Messages } from './messages';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Custom component messages override default component messages.
9
+ * Represents the custom messages component for Chart Wizard.
10
+ *
11
+ * Use this component to override the default messages of the Chart Wizard.
12
+ *
10
13
  * @example
11
14
  * ```html
12
- * <kendo-chartwizard [data]="data">
13
- * <kendo-chartwizard-messages
14
- * windowTitle="Title"
15
- * ></kendo-chartwizard-messages>
16
- * </kendo-chartwizard>
15
+ * <kendo-chartwizard>
16
+ * <kendo-chartwizard-messages windowTitle="Custom Title"></kendo-chartwizard-messages>
17
+ * </kendo-chartwizard>
17
18
  * ```
18
19
  */
19
20
  export declare class CustomMessagesComponent extends Messages {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-angular-chart-wizard",
3
- "version": "19.1.1-develop.2",
3
+ "version": "19.1.2-develop.1",
4
4
  "description": "Kendo UI Angular Chart Wizard component",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "author": "Progress",
@@ -20,7 +20,7 @@
20
20
  "package": {
21
21
  "productName": "Kendo UI for Angular",
22
22
  "productCode": "KENDOUIANGULAR",
23
- "publishDate": 1749196936,
23
+ "publishDate": 1749804515,
24
24
  "licensingDocsUrl": "https://www.telerik.com/kendo-angular-ui/my-license/?utm_medium=product&utm_source=kendoangular&utm_campaign=kendo-ui-angular-purchase-license-keys-warning"
25
25
  }
26
26
  },
@@ -29,20 +29,20 @@
29
29
  "@angular/common": "16 - 20",
30
30
  "@angular/core": "16 - 20",
31
31
  "@angular/platform-browser": "16 - 20",
32
- "@progress/kendo-angular-common": "19.1.1-develop.2",
33
- "@progress/kendo-angular-dialog": "19.1.1-develop.2",
34
- "@progress/kendo-angular-buttons": "19.1.1-develop.2",
35
- "@progress/kendo-angular-grid": "19.1.1-develop.2",
36
- "@progress/kendo-angular-charts": "19.1.1-develop.2",
37
- "@progress/kendo-angular-dropdowns": "19.1.1-develop.2",
38
- "@progress/kendo-angular-layout": "19.1.1-develop.2",
39
- "@progress/kendo-angular-icons": "19.1.1-develop.2",
40
- "@progress/kendo-angular-inputs": "19.1.1-develop.2",
41
- "@progress/kendo-angular-label": "19.1.1-develop.2",
42
- "@progress/kendo-angular-intl": "19.1.1-develop.2",
43
- "@progress/kendo-angular-l10n": "19.1.1-develop.2",
44
- "@progress/kendo-angular-navigation": "19.1.1-develop.2",
45
- "@progress/kendo-angular-popup": "19.1.1-develop.2",
32
+ "@progress/kendo-angular-common": "19.1.2-develop.1",
33
+ "@progress/kendo-angular-dialog": "19.1.2-develop.1",
34
+ "@progress/kendo-angular-buttons": "19.1.2-develop.1",
35
+ "@progress/kendo-angular-grid": "19.1.2-develop.1",
36
+ "@progress/kendo-angular-charts": "19.1.2-develop.1",
37
+ "@progress/kendo-angular-dropdowns": "19.1.2-develop.1",
38
+ "@progress/kendo-angular-layout": "19.1.2-develop.1",
39
+ "@progress/kendo-angular-icons": "19.1.2-develop.1",
40
+ "@progress/kendo-angular-inputs": "19.1.2-develop.1",
41
+ "@progress/kendo-angular-label": "19.1.2-develop.1",
42
+ "@progress/kendo-angular-intl": "19.1.2-develop.1",
43
+ "@progress/kendo-angular-l10n": "19.1.2-develop.1",
44
+ "@progress/kendo-angular-navigation": "19.1.2-develop.1",
45
+ "@progress/kendo-angular-popup": "19.1.2-develop.1",
46
46
  "@progress/kendo-drawing": "^1.21.0",
47
47
  "@progress/kendo-file-saver": "^1.1.1",
48
48
  "@progress/kendo-licensing": "^1.5.0",
@@ -51,7 +51,7 @@
51
51
  "dependencies": {
52
52
  "tslib": "^2.3.1",
53
53
  "@progress/kendo-charts": "2.7.2",
54
- "@progress/kendo-angular-schematics": "19.1.1-develop.2",
54
+ "@progress/kendo-angular-schematics": "19.1.2-develop.1",
55
55
  "@progress/kendo-common": "^1.0.1"
56
56
  },
57
57
  "schematics": "./schematics/collection.json",