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

package/field-types/marker-type.d.ts

@@ -8,12 +8,12 @@
  * > Note that `"rect"` is an alias for `"square"`.
  *
  * The possible values are:
- * - `"square"`—The marker is a square.
- * - `"circle"`—The marker is a circle.
- * - `"triangle"`—The marker is a triangle.
- * - `"cross"`—The marker is a cross.
- * - `"rect"`—The marker is a rectangle.
- * - `"roundedRect"`—The marker is a rounded rectangle.
+ * - `"square"`—Creates a square marker.
+ * - `"circle"`—Creates a circle marker.
+ * - `"triangle"`—Creates a triangle marker.
+ * - `"cross"`—Creates a cross marker.
+ * - `"rect"`—Creates a rectangle marker.
+ * - `"roundedRect"`—Creates a rounded rectangle marker.
  *
  * @example
  * ```ts

package/field-types/modifier-key.d.ts

@@ -6,10 +6,10 @@
  * Specifies a modifier key.
  *
  * The possible values are:
- * - `"none"`—No modifier key is pressed.
- * - `"ctrl"`—The `Ctrl` key is pressed.
- * - `"shift"`—The `Shift` key is pressed.
- * - `"alt"`—The `Alt` key is pressed.
+ * - `"none"`—Requires no modifier key.
+ * - `"ctrl"`—Requires the `Ctrl` key.
+ * - `"shift"`—Requires the `Shift` key.
+ * - `"alt"`—Requires the `Alt` key.
  *
  * @example
  * ```ts

package/field-types/mousewheel-select.interface.d.ts

@@ -3,18 +3,18 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Configuration of the mousewheel action for selection.
+ * Specifies the configuration of the mousewheel action for selection.
  */
 export interface MousewheelSelect {
     /**
-     * If set to `true`, the option reverses the mousewheel direction.
+     * Determines whether to reverse the mousewheel direction.
      * The normal direction is down for `"zoom out"`.
      * The normal direction is up for `"zoom in"`.
      */
     reverse?: boolean;
     /**
-     * The zoom direction of the selection.
-     * The `both` option enables zooming to expand and contract the selection on both sides, while the `left` option allows zooming on the left side only, and the `right` option permits zooming on the right side only.
+     * Specifies the zoom direction of the selection.
+     * Use `both` to enable zooming to expand and contract the selection on both sides, `left` to allow zooming on the left side only, or `right` to permit zooming on the right side only.
      */
     zoom?: 'both' | 'left' | 'right';
 }

package/field-types/mousewheel-zoom.interface.d.ts

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { LockAxis } from './lock-axis';
 /**
- * The configuration of the mousewheel action for zooming.
+ * Specifies the configuration of the mousewheel action for zooming.
  */
 export interface MousewheelZoom {
     /**
@@ -14,7 +14,7 @@ export interface MousewheelZoom {
     /**
      * Specifies the zoom rate as percentage of the axis range. The default value is 0.3 or 30% of the axis range.
      *
-     * The accepted range is from 0.01 to 0.9 (1% to 90%).
+     * Accepts the range from 0.01 to 0.9 (1% to 90%).
      *
      */
     rate?: number;

package/field-types/negative-bubble-values.interface.d.ts

@@ -3,15 +3,15 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The appearance settings for the negative values in the Bubble series.
+ * Specifies the appearance settings for the negative values in the Bubble series.
  */
 export interface NegativeBubbleValues {
     /**
-     * The color of the negative bubble Chart values.
+     * Specifies the color of the negative bubble Chart values.
      */
     color?: string;
     /**
-     * If set to `true`, the Chart displays the negative bubbles.
+     * Determines whether the Chart displays the negative bubbles.
      * By default, the negative bubbles are not displayed.
      */
     visible?: boolean;

package/field-types/note-label-position.d.ts

@@ -3,11 +3,11 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The position of a note label.
+ * Specifies the position of a note label.
  *
  * The possible values are:
- * - `"inside"`—The note label is positioned inside the axis.
- * - `"outside"`—The note label is positioned outside the axis.
+ * - `"inside"`—Positions the note label inside the axis.
+ * - `"outside"`—Positions the note label outside the axis.
  *
  * @example
  * ```ts

package/field-types/note-line.interface.d.ts

@@ -4,23 +4,23 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type';
 /**
- * The appearance settings for the note-connecting line.
+ * Specifies the appearance settings for the note-connecting line.
  */
 export interface NoteLine {
     /**
-     * The color of the note line. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the color of the note line. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The dash type of the note line.
+     * Specifies the dash type of the note line.
      */
     dashType?: DashType;
     /**
-     * The length of the connecting line in pixels.
+     * Specifies the length of the connecting line in pixels.
      */
     length?: number;
     /**
-     * The width of the connecting line in pixels.
+     * Specifies the width of the connecting line in pixels.
      */
     width?: number;
 }

package/field-types/note-position.d.ts

@@ -6,10 +6,10 @@
  * Specifies the position of a note.
  *
  * The possible values are:
- * - `"top"`—The note is positioned at the top of the axis.
- * - `"bottom"`—The note is positioned at the bottom of the axis.
- * - `"left"`—The note is positioned at the left of the axis.
- * - `"right"`—The note is positioned at the right of the axis.
+ * - `"top"`—Positions the note at the top of the axis.
+ * - `"bottom"`—Positions the note at the bottom of the axis.
+ * - `"left"`—Positions the note at the left of the axis.
+ * - `"right"`—Positions the note at the right of the axis.
  *
  * @example
  * ```ts

package/field-types/overlay.interface.d.ts

@@ -3,13 +3,13 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Appearance settings for the overlay of the series elements.
+ * Specifies the appearance settings for the overlay of the series elements.
  */
 export interface Overlay {
     /**
-     * The gradient of the Chart series.
+     * Specifies the gradient of the Chart series.
      *
-     * The `glass` is applicable for Bar, Column and Candlestick. The `roundedBevel` and `sharpBevel` are applicable to Donut and Pie series.
+     * Use `glass` for Bar, Column and Candlestick series. Use `roundedBevel` and `sharpBevel` for Donut and Pie series.
      */
     gradient?: 'glass' | 'none' | 'roundedBevel' | 'sharpBevel';
 }

package/field-types/padding.interface.d.ts

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { Margin } from './margin.interface';
 /**
- * The padding configuration for each side accepted by the [`padding`](slug:api_charts_titlecomponent#toc-padding) option.
+ * Specifies the padding configuration for each side accepted by the [`padding`](slug:api_charts_titlecomponent#toc-padding) option.
  */
 export interface Padding extends Margin {
 }

package/field-types/plot-band-label.interface.d.ts

@@ -8,70 +8,70 @@ import { Border } from './border.interface';
 import { Margin } from './margin.interface';
 import { Padding } from './padding.interface';
 /**
- * The appearance configuration for the plot band label.
+ * Specifies the appearance configuration for the plot band label.
  */
 export interface PlotBandLabel {
     /**
-     * The horizontal alignment of the label text.
+     * Specifies the horizontal alignment of the label text.
      *
      * By default, the label is aligned to the left.
      *
-     * The positioning of the label within a plot band can be set to `center` for center positioning, `right` for positioning on the right side, or `left` for positioning on the left side.
+     * Use `center` for center positioning, `right` for positioning on the right side, or `left` for positioning on the left side.
      */
     align?: 'center' | 'right' | 'left';
     /**
-     * The background color of the label. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the background color of the label. Accepts a valid CSS color string, including hex and rgb.
      */
     background?: string;
     /**
-     * The border of the label.
+     * Specifies the border of the label.
      */
     border?: Border;
     /**
-     * The color of the plot band label text.
+     * Specifies the color of the plot band label text.
      * Accepts a valid [CSS `color`](https://developer.mozilla.org/en-US/docs/Web/CSS/color)
      * configuration string, including hex and rgb.
      */
     color?: string;
     /**
-     * The font of the plot band label text.
+     * Specifies the font of the plot band label text.
      * Accepts a valid [CSS `font`](https://developer.mozilla.org/en-US/docs/Web/CSS/font)
      * configuration string.
      */
     font?: string;
     /**
-     * The margin of the label. A numeric value sets all margins.
+     * Specifies the margin of the label. A numeric value sets all margins.
      */
     margin?: Margin | number;
     /**
-     * The padding of the label. A numeric value sets all paddings.
+     * Specifies the padding of the label. A numeric value sets all paddings.
      */
     padding?: Padding | number;
     /**
-     * The vertical position of the label inside the plot band.
+     * Specifies the vertical position of the label inside the plot band.
      *
      * By default, the label is aligned to the top.
      *
-     * The positioning of the label within a plot band can be set to `bottom` for positioning at the bottom, `center` for center positioning, or `top` for positioning at the top.
+     * Use `bottom` for positioning at the bottom, `center` for center positioning, or `top` for positioning at the top.
      */
     position?: 'bottom' | 'center' | 'top';
     /**
-     * The rotation angle of the label. By default, the label is not rotated.
+     * Specifies the rotation angle of the label. By default, the label is not rotated.
      */
     rotation?: number;
     /**
-     * The text of the label.
+     * Specifies the text of the label.
      *
-     * The text can be split into multiple lines by using line feed characters ("\n").
+     * You can split the text into multiple lines by using line feed characters ("\n").
      */
     text?: string;
     /**
-     * If set to `false`, the will not display the plot band label.
+     * Determines whether to display the plot band label.
      * By default, the plot band labels are not displayed.
      */
     visible?: boolean;
     /**
-     * A function that can be used to create a custom visual for the label.
+     * Specifies a function that can be used to create a custom visual for the label.
      */
     visual?: (e: PlotBandLabelVisualArgs) => drawing.Element;
 }

package/field-types/plot-band.interface.d.ts

@@ -4,27 +4,27 @@
 *-------------------------------------------------------------------------------------------*/
 import { PlotBandLabel } from './plot-band-label.interface';
 /**
- * A plot band.
+ * Specifies a plot band.
  */
 export interface PlotBand {
     /**
-     * The color of the plot band.
+     * Specifies the color of the plot band.
      */
     color?: string;
     /**
-     * The start position of the plot band in axis units.
+     * Specifies the start position of the plot band in axis units.
      */
     from?: number | Date;
     /**
-     * The opacity of the plot band.
+     * Specifies the opacity of the plot band.
      */
     opacity?: number;
     /**
-     * The end position of the plot band in axis units.
+     * Specifies the end position of the plot band in axis units.
      */
     to?: number | Date;
     /**
-     * The label configuration of the plot band.
+     * Specifies the label configuration of the plot band.
      *
      * To display a label, set the text option.
      *

package/field-types/series-labels-alignment.d.ts

@@ -3,18 +3,18 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The alignment of the label when [`series.type`](slug:api_charts_series#toc-type) is set to `"donut"`, `"funnel"`, `"pyramid"` or `"pie"`.
+ * Specifies the alignment of the label when [`series.type`](slug:api_charts_series#toc-type) is set to `"donut"`, `"funnel"`, `"pyramid"` or `"pie"`.
  *
- * The supported values  for `"donut"` and `"pie"` are:
+ * The supported values for `"donut"` and `"pie"` are:
  *
- * - `"circle"`—The labels are positioned in circle around the Chart.
- * - `"column"`—The labels are positioned in columns to the left and right of the Chart.
+ * - `"circle"`—Positions the labels in circle around the Chart.
+ * - `"column"`—Positions the labels in columns to the left and right of the Chart.
  *
  * The supported values for `"funnel"` and `"pyramid"` are:
  *
- * - `"center"`—The labels are positioned in the center over the segment.
- * - `"right"`—The labels are positioned on the right side of the Chart and, if there is enough space, do not overlap the segments.
- * - `"left"`—The labels are positioned on the left side of the Chart and, if there is enough space, do not overlap the segments.
+ * - `"center"`—Positions the labels in the center over the segment.
+ * - `"right"`—Positions the labels on the right side of the Chart and, if there is enough space, do not overlap the segments.
+ * - `"left"`—Positions the labels on the left side of the Chart and, if there is enough space, do not overlap the segments.
  *
  */
 export type SeriesLabelsAlignment = 'circle' | 'column' | 'center' | 'right' | 'left';

package/field-types/series-labels-position.d.ts

@@ -3,19 +3,19 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Configures the position of the series labels.
+ * Specifies the position of the series labels.
  *
- * - `"above"`—The label is positioned at the top of the marker. Applicable for series that render points, including the Bubble series.
- * - `"below"`—The label is positioned at the bottom of the marker. Applicable for series that render points, including the Bubble series.
- * - `"center"`—The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, Pyramid, RadarColumn, and Waterfall series.
- * - `"insideBase"`—The label is positioned inside, near the base of the bar. Applicable for the Bar, Column, and Waterfall series.
- * - `"insideEnd"`—The label is positioned inside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series.
- * - `"left"`—The label is positioned to the left of the marker. Applicable for series that render points, including the Bubble series.
- * - `"outsideEnd"`—The label is positioned outside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series. Not applicable for stacked series.
- * - `"right"`—The label is positioned to the right of the marker. Applicable for series that render points, including the Bubble series.
- * - `"top"`—The label is positioned at the top of the segment. Applicable for the Funnel and Pyramid series.
- * - `"bottom"`—The label is positioned at the bottom of the segment. Applicable for the Funnel and Pyramid series.
- * - `"auto"`—The from and to labels are positioned at the top or bottom (for the RangeArea series), or to the left or right (for the VerticalRangeArea series), so that they are outside the filled area. Applicable for the RangeArea and VerticalRangeArea series.
+ * - `"above"`—Positions the label at the top of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"below"`—Positions the label at the bottom of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"center"`—Positions the label at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, Pyramid, RadarColumn, and Waterfall series.
+ * - `"insideBase"`—Positions the label inside, near the base of the bar. Applicable for the Bar, Column, and Waterfall series.
+ * - `"insideEnd"`—Positions the label inside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series.
+ * - `"left"`—Positions the label to the left of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"outsideEnd"`—Positions the label outside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, RadarColumn, and Waterfall series. Not applicable for stacked series.
+ * - `"right"`—Positions the label to the right of the marker. Applicable for series that render points, including the Bubble series.
+ * - `"top"`—Positions the label at the top of the segment. Applicable for the Funnel and Pyramid series.
+ * - `"bottom"`—Positions the label at the bottom of the segment. Applicable for the Funnel and Pyramid series.
+ * - `"auto"`—Positions the from and to labels at the top or bottom (for the RangeArea series), or to the left or right (for the VerticalRangeArea series), so that they are outside the filled area. Applicable for the RangeArea and VerticalRangeArea series.
  *
  */
 export type SeriesLabelsPosition = 'auto' | 'above' | 'below' | 'center' | 'insideBase' | 'insideEnd' | 'left' | 'outsideEnd' | 'right' | 'top' | 'bottom';

package/field-types/series-line.interface.d.ts

@@ -4,24 +4,24 @@
 *-------------------------------------------------------------------------------------------*/
 import { LineStyle } from './line-style';
 /**
- * The appearance settings for the line of the Area, Candlestick, OHLC, and Waterfall series.
+ * Specifies the appearance settings for the line of the Area, Candlestick, OHLC, and Waterfall series.
  */
 export interface SeriesLine {
     /**
-     * The color of the line. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the color of the line. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The line opacity. By default, the line is opaque (`opacity = 1`).
+     * Specifies the line opacity. By default, the line is opaque (`opacity = 1`).
      */
     opacity?: number;
     /**
-     * The drawing style of the line.
+     * Specifies the drawing style of the line.
      * Applicable for the Area, Range Area, Polar Area, and Radar Area series.
      */
     style?: LineStyle;
     /**
-     * The line width in pixels.
+     * Specifies the line width in pixels.
      * By default, the width is set to `0` and the line is not visible.
      */
     width?: number;

package/field-types/series-mean.interface.d.ts

@@ -4,23 +4,23 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type';
 /**
- * The appearance settings for the BoxPlot mean value indicator (line).
+ * Specifies the appearance settings for the BoxPlot mean value indicator (line).
  */
 export interface SeriesMean {
     /**
-     * The color of the line. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the color of the line. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The dash type of the line. By default, the line is dashed (`[dashType]="dash"`).
+     * Specifies the dash type of the line. By default, the line is dashed (`[dashType]="dash"`).
      */
     dashType?: DashType;
     /**
-     * The line opacity. By default, the line is opaque (`[opacity]="1"`).
+     * Specifies the line opacity. By default, the line is opaque (`[opacity]="1"`).
      */
     opacity?: number;
     /**
-     * The width (in pixels) of the line. By default, the line is 2px wide (`[width]="2"`).
+     * Specifies the width (in pixels) of the line. By default, the line is 2px wide (`[width]="2"`).
      */
     width?: number;
 }

package/field-types/series-median.interface.d.ts

@@ -4,23 +4,23 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type';
 /**
- * The appearance settings for the BoxPlot median value indicator (line).
+ * Specifies the appearance settings for the BoxPlot median value indicator (line).
  */
 export interface SeriesMedian {
     /**
-     * The color of the line. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the color of the line. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The dash type of the line. By default, the line is solid (`[dashType]="solid"`).
+     * Specifies the dash type of the line. By default, the line is solid (`[dashType]="solid"`).
      */
     dashType?: DashType;
     /**
-     * The line opacity. By default, the line is opaque (`[opacity]="1"`).
+     * Specifies the line opacity. By default, the line is opaque (`[opacity]="1"`).
      */
     opacity?: number;
     /**
-     * The width (in pixels) of the line. By default, the line is 2px wide (`[width]="2"`).
+     * Specifies the width (in pixels) of the line. By default, the line is 2px wide (`[width]="2"`).
      */
     width?: number;
 }

package/field-types/series-stack.interface.d.ts

@@ -3,18 +3,18 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Configures the Stacked series.
+ * Specifies the configuration for Stacked series.
  */
 export interface SeriesStack {
     /**
-     * The optional stack group name.
-     * The `group` option is supported for the Bar and Column series.
+     * Specifies the optional stack group name.
+     * Use this option for the Bar and Column series.
      */
     group?: string;
     /**
-     * The type of stack to plot.
+     * Specifies the type of stack to plot.
      *
-     * The `normal` option sums up all the points within the category or group to determine the stack value. On the other hand, the `100%` option always sets the stack value to 100% (1.00), with individual points represented as percentages within the category or group.
+     * Use `normal` to sum up all the points within the category or group to determine the stack value. Use `100%` to always set the stack value to 100% (1.00), with individual points represented as percentages within the category or group.
      */
     type?: 'normal' | '100%';
 }

package/field-types/series-type.d.ts

@@ -3,47 +3,47 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The series type.
+ * Specifies the series type.
  *
  * The supported values are:
- * - `"area"`—Displays the data as continuous lines that show trends over time, evenly distributed along the category field.
- * - `"bar"`—Displays the data as sets of horizontal bars that show the relationship between individual items and the whole category.
- * - `"boxPlot"`—Displays the data as a box-and-whisker diagram, which shows the distribution of values in a series.
- * - `"bubble"`—Displays the data as bubbles, where each bubble represents a value from the series data.
- * - `"bullet"`—Displays the data as vertical bars that show the performance measure, and markers that show the comparative measure.
- * - `"candlestick"`—Displays the data as candlesticks, which show the open, close, high, and low values of a series.
- * - `"column"`—Displays the data as sets of vertical bars that show the relationship between individual items and the whole category.
- * - `"donut"`—Displays the data as a series of rings that are sliced depending on the value.
- * - `"exponentialTrendline"`—Displays an exponential [trendline]({% slug trendlines_chart_charts %}#toc-exponential-trendline) for the specified parent series.
- * - `"funnel"`—Displays the data as a funnel, which is useful for sales data visualization.
- * - `"heatmap"`—Displays the data as a heatmap, which is useful for comparing values in a matrix.
- * - `"horizontalWaterfall"`—Displays the data as a horizontal waterfall chart, which is useful for comparing positive and negative values over a period.
- * - `"line"`—Displays the data as continuous lines that connect data points evenly distributed along the category field.
- * - `"linearTrendline"`—Displays a linear [trendline]({% slug trendlines_chart_charts %}#toc-linear-trendline) for the specified parent series.
- * - `"logarithmicTrendline"`—Displays a logarithmic [trendline]({% slug trendlines_chart_charts %}#toc-logarithmic-trendline) for the specified parent series.
- * - `"movingAverageTrendline"`—Displays a moving average [trendline]({% slug trendlines_chart_charts %}#toc-moving-average-trendline) for the specified parent series.
- * - `"ohlc"`—Displays the data as OHLC (open-high-low-close) bars, which show the open, high, low, and close values of a series.
- * - `"pie"`—Displays the data as a series of pie slices, which show the contribution of each value to a total.
- * - `"polarArea"`—Displays the data as a series of polar area segments, which show the contribution of each value to a total.
- * - `"polarLine"`—Displays the data as continuous lines that connect data points evenly distributed along the category field.
- * - `"polarScatter"`—Displays the data as points distributed in a polar coordinate system.
- * - `"polynomialTrendline"`—Displays a polynomial [trendline]({% slug trendlines_chart_charts %}#toc-polynomial-trendline) for the specified parent series.
- * - `"powerTrendline"`—Displays a power [trendline]({% slug trendlines_chart_charts %}#toc-power-trendline) for the specified parent series.
- * - `"pyramid"`—Displays the data as a pyramid divided in segments proportional to each value.
- * - `"radarArea"`—Displays the data as a series of radar area segments, which show the contribution of each value to a total.
- * - `"radarColumn"`—Displays the data as sets of vertical bars that show the relationship between individual items and the whole category.
- * - `"radarLine"`—Displays the data as continuous lines that connect data points evenly distributed along the category field.
- * - `"rangeArea"`—Displays the data as a series of range area segments, which show the contribution of each value to a total.
- * - `"rangeBar"`—Displays the data as sets of horizontal bars that show the relationship between individual items and the whole category.
- * - `"rangeColumn"`—Displays the data as sets of vertical bars that show the relationship between individual items and the whole category.
- * - `"scatter"`—Displays the data as points that show the relationship between two variables.
- * - `"scatterLine"`—Displays the data as continuous lines that connect data points evenly distributed along the category field.
- * - `"verticalArea"`—Displays the data as continuous lines that show trends over time, evenly distributed along the category field.
- * - `"verticalBoxPlot"`—Displays the data as a box-and-whisker diagram, which shows the distribution of values in a series.
- * - `"verticalBullet"`—Displays the data as vertical bars that show the performance measure, and markers that show the comparative measure.
- * - `"verticalLine"`—Displays the data as continuous lines that connect data points evenly distributed along the category field.
- * - `"verticalRangeArea"`—Displays the data as a series of range area segments, which show the contribution of each value to a total.
- * - `"waterfall"`—Displays the data as a waterfall chart, which is useful for comparing positive and negative values over a period.
+ * - `"area"`—Shows data as continuous lines that display trends over time, evenly distributed along the category field.
+ * - `"bar"`—Shows data as sets of horizontal bars that display the relationship between individual items and the whole category.
+ * - `"boxPlot"`—Shows data as a box-and-whisker diagram, which displays the distribution of values in a series.
+ * - `"bubble"`—Shows data as bubbles, where each bubble represents a value from the series data.
+ * - `"bullet"`—Shows data as vertical bars that display the performance measure, and markers that display the comparative measure.
+ * - `"candlestick"`—Shows data as candlesticks, which display the open, close, high, and low values of a series.
+ * - `"column"`—Shows data as sets of vertical bars that display the relationship between individual items and the whole category.
+ * - `"donut"`—Shows data as a series of rings that are sliced depending on the value.
+ * - `"exponentialTrendline"`—Shows an exponential [trendline]({% slug trendlines_chart_charts %}#toc-exponential-trendline) for the specified parent series.
+ * - `"funnel"`—Shows data as a funnel, which is useful for sales data visualization.
+ * - `"heatmap"`—Shows data as a heatmap, which is useful for comparing values in a matrix.
+ * - `"horizontalWaterfall"`—Shows data as a horizontal waterfall chart, which is useful for comparing positive and negative values over a period.
+ * - `"line"`—Shows data as continuous lines that connect data points evenly distributed along the category field.
+ * - `"linearTrendline"`—Shows a linear [trendline]({% slug trendlines_chart_charts %}#toc-linear-trendline) for the specified parent series.
+ * - `"logarithmicTrendline"`—Shows a logarithmic [trendline]({% slug trendlines_chart_charts %}#toc-logarithmic-trendline) for the specified parent series.
+ * - `"movingAverageTrendline"`—Shows a moving average [trendline]({% slug trendlines_chart_charts %}#toc-moving-average-trendline) for the specified parent series.
+ * - `"ohlc"`—Shows data as OHLC (open-high-low-close) bars, which display the open, high, low, and close values of a series.
+ * - `"pie"`—Shows data as a series of pie slices, which display the contribution of each value to a total.
+ * - `"polarArea"`—Shows data as a series of polar area segments, which display the contribution of each value to a total.
+ * - `"polarLine"`—Shows data as continuous lines that connect data points evenly distributed along the category field.
+ * - `"polarScatter"`—Shows data as points distributed in a polar coordinate system.
+ * - `"polynomialTrendline"`—Shows a polynomial [trendline]({% slug trendlines_chart_charts %}#toc-polynomial-trendline) for the specified parent series.
+ * - `"powerTrendline"`—Shows a power [trendline]({% slug trendlines_chart_charts %}#toc-power-trendline) for the specified parent series.
+ * - `"pyramid"`—Shows data as a pyramid divided in segments proportional to each value.
+ * - `"radarArea"`—Shows data as a series of radar area segments, which display the contribution of each value to a total.
+ * - `"radarColumn"`—Shows data as sets of vertical bars that display the relationship between individual items and the whole category.
+ * - `"radarLine"`—Shows data as continuous lines that connect data points evenly distributed along the category field.
+ * - `"rangeArea"`—Shows data as a series of range area segments, which display the contribution of each value to a total.
+ * - `"rangeBar"`—Shows data as sets of horizontal bars that display the relationship between individual items and the whole category.
+ * - `"rangeColumn"`—Shows data as sets of vertical bars that display the relationship between individual items and the whole category.
+ * - `"scatter"`—Shows data as points that display the relationship between two variables.
+ * - `"scatterLine"`—Shows data as continuous lines that connect data points evenly distributed along the category field.
+ * - `"verticalArea"`—Shows data as continuous lines that display trends over time, evenly distributed along the category field.
+ * - `"verticalBoxPlot"`—Shows data as a box-and-whisker diagram, which displays the distribution of values in a series.
+ * - `"verticalBullet"`—Shows data as vertical bars that display the performance measure, and markers that display the comparative measure.
+ * - `"verticalLine"`—Shows data as continuous lines that connect data points evenly distributed along the category field.
+ * - `"verticalRangeArea"`—Shows data as a series of range area segments, which display the contribution of each value to a total.
+ * - `"waterfall"`—Shows data as a waterfall chart, which is useful for comparing positive and negative values over a period.
  *
  * @example
  * ```ts

package/field-types/series-whiskers.interface.d.ts

@@ -4,23 +4,23 @@
 *-------------------------------------------------------------------------------------------*/
 import { DashType } from './dash-type';
 /**
- * The appearance settings for the BoxPlot whiskers.
+ * Specifies the appearance settings for the BoxPlot whiskers.
  */
 export interface SeriesWhiskers {
     /**
-     * The color of the whiskers. Accepts a valid CSS color string, including hex and rgb.
+     * Specifies the color of the whiskers. Accepts a valid CSS color string, including hex and rgb.
      */
     color?: string;
     /**
-     * The dash type of the whiskers.
+     * Specifies the dash type of the whiskers.
      */
     dashType?: DashType;
     /**
-     * The whiskers opacity. By default, the whiskers area is opaque (`opacity = 1`).
+     * Specifies the whiskers opacity. By default, the whiskers area is opaque (`opacity = 1`).
      */
     opacity?: number;
     /**
-     * The width (in pixels) of the whiskers.
+     * Specifies the width (in pixels) of the whiskers.
      */
     width?: number;
 }