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

package/dist/npm/option-types/navigator/select.interface.d.ts

@@ -0,0 +1,22 @@
+import { MousewheelSelect } from "../../property-types";
+
+/**
+ * Represents the `navigator.select` options.
+ */
+export interface NavigatorSelect {
+  /**
+   * Specifies the lower boundary of the selected range.
+   */
+  from?: Date;
+
+  /**
+   * Specifies the configuration of the mousewheel selection.
+   * When set to `false`, the mousewheel does not update the selection.
+   */
+  mousewheel?: boolean | MousewheelSelect;
+
+  /**
+   * Specifies the upper boundary of the selected range.
+   */
+  to?: Date;
+}

package/dist/npm/option-types/navigator.interface.d.ts

@@ -0,0 +1,56 @@
+import { CategoryAxis } from './category-axis-item.interface';
+import { Pane } from './pane.interface';
+import { Series } from './series-item.interface';
+import { NavigatorHintOptions as NavigatorHint } from './navigator/hint.interface';
+import { NavigatorSelect } from './navigator/select.interface';
+
+/**
+ * Represents the configuration options of the navigator.
+ */
+export interface NavigatorOptions {
+  /**
+   * Specifies the visibility of the navigator.
+   */
+  visible?: boolean;
+
+  // These options are also available as child components.
+
+  /**
+   * Specifies the configuration options of the category axis.
+   */
+  categoryAxis?: CategoryAxis;
+
+  /**
+   * Specifies the default options of the navigator hint.
+   */
+  hint?: NavigatorHint;
+
+  /**
+   * Specifies the navigator pane configuration.
+   */
+  pane?: Pane;
+
+  /**
+   * Specifies the position of the navigator.
+   * By default, the navigator is positioned at the bottom.
+   */
+  position?: 'top' | 'bottom';
+
+  /**
+   * Specifies the initially selected range.
+   * If no range is specified, the full range of values is shown.
+   */
+  select?: NavigatorSelect;
+
+  /**
+   * An array of series definitions.
+   * Accepts the same options as the root series collection.
+   * Omitting the array and specifying a single series is also acceptable.
+   */
+  series?: Series | Series[];
+
+  /**
+   * @hidden
+   */
+  redrawSlaves(): void;
+}

package/dist/npm/option-types/pane/title.interface.d.ts

@@ -0,0 +1,65 @@
+import { drawing } from '@progress/kendo-drawing';
+import { Border, Margin } from '../../property-types';
+
+/**
+ * Represents the `panes.title` options.
+ */
+export interface PanesTitle {
+
+  /**
+   * 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 position of the title.
+   *
+   * You can set the positioning to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
+   */
+  position?: 'left' | 'right' | 'center';
+
+  /**
+   * Specifies the text of the title.
+   * You can split the text into multiple lines by using line feed characters (`"\n"`).
+   */
+  text?: string;
+
+  /**
+   * Determines whether the Chart displays the pane title.
+   * When set to `true`, the title is visible. By default, the pane title is visible.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies a function that can be used to create a custom visual for the title.
+   *
+   * The available argument fields are:
+   *
+   * - `text`—The label text.
+   * - `rect`—The geometry `Rect` that defines where the visual has to be rendered.
+   * - `sender`—The Chart instance (might be `undefined`).
+   * - `options`—The label options.
+   * - `createVisual`—A function that can be used to get the default visual.
+   */
+  visual?: (e: any) => drawing.Element;
+}

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

@@ -0,0 +1,51 @@
+import { drawing } from '@progress/kendo-drawing';
+import { Border, Margin } from '../../property-types';
+
+/**
+ * Represents the options for default pane title.
+ */
+export interface PaneDefaultsTitle {
+
+  /**
+   * 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 position of the title.
+   *
+   * You can set the positioning to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
+   */
+  position?: 'left' | 'right' | 'center';
+
+  /**
+   * Determines whether the Chart displays the pane title.
+   * When set to `true`, the title is visible. By default, the pane title is visible.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies a function that can be used to create a custom visual for the title.
+   */
+  visual?: (e: any) => drawing.Element;
+}

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

@@ -0,0 +1,53 @@
+import { Border, Margin, Padding } from '../property-types';
+import { PanesTitle } from './pane/title.interface';
+
+/**
+ * Represents the configuration options of the Chart pane defaults.
+ */
+export interface PaneDefaults {
+  /**
+   * Specifies the background color of the pane. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of the pane.
+   */
+  border?: Border;
+
+  /**
+   * Specifies whether the Charts in the pane have to be clipped.
+   * By default, all Charts except the Radar and Polar Charts are clipped.
+   */
+  clip?: boolean;
+
+  /**
+   * Specifies the height of the pane in pixels.
+   */
+  height?: number;
+
+  /**
+   * Specifies the margin of the pane. A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Specifies the padding of the pane. A numeric value sets all paddings.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Specifies the title configuration of the pane.
+   * To display the title, set the [`panes.title.text`]({% slug api_charts_panes_title %}#text) option.
+   */
+  title?: PanesTitle;
+
+  /**
+   * The unique name of the pane.
+   *
+   * @hidden
+   * There's no point in setting a default name for panes, as it must be unique.
+   * Included for backward compatibility with KendoReact.
+   */
+  name?: string;
+}

package/dist/npm/option-types/pane.interface.d.ts

@@ -0,0 +1,53 @@
+import { Border, Margin, Padding } from '../property-types';
+import { PanesTitle } from './pane/title.interface';
+
+/**
+ * Represents the Chart pane configuration options.
+ */
+export interface Pane {
+
+  /**
+   * Sets the background color of the pane.
+   * Accepts a valid CSS color string, including hex and rgb.
+   */
+  background?: string;
+
+  /**
+   * Configures the border of the pane.
+   */
+  border?: Border;
+
+  /**
+   * Determines if the Charts in the pane have to be clipped.
+   * By default, all Charts except the Radar and Polar Charts are clipped.
+   */
+  clip?: boolean;
+
+  /**
+   * Sets the height of the pane in pixels.
+   */
+  height?: number;
+
+  /**
+   * Sets the margin of the pane.
+   * A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Sets the unique name of the pane.
+   */
+  name?: string;
+
+  /**
+   * Sets the padding of the pane.
+   * A numeric value sets all paddings.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Configures the title of the pane.
+   * To display the title, set the [`panes.title.text`]({% slug api_charts_panestitle %}#text) option.
+   */
+  title?: string | PanesTitle;
+}

package/dist/npm/option-types/plot-area.interface.d.ts

@@ -0,0 +1,33 @@
+import { Border, Margin, Padding } from '../property-types';
+/**
+ * Specifies the configuration options of the Chart plot area.
+ */
+export interface PlotArea {
+
+  /**
+   * Specifies the background color of the Chart plot area.
+   * Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of the plot area.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the margin of the plot area. A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Specifies the background opacity of the plot area. By default, the background is opaque.
+   */
+  opacity?: number;
+
+  /**
+   * Specifies the padding of the plot area. A numeric value sets all paddings.
+   * For Pie, Donut, Radar, and Polar Charts, the default padding is proportional to the Chart size.
+   */
+  padding?: Padding | number;
+}

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

@@ -0,0 +1,54 @@
+import { Border, Margin, Padding, SeriesLabelsContentArgs } from '../../property-types';
+
+/**
+ * Represents the configuration options of the Chart series `from` labels.
+ */
+export interface SeriesDefaultsLabelsFrom {
+
+  /**
+   * Specifies the background color of the `from` labels. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of the `from` labels.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the text color of the `from` labels. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Specifies the function which returns the `from` label content of the Chart series.
+   * You can split the text into multiple lines by using line feed characters (`"\n"`).
+   */
+  content?: (e: SeriesLabelsContentArgs) => string;
+
+  /**
+   * Specifies the font style of the from labels.
+   */
+  font?: string;
+
+  /**
+   * Specifies 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;
+
+  /**
+   * Specifies the margin of the `from` labels. A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Specifies the padding of the `from` labels. A numeric value sets all paddings.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Determines whether the Chart displays the series `from` labels.
+   * When set to `true`, the labels are visible. By default, the Chart series from labels are not displayed.
+   */
+  visible?: boolean;
+}

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

@@ -0,0 +1,78 @@
+import { drawing } from '@progress/kendo-drawing';
+import { Border, Margin, Padding, SeriesLabelsContentArgs, SeriesLabelsVisualArgs } from '../../property-types';
+import { SeriesDefaultsLabelsFrom } from './labels.from.interface';
+import { SeriesDefaultsLabelsTo } from './labels.to.interface';
+/**
+ * Represents the configuration options of the series labels.
+ */
+export interface SeriesDefaultsLabels {
+
+  /**
+   * 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 the function which returns the Chart series labels content.
+   * You can split the text into multiple lines by using line feed characters (`"\n"`).
+   */
+  content?: (e: SeriesLabelsContentArgs) => string;
+
+  /**
+   * 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 margins.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Specifies the rotation angle of the labels. By default, the labels are not rotated.
+   */
+  rotation?: number;
+
+  /**
+   * Determines whether the Chart displays the series labels.
+   * When set to `true`, the labels are visible. 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 Chart series `from` label configuration.
+   * Displays the series labels when either the `seriesDefaults.labels.visible` or the `seriesDefaults.labels.from.visible` option is set to `true`.
+   */
+  from?: SeriesDefaultsLabelsFrom;
+
+  /**
+   * Specifies the Chart series `to` label configuration.
+   * Displays the series labels when either the `seriesDefaults.labels.visible` or the `seriesDefaults.labels.to.visible` option is set to `true`.
+   */
+  to?: SeriesDefaultsLabelsTo;
+}

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

@@ -0,0 +1,57 @@
+import { Border, Margin, Padding, SeriesLabelsContentArgs } from '../../property-types';
+
+/**
+ * Represents the configuration options of the Chart series `to` labels.
+ */
+export interface SeriesDefaultsLabelsTo {
+
+  /**
+   * Specifies the background color of `to` lables. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of `to` labels.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the text color of `to` labels. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Specifies the function which returns the `from` label content of the Chart series.
+   * You can split the text into multiple lines by using the line feed characters (`"\n"`).
+   */
+  content?: (e: SeriesLabelsContentArgs) => string;
+
+  /**
+   * Specifies the font style of the `to` labels.
+   */
+  font?: string;
+
+  /**
+   * Specifies the format of the `to` labels.
+   * {% platform_content angular %}
+   * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
+   * {% endplatform_content %}
+   */
+  format?: string;
+
+  /**
+   * Specifies the margin of the `to` labels. A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Specifies the padding of the `to` labels. A numeric value sets all paddings.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Determines whether the Chart displays the `to` labels of the series.
+   * When set to `true`, the labels are visible. By default, the `to` labels of the Chart series are not displayed.
+   */
+  visible?: boolean;
+}

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

@@ -0,0 +1,32 @@
+import { Border, MarkerType } from '../../property-types';
+
+/**
+ * Represents the configuration options of the series notes icon.
+ */
+export interface SeriesDefaultsNotesIcon {
+
+  /**
+   * 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/series-defaults/notes.interface.d.ts

@@ -0,0 +1,31 @@
+import { drawing } from '@progress/kendo-drawing';
+import { NoteLine, SeriesNoteVisualArgs } from '../../property-types';
+import { SeriesDefaultsNotesIcon } from './notes.icon.interface';
+import { SeriesDefaultsNotesLabel } from './notes.label.interface';
+
+/**
+ * Represents the configuration options of the series notes.
+ */
+export interface SeriesDefaultsNotes {
+
+  /**
+   * Specifies the line of the notes.
+   */
+  line?: NoteLine;
+
+  /**
+   * Specifies a function for creating a custom visual for the notes.
+   *
+   */
+  visual?: (e: SeriesNoteVisualArgs) => drawing.Element;
+
+  /**
+   * Specifies the icon of the notes.
+   */
+  icon?: SeriesDefaultsNotesIcon;
+
+  /**
+   * Specifies the label of the notes.
+   */
+  label?: SeriesDefaultsNotesLabel;
+}

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

@@ -0,0 +1,58 @@
+import { Border, NoteLabelPosition, SeriesNoteContentArgs } from '../../property-types';
+
+/**
+ * Represents the configuration options of the series notes label.
+ */
+export interface SeriesDefaultsNotesLabel {
+
+  /**
+   * Specifies the background color of the label. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of the label.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the text color of the label. Accepts a valid CSS color string, including HEX and RGB.
+   */
+  color?: string;
+
+  /**
+   * Specifies the function which returns the label content.
+   * You can split the text into multiple lines by using line feed characters (`"\n"`).
+   */
+  content?: (e: SeriesNoteContentArgs) => string;
+
+  /**
+   * Specifies the font style of the label.
+   */
+  font?: string;
+
+  /**
+   * Specifies the format for displaying the notes label.
+   * Contains one placeholder (`"{0}"`) which represents the axis value.
+   * {% platform_content angular %}
+   * The value is formatted using the [`format`](https://www.telerik.com/kendo-angular-ui/components/globalization/internationalization/api/intlservice#format) method of `IntlService`.
+   * {% endplatform_content %}
+   */
+  format?: string;
+
+  /**
+   * Specifies the position of the labels.
+   */
+  position?: NoteLabelPosition;
+
+  /**
+   * Specifies the rotation angle of the label. By default, the label is not rotated.
+   */
+  rotation?: number;
+
+  /**
+   * Determines whether the Chart displays the [`seriesDefaults`]({% slug api_charts_seriesdefaults %}) notes label.
+   * When set to `true`, the label is visible. By default, the notes label is visible.
+   */
+  visible?: boolean;
+}