@progress/kendo-react-chart-wizard 8.2.0-develop.38

package/grid-integration/get-wizard-data-from-grid-selection.js

@@ -0,0 +1,8 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./get-grid-selected-rows.js"),r=require("../common/get-wizard-data-from-data-rows.js"),a=e=>r.getWizardDataFromDataRows(t.getGridSelectedRows(e));exports.getWizardDataFromGridSelection=a;

package/grid-integration/get-wizard-data-from-grid-selection.mjs

@@ -0,0 +1,14 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";
+import { getGridSelectedRows as e } from "./get-grid-selected-rows.mjs";
+import { getWizardDataFromDataRows as o } from "../common/get-wizard-data-from-data-rows.mjs";
+const i = (t) => o(e(t));
+export {
+  i as getWizardDataFromGridSelection
+};

package/index.d.mts

@@ -0,0 +1,322 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { Chart } from '@progress/kendo-react-charts';
+import { ChartAreaProps } from '@progress/kendo-react-charts';
+import { ChartCategoryAxisItemProps } from '@progress/kendo-react-charts';
+import { ChartLegendProps } from '@progress/kendo-react-charts';
+import { ChartSeriesItemProps } from '@progress/kendo-react-charts';
+import { ChartSubtitleProps } from '@progress/kendo-react-charts';
+import { ChartTitleProps } from '@progress/kendo-react-charts';
+import { ChartValueAxisItemProps } from '@progress/kendo-react-charts';
+import { ChartXAxisItemProps } from '@progress/kendo-react-charts';
+import { ChartYAxisItemProps } from '@progress/kendo-react-charts';
+import { GridHandle } from '@progress/kendo-react-grid';
+import { ImageExportOptions } from '@progress/kendo-drawing';
+import { PDFOptions } from '@progress/kendo-drawing/pdf';
+import * as React_2 from 'react';
+import { SeriesStack } from '@progress/kendo-react-charts';
+import { SeriesType } from '@progress/kendo-react-charts';
+
+/**
+ * @hidden
+ */
+export declare enum ActionTypes {
+    seriesType = 0,
+    stacked = 1,
+    categoryAxisX = 2,
+    valueAxisY = 3,
+    seriesChange = 4,
+    areaMarginLeft = 5,
+    areaMarginRight = 6,
+    areaMarginTop = 7,
+    areaMarginBottom = 8,
+    areaBackground = 9,
+    titleText = 10,
+    titleFontName = 11,
+    titleFontSize = 12,
+    titleColor = 13,
+    subtitleText = 14,
+    subtitleFontName = 15,
+    subtitleFontSize = 16,
+    subtitleColor = 17,
+    seriesColor = 18,
+    seriesLabel = 19,
+    legendVisible = 20,
+    legendFontName = 21,
+    legendFontSize = 22,
+    legendColor = 23,
+    legendPosition = 24,
+    categoryAxisTitleText = 25,
+    categoryAxisTitleFontName = 26,
+    categoryAxisTitleFontSize = 27,
+    categoryAxisTitleColor = 28,
+    categoryAxisLabelsFontName = 29,
+    categoryAxisLabelsFontSize = 30,
+    categoryAxisLabelsColor = 31,
+    categoryAxisLabelsRotation = 32,
+    categoryAxisReverseOrder = 33,
+    valueAxisTitleText = 34,
+    valueAxisTitleFontName = 35,
+    valueAxisTitleFontSize = 36,
+    valueAxisTitleColor = 37,
+    valueAxisLabelsFormat = 38,
+    valueAxisLabelsFontName = 39,
+    valueAxisLabelsFontSize = 40,
+    valueAxisLabelsColor = 41,
+    valueAxisLabelsRotation = 42
+}
+
+/**
+ * The KendoReact ChartWizard component.
+ */
+export declare const ChartWizard: React_2.FC<ChartWizardProps>;
+
+/**
+ * Describes a single data cell for the Chart Wizard.
+ */
+export declare interface ChartWizardDataCell {
+    /**
+     * The field name of the data cell.
+     */
+    field: string;
+    /**
+     * The value of the data cell.
+     */
+    value: any;
+}
+
+/**
+ * Describes a data row for the Chart Wizard.
+ */
+export declare type ChartWizardDataRow = ChartWizardDataCell[];
+
+/**
+ * The default state of the ChartWizard component.
+ */
+export declare interface ChartWizardDefaultState extends Pick<ChartWizardState, 'stack' | 'seriesType'> {
+}
+
+/**
+ * The props of the KendoReact ChartWizard component.
+ */
+export declare interface ChartWizardProps {
+    /**
+     * The data to be visualized in the ChartWizard component.
+     */
+    data: ChartWizardDataRow[];
+    /**
+     * The event that will be fired when the ChartWizard component is closed.
+     */
+    onClose?: () => void;
+    /**
+     * Fires when the Chart is about to be exported. Can be prevented.
+     */
+    onExport?: (event: ExportEvent) => void;
+    /**
+     * The export options for the ChartWizard component.
+     */
+    exportOptions?: ExportOptions;
+    /**
+     * The default state of the ChartWizard component.
+     */
+    defaultState?: ChartWizardDefaultState;
+}
+
+/**
+ * @hidden
+ */
+export declare interface ChartWizardState {
+    title?: ChartTitleProps;
+    subtitle?: ChartSubtitleProps;
+    area: ChartAreaProps;
+    categoryAxis: ChartCategoryAxisItemProps[];
+    valueAxis: ChartValueAxisItemProps[];
+    series: SeriesItem[];
+    initialSeries: SeriesItem[];
+    xAxis?: ChartXAxisItemProps[];
+    yAxis?: ChartYAxisItemProps[];
+    legend?: ChartLegendProps;
+    columns: string[];
+    data: ChartWizardDataRow[];
+    /**
+     * The series type of the chart.
+     *
+     * The supported series types are:
+     * - `'column'`
+     * - `'bar'`
+     * - `'line'`
+     * - `'pie'`
+     * - `'scatter'`
+     */
+    seriesType?: SeriesType;
+    categoryField?: string;
+    valueField?: string;
+    /**
+     * The stack configuration of the series.
+     */
+    stack?: SeriesStack | false;
+}
+
+/**
+ * @hidden
+ */
+export declare const createInitialState: (data: ChartWizardDataRow[], seriesType: SeriesType, defaultState?: ChartWizardDefaultState) => ChartWizardState;
+
+/**
+ * @hidden
+ */
+export declare const createState: (data: any[], seriesType: SeriesType) => ChartWizardState;
+
+/**
+ * Represents a data column from a grid component or similar.
+ */
+export declare interface DataColumn {
+    field: string;
+    title: string;
+}
+
+/**
+ * Represents a data row from a grid component or similar.
+ */
+export declare interface DataRow {
+    dataItem: any;
+    dataColumns: DataColumn[];
+}
+
+/**
+ * Arguments for the `export` event on the Chart Wizard.
+ */
+export declare class ExportEvent extends PreventableEvent {
+    /**
+     * The export options on the Chart Wizard.
+     */
+    exportOptions: ExportOptions;
+    /**
+     * The current Chart chart instance to be exported.
+     */
+    chart: Chart;
+    constructor(chart: Chart, exportOptions: ExportOptions);
+}
+
+/**
+ * The export options for the Chart Wizard.
+ */
+export declare interface ExportOptions {
+    fileName?: string;
+    pdf?: PDFOptions;
+    image?: ImageExportOptions;
+}
+
+/**
+ * @hidden
+ */
+export declare const fontNames: {
+    text: string;
+    value: string;
+    style: {
+        fontFamily: string;
+    };
+}[];
+
+/**
+ * @hidden
+ */
+export declare const fontSizes: {
+    text: string;
+    value: string;
+}[];
+
+/**
+ * Maps the Grid selectedState to a more general DataRows type to be displayed in the Chart Wizard.
+ *
+ * The selectedKeys can be either row keys or cell keys.
+ *
+ * @returns DataRow array that can be passed to getWizardDataFromDataRows in order to bind the Chart Wizard.
+ */
+export declare function getGridSelectedRows(args: {
+    grid: GridHandle | null;
+    data: any[];
+    selectedState: {
+        [id: string]: boolean | number[];
+    };
+    dataItemKey: string;
+}): DataRow[];
+
+/**
+ * Maps data rows to the Chart Wizard data format.
+ *
+ * @returns collection that can be used as Chart Wizard.
+ */
+export declare function getWizardDataFromDataRows(dataRows: DataRow[]): ChartWizardDataRow[];
+
+/**
+ * Maps the Grid selectedState to data to be displayed in the Chart Wizard.
+ *
+ * Supports both row and cell selection.
+ *
+ * @returns collection that can be used as Chart Wizard.
+ */
+export declare const getWizardDataFromGridSelection: (args: {
+    grid: GridHandle | null;
+    data: any[];
+    selectedState: {
+        [id: string]: boolean | number[];
+    };
+    dataItemKey: string;
+}) => ChartWizardDataRow[];
+
+/**
+ * @hidden
+ */
+export declare const isCategorical: (type?: SeriesType) => boolean | undefined;
+
+/**
+ * @hidden
+ */
+export declare const mergeStates: (state: ChartWizardState, newState: ChartWizardState) => ChartWizardState;
+
+/**
+ * @hidden
+ */
+export declare const parseFont: (font?: string) => {
+    size: string | undefined;
+    name: string | undefined;
+};
+
+/**
+ * @hidden
+ */
+declare abstract class PreventableEvent {
+    private prevented;
+    /**
+     * Prevents the default action for a specified event.
+     * In this way, the source component suppresses the built-in behavior that follows the event.
+     */
+    preventDefault(): void;
+    /**
+     * Returns `true` if the event was prevented by any of its subscribers.
+     *
+     * @returns - Returns `true` if the default action was prevented.
+     * Otherwise, returns `false`.
+     */
+    isDefaultPrevented(): boolean;
+}
+
+/**
+ * @hidden
+ */
+export declare interface SeriesItem extends ChartSeriesItemProps {
+    id: number;
+}
+
+/**
+ * @hidden
+ */
+export declare const updateState: (currentState: ChartWizardState, action: ActionTypes, value: any) => ChartWizardState;
+
+export { }

package/index.d.ts

@@ -0,0 +1,322 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { Chart } from '@progress/kendo-react-charts';
+import { ChartAreaProps } from '@progress/kendo-react-charts';
+import { ChartCategoryAxisItemProps } from '@progress/kendo-react-charts';
+import { ChartLegendProps } from '@progress/kendo-react-charts';
+import { ChartSeriesItemProps } from '@progress/kendo-react-charts';
+import { ChartSubtitleProps } from '@progress/kendo-react-charts';
+import { ChartTitleProps } from '@progress/kendo-react-charts';
+import { ChartValueAxisItemProps } from '@progress/kendo-react-charts';
+import { ChartXAxisItemProps } from '@progress/kendo-react-charts';
+import { ChartYAxisItemProps } from '@progress/kendo-react-charts';
+import { GridHandle } from '@progress/kendo-react-grid';
+import { ImageExportOptions } from '@progress/kendo-drawing';
+import { PDFOptions } from '@progress/kendo-drawing/pdf';
+import * as React_2 from 'react';
+import { SeriesStack } from '@progress/kendo-react-charts';
+import { SeriesType } from '@progress/kendo-react-charts';
+
+/**
+ * @hidden
+ */
+export declare enum ActionTypes {
+    seriesType = 0,
+    stacked = 1,
+    categoryAxisX = 2,
+    valueAxisY = 3,
+    seriesChange = 4,
+    areaMarginLeft = 5,
+    areaMarginRight = 6,
+    areaMarginTop = 7,
+    areaMarginBottom = 8,
+    areaBackground = 9,
+    titleText = 10,
+    titleFontName = 11,
+    titleFontSize = 12,
+    titleColor = 13,
+    subtitleText = 14,
+    subtitleFontName = 15,
+    subtitleFontSize = 16,
+    subtitleColor = 17,
+    seriesColor = 18,
+    seriesLabel = 19,
+    legendVisible = 20,
+    legendFontName = 21,
+    legendFontSize = 22,
+    legendColor = 23,
+    legendPosition = 24,
+    categoryAxisTitleText = 25,
+    categoryAxisTitleFontName = 26,
+    categoryAxisTitleFontSize = 27,
+    categoryAxisTitleColor = 28,
+    categoryAxisLabelsFontName = 29,
+    categoryAxisLabelsFontSize = 30,
+    categoryAxisLabelsColor = 31,
+    categoryAxisLabelsRotation = 32,
+    categoryAxisReverseOrder = 33,
+    valueAxisTitleText = 34,
+    valueAxisTitleFontName = 35,
+    valueAxisTitleFontSize = 36,
+    valueAxisTitleColor = 37,
+    valueAxisLabelsFormat = 38,
+    valueAxisLabelsFontName = 39,
+    valueAxisLabelsFontSize = 40,
+    valueAxisLabelsColor = 41,
+    valueAxisLabelsRotation = 42
+}
+
+/**
+ * The KendoReact ChartWizard component.
+ */
+export declare const ChartWizard: React_2.FC<ChartWizardProps>;
+
+/**
+ * Describes a single data cell for the Chart Wizard.
+ */
+export declare interface ChartWizardDataCell {
+    /**
+     * The field name of the data cell.
+     */
+    field: string;
+    /**
+     * The value of the data cell.
+     */
+    value: any;
+}
+
+/**
+ * Describes a data row for the Chart Wizard.
+ */
+export declare type ChartWizardDataRow = ChartWizardDataCell[];
+
+/**
+ * The default state of the ChartWizard component.
+ */
+export declare interface ChartWizardDefaultState extends Pick<ChartWizardState, 'stack' | 'seriesType'> {
+}
+
+/**
+ * The props of the KendoReact ChartWizard component.
+ */
+export declare interface ChartWizardProps {
+    /**
+     * The data to be visualized in the ChartWizard component.
+     */
+    data: ChartWizardDataRow[];
+    /**
+     * The event that will be fired when the ChartWizard component is closed.
+     */
+    onClose?: () => void;
+    /**
+     * Fires when the Chart is about to be exported. Can be prevented.
+     */
+    onExport?: (event: ExportEvent) => void;
+    /**
+     * The export options for the ChartWizard component.
+     */
+    exportOptions?: ExportOptions;
+    /**
+     * The default state of the ChartWizard component.
+     */
+    defaultState?: ChartWizardDefaultState;
+}
+
+/**
+ * @hidden
+ */
+export declare interface ChartWizardState {
+    title?: ChartTitleProps;
+    subtitle?: ChartSubtitleProps;
+    area: ChartAreaProps;
+    categoryAxis: ChartCategoryAxisItemProps[];
+    valueAxis: ChartValueAxisItemProps[];
+    series: SeriesItem[];
+    initialSeries: SeriesItem[];
+    xAxis?: ChartXAxisItemProps[];
+    yAxis?: ChartYAxisItemProps[];
+    legend?: ChartLegendProps;
+    columns: string[];
+    data: ChartWizardDataRow[];
+    /**
+     * The series type of the chart.
+     *
+     * The supported series types are:
+     * - `'column'`
+     * - `'bar'`
+     * - `'line'`
+     * - `'pie'`
+     * - `'scatter'`
+     */
+    seriesType?: SeriesType;
+    categoryField?: string;
+    valueField?: string;
+    /**
+     * The stack configuration of the series.
+     */
+    stack?: SeriesStack | false;
+}
+
+/**
+ * @hidden
+ */
+export declare const createInitialState: (data: ChartWizardDataRow[], seriesType: SeriesType, defaultState?: ChartWizardDefaultState) => ChartWizardState;
+
+/**
+ * @hidden
+ */
+export declare const createState: (data: any[], seriesType: SeriesType) => ChartWizardState;
+
+/**
+ * Represents a data column from a grid component or similar.
+ */
+export declare interface DataColumn {
+    field: string;
+    title: string;
+}
+
+/**
+ * Represents a data row from a grid component or similar.
+ */
+export declare interface DataRow {
+    dataItem: any;
+    dataColumns: DataColumn[];
+}
+
+/**
+ * Arguments for the `export` event on the Chart Wizard.
+ */
+export declare class ExportEvent extends PreventableEvent {
+    /**
+     * The export options on the Chart Wizard.
+     */
+    exportOptions: ExportOptions;
+    /**
+     * The current Chart chart instance to be exported.
+     */
+    chart: Chart;
+    constructor(chart: Chart, exportOptions: ExportOptions);
+}
+
+/**
+ * The export options for the Chart Wizard.
+ */
+export declare interface ExportOptions {
+    fileName?: string;
+    pdf?: PDFOptions;
+    image?: ImageExportOptions;
+}
+
+/**
+ * @hidden
+ */
+export declare const fontNames: {
+    text: string;
+    value: string;
+    style: {
+        fontFamily: string;
+    };
+}[];
+
+/**
+ * @hidden
+ */
+export declare const fontSizes: {
+    text: string;
+    value: string;
+}[];
+
+/**
+ * Maps the Grid selectedState to a more general DataRows type to be displayed in the Chart Wizard.
+ *
+ * The selectedKeys can be either row keys or cell keys.
+ *
+ * @returns DataRow array that can be passed to getWizardDataFromDataRows in order to bind the Chart Wizard.
+ */
+export declare function getGridSelectedRows(args: {
+    grid: GridHandle | null;
+    data: any[];
+    selectedState: {
+        [id: string]: boolean | number[];
+    };
+    dataItemKey: string;
+}): DataRow[];
+
+/**
+ * Maps data rows to the Chart Wizard data format.
+ *
+ * @returns collection that can be used as Chart Wizard.
+ */
+export declare function getWizardDataFromDataRows(dataRows: DataRow[]): ChartWizardDataRow[];
+
+/**
+ * Maps the Grid selectedState to data to be displayed in the Chart Wizard.
+ *
+ * Supports both row and cell selection.
+ *
+ * @returns collection that can be used as Chart Wizard.
+ */
+export declare const getWizardDataFromGridSelection: (args: {
+    grid: GridHandle | null;
+    data: any[];
+    selectedState: {
+        [id: string]: boolean | number[];
+    };
+    dataItemKey: string;
+}) => ChartWizardDataRow[];
+
+/**
+ * @hidden
+ */
+export declare const isCategorical: (type?: SeriesType) => boolean | undefined;
+
+/**
+ * @hidden
+ */
+export declare const mergeStates: (state: ChartWizardState, newState: ChartWizardState) => ChartWizardState;
+
+/**
+ * @hidden
+ */
+export declare const parseFont: (font?: string) => {
+    size: string | undefined;
+    name: string | undefined;
+};
+
+/**
+ * @hidden
+ */
+declare abstract class PreventableEvent {
+    private prevented;
+    /**
+     * Prevents the default action for a specified event.
+     * In this way, the source component suppresses the built-in behavior that follows the event.
+     */
+    preventDefault(): void;
+    /**
+     * Returns `true` if the event was prevented by any of its subscribers.
+     *
+     * @returns - Returns `true` if the default action was prevented.
+     * Otherwise, returns `false`.
+     */
+    isDefaultPrevented(): boolean;
+}
+
+/**
+ * @hidden
+ */
+export declare interface SeriesItem extends ChartSeriesItemProps {
+    id: number;
+}
+
+/**
+ * @hidden
+ */
+export declare const updateState: (currentState: ChartWizardState, action: ActionTypes, value: any) => ChartWizardState;
+
+export { }

package/index.js

@@ -0,0 +1,8 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("./ChartWizard.js"),e=require("./chart-wizard-state.js"),a=require("./grid-integration/get-grid-selected-rows.js"),r=require("./grid-integration/get-wizard-data-from-grid-selection.js"),i=require("./common/get-wizard-data-from-data-rows.js");exports.ChartWizard=t.ChartWizard;exports.ActionTypes=e.ActionTypes;exports.createInitialState=e.createInitialState;exports.createState=e.createState;exports.fontNames=e.fontNames;exports.fontSizes=e.fontSizes;exports.isCategorical=e.isCategorical;exports.mergeStates=e.mergeStates;exports.parseFont=e.parseFont;exports.updateState=e.updateState;exports.getGridSelectedRows=a.getGridSelectedRows;exports.getWizardDataFromGridSelection=r.getWizardDataFromGridSelection;exports.getWizardDataFromDataRows=i.getWizardDataFromDataRows;

package/index.mjs

@@ -0,0 +1,28 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";
+import { ChartWizard as r } from "./ChartWizard.mjs";
+import { ActionTypes as o, createInitialState as i, createState as m, fontNames as s, fontSizes as p, isCategorical as c, mergeStates as d, parseFont as f, updateState as n } from "./chart-wizard-state.mjs";
+import { getGridSelectedRows as g } from "./grid-integration/get-grid-selected-rows.mjs";
+import { getWizardDataFromGridSelection as x } from "./grid-integration/get-wizard-data-from-grid-selection.mjs";
+import { getWizardDataFromDataRows as D } from "./common/get-wizard-data-from-data-rows.mjs";
+export {
+  o as ActionTypes,
+  r as ChartWizard,
+  i as createInitialState,
+  m as createState,
+  s as fontNames,
+  p as fontSizes,
+  g as getGridSelectedRows,
+  D as getWizardDataFromDataRows,
+  x as getWizardDataFromGridSelection,
+  c as isCategorical,
+  d as mergeStates,
+  f as parseFont,
+  n as updateState
+};