@progress/kendo-angular-charts 19.1.2-develop.4 → 19.1.2-develop.5

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

@@ -7,94 +7,94 @@ import { LegendInactiveItems } from './legend/inactive-items.interface';
 import { LegendItem } from './legend/item.interface';
 import { LegendMarkers } from './legend/markers.interface';
 /**
- * The configuration options of the Chart legend ([see examples](slug:legend_chart_charts)).
+ * Specifies the configuration options of the Chart legend ([see examples](slug:legend_chart_charts)).
  */
 export interface Legend {
     /**
-     * The legend is horizontally aligned when [`legend.position`]({% slug api_charts_legend %}#toc-position) is set to `"top"` or `"bottom"`.
-     * The legend is vertically aligned when [`legend.position`]({% slug api_charts_legend %}#toc-position) is set to `"left"` or `"right"`.
+     * Specifies how the legend aligns horizontally when [`legend.position`]({% slug api_charts_legend %}#toc-position) is set to `"top"` or `"bottom"`
+     * or aligns vertically when [`legend.position`]({% slug api_charts_legend %}#toc-position) is set to `"left"` or `"right"`.
      */
     align?: 'start' | 'center' | 'end';
     /**
-     * The background color of the legend. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the background color of the legend. Accepts a valid CSS color string, including hex and rgb.
      */
     background?: string;
     /**
-     * The border of the legend.
+     * Specifies the border of the legend.
      */
     border?: Border;
     /**
-     * The height of the legend when [`legend.orientation`]({% slug api_charts_legend %}#toc-orientation) is set to `"vertical"`.
+     * Specifies the height of the legend when [`legend.orientation`]({% slug api_charts_legend %}#toc-orientation) is set to `"vertical"`.
      */
     height?: number;
     /**
-     * The label configuration of the Chart legend.
+     * Specifies the label configuration of the Chart legend.
      */
     labels?: LegendLabels;
     /**
-     * The margin of the Chart legend. A numeric value sets all paddings.
+     * Specifies the margin of the Chart legend. A numeric value sets all paddings.
      */
     margin?: Margin | number;
     /**
-     * The X offset of the Chart legend. The offset is relative to the default position of the legend.
+     * 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;
     /**
-     * The Y offset of the chart legend. The offset is relative to the current position of the legend.
+     * 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;
     /**
-     * The orientation of the legend items.
+     * Specifies the orientation of the legend items.
      */
     orientation?: 'vertical' | 'horizontal';
     /**
-     * The padding of the Chart legend. A numeric value sets all paddings.
+     * Specifies the padding of the Chart legend. A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * The positions of the Chart legend.
+     * Specifies the positions of the Chart legend.
      * Setting the legend position to `custom` allows you to position the legend using the [`legend.offsetX`](slug:api_charts_legend#toc-offsetx) and [`legend.offsetY`](slug:api_charts_legend#toc-offsety) options.
      */
     position?: 'top' | 'bottom' | 'left' | 'right' | 'custom';
     /**
-     * If set to `true`, the legend items are reversed.
+     * Determines whether the legend items are reversed.
      */
     reverse?: boolean;
     /**
-     * If set to `true`, the Chart displays the legend. By default, the Chart legend is visible.
+     * Determines whether the Chart displays the legend. By default, the Chart legend is visible.
      */
     visible?: boolean;
     /**
-     * The legend width when the [`legend.orientation`]({% slug api_charts_legend %}#toc-orientation) is set to `"horizontal"`.
+     * Specifies the legend width when the [`legend.orientation`]({% slug api_charts_legend %}#toc-orientation) is set to `"horizontal"`.
      */
     width?: number;
     /**
-     * The configuration of the Chart inactive legend items.
+     * Specifies the configuration of the Chart inactive legend items.
      */
     inactiveItems?: LegendInactiveItems;
     /**
-     * The configuration of the Chart legend item.
+     * Specifies the configuration of the Chart legend item.
      */
     item?: LegendItem;
     /**
-     * The configuration of the Chart legend markers.
+     * Specifies the configuration of the Chart legend markers.
      */
     markers?: LegendMarkers;
     /**
-     * The distance (in pixels) between the legend items. Defaults to `6`.
+     * Specifies the distance (in pixels) between the legend items. Defaults to `6`.
      */
     spacing?: number;
     /**
-     * The title of the Chart legend.
+     * Specifies the title of the Chart legend.
      * By default, the Chart will not render a legend title.
      */
     title?: LegendTitle;
     /**
-     * The focus highlight configuration options of the Chart legend.
+     * Specifies the focus highlight configuration options of the Chart legend.
      */
     focusHighlight?: FocusHighlight;
 }

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

@@ -5,46 +5,47 @@
 import { drawing } from '@progress/kendo-drawing';
 import { Border, Margin } from '../../common/property-types';
 /**
- * The `panes.title` options.
+ * Represents the `panes.title` options.
  */
 export interface PanesTitle {
     /**
-     * The background color of the title. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the background color of the title. Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border of the title.
+     * Specifies the border of the title.
      */
     border?: Border;
     /**
-     * The text color of the title. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the text color of the title. Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
-     * The font style of the title.
+     * Specifies the font style of the title.
      */
     font?: string;
     /**
-     * The margin of the title. A numeric value sets all margins.
+     * Specifies the margin of the title. A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The position of the title.
+     * Specifies the position of the title.
      *
-     * The positioning of the axis title can be set to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
+     * 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';
     /**
-     * The text of the title.
+     * Specifies the text of the title.
      * You can split the text into multiple lines by using line feed characters (`"\n"`).
      */
     text?: string;
     /**
-     * If set to `true`, the Chart displays the pane title. By default, the pane title is visible.
+     * 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;
     /**
-     * A function that can be used to create a custom visual for the title.
+     * Specifies a function that can be used to create a custom visual for the title.
      *
      * The available argument fields are:
      *

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

@@ -5,41 +5,42 @@
 import { drawing } from '@progress/kendo-drawing';
 import { Border, Margin } from '../../common/property-types';
 /**
- * The options for default pane title.
+ * Represents the options for default pane title.
  */
 export interface PaneDefaultsTitle {
     /**
-     * The background color of the title. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the background color of the title. Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border of the title.
+     * Specifies the border of the title.
      */
     border?: Border;
     /**
-     * The text color of the title. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the text color of the title. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The font style of the title.
+     * Specifies the font style of the title.
      */
     font?: string;
     /**
-     * The margin of the title. A numeric value sets all margins.
+     * Specifies the margin of the title. A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The position of the title.
+     * Specifies the position of the title.
      *
-     * The positioning of the axis title can be set to `left` for left positioning, `right` for right positioning (both applicable to the horizontal axis), or `center` for positioning in the center.
+     * 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';
     /**
-     * If set to `true`, the Chart displays the pane title. By default, the pane title is visible.
+     * 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;
     /**
-     * A function that can be used to create a custom visual for the title.
+     * Specifies a function that can be used to create a custom visual for the title.
      */
     visual?: (e: any) => drawing.Element;
 }

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

@@ -5,15 +5,15 @@
 import { Border, Margin, Padding } from '../common/property-types';
 import { PanesTitle } from './pane/title.interface';
 /**
- * The configuration options of the Chart pane defaults.
+ * Represents the configuration options of the Chart pane defaults.
  */
 export interface PaneDefaults {
     /**
-     * The background color of the pane. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the background color of the pane. Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border of the pane.
+     * Specifies the border of the pane.
      */
     border?: Border;
     /**
@@ -22,19 +22,19 @@ export interface PaneDefaults {
      */
     clip?: boolean;
     /**
-     * The height of the pane in pixels.
+     * Specifies the height of the pane in pixels.
      */
     height?: number;
     /**
-     * The margin of the pane. A numeric value sets all margins.
+     * Specifies the margin of the pane. A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The padding of the pane. A numeric value sets all paddings.
+     * Specifies the padding of the pane. A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * The title configuration of the pane.
+     * Specifies the title configuration of the pane.
      * To display the title, set the [`panes.title.text`]({% slug api_charts_panestitle %}#toc-text) option.
      */
     title?: PanesTitle;

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

@@ -5,40 +5,43 @@
 import { Border, Margin, Padding } from '../common/property-types';
 import { PanesTitle } from './pane/title.interface';
 /**
- * The configuration options of the Chart pane.
+ * Represents the Chart pane configuration options.
  */
 export interface Pane {
     /**
-     * The background color of the pane. Accepts a valid CSS color string, including hex and rgb.
+     * Sets the background color of the pane.
+     * Accepts a valid CSS color string, including hex and rgb.
      */
     background?: string;
     /**
-     * The border of the pane.
+     * Configures the border of the pane.
      */
     border?: Border;
     /**
-     * Specifies whether the Charts in the pane have to be clipped.
+     * 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;
     /**
-     * The height of the pane in pixels.
+     * Sets the height of the pane in pixels.
      */
     height?: number;
     /**
-     * The margin of the pane. A numeric value sets all margins.
+     * Sets the margin of the pane.
+     * A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The unique name of the pane.
+     * Sets the unique name of the pane.
      */
     name?: string;
     /**
-     * The padding of the pane. A numeric value sets all paddings.
+     * Sets the padding of the pane.
+     * A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * The title configuration of the pane.
+     * Configures the title of the pane.
      * To display the title, set the [`panes.title.text`]({% slug api_charts_panestitle %}#toc-text) option.
      */
     title?: string | PanesTitle;

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

@@ -4,29 +4,29 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, Margin, Padding } from '../common/property-types';
 /**
- * The configuration options of the Chart plot area.
+ * Specifies the configuration options of the Chart plot area.
  */
 export interface PlotArea {
     /**
-     * The background color of the Chart plot area.
+     * Specifies the background color of the Chart plot area.
      * Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border of the plot area.
+     * Specifies the border of the plot area.
      */
     border?: Border;
     /**
-     * The margin of the plot area. A numeric value sets all margins.
+     * Specifies the margin of the plot area. A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The background opacity of the plot area. By default, the background is opaque.
+     * Specifies the background opacity of the plot area. By default, the background is opaque.
      */
     opacity?: number;
     /**
-     * The padding of the plot area. A numeric value sets all paddings.
-     * The default padding for the Pie, Donut, Radar, and Polar Charts is proportional of the Chart size.
+     * 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/option-types/series-defaults/labels.from.interface.d.ts

@@ -4,45 +4,45 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, Margin, Padding, SeriesLabelsContentArgs } from '../../common/property-types';
 /**
- * The configuration options of the Chart series `from` labels.
+ * Represents the configuration options of the Chart series `from` labels.
  */
 export interface SeriesDefaultsLabelsFrom {
     /**
-     * The background color of the `from` labels. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the background color of the `from` labels. Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border of the `from` labels.
+     * Specifies the border of the `from` labels.
      */
     border?: Border;
     /**
-     * The text color of the `from` labels. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the text color of the `from` labels. Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
-     * The function which returns the `from` label content of the Chart series.
+     * 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;
     /**
-     * The font style of the from labels.
+     * Specifies the font style of the from labels.
      */
     font?: string;
     /**
-     * The format of the `from` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) of IntlService.
+     * Specifies the format of the `from` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) of IntlService.
      */
     format?: string;
     /**
-     * The margin of the `from` labels. A numeric value sets all margins.
+     * Specifies the margin of the `from` labels. A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The padding of the `from` labels. A numeric value sets all paddings.
+     * Specifies the padding of the `from` labels. A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * If set to `true`, the Chart displays the series `from` labels.
-     * By default, the Chart series from labels are not displayed.
+     * 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/option-types/series-defaults/labels.interface.d.ts

@@ -7,65 +7,63 @@ import { Border, Margin, Padding, SeriesLabelsContentArgs, SeriesLabelsVisualArg
 import { SeriesDefaultsLabelsFrom } from './labels.from.interface';
 import { SeriesDefaultsLabelsTo } from './labels.to.interface';
 /**
- * The configuration options of the series labels.
+ * Represents the configuration options of the series labels.
  */
 export interface SeriesDefaultsLabels {
     /**
-     * The background color of the labels. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the background color of the labels. Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border of the labels.
+     * Specifies the border of the labels.
      */
     border?: Border;
     /**
-     * The text color of the labels. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the text color of the labels. Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
-     * The function which returns the Chart series labels content.
+     * 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;
     /**
-     * The font style of the labels.
+     * Specifies the font style of the labels.
      */
     font?: string;
     /**
-     * The format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
+     * Specifies the format of the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
      */
     format?: string;
     /**
-     * The margin of the labels. A numeric value sets all margins.
+     * Specifies the margin of the labels. A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The padding of the labels. A numeric value sets all margins.
+     * Specifies the padding of the labels. A numeric value sets all margins.
      */
     padding?: Padding | number;
     /**
-     * The rotation angle of the labels. By default, the labels are not rotated.
+     * 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.
+     * 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;
     /**
-     * A function that can be used to create a custom visual for the labels.
+     * Specifies a function that can be used to create a custom visual for the labels.
      */
     visual?: (e: SeriesLabelsVisualArgs) => drawing.Element;
     /**
-     * The Chart series `from` label configuration.
-     * The Chart displays the series labels when either the [`seriesDefaults.labels.visible`]({% slug api_charts_seriesdefaultslabels %}#toc-visible) or
-     * the [`seriesDefaults.labels.from.visible`]({% slug api_charts_seriesdefaultslabelsfrom %}#toc-visible) option is set to `true`.
+     * Specifies the Chart series `from` label configuration.
+     * Displays the series labels when either the [`seriesDefaults.labels.visible`]({% slug api_charts_seriesdefaultslabels %}#toc-visible) or the [`seriesDefaults.labels.from.visible`]({% slug api_charts_seriesdefaultslabelsfrom %}#toc-visible) option is set to `true`.
      */
     from?: SeriesDefaultsLabelsFrom;
     /**
-     * The Chart series `to` label configuration.
-     * The Chart displays the series labels when either the [`seriesDefaults.labels.visible`]({% slug api_charts_seriesdefaultslabels %}#toc-visible) or
-     * the [`seriesDefaults.labels.to.visible`]({% slug api_charts_seriesdefaultslabelsto %}#toc-visible) option is set to `true`.
+     * Specifies the Chart series `to` label configuration.
+     * Displays the series labels when either the [`seriesDefaults.labels.visible`]({% slug api_charts_seriesdefaultslabels %}#toc-visible) or the [`seriesDefaults.labels.to.visible`]({% slug api_charts_seriesdefaultslabelsto %}#toc-visible) option is set to `true`.
      */
     to?: SeriesDefaultsLabelsTo;
 }

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

@@ -4,45 +4,45 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, Margin, Padding, SeriesLabelsContentArgs } from '../../common/property-types';
 /**
- * The configuration options of the Chart series `to` labels.
+ * Represents the configuration options of the Chart series `to` labels.
  */
 export interface SeriesDefaultsLabelsTo {
     /**
-     * The background color of `to` lables. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the background color of `to` lables. Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border of `to` labels.
+     * Specifies the border of `to` labels.
      */
     border?: Border;
     /**
-     * The text color of `to` labels. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the text color of `to` labels. Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
-     * The function which returns the `from` label content of the Chart series.
+     * 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;
     /**
-     * The font style of the `to` labels.
+     * Specifies the font style of the `to` labels.
      */
     font?: string;
     /**
-     * The format of the `to` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
+     * Specifies the format of the `to` labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
      */
     format?: string;
     /**
-     * The margin of the `to` labels. A numeric value sets all margins.
+     * Specifies the margin of the `to` labels. A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The padding of the `to` labels. A numeric value sets all paddings.
+     * Specifies the padding of the `to` labels. A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * If set to `true`, the Chart displays the `to` labels of the series.
-     * By default, the `to` labels of the Chart series are not displayed.
+     * 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/option-types/series-defaults/notes.icon.interface.d.ts

@@ -4,27 +4,27 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, MarkerType } from '../../common/property-types';
 /**
- * The configuration options of the series notes icon.
+ * Represents the configuration options of the series notes icon.
  */
 export interface SeriesDefaultsNotesIcon {
     /**
-     * The background color of the notes icon.
+     * Specifies the background color of the notes icon.
      */
     background?: string;
     /**
-     * The border of the notes icon.
+     * Specifies the border of the notes icon.
      */
     border?: Border;
     /**
-     * The size of the notes icon.
+     * Specifies the size of the notes icon.
      */
     size?: number;
     /**
-     * The shape of the notes icon.
+     * Specifies the shape of the notes icon.
      */
     type?: MarkerType;
     /**
-     * The visibility of the notes icon.
+     * Determines the visibility of the notes icon.
      */
     visible?: boolean;
 }

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

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