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

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

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

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

@@ -4,28 +4,28 @@
 *-------------------------------------------------------------------------------------------*/
 import { XAxisCrosshairTooltip } from './crosshair.tooltip.interface';
 /**
- * The configuration options of the X-axis crosshair.
+ * Represents the configuration options of the X-axis crosshair.
  */
 export interface XAxisCrosshair {
     /**
-     * The color of the crosshair. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies 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.
+     * Specifies the opacity of the crosshair. By default, the crosshair is opaque.
      */
     opacity?: number;
     /**
-     * If set to `true`, the Chart displays the X-axis crosshair of the Scatter Chart.
+     * Determines whether the Chart displays the X-axis crosshair of the Scatter Chart.
      * By default, the X-axis crosshair of the Scatter Chart is not visible.
      */
     visible?: boolean;
     /**
-     * The width of the crosshair in pixels.
+     * Specifies the width of the crosshair in pixels.
      */
     width?: number;
     /**
-     * The options of the crosshair tooltip.
+     * Specifies the options of the crosshair tooltip.
      * The crosshair tooltip is displayed when the [`xAxis.crosshair.tooltip.visible`]({% slug api_charts_xaxiscrosshairtooltip %}#toc-visible) option is set to `true`.
      */
     tooltip?: XAxisCrosshairTooltip;

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

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

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

@@ -6,75 +6,76 @@ import { drawing } from '@progress/kendo-drawing';
 import { AxisLabelContentArgs, AxisLabelsPosition, AxisLabelVisualArgs, Border, DateFormats, LabelRotation } from '../../common/property-types';
 import { Margin, Padding } from '../../common/property-types';
 /**
- * The configuration of the X-axis labels.
+ * Represents the configuration of the X-axis labels.
  */
 export interface XAxisLabels {
     /**
-     * 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.
+     * Specifies a function which returns the label content.
      * You can split the text into multiple lines by using the line feed characters (`"\n"`).
      */
     content?: (e: AxisLabelContentArgs) => string;
     /**
-     * The culture to use when formatting date values.
-     * The specified culture must be loaded as demonstrated in the [Internationalization Overview]({% slug overview_intl %}).
+     * Specifies the culture to use when formatting date values.
+     * You must load the specified culture as demonstrated in the [Internationalization Overview]({% slug overview_intl %}).
      */
     culture?: string;
     /**
-     * The format for displaying the labels when the X values are dates. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
+     * Specifies the format for displaying the labels when the X values are dates. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
      * Contains one placeholder (`"{0}"`) which represents the category value.
-     * The Chart selects the appropriate format for the current [`xAxis.baseUnit`]({% slug api_charts_xaxis %}#toc-baseunit). Setting the
+     * Charts select the appropriate format for the current [`xAxis.baseUnit`]({% slug api_charts_xaxis %}#toc-baseunit). Setting the
      * [`categoryAxis.labels.format`]({% slug api_charts_categoryaxislabels %}#toc-format) option overrides the date formats.
      */
     dateFormats?: DateFormats;
     /**
-     * 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;
     /**
-     * If set to `true`, the Chart mirrors the axis labels and ticks. If the labels are normally on the
+     * Determines whether the Chart mirrors the axis labels and ticks.
+     * When set to `true`, the Chart mirrors the axis labels and ticks. If the labels are normally on the
      * left side of the axis, the mirroring of the axis renders them to the right.
      */
     mirror?: boolean;
     /**
-     * The padding of the labels. A numeric value sets all paddings.
+     * Specifies the padding of the labels. A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * The rotation angle of the labels. By default, the labels are not rotated. Can be set to `"auto"`.
+     * Specifies the rotation angle of the labels. By default, the labels are not rotated. Can be set to `"auto"`.
      * In this case, the labels are rotated only if the slot size is not sufficient for the entire labels.
      */
     rotation?: LabelRotation | number | 'auto';
     /**
-     * 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.
      */
     position?: AxisLabelsPosition;
     /**
-     * The number of labels to skip.
+     * Specifies the number of labels to skip.
      */
     skip?: number;
     /**
-     * The label rendering step&mdash;renders every n<sup>th</sup> label. By default, every label is rendered.
+     * Specifies the label rendering step&mdash;renders every n<sup>th</sup> label. By default, every label is rendered.
      */
     step?: number;
     /**
@@ -82,7 +83,7 @@ export interface XAxisLabels {
      */
     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/x-axis-item/notes.icon.interface.d.ts

@@ -4,27 +4,27 @@
 *-------------------------------------------------------------------------------------------*/
 import { Border, MarkerType } from '../../common/property-types';
 /**
- * The configuration options of the X-axis notes icon.
+ * Represents the configuration options of the X-axis notes icon.
  */
 export interface XAxisNotesIcon {
     /**
-     * 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/x-axis-item/notes.interface.d.ts

@@ -7,31 +7,31 @@ import { AxisNoteVisualArgs, NoteLine, NotePosition } from '../../common/propert
 import { XAxisNotesIcon } from './notes.icon.interface';
 import { XAxisNotesLabel } from './notes.label.interface';
 /**
- * The  configuration options of the X-axis notes.
+ * Represents the configuration options of the X-axis notes.
  */
 export interface XAxisNotes {
     /**
-     * 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 X-axis note.
+     * Specifies the position of the X-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?: XAxisNotesIcon;
     /**
-     * The label of the notes.
+     * Specifies the label of the notes.
      */
     label?: XAxisNotesLabel;
 }

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

@@ -4,46 +4,48 @@
 *-------------------------------------------------------------------------------------------*/
 import { AxisNoteContentArgs, Border, NoteLabelPosition } from '../../common/property-types';
 /**
- * The configuration options of the X-axis notes label.
+ * Represents the X-axis notes label options.
  */
 export interface XAxisNotesLabel {
     /**
-     * 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.
-     * The function argument contains a `value` field. It defines the axis value.
-     * You can split the text into multiple lines by using the line feed characters (`"\n"`).
+     * Sets the function which returns the label content.
+     * The function argument contains a `value` field which defines the axis value. You can split the text into multiple lines by using line feed characters (`"\n"`).
      */
     content?: (e: AxisNoteContentArgs) => string;
     /**
-     * The font style of the label.
+     * Sets the font style of the label.
      */
     font?: string;
     /**
-     * The format for displaying the notes label. Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of IntlService.
-     * Contains one placeholder (`"{0}"`) which represents the axis value.
+     * Sets the format for displaying the notes label.
+     * Uses the [`format`]({% slug api_intl_intlservice %}#toc-format) method of `IntlService` 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 X-axis notes label.
+     * Determines if the Chart displays the X-axis notes label.
      * By default, the X-axis notes label is visible.
      */
     visible?: boolean;

package/option-types/x-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 X-axis title.
+ * Represents the configuration options of the X-axis title.
  */
 export interface XAxisTitle {
     /**
-     * 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 XAxisTitle {
      */
     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: TitleVisualArgs) => drawing.Element;
 }

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

@@ -8,7 +8,7 @@ import { XAxisLabels } from './x-axis-item/labels.interface';
 import { XAxisNotes } from './x-axis-item/notes.interface';
 import { XAxisTitle } from './x-axis-item/title.interface';
 /**
- * The configuration options of the X-axis.
+ * Represents the configuration options of the X-axis.
  */
 export interface XAxis {
     /**
@@ -18,7 +18,7 @@ export interface XAxis {
      */
     axisCrossingValue?: any | any[];
     /**
-     * The background color of the axis.
+     * Specifies the background color of the axis.
      */
     background?: string;
     /**
@@ -31,7 +31,7 @@ export interface XAxis {
      */
     baseUnit?: BaseUnit;
     /**
-     * The color of the axis. Accepts a valid CSS color string, including HEX and RGB.
+     * Specifies the color of the axis. Accepts a valid CSS color string, including HEX and RGB.
      */
     color?: string;
     /**
@@ -100,7 +100,7 @@ export interface XAxis {
      */
     reverse?: boolean;
     /**
-     * The angle (in degrees) where the zero value is placed.
+     * Specifies the angle (in degrees) where the zero value is placed.
      * Angles increase counterclockwise and zero is to the right. Negative values are acceptable.
      */
     startAngle?: number;

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

@@ -4,28 +4,30 @@
 *-------------------------------------------------------------------------------------------*/
 import { YAxisCrosshairTooltip } from './crosshair.tooltip.interface';
 /**
- * The configuration options of the Y-axis crosshair.
+ * Represents the Y-axis crosshair options.
  */
 export interface YAxisCrosshair {
     /**
-     * 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 Y-axis crosshair of the Scatter Chart.
+     * Determines if the Chart displays the Y-axis crosshair of the Scatter Chart.
      * By default, the Y-axis crosshair of the Scatter Chart is not visible.
      */
     visible?: boolean;
     /**
-     * The width of the crosshair in pixels.
+     * Sets the width of the crosshair in pixels.
      */
     width?: number;
     /**
-     * The options of the crosshair tooltip.
+     * Configures the crosshair tooltip options.
      * The crosshair tooltip is displayed when the [`yAxis.crosshair.tooltip.visible`]({% slug api_charts_yaxiscrosshairtooltip %}#toc-visible) option is set to `true`.
      */
     tooltip?: YAxisCrosshairTooltip;

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

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