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

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

@@ -4,58 +4,58 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, Margin, Padding } from '../common/property-types';
 /**
- * The configuration options of the subtitle
+ * Specifies the configuration options of the subtitle
  * ([see example]({% slug api_charts_subtitlecomponent %})).
  */
 export interface Subtitle {
     /**
-     * The alignment of the subtitle.
+     * Specifies the alignment of the subtitle.
      *
      * By default, the subtitle has the same alignment as the title.
      *
-     * The alignment options for subtitle include `center` for middle alignment, `left` for left alignment, and `right` for right alignment, allowing for flexible positioning of the subtitle.
+     * Use `center` for middle alignment, `left` for left alignment, and `right` for right alignment.
      */
     align?: 'center' | 'left' | 'right';
     /**
-     * The background color of the subtitle. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the background color of the subtitle. Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border of the subtitle.
+     * Specifies the border of the subtitle.
      */
     border?: Border;
     /**
-     * The text color of the subtitle. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the text color of the subtitle. Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
-     * The font of the subtitle.
+     * Specifies the font of the subtitle.
      */
     font?: string;
     /**
-     * The margin of the subtitle. A numeric value sets all margins.
+     * Specifies the margin of the subtitle. A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The padding of the subtitle. A numeric value sets all paddings.
+     * Specifies the padding of the subtitle. A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * The position of the subtitle.
+     * Specifies the position of the subtitle.
      *
      * By default, the subtitle is placed in the same position as the title.
      *
-     * The positioning options for subtitle include `bottom` for positioning at the bottom and `top` for positioning at the top, providing flexibility in the subtitle placement.
+     * Use `bottom` to place the subtitle at the bottom or `top` to place it at the top.
      */
     position?: 'top' | 'bottom';
     /**
-     * The text of the chart subtitle. You can also set the text directly for a title with default options.
+     * Specifies the text of the chart subtitle. You can also set the text directly for a title with default options.
      *
-     * You can split the text into multiple lines by using the line feed characters ("\n").
+     * Use line feed characters ("\n") to split the text into multiple lines.
      */
     text?: string;
     /**
-     * If set to `true`, the Chart displays the subtitle. By default, the subtitle is displayed.
+     * Determines whether the Chart displays the subtitle. By default, the subtitle is displayed.
      */
     visible?: boolean;
 }

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

@@ -4,57 +4,57 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, Margin, Padding } from '../common/property-types';
 /**
- * The configuration options of the title
+ * Specifies the configuration options of the title
  * ([see example]({% slug api_charts_titlecomponent %})).
  */
 export interface Title {
     /**
-     * The alignment of the title.
-     * The alignment options for text include `center` for middle alignment, `left` for left alignment, and `right` for right alignment, allowing for flexible positioning of the title.
+     * Specifies the alignment of the title.
+     * Use `center` for middle alignment, `left` for left alignment, and `right` for right alignment.
      */
     align?: 'center' | 'left' | 'right';
     /**
-     * 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 of the title.
+     * Specifies the font 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 padding of the title. A numeric value sets all margins.
+     * Specifies the padding of the title. A numeric value sets all margins.
      */
     padding?: Padding | number;
     /**
-     * The position of the title.
-     * The positioning options for titles include `bottom` for positioning at the bottom and `top` for positioning at the top, providing flexibility in title placement.
+     * Specifies the position of the title.
+     * Use `bottom` to place the title at the bottom or `top` to place it at the top.
      */
     position?: 'top' | 'bottom';
     /**
-     * The text of the chart title. You can also set the text directly for a title with default options.
-     * You can split the text into multiple lines by using the line feed characters ("\n").
+     * Specifies the text of the chart title. You can also set the text directly for a title with default options.
+     * Use line feed characters ("\n") to split the text into multiple lines.
      */
     text?: string;
     /**
-     * The accessible description of the Chart.
+     * Specifies the accessible description of the Chart.
      *
-     * The description is announced by screen readers when the Chart is focused.
+     * Screen readers announce the description when the Chart is focused.
      */
     description?: string;
     /**
-     * If set to `true`, the Chart displays the title. By default, the title is displayed.
+     * Determines whether the Chart displays the title. By default, the title is displayed.
      */
     visible?: boolean;
 }

package/option-types/tooltip-border.interface.d.ts

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, DashType } from '../common/property-types';
 /**
- * The border options of the tooltip.
+ * Represents the tooltip border options.
  */
 export interface TooltipBorder extends Omit<Border, 'dashType'> {
     /**

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

@@ -5,27 +5,27 @@
 import { Padding } from '../common/property-types';
 import { TooltipBorder } from './tooltip-border.interface';
 /**
- * The configuration options of the tooltip.
+ * Specifies the configuration options of the tooltip.
  */
 export interface Tooltip {
     /**
-     * The background color of the tooltip. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the background color of the tooltip. Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border configuration options.
+     * Specifies the border configuration options.
      */
     border?: TooltipBorder;
     /**
-     * The text color of the tooltip. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the text color of the tooltip. Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
-     * The font of the tooltip.
+     * Specifies the font of the tooltip.
      */
     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.
      *
      * The Area, Bar, Column, Funnel, Pyramid, Line, and Pie are represented by `{0}` as the value placeholder.
      *
@@ -37,19 +37,19 @@ export interface Tooltip {
      */
     format?: string;
     /**
-     * The opacity of the tooltip.
+     * Specifies the opacity of the tooltip.
      */
     opacity?: number;
     /**
-     * The padding of the tooltip. A numeric value sets all paddings.
+     * Specifies the padding of the tooltip. A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * If set to `true`, the Chart displays a single tooltip for every category.
+     * Determines whether the Chart displays a single tooltip for every category.
      */
     shared?: boolean;
     /**
-     * If set to `true`, the Chart displays the series tooltip.
+     * Determines whether the Chart displays the series tooltip.
      * By default, the series tooltip is not displayed.
      */
     visible?: boolean;

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

@@ -4,30 +4,31 @@
 *-------------------------------------------------------------------------------------------*/
 import { ValueAxisCrosshairTooltip } from './crosshair.tooltip.interface';
 /**
- * The configuration options of the value axis crosshair.
+ * Represents the value axis crosshair options.
  */
 export interface ValueAxisCrosshair {
     /**
-     * The color of the crosshair. Accepts a valid CSS color string, including HEX and RGB.
+     * Sets the color of the crosshair.
+     * Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
-     * The opacity of the crosshair. By default, the crosshair is opaque.
+     * Sets the opacity of the crosshair.
+     * By default, the crosshair is opaque.
      */
     opacity?: number;
     /**
-     * If set to `true`, the Chart displays the value axis crosshair.
+     * Determines if the Chart displays the value axis crosshair.
      * By default, the value axis crosshair is not visible.
      */
     visible?: boolean;
     /**
-     * The width of the crosshair in pixels.
+     * Sets the width of the crosshair in pixels.
      */
     width?: number;
     /**
-     * The options of the crosshair tooltip.
-     * The crosshair tooltip is displayed when the [`valueAxis.crosshair.tooltip.visible`]({% slug api_charts_valueaxiscrosshairtooltip %}#toc-visible)
-     * option is set to `true`.
+     * Configures the crosshair tooltip options.
+     * The crosshair tooltip is displayed when the [`valueAxis.crosshair.tooltip.visible`]({% slug api_charts_valueaxiscrosshairtooltip %}#toc-visible) option is set to `true`.
      */
     tooltip?: ValueAxisCrosshairTooltip;
 }

package/option-types/value-axis-item/crosshair.tooltip.interface.d.ts

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { AxisCrosshairTooltip } from "../axis-crosshair-tooltip.interface";
 /**
- * The configuration options of the value axis crosshair tooltip.
+ * Represents the value axis crosshair tooltip options.
  */
 export interface ValueAxisCrosshairTooltip extends AxisCrosshairTooltip {
 }

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

@@ -6,38 +6,38 @@ import { drawing } from '@progress/kendo-drawing';
 import { AxisLabelContentArgs, AxisLabelsPosition, AxisLabelVisualArgs, Border, LabelRotation, Margin } from '../../common/property-types';
 import { Padding } from '../../common/property-types';
 /**
- * The configuration options of the value axis labels.
+ * Represents the configuration options of the value axis labels.
  */
 export interface ValueAxisLabels {
     /**
-     * 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 label content.
-     * The function argument contains a `value` field which defines the label value.
+     * Specifies a function which returns the label content.
+     * Specifies the function argument contains a `value` field which defines the label value.
      * You can split the text into multiple lines by using the line feed characters (`"\n"`).
      */
     content?: (e: AxisLabelContentArgs) => string;
     /**
-     * The font style of the labels.
+     * Specifies the font style of the labels.
      */
     font?: string;
     /**
-     * The format for displaying the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
+     * Specifies the format for displaying the labels. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
      * Contains one placeholder (`"{0}"`) which represents the category value.
      */
     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;
     /**
@@ -46,28 +46,28 @@ export interface ValueAxisLabels {
      */
     mirror?: boolean;
     /**
-     * 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 position of the axis labels. By default, labels are positioned next to the axis.
+     * Specifies the position of the axis labels. By default, labels are positioned next to the axis.
      * When `position` is set to `end`, the labels are placed at the end of the crossing axis, usually at the top or right end of the Chart unless the crossing axis has been reversed.
      * Alternatively, when the `position` property is set to `start`, the axis labels will be positioned at the beginning of the crossing axis, typically located at the left or bottom end of the Chart, unless the crossing axis has been reversed.
      */
     position?: AxisLabelsPosition;
     /**
-     * The rotation angle (in degrees) of the labels. By default, the labels are not rotated. Angles
+     * Specifies the rotation angle (in degrees) of the labels. By default, the labels are not rotated. Angles
      * increase clockwise and zero is to the left. Negative values are acceptable. Can be set to `"auto"` if
-     * the axis is horizontal. In this case, the labels will be rotated only if the slot size is not
+     * the axis is horizontal. In this case, labels will be rotated only if the slot size is not
      * sufficient for the entire labels.
      */
     rotation?: LabelRotation | number | 'auto';
     /**
-     * The number of labels to skip. By default, no labels are skipped.
+     * Specifies the number of labels to skip. By default, no labels are skipped.
      */
     skip?: number;
     /**
-     * The label rendering step.
+     * Specifies the label rendering step.
      * Every n<sup>th</sup> label is rendered where `n` is the step.
      */
     step?: number;
@@ -77,7 +77,7 @@ export interface ValueAxisLabels {
      */
     visible?: boolean;
     /**
-     * A function for creating custom visuals for the labels.
+     * Specifies a function for creating custom visuals for the labels.
      */
     visual?: (e: AxisLabelVisualArgs) => drawing.Element;
 }

package/option-types/value-axis-item/notes.icon.interface.d.ts

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

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

@@ -7,31 +7,31 @@ import { AxisNoteVisualArgs, NoteLine, NotePosition } from '../../common/propert
 import { ValueAxisNotesIcon } from './notes.icon.interface';
 import { ValueAxisNotesLabel } from './notes.label.interface';
 /**
- * The configuration options of the value axis notes.
+ * Represents the configuration options of the value axis notes.
  */
 export interface ValueAxisNotes {
     /**
-     * The items of the notes.
+     * Specifies the items of the notes.
      */
     data?: any[];
     /**
-     * The line of the notes.
+     * Specifies the line of the notes.
      */
     line?: NoteLine;
     /**
-     * The position of the value axis note.
+     * Specifies the position of the value axis note.
      */
     position?: NotePosition;
     /**
-     * A function for creating custom visuals for the notes.
+     * Specifies a function for creating custom visuals for the notes.
      */
     visual?: (e: AxisNoteVisualArgs) => drawing.Element;
     /**
-     * The icon of the notes.
+     * Specifies the icon of the notes.
      */
     icon?: ValueAxisNotesIcon;
     /**
-     * The label of the notes.
+     * Specifies the label of the notes.
      */
     label?: ValueAxisNotesLabel;
 }

package/option-types/value-axis-item/notes.label.interface.d.ts

@@ -4,45 +4,48 @@
 *-------------------------------------------------------------------------------------------*/
 import { AxisNoteContentArgs, Border, NoteLabelPosition } from '../../common/property-types';
 /**
- * The configuration options of the value axis notes label.
+ * Represents the value axis notes label options.
  */
 export interface ValueAxisNotesLabel {
     /**
-     * The background color of the label. Accepts a valid CSS color string, including HEX and RGB.
+     * Sets the background color of the label.
+     * Accepts a valid CSS color string, including HEX and RGB.
      */
     background?: string;
     /**
-     * The border of the label.
+     * Configures the border of the label.
      */
     border?: Border;
     /**
-     * The text color of the label. Accepts a valid CSS color string, including HEX and RGB.
+     * Sets the text color of the label.
+     * Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
-     * The function which returns the label content.
-     * You can split the text into multiple lines by using the line feed characters (`"\n"`).
+     * Sets the function which returns the label content.
+     * You can split the text into multiple lines by using line feed characters (`"\n"`).
      */
     content?: (e: AxisNoteContentArgs) => string;
     /**
-     * The font style of the label.
+     * Sets the font style of the label.
      */
     font?: string;
     /**
-     * The format used to display the notes label. Uses the IntlService [`format`]({% slug api_intl_intlservice %}#toc-format) method.
-     * Contains one placeholder (`"{0}"`) which represents the axis value.
+     * Sets the format used to display the notes label.
+     * Uses the `IntlService` [`format`]({% slug api_intl_intlservice %}#toc-format) method and contains one placeholder (`"{0}"`) which represents the axis value.
      */
     format?: string;
     /**
-     * The position of the labels.
+     * Sets the position of the labels.
      */
     position?: NoteLabelPosition;
     /**
-     * The rotation angle of the label. By default, the label is not rotated.
+     * Sets the rotation angle of the label.
+     * By default, the label is not rotated.
      */
     rotation?: number;
     /**
-     * If set to `true`, the Chart displays the value axis notes label.
+     * Determines if the Chart displays the value axis notes label.
      * By default, the value axis notes label is visible.
      */
     visible?: boolean;

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

@@ -5,43 +5,43 @@
 import { drawing } from '@progress/kendo-drawing';
 import { AxisTitlePosition, Border, Margin, Padding, TitleVisualArgs } from '../../common/property-types';
 /**
- * The configuration options of the value axis title.
+ * Represents the configuration options of the value axis title.
  */
 export interface ValueAxisTitle {
     /**
-     * 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 padding of the title. A numeric value sets all paddings.
+     * Specifies the padding of the title. A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * The position of the title.
+     * Specifies the position of the title.
      */
     position?: AxisTitlePosition;
     /**
-     * The rotation angle of the title. By default, the title is not rotated.
+     * Specifies the rotation angle of the title. By default, the title is not rotated.
      */
     rotation?: number;
     /**
-     * The text of the title.
+     * Specifies the text of the title.
      * You can split the text into multiple lines by using the line feed characters (`"\n"`).
      */
     text?: string;
@@ -51,7 +51,7 @@ export interface ValueAxisTitle {
      */
     visible?: boolean;
     /**
-     * A function for creating a custom visual for the title.
+     * Specifies a function for creating a custom visual for the title.
      */
     visual?: (e: TitleVisualArgs) => drawing.Element;
 }