@progress/kendo-angular-charts
Version:
Kendo UI Charts for Angular - A comprehensive package for creating beautiful and interactive data visualization. Every chart type, stock charts, and sparklines are included.
57 lines (56 loc) • 2.93 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2024 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { drawing } from '@progress/kendo-drawing';
import { ErrorBarLine, ErrorBarsValueArgs, ErrorBarsVisualArgs } from '../../common/property-types';
/**
* The configuration options of the series error bars.
*/
export interface SeriesErrorBars {
/**
* The color of the error bars. Accepts a valid CSS color string, including HEX and RGB.
*/
color?: string;
/**
* If set to `false`, the caps of the error bars are not displayed. By default, the caps are visible.
*/
endCaps?: boolean;
/**
* The error bars line options.
*/
line?: ErrorBarLine;
/**
* The error bars value.
* The value option is supported when [series.type]({% slug api_charts_series %}#toc-type) is set to `"bar"`, `"column"`, `"line"`, or `"area"`.
*
* The following value types are supported:
*
* - `"stderr"`—The standard error of the series values will be used to calculate the point low and
* high values.
* - `"stddev(n)"`—The standard deviation of the series values will be used to calculate the point low
* and high values. Between the parentheses, a number can be specified that will be multiplied by the
* calculated standard deviation.
* - `"percentage(n)"`—A percentage of the point value.
* - A number that will be subtracted or added to the point value.
* - An array that holds the low and high difference from the point value.
* - A function that returns the `errorBars` point value.
*/
value?: string | number | [number, number] | ((e: ErrorBarsValueArgs) => [number, number]);
/**
* A function for creating custom visuals for the error bars.
*/
visual?: (e: ErrorBarsVisualArgs) => drawing.Element;
/**
* The value of the [`xAxis`]({% slug api_charts_xaxis %}) error bars. For a list of the supported value
* types, refer to the [`series.errorBars.value`]({% slug api_charts_serieserrorbars %}#toc-value) option.
* The `xValue` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
*/
xValue?: string;
/**
* The value of the [`yAxis`]({% slug api_charts_yaxis %}) error bars. For a list of supported value types, refer
* to the [`series.errorBars.value`]({% slug api_charts_serieserrorbars %}#toc-value) option.
* The `yValue` option is supported when [`series.type`]({% slug api_charts_series %}#toc-type) is set to `"scatter"`, `"scatterLine"`, or `"bubble"`.
*/
yValue?: string;
}