@progress/kendo-charts 2.4.2 → 2.5.0-dev.202409030746

package/dist/es2015/chart-wizard.js

@@ -0,0 +1,19 @@
+import { getWizardDataFromDataRows } from './chart-wizard/get-wizard-data-from-data-rows';
+import { ActionTypes, createInitialState, createState, fontNames, fontSizes, isCategorical, mergeStates, parseFont, updateState } from './chart-wizard/state';
+import {
+    messages
+} from './chart-wizard/messages';
+
+export const ChartWizardCommon = Object.freeze({
+    getWizardDataFromDataRows,
+    ActionTypes,
+    createInitialState,
+    createState,
+    fontNames,
+    fontSizes,
+    isCategorical,
+    mergeStates,
+    parseFont,
+    updateState,
+    messages
+});

package/dist/es2015/main.js

@@ -9,6 +9,7 @@ export * from './qrcode';
 export * from './map';
 export * from './sankey';
 export * from './common';
+export * from './chart-wizard';
 
 export { baseTheme as chartBaseTheme } from './chart/base-theme';
 

package/dist/npm/chart-wizard.d.ts

@@ -0,0 +1,313 @@
+import { Margin } from './field-types/margin.interface';
+
+/**
+ * Describes a single data cell for the Chart Wizard.
+ */
+export 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 type ChartWizardDataRow = ChartWizardDataCell[];
+
+/**
+ * Represents a data column from a grid component or similar.
+ */
+export interface DataColumn {
+    field: string;
+    title: string;
+}
+
+/**
+ * Represents a data row from a grid component or similar.
+ */
+export interface DataRow {
+    dataItem: any;
+    dataColumns: DataColumn[];
+}
+
+export type ChartWizardSeriesType = 'bar' | 'column' | 'line' | 'pie' | 'scatter';
+
+interface FontInterface {
+    font?: string;
+    color?: string;
+}
+
+export interface ChartWizardTitle extends FontInterface {
+    text?: string;
+}
+
+export interface ChartWizardSeriesStack {
+    type?: 'normal' | '100%';
+}
+
+export interface ChartWizardArea {
+    background?: string;
+    margin?: Margin;
+}
+
+export interface ChartWizardAxisLabel extends FontInterface {
+    rotation?: number | 'auto';
+    format?: string;
+}
+
+interface ChartAxisItem {
+    title?: ChartWizardTitle;
+    labels?: ChartWizardAxisLabel;
+    reverse?: boolean;
+}
+
+export interface ChartWizardCategoryAxisItem extends ChartAxisItem {
+    categories?: any[];
+}
+
+export interface ChartWizardValueAxisItem extends ChartAxisItem { }
+
+export interface ChartWizardLegend {
+    visible?: boolean;
+    position?: 'top' | 'bottom' | 'left' | 'right';
+    labels?: FontInterface;
+}
+
+/**
+ * @hidden
+ */
+export interface ChartWizardSeriesItem {
+    id: number;
+    name?: string;
+    color?: string;
+    type?: ChartWizardSeriesType;
+    data?: any[];
+    stack?: ChartWizardSeriesStack | false;
+    labels?: {
+        visible?: boolean;
+    };
+    categoryField?: string;
+    field?: string;
+    width?: number;
+}
+
+/**
+ * @hidden
+ */
+export interface ChartWizardState {
+    title?: ChartWizardTitle;
+    subtitle?: ChartWizardTitle;
+    area: ChartWizardArea;
+    categoryAxis: ChartWizardCategoryAxisItem[];
+    valueAxis: ChartWizardValueAxisItem[];
+    series: ChartWizardSeriesItem[];
+    initialSeries: ChartWizardSeriesItem[];
+    legend?: ChartWizardLegend;
+    columns: string[];
+    data: ChartWizardDataRow[];
+    /**
+     * The series type of the chart.
+     *
+     * The supported series types are:
+     * - `'column'`
+     * - `'bar'`
+     * - `'line'`
+     * - `'pie'`
+     * - `'scatter'`
+     */
+    seriesType?: ChartWizardSeriesType;
+    categoryField?: string;
+    valueField?: string;
+    /**
+     * The stack configuration of the series.
+     */
+    stack?: ChartWizardSeriesStack | false;
+}
+
+/**
+ * The default state of the ChartWizard component.
+ */
+export interface ChartWizardDefaultState extends Pick<ChartWizardState, 'stack' | 'seriesType'> { }
+
+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
+}
+
+declare const ChartWizardMessages: {
+    readonly windowTitle: string;
+    readonly exportButton: string;
+    readonly exportPDFButton: string;
+    readonly exportSVGButton: string;
+    readonly exportPNGButton: string;
+    readonly tabChart: string;
+    readonly tabData: string;
+    readonly tabFormat: string;
+    readonly barChart: string;
+    readonly barChartBar: string;
+    readonly barChartStackedBar: string;
+    readonly barChart100StackedBar: string;
+    readonly pieChart: string;
+    readonly pieChartPie: string;
+    readonly columnChart: string;
+    readonly columnChartColumn: string;
+    readonly columnChartStackedColumn: string;
+    readonly columnChart100StackedColumn: string;
+    readonly lineChart: string;
+    readonly lineChartLine: string;
+    readonly lineChartStackedLine: string;
+    readonly lineChart100StackedLine: string;
+    readonly scatterChart: string;
+    readonly scatterChartScatter: string;
+    readonly configuration: string;
+    readonly configurationCategoryAxis: string;
+    readonly configurationXAxis: string;
+    readonly configurationValueAxis: string;
+    readonly configurationSeries: string;
+    readonly configurationSeriesAdd: string;
+    readonly formatChartArea: string;
+    readonly formatChartAreaMargins: string;
+    readonly formatChartAreaMarginsAuto: string;
+    readonly formatChartAreaMarginsLeft: string;
+    readonly formatChartAreaMarginsRight: string;
+    readonly formatChartAreaMarginsTop: string;
+    readonly formatChartAreaMarginsBottom: string;
+    readonly formatChartAreaBackground: string;
+    readonly formatChartAreaBackgroundColor: string;
+    readonly formatTitle: string;
+    readonly formatTitleApplyTo: string;
+    readonly formatTitleChartTitle: string;
+    readonly formatTitleChartSubtitle: string;
+    readonly formatTitleLabel: string;
+    readonly formatTitleFont: string;
+    readonly formatTitleFontPlaceholder: string;
+    readonly formatTitleSize: string;
+    readonly formatTitleSizePlaceholder: string;
+    readonly formatTitleColor: string;
+    readonly formatSeries: string;
+    readonly formatSeriesApplyTo: string;
+    readonly formatSeriesAllSeries: string;
+    readonly formatSeriesColor: string;
+    readonly formatSeriesShowLabels: string;
+    readonly formatLegend: string;
+    readonly formatLegendShowLegend: string;
+    readonly formatLegendFont: string;
+    readonly formatLegendFontPlaceholder: string;
+    readonly formatLegendSize: string;
+    readonly formatLegendSizePlaceholder: string;
+    readonly formatLegendColor: string;
+    readonly formatLegendPosition: string;
+    readonly formatLegendPositionTop: string;
+    readonly formatLegendPositionBottom: string;
+    readonly formatLegendPositionLeft: string;
+    readonly formatLegendPositionRight: string;
+    readonly formatCategoryAxis: string;
+    readonly formatXAxis: string;
+    readonly formatCategoryAxisTitle: string;
+    readonly formatCategoryAxisTitlePlaceholder: string;
+    readonly formatCategoryAxisTitleFont: string;
+    readonly formatCategoryAxisTitleFontPlaceholder: string;
+    readonly formatCategoryAxisTitleSize: string;
+    readonly formatCategoryAxisTitleSizePlaceholder: string;
+    readonly formatCategoryAxisTitleColor: string;
+    readonly formatCategoryAxisLabels: string;
+    readonly formatCategoryAxisLabelsFont: string;
+    readonly formatCategoryAxisLabelsFontPlaceholder: string;
+    readonly formatCategoryAxisLabelsSize: string;
+    readonly formatCategoryAxisLabelsSizePlaceholder: string;
+    readonly formatCategoryAxisLabelsColor: string;
+    readonly formatCategoryAxisLabelsRotation: string;
+    readonly formatCategoryAxisLabelsRotationAuto: string;
+    readonly formatCategoryAxisLabelsReverseOrder: string;
+    readonly formatValueAxis: string;
+    readonly formatYAxis: string;
+    readonly formatValueAxisTitle: string;
+    readonly formatValueAxisTitlePlaceholder: string;
+    readonly formatValueAxisTitleFont: string;
+    readonly formatValueAxisTitleFontPlaceholder: string;
+    readonly formatValueAxisTitleSize: string;
+    readonly formatValueAxisTitleSizePlaceholder: string;
+    readonly formatValueAxisTitleColor: string;
+    readonly formatValueAxisLabels: string;
+    readonly formatValueAxisLabelsFormat: string;
+    readonly formatValueAxisLabelsFormatText: string;
+    readonly formatValueAxisLabelsFormatNumber: string;
+    readonly formatValueAxisLabelsFormatCurrency: string;
+    readonly formatValueAxisLabelsFormatPercent: string;
+    readonly formatValueAxisLabelsFont: string;
+    readonly formatValueAxisLabelsFontPlaceholder: string;
+    readonly formatValueAxisLabelsSize: string;
+    readonly formatValueAxisLabelsSizePlaceholder: string;
+    readonly formatValueAxisLabelsColor: string;
+    readonly formatValueAxisLabelsRotation: string;
+    readonly formatValueAxisLabelsRotationAuto: string;
+}
+
+export const ChartWizardCommon: Readonly<{
+    ActionTypes: typeof ActionTypes;
+    messages: typeof ChartWizardMessages;
+
+    fontSizes: { text: string; value: string }[];
+    fontNames: { text: string; value: string;  style: { fontFamily: string }}[];
+
+    isCategorical(seriesType?: ChartWizardSeriesType): boolean;
+    parseFont(font?: string): { name: string; size: string };
+    createInitialState(data: ChartWizardDataRow[], seriesType: ChartWizardSeriesType, defaultState?: ChartWizardDefaultState): ChartWizardState;
+    createState(data: ChartWizardDataRow[], seriesType: ChartWizardSeriesType): ChartWizardState;
+    mergeStates(state: ChartWizardState, newState: ChartWizardState): ChartWizardState;
+    updateState(currentState: ChartWizardState, action: ActionTypes, value: any): ChartWizardState;
+
+    /**
+     * Maps data rows to the Chart Wizard data format.
+     *
+     * @returns collection that can be used as Chart Wizard.
+     */
+    getWizardDataFromDataRows(dataRows: DataRow[]): ChartWizardDataRow[];
+}>;

package/dist/npm/main.d.ts

@@ -11,5 +11,6 @@ export * from './sankey';
 export * from './common';
 export * from './field-types'
 export * from './validation';
+export * from './chart-wizard';
 
 export function chartBaseTheme(): any;