@progress/kendo-charts 2.12.3-develop.3 → 2.13.0-develop.1

package/dist/npm/option-types/value-axis-item.interface.d.ts

@@ -0,0 +1,148 @@
+import { AxisLine, AxisTicks, GridLines, PlotBand } from '../property-types';
+import { ValueAxisCrosshair } from './value-axis-item/crosshair.interface';
+import { ValueAxisLabels } from './value-axis-item/labels.interface';
+import { ValueAxisNotes } from './value-axis-item/notes.interface';
+import { ValueAxisTitle } from './value-axis-item/title.interface';
+/**
+ * Specifies the configuration options of the value axis.
+ */
+export interface ValueAxis {
+
+  /**
+   * Specifies the value at which the category axis crosses this axis.
+   * For objects, sets the crossing value directly.
+   * For arrays, sets the value indices at which the category axes cross the value axis.
+   * For dates, sets the date at which the category axis crosses this axis.
+   */
+  axisCrossingValue?: any | any[];
+
+  /**
+   * Specifies the background color of the axis.
+   */
+  background?: string;
+
+  /**
+   * Specifies the color of the value axis. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Specifies the configuration of the axis lines.
+   * Also affects the major and minor ticks, but not the grid lines.
+   */
+  line?: AxisLine;
+
+  /**
+   * Specifies the configuration of the major grid lines.
+   * These lines extend the major ticks through the body of the Chart.
+   */
+  majorGridLines?: GridLines;
+
+  /**
+   * Specifies the configuration of the value axis major ticks.
+   */
+  majorTicks?: AxisTicks;
+
+  /**
+   * Specifies the interval between major divisions.
+   * If [`valueAxis.type`]({% slug api_charts_valueaxis %}#type) is set to `"log"`, the `majorUnit` value is used for the base of the
+   * logarithm.
+   */
+  majorUnit?: number;
+
+  /**
+   * Specifies the maximum value of the axis.
+   */
+  max?: any;
+
+  /**
+   * Specifies the minimum value of the axis.
+   */
+  min?: any;
+
+  /**
+   * Specifies the configuration of the minor grid lines.
+   * These lines extend the minor ticks through the body of the Chart.
+   */
+  minorGridLines?: GridLines;
+
+  /**
+   * Specifies the configuration of the value axis minor ticks.
+   */
+  minorTicks?: AxisTicks;
+
+  /**
+   * Specifies the interval between minor divisions.
+   * Defaults to one-fifth (1/5) of the [`valueAxis.majorUnit`]({% slug api_charts_valueaxis %}#majorunit).
+   * If [`valueAxis.type`]({% slug api_charts_valueaxis %}#type) is set to `"log"`, the `minorUnit` value represents the number of divisions
+   * between two major units and defaults to the major unit minus one.
+   */
+  minorUnit?: number;
+
+  /**
+   * Specifies the unique axis name.
+   * Use this to associate a series with a value axis by using the [`series.axis`]({% slug api_charts_series %}#axis) option.
+   */
+  name?: string;
+
+  /**
+   * Determines whether the Chart prevents the automatic axis range from snapping to zero.
+   * Set to `false` to force the automatic axis range to snap to zero.
+   */
+  narrowRange?: boolean;
+
+  /**
+   * Specifies the name of the pane that renders the value axis.
+   * If not set, the axis renders in the first (default) pane.
+   */
+  pane?: string;
+
+  /**
+   * Specifies the plot bands of the value axis.
+   */
+  plotBands?: PlotBand[];
+
+  /**
+   * Determines whether the value axis direction is reversed.
+   * By default, categories are listed from left to right and from bottom to top.
+   *
+   * Radar and Polar Charts do not support reverse value axes.
+   */
+  reverse?: boolean;
+
+  /**
+   * Specifies the axis type.
+   *
+   * Use `"numeric"` for a numeric axis or `"log"` for a logarithmic axis.
+   */
+  type?: 'numeric' | 'log';
+
+  /**
+   * Determines whether to display the value axis. By default, the value axis is visible.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies the crosshair configuration options.
+   *
+   * The crosshair displays when the [`valueAxis.crosshair.visible`]({% slug api_charts_valueaxiscrosshair %}#visible) option is set to `true`.
+   */
+  crosshair?: ValueAxisCrosshair;
+
+  /**
+   * Specifies the axis labels configuration.
+   */
+  labels?: ValueAxisLabels;
+
+  /**
+   * Specifies the value axis notes configuration.
+   */
+  notes?: ValueAxisNotes;
+
+  /**
+   * Specifies the title configuration of the value axis.
+   *
+   * To display the title, set the [`valueAxis.title.text`]({% slug api_charts_valueaxistitle %}#text) option.
+   */
+  title?: ValueAxisTitle;
+}

package/dist/npm/option-types/x-axis-item/crosshair.interface.d.ts

@@ -0,0 +1,33 @@
+import { XAxisCrosshairTooltip } from './crosshair.tooltip.interface';
+/**
+ * Represents the configuration options of the X-axis crosshair.
+ */
+export interface XAxisCrosshair {
+
+  /**
+   * Specifies the color of the crosshair. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Specifies the opacity of the crosshair. By default, the crosshair is opaque.
+   */
+  opacity?: number;
+
+  /**
+   * Determines whether the Chart displays the X-axis crosshair of the Scatter Chart.
+   * By default, the X-axis crosshair of the Scatter Chart is not visible.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies the width of the crosshair in pixels.
+   */
+  width?: number;
+
+  /**
+   * Specifies the options of the crosshair tooltip.
+   * The crosshair tooltip is displayed when the `xAxis.crosshair.tooltip.visible` option is set to `true`.
+   */
+  tooltip?: XAxisCrosshairTooltip;
+}

package/dist/npm/option-types/x-axis-item/crosshair.tooltip.interface.d.ts

@@ -0,0 +1,6 @@
+import { AxisCrosshairTooltip } from "../axis-crosshair-tooltip.interface";
+
+/**
+ * Represents the X-axis crosshair tooltip options.
+ */
+export interface XAxisCrosshairTooltip extends AxisCrosshairTooltip {}

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

@@ -0,0 +1,109 @@
+import { drawing } from '@progress/kendo-drawing';
+import {
+    AxisLabelContentArgs,
+    AxisLabelVisualArgs,
+    AxisLabelsPosition,
+    Border,
+    DateFormats,
+    LabelRotation,
+    Margin,
+    Padding,
+} from '../../property-types';
+
+/**
+ * Represents the configuration of the X-axis labels.
+ */
+export interface XAxisLabels {
+    /**
+     * 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 label content.
+     * You can split the text into multiple lines by using the line feed characters (`"\n"`).
+     */
+    content?: (e: AxisLabelContentArgs) => string;
+
+    /**
+     * Specifies the culture to use when formatting date values.
+     */
+    culture?: string;
+
+    /**
+     * Specifies the format for displaying the labels when the X values are dates. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
+     * Contains one placeholder (`"{0}"`) which represents the category value.
+     * Charts select the appropriate format for the current `xAxis.baseUnit`. Setting the
+     * `categoryAxis.labels.format` option overrides the date formats.
+     */
+    dateFormats?: DateFormats;
+
+    /**
+     * Specifies the font style of the labels.
+     */
+    font?: string;
+
+    /**
+     * Specifies the format for displaying the labels. Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting).
+     * Contains one placeholder (`"{0}"`) which represents the category value.
+     */
+    format?: string;
+
+    /**
+     * Specifies the margin of the labels. A numeric value sets all margins.
+     */
+    margin?: Margin | number;
+
+    /**
+     * Determines whether the Chart mirrors the axis labels and ticks.
+     * When set to `true`, the Chart mirrors the axis labels and ticks. If the labels are normally on the
+     * left side of the axis, the mirroring of the axis renders them to the right.
+     */
+    mirror?: boolean;
+
+    /**
+     * Specifies the padding of the labels. A numeric value sets all paddings.
+     */
+    padding?: Padding | number;
+
+    /**
+     * Specifies the rotation angle of the labels. By default, the labels are not rotated. Can be set to `"auto"`.
+     * In this case, the labels are rotated only if the slot size is not sufficient for the entire labels.
+     */
+    rotation?: LabelRotation | number | 'auto';
+
+    /**
+     * Specifies the position of the axis labels. By default, labels are positioned next to the axis.
+     */
+    position?: AxisLabelsPosition;
+
+    /**
+     * Specifies the number of labels to skip.
+     */
+    skip?: number;
+
+    /**
+     * Specifies the label rendering step&mdash;renders every n<sup>th</sup> label. By default, every label is rendered.
+     */
+    step?: number;
+
+    /**
+     * If set to `true`, the Chart displays the X-axis labels. By default, the X-axis labels are visible.
+     */
+    visible?: boolean;
+
+    /**
+     * Specifies a function for creating custom visuals for the labels.
+     */
+    visual?: (e: AxisLabelVisualArgs) => drawing.Element;
+}

package/dist/npm/option-types/x-axis-item/notes.icon.interface.d.ts

@@ -0,0 +1,32 @@
+import { Border, MarkerType } from '../../property-types';
+
+/**
+ * Represents the configuration options of the X-axis notes icon.
+ */
+export interface XAxisNotesIcon {
+
+  /**
+   * Specifies the background color of the notes icon.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of the notes icon.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the size of the notes icon.
+   */
+  size?: number;
+
+  /**
+   * Specifies the shape of the notes icon.
+   */
+  type?: MarkerType;
+
+  /**
+   * Determines the visibility of the notes icon.
+   */
+  visible?: boolean;
+}

package/dist/npm/option-types/x-axis-item/notes.interface.d.ts

@@ -0,0 +1,40 @@
+import { drawing } from '@progress/kendo-drawing';
+import { AxisNoteVisualArgs, NoteLine, NotePosition } from '../../property-types';
+import { XAxisNotesIcon } from './notes.icon.interface';
+import { XAxisNotesLabel } from './notes.label.interface';
+
+/**
+ * Represents the configuration options of the X-axis notes.
+ */
+export interface XAxisNotes {
+
+  /**
+   * Specifies the items of the notes.
+   */
+  data?: any[];
+
+  /**
+   * Specifies the line of the notes.
+   */
+  line?: NoteLine;
+
+  /**
+   * Specifies the position of the X-axis note.
+   */
+  position?: NotePosition;
+
+  /**
+   * Specifies a function for creating custom visuals for the notes.
+   */
+  visual?: (e: AxisNoteVisualArgs) => drawing.Element;
+
+  /**
+   * Specifies the icon of the notes.
+   */
+  icon?: XAxisNotesIcon;
+
+  /**
+   * Specifies the label of the notes.
+   */
+  label?: XAxisNotesLabel;
+}

package/dist/npm/option-types/x-axis-item/notes.label.interface.d.ts

@@ -0,0 +1,58 @@
+import { AxisNoteContentArgs, Border, NoteLabelPosition } from '../../property-types';
+
+/**
+ * Represents the X-axis notes label options.
+ */
+export interface XAxisNotesLabel {
+
+  /**
+   * Sets the background color of the label.
+   * Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Configures the border of the label.
+   */
+  border?: Border;
+
+  /**
+   * Sets the text color of the label.
+   * Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Sets the function which returns the label content.
+   * The function argument contains a `value` field which defines the axis value. You can split the text into multiple lines by using line feed characters (`"\n"`).
+   */
+  content?: (e: AxisNoteContentArgs) => string;
+
+  /**
+   * Sets the font style of the label.
+   */
+  font?: string;
+
+  /**
+   * Sets the format for displaying the notes label.
+   * Uses the [`format` method from `@progress/kendo-intl`](https://github.com/telerik/kendo-intl?tab=readme-ov-file#general-formatting) and contains one placeholder (`"{0}"`) which represents the axis value.
+   */
+  format?: string;
+
+  /**
+   * Sets the position of the labels.
+   */
+  position?: NoteLabelPosition;
+
+  /**
+   * Sets the rotation angle of the label.
+   * By default, the label is not rotated.
+   */
+  rotation?: number;
+
+  /**
+   * Determines if the Chart displays the X-axis notes label.
+   * By default, the X-axis notes label is visible.
+   */
+  visible?: boolean;
+}

package/dist/npm/option-types/x-axis-item/title.interface.d.ts

@@ -0,0 +1,65 @@
+import { drawing } from '@progress/kendo-drawing';
+import { AxisTitlePosition, Border, Margin, Padding, TitleVisualArgs } from '../../property-types';
+
+/**
+ * Represents the configuration options of the X-axis title.
+ */
+export interface XAxisTitle {
+
+  /**
+   * Specifies the background color of the title. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of the title.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the text color of the title. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Specifies the font style of the title.
+   */
+  font?: string;
+
+  /**
+   * Specifies the margin of the title. A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Specifies the padding of the title. A numeric value sets all paddings.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Specifies the position of the title.
+   */
+  position?: AxisTitlePosition;
+
+  /**
+   * Specifies the rotation angle of the title. By default, the title is not rotated.
+   */
+  rotation?: number;
+
+  /**
+   * Specifies the text of the title.
+   * You can split the text into multiple lines by using the line feed characters (`"\n"`).
+   */
+  text?: string;
+
+  /**
+   * If set to `true`, the Chart displays the X axis title of the Scatter Chart.
+   * By default, the X-axis title of the Scatter Chart is visible.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies a function that can be used to create a custom visual for the title.
+   */
+  visual?: (e: TitleVisualArgs) => drawing.Element;
+}

package/dist/npm/option-types/x-axis-item.interface.d.ts

@@ -0,0 +1,165 @@
+import { AxisLine, AxisTicks, BaseUnit, GridLines, PlotBand, WeekStartDay } from '../property-types';
+import { XAxisCrosshair } from './x-axis-item/crosshair.interface';
+import { XAxisLabels } from './x-axis-item/labels.interface';
+import { XAxisNotes } from './x-axis-item/notes.interface';
+import { XAxisTitle } from './x-axis-item/title.interface';
+/**
+ * Represents the configuration options of the X-axis.
+ */
+export interface XAxis {
+
+  /**
+   * When dealing with objects, it specifies the value at which the Y axis crosses this axis, for arrays it denotes the value indices at which the Y axes cross the value axis, and for dates, it represents the date at which the Y axis crosses this axis.
+   *
+   * To denote the far end of the axis, set a value that is greater than or equal to the axis maximum value.
+   */
+  axisCrossingValue?: any | any[];
+
+  /**
+   * Specifies the background color of the axis.
+   */
+  background?: string;
+
+  /**
+   * The category names. Applicable for charts with X and Y category axes.
+   */
+   categories?: any[];
+
+  /**
+   * The base time interval for the axis labels.
+   * The default `baseUnit` is automatically determined from the value range.
+   */
+  baseUnit?: BaseUnit;
+
+  /**
+   * Specifies the color of the axis. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * The configuration of the axis lines. Also affects the major and minor ticks, but not the grid lines.
+   */
+  line?: AxisLine;
+
+  /**
+   * The configuration of the major grid lines. These are the lines that are an extension of the major
+   * ticks through the body of the Chart.
+   */
+  majorGridLines?: GridLines;
+
+  /**
+   * The configuration of the Scatter Chart X-axis major ticks.
+   */
+  majorTicks?: AxisTicks;
+
+  /**
+   * The interval between major divisions.
+   * If this is a date axis, the value represents the number of [`xAxis.baseUnit`]({% slug api_charts_xaxis %}#baseunit) between major divisions.
+   * If [`xAxis.type`]({% slug api_charts_xaxis %}#type) is set to `"log"`, the `majorUnit` value is used for the base of the logarithm.
+   */
+  majorUnit?: number;
+
+  /**
+   * The maximum value of the axis.
+   */
+  max?: any;
+
+  /**
+   * The minimum value of the axis.
+   */
+  min?: any;
+
+  /**
+   * The configuration of the minor grid lines. These are the lines that are an extension of the minor
+   * ticks through the body of the Chart.
+   */
+  minorGridLines?: GridLines;
+
+  /**
+   * The configuration of the X-axis minor ticks.
+   */
+  minorTicks?: AxisTicks;
+
+  /**
+   * The interval between minor divisions. It defaults to 1/5 of the [`xAxis.majorUnit`]({% slug api_charts_xaxis %}#majorunit).
+   * If [`xAxis.type`]({% slug api_charts_xaxis %}#type) is set to `"log"`, the `minorUnit` value represents the number of divisions between
+   * two major units and defaults to the major unit minus one.
+   */
+  minorUnit?: number;
+
+  /**
+   * The unique axis name. Used to associate a series with a X axis by using the [`series.xAxis`]({% slug api_charts_series %}#xaxis) option.
+   */
+  name?: string;
+
+  /**
+   * If set to `true`, the Chart prevents the automatic axis range from snapping to zero.
+   * Setting it to `false` forces the automatic axis range to snap to zero.
+   */
+  narrowRange?: boolean;
+
+  /**
+   * The name of the pane in which the axis has to be rendered.
+   * If not set, the axis is rendered in the first (default) pane.
+   */
+  pane?: string;
+
+  /**
+   * The plot bands of the X axis.
+   */
+  plotBands?: PlotBand[];
+
+  /**
+   * If set to `true`, the value axis direction is reversed.
+   * By default, values increase from left to right and from bottom to top.
+   */
+  reverse?: boolean;
+
+  /**
+   * Specifies the angle (in degrees) where the zero value is placed.
+   * Angles increase counterclockwise and zero is to the right. Negative values are acceptable.
+   */
+  startAngle?: number;
+
+  /**
+   * The axis type.
+   *
+   * The options are `numeric` for a numeric axis, `date` for a specialized axis for displaying chronological data, and `log` for a logarithmic axis.
+   *
+   * If the series X value is of the `date` type, the Chart automatically switches to a date axis.
+   * To avoid this behavior, set the `type`.
+   */
+  type?: 'numeric' | 'log' | 'date';
+
+  /**
+   * If set to `true`, the Chart displays the X axis. By default, the X axis is visible.
+   */
+  visible?: boolean;
+
+  /**
+   * The configuration options of the crosshair.
+   * The crosshair is displayed when the [`xAxis.crosshair.visible`]({% slug api_charts_xaxiscrosshair %}#visible) option is set to `true`.
+   */
+  crosshair?: XAxisCrosshair;
+
+  /**
+   * The axis labels configuration.
+   */
+  labels?: XAxisLabels;
+
+  /**
+   * The X-axis notes configuration.
+   */
+  notes?: XAxisNotes;
+
+  /**
+   * The title configuration of the Scatter Chart X axis.
+   * To display the title, set the [`xAxis.title.text`]({% slug api_charts_xaxistitle %}#text) option.
+   */
+  title?: XAxisTitle;
+
+  /**
+   * The week start day when the `baseUnit` is set to `"weeks"`.
+   */
+  weekStartDay?: WeekStartDay;
+}

package/dist/npm/option-types/y-axis-item/crosshair.interface.d.ts

@@ -0,0 +1,36 @@
+import { YAxisCrosshairTooltip } from './crosshair.tooltip.interface';
+
+/**
+ * Represents the Y-axis crosshair options.
+ */
+export interface YAxisCrosshair {
+
+  /**
+   * Sets the color of the crosshair.
+   * Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Sets the opacity of the crosshair.
+   * By default, the crosshair is opaque.
+   */
+  opacity?: number;
+
+  /**
+   * Determines if the Chart displays the Y-axis crosshair of the Scatter Chart.
+   * By default, the Y-axis crosshair of the Scatter Chart is not visible.
+   */
+  visible?: boolean;
+
+  /**
+   * Sets the width of the crosshair in pixels.
+   */
+  width?: number;
+
+  /**
+   * Configures the crosshair tooltip options.
+   * The crosshair tooltip is displayed when the `yAxis.crosshair.tooltip.visible` option is set to `true`.
+   */
+  tooltip?: YAxisCrosshairTooltip;
+}