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

package/dist/npm/option-types/category-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 category axis title.
+ */
+export interface CategoryAxisTitle {
+
+  /**
+   * 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.
+   * The text can be split into multiple lines by using the line feed characters (`"\n"`).
+   */
+  text?: string;
+
+  /**
+   * Determines whether the Chart displays the category axis title.
+   * When set to `true`, the title is visible. By default, the category axis title 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/category-axis-item.interface.d.ts

@@ -0,0 +1,195 @@
+import { AutoBaseUnitSteps, AxisLine, AxisTicks, CategoryBaseUnit, GridLines, PlotBand, WeekStartDay } from '../property-types';
+import { CategoryAxisCrosshair } from './category-axis-item/crosshair.interface';
+import { CategoryAxisLabels } from './category-axis-item/labels.interface';
+import { CategoryAxisRangeLabels } from './category-axis-item/range-labels.interface';
+import { CategoryAxisNotes } from './category-axis-item/notes.interface';
+import { CategoryAxisSelect } from './category-axis-item/select.interface';
+import { CategoryAxisTitle } from './category-axis-item/title.interface';
+/**
+ * Represents the category axis configuration options.
+ */
+export interface CategoryAxis {
+  /**
+   * Sets the time-interval steps when [`baseUnit`](#baseunit) is set to `"fit"` or `"auto"`.
+   * The axis tries to divide the active period into the smallest possible units that yield [`maxDateGroups`](#maxdategroups) or less discrete intervals.
+   */
+  autoBaseUnitSteps?: AutoBaseUnitSteps;
+  /**
+   * Sets the category index or date at which the first value axis crosses this axis.
+   * Use an array to set the category indices or dates at which the value axes cross the category axis. To denote the far end of the axis, set an index greater than or equal to the number of categories.
+   */
+  axisCrossingValue?: any | any[];
+
+  /**
+   * Sets the background color of the axis.
+   */
+  background?: string;
+
+  /**
+   * Sets the base time interval for the date axis.
+   * The default base unit is automatically determined by the minimum difference between subsequent categories. Use `"fit"` to set a base unit and [`baseUnitStep`](#baseunitstep) so the total number of categories does not exceed [`categoryAxis.maxDateGroups`](#maxdategroups). Series data is aggregated for the specified base unit by using the [`series.aggregate`](#aggregate) function.
+   */
+  baseUnit?: CategoryBaseUnit;
+
+  /**
+   * Sets the step (interval) between categories in base units.
+   * Use `"auto"` to set the step so the total number of categories does not exceed [`maxDateGroups`](#maxdategroups). This option is ignored if [`baseUnit`](#baseunit) is set to `"fit"`.
+   */
+  baseUnitStep?: number | 'auto';
+
+  /**
+   * Sets the category names.
+   * The Chart creates a category for every item of the array.
+   */
+  categories?: any[];
+
+  /**
+   * Sets the color to apply to all axis elements.
+   * Accepts a valid CSS color string, including HEX and RGB and can be overridden by [`labels.color`](#labels) and [`line.color`](#line).
+   */
+  color?: string;
+
+  /**
+   * Determines if the Chart positions categories and series points on major ticks.
+   * This removes the empty space before and after the series. The default value is `false` except for `"area"`, `"verticalArea"`, `"rangeArea"`, and `"verticalRangeArea"`. This option is ignored if series `type` is set to `"bar"`, `"column"`, `"boxPlot"`, `"ohlc"`, `"candlestick"`, or `"waterfall"`.
+   */
+  justified?: boolean;
+
+  /**
+   * Configures the axis lines.
+   * Also affects the major and minor ticks, but not the grid lines.
+   */
+  line?: AxisLine;
+
+  /**
+   * Configures the major grid lines.
+   * These are the lines that are an extension of the major ticks through the body of the Chart.
+   */
+  majorGridLines?: GridLines;
+
+  /**
+   * Configures the category axis major ticks.
+   */
+  majorTicks?: AxisTicks;
+
+  /**
+   * Sets the last date displayed on a date category axis or the index of the last category displayed on a category axis.
+   * By default, the max value is the same as the last category. This is often used in combination with [`min`](#min) and [`roundToBaseUnit`](#roundtobaseunit) to set up a fixed date range.
+   */
+  max?: any;
+
+  /**
+   * Sets the maximum number of groups (categories) to display when [`baseUnit`](#baseunit) is set to `"fit"` or [`baseUnitStep`](#baseunitstep) is set to `"auto"`.
+   */
+  maxDateGroups?: number;
+
+  /**
+   * Sets the maximum number of ticks and labels to display.
+   * Applicable for date category axis.
+   */
+  maxDivisions?: number;
+
+  /**
+   * Sets the first date displayed on a date category axis or the index of the first category displayed on a category axis.
+   * By default, the min value is the same as the first category. This is often used in combination with [`max`](#max) and [`roundToBaseUnit`](#roundtobaseunit) to set up a fixed date range.
+   */
+  min?: any;
+
+  /**
+   * Configures the minor grid lines.
+   * These are the lines that are an extension of the minor ticks through the body of the Chart.
+   */
+  minorGridLines?: GridLines;
+
+  /**
+   * Configures the category axis minor ticks.
+   */
+  minorTicks?: AxisTicks;
+
+  /**
+   * Sets the unique category axis name.
+   * To associate a series with a category axis, set the [`series.categoryAxis`]({% slug api_charts_seriesitem %}#categoryaxis) option to the name of the axis.
+   * {% platform_content angular %}
+   * See the [Multiple Categorical Chart Axes](https://www.telerik.com/kendo-angular-ui/components/charts/elements/axes#multiple-categorical-chart-axes) example.
+   * {% endplatform_content %}
+   */
+  name?: string;
+
+  /**
+   * Configures the date axis date range labels.
+   */
+  rangeLabels?: CategoryAxisRangeLabels;
+
+  /**
+   * Sets the name of the pane in which the category axis has to be rendered.
+   * If not set, the axis will be rendered in the first (default) pane.
+   */
+  pane?: string;
+
+  /**
+   * Sets the plot bands of the category axis.
+   */
+  plotBands?: PlotBand[];
+
+  /**
+   * Determines if the category axis direction is reversed.
+   * By default, categories are listed from left to right and from bottom to top.
+   */
+  reverse?: boolean;
+
+  /**
+   * Determines if the Chart rounds the first and last date to the nearest base unit.
+   */
+  roundToBaseUnit?: boolean;
+
+  /**
+   * Sets the angle (degrees) of the first category on the axis.
+   * Angles increase clockwise with zero to the left and negative values are acceptable.
+   */
+  startAngle?: number;
+
+  /**
+   * Sets the category axis type.
+   * Use `"category"` for a discrete category axis or `"date"` for a specialized axis for displaying chronological data.
+   */
+  type?: 'category' | 'date';
+
+  /**
+   * Determines if the Chart displays the category axis.
+   * By default, the category axis is visible.
+   */
+  visible?: boolean;
+
+  /**
+   * Sets the week start day when the `baseUnit` is set to `"weeks"`.
+   */
+  weekStartDay?: WeekStartDay;
+
+  /**
+   * Configures the crosshair options.
+   * The crosshair is displayed when the [`categoryAxis.crosshair.visible`]({% slug api_charts_categoryaxiscrosshair %}#visible) option is set to `true`.
+   */
+  crosshair?: CategoryAxisCrosshair;
+
+  /**
+   * Configures the axis labels.
+   */
+  labels?: CategoryAxisLabels;
+
+  /**
+   * Configures the category axis notes.
+   */
+  notes?: CategoryAxisNotes;
+
+  /**
+   * Configures the selected axis range.
+   * Setting this option enables axis selection and the range is index-based, starting from zero. Categories with indexes in the range (`select.from`, `select.to`) will be selected, but the last category in the range will not be included in the selection. If the categories are dates, specify the range with date values. Selection is only supported if the axis is horizontal.
+   */
+  select?: CategoryAxisSelect;
+
+  /**
+   * Configures the title of the category axis.
+   * To display the title, set the [`categoryAxis.title.text`]({% slug api_charts_categoryaxistitle %}#text) option.
+   */
+  title?: CategoryAxisTitle;
+}

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

@@ -0,0 +1,36 @@
+import { Border, Margin } from '../property-types';
+/**
+ * Specifies the configuration options of the Chart area.
+ */
+export interface ChartArea {
+
+  /**
+   * Specifies the background color of the Chart area. Accepts a valid CSS color string, including hex and rgb.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of the Chart area.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the height of the Chart area.
+   */
+  height?: number;
+
+  /**
+   * Specifies the margin of the Chart area. A numeric value sets all margins.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Specifies the background opacity of the Chart area. By default, the background is opaque.
+   */
+  opacity?: number;
+
+  /**
+   * Specifies the width of the Chart area.
+   */
+  width?: number;
+}

package/dist/npm/option-types/legend/inactive-items.interface.d.ts

@@ -0,0 +1,12 @@
+import { LegendLabels } from '../../property-types';
+
+/**
+ * Represents the configuration options of the inactive legend items.
+ */
+export interface LegendInactiveItems {
+
+  /**
+   * Specifies the label configuration of the Chart legend.
+   */
+  labels?: LegendLabels;
+}

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

@@ -0,0 +1,124 @@
+import { drawing } from '@progress/kendo-drawing';
+import { Border, DashType, LegendItemVisualArgs } from '../../property-types';
+import { SeriesMarkers } from './../series-item/markers.interface';
+
+/**
+ * Represents the configuration options of the legend item.
+ */
+export interface LegendItem {
+
+  /**
+   * Specifies the cursor style of the legend item.
+   */
+  cursor?: string;
+
+  /**
+     * Specifies the type of the legend item.
+     * The default value is based on the series type.
+     */
+  type?: LegendItemType;
+
+  /**
+   * Specifies the configuration of the legend items of type `line`.
+   * This is the default legend item type for all line and scatter series.
+   */
+  line?: LegendItemLine;
+
+  /**
+   * Specifies the configuration of the legend items of type `area`.
+   * By default, all series except line and scatter use this legend type.
+   */
+  area?: LegendItemArea;
+
+  /**
+   * Specifies the markers configuration of the legend item.
+   * Defaults to the series options.
+   */
+  markers?: LegendItemMarkers;
+
+  /**
+   * Specifies the highlight configuration of the legend item.
+   */
+  highlight?: LegendItemHighlight;
+
+  /**
+   * Specifies a function for creating a custom visual for the legend items.
+   */
+  visual?: (e: LegendItemVisualArgs) => drawing.Element;
+}
+
+/**
+ * The configuration of the Chart legend item markers border.
+ */
+export interface LegendItemMarkersBorder extends Omit<Border, 'width'> { }
+
+/**
+ * The configuration of the Chart legend item markers.
+ */
+export interface LegendItemMarkers extends Omit<SeriesMarkers, 'size' | 'border' | 'rotation' | 'from' | 'to'> {
+    /**
+     * Specifies the border of the markers.
+     */
+    border?: LegendItemMarkersBorder;
+}
+
+/**
+ * The configuration of the Chart legend item highlight state.
+ */
+export interface LegendItemHighlight {
+    /**
+     * Determines whether the hover effect of the legend item is disabled.
+     * When set to `false`, the hover effect is disabled.
+     */
+    visible?: boolean;
+    /**
+     * Specifies the `markers` configuration of the legend item when it is hovered.
+     */
+    markers?: LegendItemMarkers;
+}
+
+/**
+ * The configuration of the Chart legend item of type `line`.
+ * Defaults to the series options.
+ */
+export interface LegendItemLine {
+    /**
+     * Specifies the color of the legend item. Accepts a valid CSS color string, including HEX and RGB.
+     * Defaults to the series color.
+     */
+    color?: string;
+    /**
+     * Specifies the opacity of the legend item.
+     * Defaults to the series opacity.
+     */
+    opacity?: number;
+    /**
+     * Specifies the dash type of the legend item.
+     * Defaults to the series dash type.
+     */
+    dashType?: DashType;
+}
+
+/**
+ * The configuration of the Chart legend items of type `area`.
+ * Defaults to the series options.
+ */
+export interface LegendItemArea {
+    /**
+     * Specifies the background color of the legend item. Accepts a valid CSS color string, including HEX and RGB.
+     * Defaults to the series color.
+     */
+    background?: string;
+    /**
+     * Specifies the opacity of the legend item.
+     * Defaults to the series opacity.
+     */
+    opacity?: number;
+}
+
+/**
+ * Specifies the type of the Chart legend item.
+ *
+ * The options are `"line"` for rendering legend items as a line (default for line charts) and `"area"` for rendering legend items as a filled rectangle (default for area charts).
+ */
+export type LegendItemType = 'line' | 'area';

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

@@ -0,0 +1,67 @@
+import { Element } from '@progress/kendo-drawing';
+import { Border, Margin, Padding, TitleVisualArgs } from '../../property-types';
+
+/**
+ * Represents the configuration options for the Legend title.
+ * {% platform_content angular %}
+ * See the [Adding a Legend Title example](https://www.telerik.com/kendo-angular-ui/components/charts/elements/legend#adding-a-title).
+ * {% endplatform_content %}
+ */
+export interface LegendTitle {
+  /**
+   * Specifies the alignment of the title.
+   */
+  align?: 'center' | 'left' | 'right';
+
+  /**
+   * 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 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 margins.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Specifies the position of the title.
+   */
+  position?: 'top' | 'bottom';
+
+  /**
+   * Specifies the text of the title.
+   * You can split the text into multiple lines by using the line feed characters ("\n").
+   */
+  text?: string;
+
+  /**
+   * Determines whether the Chart displays the Legend title.
+   * When set to `true`, the title is visible. By default, the title is displayed.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies a function for creating a custom visual for the title.
+   */
+  visual?: (args: TitleVisualArgs) => Element;
+}

package/dist/npm/option-types/legend/markers.interface.d.ts

@@ -0,0 +1,34 @@
+import { drawing } from '@progress/kendo-drawing';
+import { MarkersVisualArgs, MarkerType } from '../../property-types';
+
+/**
+ * Represents the configuration options of the legend markers.
+ */
+export interface LegendMarkers {
+
+  /**
+   * Specifies the width (in pixels) of the markers. Defaults to `15`.
+   */
+  width?: number;
+
+  /**
+   * Specifies the height (in pixels) of the markers. Defaults to `3`.
+   */
+  height?: number;
+
+  /**
+   * Specifies the shape of the legend item markers. Defaults to `circle`.
+   */
+  type?: MarkerType;
+
+  /**
+   * Determines whether the Chart displays the markers.
+   * When set to `true`, the markers are visible. By default, the legend item markers are displayed.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies a function for creating a custom visual for the markers.
+   */
+  visual?: (e: MarkersVisualArgs) => drawing.Element;
+}

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

@@ -0,0 +1,120 @@
+import { Border, LegendLabels, Margin, Padding, LegendTitle, FocusHighlight } from '../property-types';
+import { LegendInactiveItems } from './legend/inactive-items.interface';
+import { LegendItem } from './legend/item.interface';
+import { LegendMarkers } from './legend/markers.interface';
+
+/**
+ * Specifies the configuration options of the Chart legend.
+ * {% platform_content angular %}
+ * See [implementation examples](https://www.telerik.com/kendo-angular-ui/components/charts/elements/legend).
+ * {% endplatform_content %}
+ */
+export interface Legend {
+
+  /**
+   * Specifies how the legend aligns horizontally when [`position`](#position) is set to `"top"` or `"bottom"`
+   * or aligns vertically when [`position`](#position) is set to `"left"` or `"right"`.
+   */
+  align?: 'start' | 'center' | 'end';
+
+  /**
+   * Specifies the background color of the legend. Accepts a valid CSS color string, including hex and rgb.
+   */
+  background?: string;
+
+  /**
+   * Specifies the border of the legend.
+   */
+  border?: Border;
+
+  /**
+   * Specifies the height of the legend when [`orientation`](#orientation) is set to `"vertical"`.
+   */
+  height?: number;
+
+  /**
+   * Specifies the label configuration of the Chart legend.
+   */
+  labels?: LegendLabels;
+
+  /**
+   * Specifies the margin of the Chart legend. A numeric value sets all paddings.
+   */
+  margin?: Margin | number;
+
+  /**
+   * Specifies the X offset of the Chart legend. The offset is relative to the default position of the legend.
+   * For example, a value of `20` moves the legend 20 pixels to the right of its initial position.
+   * Negative values move the legend to the left of its current position.
+   */
+  offsetX?: number;
+
+  /**
+   * Specifies the Y offset of the chart legend. The offset is relative to the current position of the legend.
+   * For example, a value of `20` moves the legend 20 pixels down from its initial position.
+   * Negative values move the legend upwards from its current position.
+   */
+  offsetY?: number;
+
+  /**
+   * Specifies the orientation of the legend items.
+   */
+  orientation?: 'vertical' | 'horizontal';
+
+  /**
+   * Specifies the padding of the Chart legend. A numeric value sets all paddings.
+   */
+  padding?: Padding | number;
+
+  /**
+   * Specifies the positions of the Chart legend.
+   * Setting the legend position to `custom` allows you to position the legend using the [`offsetX`](#offsetx) and [`offsetY`](#offsety) options.
+   */
+  position?: 'top' | 'bottom' | 'left' | 'right' | 'custom';
+
+  /**
+   * Determines whether the legend items are reversed.
+   */
+  reverse?: boolean;
+
+  /**
+   * Determines whether the Chart displays the legend. By default, the Chart legend is visible.
+   */
+  visible?: boolean;
+
+  /**
+   * Specifies the legend width when the [`orientation`](#orientation) is set to `"horizontal"`.
+   */
+  width?: number;
+
+  /**
+   * Specifies the configuration of the Chart inactive legend items.
+   */
+  inactiveItems?: LegendInactiveItems;
+
+  /**
+   * Specifies the configuration of the Chart legend item.
+   */
+  item?: LegendItem;
+
+  /**
+   * Specifies the configuration of the Chart legend markers.
+   */
+  markers?: LegendMarkers;
+
+  /**
+   * Specifies the distance (in pixels) between the legend items. Defaults to `6`.
+   */
+  spacing?: number;
+
+  /**
+   * Specifies the title of the Chart legend.
+   * By default, the Chart will not render a legend title.
+   */
+  title?: LegendTitle;
+
+  /**
+   * Specifies the focus highlight configuration options of the Chart legend.
+   */
+  focusHighlight?: FocusHighlight;
+}

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

@@ -0,0 +1,15 @@
+
+/**
+ * Represents the navigator hint content function arguments.
+ */
+export interface NavigatorHintContentArgs {
+  /**
+   * Specifies the lower boundary of the selected range.
+   */
+  from?: Date;
+
+  /**
+   * Specifies the upper boundary of the selected range.
+   */
+  to?: Date;
+}

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

@@ -0,0 +1,27 @@
+import { NavigatorHintContentArgs } from './hint-content-args.interface';
+
+/**
+ * Represents the `navigator.hint` options.
+ */
+export interface NavigatorHintOptions {
+  /**
+   * Specifies a function that returns the content of the hint.
+   */
+  content?: (e: NavigatorHintContentArgs) => string;
+
+  /**
+   * Specifies the format of the hint.
+   *
+   * By default, the format is set to `"{0} - {1}"`, where `"{0}"` represents the start value of the selected range, and `"{1}"` represents the end value.
+   *
+   * {% platform_content angular %}
+   * Example of usage: `[hint]="{format:'{0:dd.MM.yyyy} {1:yyyy.dd.MM}'}"`
+   * {% endplatform_content %}
+   */
+  format?: string;
+
+  /**
+   * Specifies the visibility of the hint.
+   */
+  visible?: boolean;
+}