@progress/kendo-charts 2.12.3-develop.4 → 2.13.0-develop.2

package/dist/npm/option-types/series-defaults/tooltip.interface.d.ts

@@ -0,0 +1,54 @@
+import { Border, Padding } from '../../property-types';
+
+/**
+ * Represents the configuration options of the series tooltip.
+ */
+export interface SeriesDefaultsTooltip {
+
+  /**
+   * Specifies the background color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border configuration options.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the text color of the tooltip. Accepts a valid CSS color string, including hex and rgb.
+   */
+  color?: string;
+
+  /**
+   * Specifies the tooltip font.
+   */
+  font?: string;
+
+  /**
+   * Specifies the format of the labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
+   *
+   * Area, Bar, Column, Funnel, Pyramid, Line, and Pie charts are represented by `{0}` as the value placeholder.
+   *
+   * Bubble chart type uses the following value placeholders: `{0}` - x value, `{1}` - y value, `{2}` - size value, and `{3}` - category name.
+   *
+   * Scatter and ScatterLine chart types use the following value placeholders: `{0}` - x value and `{1}` - y value.
+   *
+   * Candlestick and OHLC chart types use the following value placeholders: `{0}` - open value, `{1}` - high value, `{2}` - low value, `{3}` - close value, and `{4}` - category name.
+   *
+   * RangeArea, RangeBar, and RangeColumn chart types utilize the following value placeholders: `{0}` - from value and `{1}` - to value.
+   *
+   */
+  format?: string;
+
+  /**
+   * Specifies the padding of the tooltip. A numeric value sets all paddings.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Determines whether the Chart displays the series tooltip.
+   * When set to `true`, the tooltip is visible. By default, the series tooltip is not displayed.
+   */
+  visible?: boolean;
+}

package/dist/npm/option-types/series-defaults.interface.d.ts

@@ -0,0 +1,218 @@
+import { drawing } from '@progress/kendo-drawing';
+import { Border, FocusHighlight, Overlay, SeriesHighlight, SeriesStack, SeriesType, SeriesVisualArgs } from '../property-types';
+import { Series } from '../option-types/series-item.interface';
+import { SeriesDefaultsLabels } from './series-defaults/labels.interface';
+import { SeriesDefaultsNotes } from './series-defaults/notes.interface';
+import { SeriesDefaultsTooltip } from './series-defaults/tooltip.interface';
+
+/**
+ * Represents the configuration options of the series.
+ */
+export interface SeriesDefaults {
+
+  /**
+   * Default settings for area series.
+   */
+  area?: Series;
+
+  /**
+   * Default settings for bar series.
+   */
+  bar?: Series;
+
+  /**
+   * Default settings for bubble series.
+   */
+  bubble?: Series;
+
+  /**
+   * Default settings for bullet series.
+   */
+  bullet?: Series;
+
+  /**
+   * Default settings for candlestick series.
+   */
+  candlestick?: Series;
+
+  /**
+   * Default settings for column series.
+   */
+  column?: Series;
+
+  /**
+   * Default settings for donut series.
+   */
+  donut?: Series;
+
+  /**
+   * Default settings for funnel series.
+   */
+  funnel?: Series;
+
+  /**
+   * Default settings for pyramid series.
+   */
+  pyramid?: Series;
+
+  /**
+   * Default settings for line series.
+   */
+  line?: Series;
+
+  /**
+   * Default settings for ohlc series.
+   */
+  ohlc?: Series;
+
+  /**
+   * Default settings for pie series.
+   */
+  pie?: Series;
+
+  /**
+   * Default settings for polarArea series.
+   */
+  polarArea?: Series;
+
+  /**
+   * Default settings for polarLine series.
+   */
+  polarLine?: Series;
+
+  /**
+   * Default settings for polarScatter series.
+   */
+  polarScatter?: Series;
+
+  /**
+   * Default settings for radarArea series.
+   */
+  radarArea?: Series;
+
+  /**
+   * Default settings for radarColumn series.
+   */
+  radarColumn?: Series;
+
+  /**
+   * Default settings for radarLine series.
+   */
+  radarLine?: Series;
+
+  /**
+   * Default settings for rangeArea series.
+   */
+  rangeArea?: Series;
+
+  /**
+   * Default settings for rangeBar series.
+   */
+  rangeBar?: Series;
+
+  /**
+   * Default settings for rangeColumn series.
+   */
+  rangeColumn?: Series;
+
+  /**
+   * Default settings for scatter series.
+   */
+  scatter?: Series;
+
+  /**
+   * Default settings for scatterLine series.
+   */
+  scatterLine?: Series;
+
+  /**
+   * Default settings for verticalArea series.
+   */
+  verticalArea?: Series;
+
+  /**
+   * Default settings for verticalBullet series.
+   */
+  verticalBullet?: Series;
+
+  /**
+   * Default settings for verticalLine series.
+   */
+  verticalLine?: Series;
+
+  /**
+   * Default settings for verticalRangeArea series.
+   */
+  verticalRangeArea?: Series;
+
+  /**
+   * Default settings for waterfall series.
+   */
+  waterfall?: Series;
+
+  /**
+   * Specifies the border of the series.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the distance between category clusters.
+   */
+  gap?: number;
+
+  /**
+   * Specifies the default highlight configuration.
+   */
+  highlight?: SeriesHighlight;
+
+  /**
+   * Specifies the Chart series overlay options.
+   */
+  overlay?: Overlay;
+
+  /**
+   * Specifies the space between the Chart series as a proportion of the series width.
+   * The `spacing` option is supported when [`series.type`]({% slug api_charts_series %}#type) is set to `"bar"`, `"column"`, `"candlestick"`, `"ohlc"`,
+   * and `"waterfall"`.
+   */
+  spacing?: number;
+
+  /**
+   * Determines whether the series has to be stacked.
+   * This option is supported when [`series.type`]({% slug api_charts_series %}#type) is set to `"bar"`, `"column"`, `"line"`, `"area"`,
+   * `"verticalLine"`, `"verticalArea"`, `"radarLine"`, `"radarArea"`, and `"radarColumn"`.
+   */
+  stack?: boolean | string | SeriesStack;
+
+  /**
+   * Specifies the default type of the series.
+   */
+  type?: SeriesType;
+
+  /**
+   * Specifies a function for creating custom visuals for the points.
+   * Applicable for the Bar and Column series.
+   */
+  visual?: (e: SeriesVisualArgs) => drawing.Element;
+
+  /**
+   * Specifies the label configuration of the Chart series.
+   * Displays the series labels when the [`seriesDefaults.labels.visible`]({% slug api_charts_seriesdefaultslabels %}#visible) option is set to `true`.
+   */
+  labels?: SeriesDefaultsLabels;
+
+  /**
+   * Specifies the `seriesDefaults` notes configuration.
+   */
+  notes?: SeriesDefaultsNotes;
+
+  /**
+   * Specifies the configuration options of the Chart series tooltip.
+   */
+  tooltip?: SeriesDefaultsTooltip;
+
+  /**
+   * Specifies the focus highlight configuration options.
+   */
+  focusHighlight?: FocusHighlight;
+}

package/dist/npm/option-types/series-item/error-bars.interface.d.ts

@@ -0,0 +1,60 @@
+import { drawing } from '@progress/kendo-drawing';
+import { ErrorBarLine, ErrorBarsValueArgs, ErrorBarsVisualArgs } from '../../property-types';
+
+/**
+ * Represents the configuration options of the series error bars.
+ */
+export interface SeriesErrorBars {
+
+  /**
+   * Specifies the color of the error bars. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * If set to `false`, the caps of the error bars are not displayed. By default, the caps are visible.
+   */
+  endCaps?: boolean;
+
+  /**
+   * Specifies the error bars line options.
+   */
+  line?: ErrorBarLine;
+
+  /**
+   * Specifies the error bars value.
+   * Supports the value option when `series.type` is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
+   *
+   * Supports the following value types:
+   *
+   * - `"stderr"`—The standard error of the series values will be used to calculate the point low and
+   * high values.
+   * - `"stddev(n)"`—The standard deviation of the series values will be used to calculate the point low
+   * and high values. Between the parentheses, a number can be specified that will be multiplied by the
+   * calculated standard deviation.
+   * - `"percentage(n)"`—A percentage of the point value.
+   * - A number that will be subtracted or added to the point value.
+   * - An array that holds the low and high difference from the point value.
+   * - A function that returns the `errorBars` point value.
+   */
+  value?: string | number | [number, number] | ((e: ErrorBarsValueArgs) => [number, number]);
+
+  /**
+   * Specifies a function for creating custom visuals for the error bars.
+   */
+  visual?: (e: ErrorBarsVisualArgs) => drawing.Element;
+
+  /**
+   * Specifies the value of the `xAxis` error bars. For a list of the supported value
+   * types, refer to the `series.errorBars.value` option.
+   * Supports the `xValue` option when `series.type` is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
+   */
+  xValue?: string;
+
+  /**
+   * Specifies the value of the `yAxis` error bars. For a list of supported value types, refer
+   * to the `series.errorBars.value` option.
+   * Supports the `yValue` option when `series.type` is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
+   */
+  yValue?: string;
+}

package/dist/npm/option-types/series-item/extremes.interface.d.ts

@@ -0,0 +1,32 @@
+import { Border, MarkerType } from '../../property-types';
+
+/**
+ * Represents the configuration options of the series extremes.
+ */
+export interface SeriesExtremes {
+
+  /**
+   * Sets the background color of the series extremes.
+   */
+  background?: string;
+
+  /**
+   * Configures the border of the extremes.
+   */
+  border?: Border;
+
+  /**
+   * Sets the rotation angle of the extremes.
+   */
+  rotation?: number;
+
+  /**
+   * Sets the extremes size in pixels.
+   */
+  size?: number;
+
+  /**
+   * Sets the shape of the series extremes.
+   */
+  type?: MarkerType;
+}

package/dist/npm/option-types/series-item/highlight.interface.d.ts

@@ -0,0 +1,64 @@
+import { drawing } from '@progress/kendo-drawing';
+import { Border, HighlightLine, HighlightVisualArgs, HighlightToggleArgs } from '../../property-types';
+import { MarkersHighlight } from './markers-highlight.interface';
+
+/**
+ * Represents the configuration options of the series highlight.
+ */
+export interface SeriesHighlight {
+
+  /**
+   * Specifies the border of the highlighted Chart series.
+   * Computes the color automatically from the base point color.
+   * This option is supported when `series.type` is set to
+   * `"donut"`, `"bubble"`, `"pie"`, `"candlestick"`, or `"ohlc"`.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the highlight color. Accepts a valid CSS color string, including HEX and RGB.
+   * This option is supported when `series.type` is set to `"donut"` or `"pie"`.
+   */
+  color?: string;
+
+  /**
+   * Specifies the line of the highlighted Chart series.
+   * Computes the color automatically from the base point color.
+   * This option is supported when `series.type` is set to `"candlestick"` or `"ohlc"`.
+   */
+  line?: HighlightLine;
+
+  /**
+   * Specifies the opacity of the highlighted points.
+   * This option is supported when `series.type` is set to `"bubble"`, `"pie"`, or `"donut"`.
+   */
+  opacity?: number;
+
+  /**
+   * Specifies the opacity of the series when another series is highlighted.
+   */
+  inactiveOpacity?: number;
+
+  /**
+   * Specifies the appearance of the highlighted point markers.
+   * This option is supported when `series.type` is set to `"line"`, `"area"`, `"scatter"`, `"scatterLine"`, or `"rangeArea"`.
+   */
+  markers?: MarkersHighlight;
+
+  /**
+   * Specifies a function for handling the toggling of the points highlight.
+   */
+  toggle?: (e: HighlightToggleArgs) => void;
+
+  /**
+   * Determines whether the Chart highlights the series when the user hovers over it with the mouse.
+   * When set to `true`, the Chart highlights the series when the user hovers over it with the mouse.
+   * By default, the highlighting of the Chart series is enabled.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies a function for setting custom visuals for the point highlights.
+   */
+  visual?: (e: HighlightVisualArgs) => drawing.Element;
+}

package/dist/npm/option-types/series-item/labels.from.interface.d.ts

@@ -0,0 +1,73 @@
+import { Border, Margin, Padding, SeriesLabelsContentArgs } from '../../property-types';
+
+/**
+ * Represents the series `from` labels options.
+ */
+export interface SeriesLabelsFrom {
+
+  /**
+   * Sets the background color of the `from` labels.
+   * Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Configures the border of the `from` labels.
+   */
+  border?: Border;
+
+  /**
+   * Sets the text color of the `from` labels.
+   * Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Sets the function which returns the Chart series `from` label content.
+   * You can split the text into multiple lines by using line feed characters (`"\n"`).
+   */
+  content?: (e: SeriesLabelsContentArgs) => string;
+
+  /**
+   * Sets the font style of the `from` labels.
+   */
+  font?: string;
+
+  /**
+   * Sets the format of the `from` labels.
+   * Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
+   */
+  format?: string;
+
+  /**
+   * Sets the margin of the `from` labels.
+   * A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Sets the padding of the `from` labels.
+   * A numeric value sets all paddings.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Sets the position of the `from` labels.
+   *
+   * - `"center"`—The label is positioned at the point center.
+   * - `"insideBase"`—The label is positioned inside, near the base of the bar.
+   * - `"insideEnd"`—The label is positioned inside, near the end of the point.
+   * - `"outsideEnd"`—The label is positioned outside, near the end of the point.
+   * - `"above"`—the label is positioned at the top of the marker. Applicable for `"rangeArea"` and `"verticalRangeArea"` series.
+   * - `"below"`—the label is positioned at the bottom of the marker. Applicable for `"rangeArea"` and `"verticalRangeArea"` series.
+   * - `"left"`—the label is positioned to the left of the marker. Applicable for `"rangeArea"` and `"verticalRangeArea"` series.
+   * - `"right"`—the label is positioned to the right of the marker. Applicable for `"rangeArea"` and `"verticalRangeArea"` series.
+   */
+  position?: 'center' | 'insideBase' | 'insideEnd' | 'outsideEnd';
+
+  /**
+   * Determines if the Chart displays the series `from` labels.
+   * By default, the Chart series `from` labels are not displayed.
+   */
+  visible?: boolean;
+}

package/dist/npm/option-types/series-item/labels.interface.d.ts

@@ -0,0 +1,104 @@
+import { drawing } from '@progress/kendo-drawing';
+import { SeriesLabelsAlignment, SeriesLabelsContentArgs } from '../../property-types';
+import { Border, Margin, Padding, SeriesLabelsVisualArgs } from '../../property-types';
+import { SeriesLabelsPosition } from '../../property-types';
+import { SeriesLabelsFrom } from './labels.from.interface';
+import { SeriesLabelsTo } from './labels.to.interface';
+
+/**
+ * Represents the configuration options of the series labels.
+ */
+export interface SeriesLabels {
+
+  /**
+   * Specifies the alignment of the label when `series.type` is set to `"donut"`, `"funnel"`, `"pyramid"` or `"pie"`.
+   */
+  align?: SeriesLabelsAlignment;
+
+  /**
+   * Specifies the background color of the labels. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of the labels.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the text color of the labels. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Specifies a function which returns the Chart series label content.
+   * You can split the text into multiple lines by using line feed characters (`"\n"`).
+   */
+  content?: (e: SeriesLabelsContentArgs) => string;
+
+  /**
+   * Specifies a function which returns the content for the ARIA label for the series labels.
+   */
+  ariaContent?: (e: SeriesLabelsContentArgs) => string;
+
+  /**
+   * Specifies the distance between the labels when `series.type` is set to `"donut"` or `"pie"`.
+   */
+  distance?: number;
+
+  /**
+   * Specifies the font style of the labels.
+   */
+  font?: string;
+
+  /**
+   * Specifies the format of the labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
+   */
+  format?: string;
+
+  /**
+   * Specifies the margin of the labels. A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Specifies the padding of the labels. A numeric value sets all paddings.
+   * Bar and Column series always apply full padding and ignore this setting.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Specifies the position of the labels.
+   */
+  position?: SeriesLabelsPosition;
+
+  /**
+   * Specifies the rotation angle of the labels. By default, the labels are not rotated.
+   */
+  rotation?: number;
+
+  /**
+   * If set to `true`, the Chart displays the series labels.
+   * By default, the Chart series labels are not displayed.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies a function that can be used to create a custom visual for the labels.
+   */
+  visual?: (e: SeriesLabelsVisualArgs) => drawing.Element;
+
+  /**
+   * Specifies the `from` label configuration of the Chart series.
+   * Displays the series from labels when either the `series.labels.visible` or
+   * the `series.labels.from.visible` option is set to `true`.
+   */
+  from?: SeriesLabelsFrom;
+
+  /**
+   * Specifies the `to` label configuration of the Chart series.
+   * Displays the series to labels when either the `series.labels.visible` or
+   * the `series.labels.to.visible` option is set to `true`.
+   */
+  to?: SeriesLabelsTo;
+}

package/dist/npm/option-types/series-item/labels.to.interface.d.ts

@@ -0,0 +1,74 @@
+import { Border, Margin, Padding, SeriesLabelsContentArgs } from '../../property-types';
+
+/**
+ * Represents the series `to` labels options.
+ */
+export interface SeriesLabelsTo {
+
+  /**
+   * Sets the background color of the `to` labels.
+   * Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Configures the border of the `to` labels.
+   */
+  border?: Border;
+
+  /**
+   * Sets the text color of the `to` labels.
+   * Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Sets the function which returns the Chart series `to` label content.
+   * You can split the text into multiple lines by using line feed characters (`"\n"`).
+   */
+  content?: (e: SeriesLabelsContentArgs) => string;
+
+  /**
+   * Sets the font style of the `to` labels.
+   */
+  font?: string;
+
+  /**
+   * Sets the format of the `to` labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
+   */
+  format?: string;
+
+  /**
+   * Sets the margin of the `to` labels.
+   * A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Sets the padding of the `to` labels.
+   * A numeric value sets all paddings.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Sets the position of the `to` labels.
+   *
+   * The available options are:
+   *
+   * - `"center"`—The label is positioned at the point center.
+   * - `"insideBase"`—The label is positioned inside, near the base of the bar.
+   * - `"insideEnd"`—The label is positioned inside, near the end of the point.
+   * - `"outsideEnd"`—The label is positioned outside, near the end of the point.
+   * - `"above"`—The label is positioned at the top of the marker. Applicable for the `"rangeArea"` and `"verticalRangeArea"` series.
+   * - `"below"`—The label is positioned at the bottom of the marker. Applicable for the `"rangeArea"` and `"verticalRangeArea"` series.
+   * - `"left"`—The label is positioned to the left of the marker. Applicable for the `"rangeArea"` and `"verticalRangeArea"` series.
+   * - `"right"`—The label is positioned to the right of the marker. Applicable for the `"rangeArea"` and `"verticalRangeArea"` series.
+   */
+  position?: 'center' | 'insideBase' | 'insideEnd' | 'outsideEnd';
+
+  /**
+   * Determines if the Chart displays the series `to` labels.
+   * By default, the Chart series `to` labels are not displayed.
+   */
+  visible?: boolean;
+}