ChartSeriesProps
Represents the configuration model for a chart series. Extend this interface to define properties related to series data and appearance.
Props
The following table outlines the props for the ChartSeriesProps:
| Name | Type | Default | Description |
|---|---|---|---|
| accessibility | { ariaLabel: null, descriptionFormat: null, focusable: true, role: null, tabIndex: 0 } | Enhances accessibility for series elements to ensure compatibility with assistive technologies, such as screen readers and keyboard navigation. | |
| animation | { enable: true, duration: 1000, delay: 0 } | Specifies animation settings for the series, including options to enable or disable animation, and configure its duration and delay for smoother visual transitions. | |
| bearFillColor | string | null | null | Specifies the fill color for bearish candles or points, where the closing price is lower than the opening price. Commonly used to indicate downward price movement. |
| border | { color: '', width: 0 } | Defines the border styling for the series. This includes customization options such as border color and width. | |
| bullFillColor | string | null | null | Specifies the fill color for bullish candles or points, where the closing price is higher than the opening price. Commonly used to indicate upward price movement. |
| cardinalSplineTension | number | 0.5 | Specifies the tension parameter for cardinal splines. This affects the curvature of the spline. |
| close | string | '' | Specifies the data field name that contains the closing price value for each data point in the financial chart. This value represents the price at the end of the time interval. |
| colorField | string | '' | Maps a data source field to assign individual colors to each point in the series. |
| columnSpacing | number | 0 | Defines the spacing between columns in column or bar charts. Accepts a value between 0 and 1. |
| columnWidth | number | null | Specifies the relative width of each column in column and bar charts. Accepts a value between |
| columnWidthInPixel | number | null | Sets a fixed column width in pixels for points in column and bar charts. This property overrides relative sizing and ensures consistent column width across categories. |
| cornerRadius | { topLeft: 0, topRight: 0, bottomLeft: 0, bottomRight: 0 } | Defines the corner radius for data points. | |
| dashArray | string | '' | Defines the dash pattern for the stroke in |
| dataSource | Object | DataManager | '' | Specifies the data source for the series.
Can be an array of JSON objects or an instance of |
| emptyPointSettings | { border: {color: 'gray', width: 1 }, mode: 'Gap', fill: 'gray' } | Customizes the appearance of empty points in the series.
Points with | |
| enableComplexProperty | boolean | false | Enables complex property mapping to improve performance when binding large data sets. |
| enableSolidCandles | boolean | false | Enables the solid candlestick rendering style in charts. When enabled, candlesticks are filled based on the relationship between the open and close prices of the current data point:
|
| enableTooltip | boolean | true | Determines whether tooltips for the chart series are enabled.
Set to |
| fill | string | null | null | Sets the fill color of the series. Accepts any valid CSS color value, including hex codes, RGB, RGBA, HSL. |
| groupName | string | '' | Specifies a group name to overlay mutually exclusive chart series. Series in the same group share the same baseline and axis location. |
| high | string | '' | Specifies the data field name that contains the high price value for each data point in the financial chart. This value represents the highest price reached during the time interval. |
| legendShape | 'SeriesType' | Specifies the shape used to represent the series in the chart legend. | |
| low | string | '' | Specifies the data field name that contains the low price value for each data point in the financial chart. This value represents the lowest price reached during the time interval. |
| maxRadius | number | 3 | Sets the maximum radius for data points (bubbles) in the series. |
| minRadius | number | 1 | Sets the minimum radius for data points (bubbles) in the series. |
| name | string | '' | Sets the name of the series, which is displayed in the chart legend. Useful for identifying multiple series. |
| noRisers | boolean | false | Determines whether vertical risers are rendered in a step series.
When set to |
| opacity | number | 1 | Sets the opacity of the series. Accepts a value between 0 (fully transparent) and 1 (fully opaque). |
| open | string | '' | Specifies the data field name that contains the opening price value for each data point in the financial chart. This value represents the price at the beginning of the time interval. |
| query | Query | string | '' | Defines a query to retrieve data from the data source.
Applicable only when using |
| sizeField | string | '' | Specifies the name of the data field that contains the values used to determine the size (radius) of each bubble in a bubble chart. |
| splineType | 'Natural' | Selects the algorithm used to draw curved lines between data points in spline series. Available options:
| |
| stackingGroup | string | '' | Groups series in stacked column and stacked bar charts.
Series with the same |
| step | 'Left' | Specifies the position of steps in step line chart type.
| |
| tooltipField | string | '' | Maps a specific field from the data source to use as tooltip content. The mapped field's value is stored in the point's tooltip property and it can be accessed through tooltip format. |
| tooltipFormat | string | '' | Defines a custom format string for displaying tooltips when hovering over data points in this series. The format string can include placeholders that will be replaced with actual values. |
| type | 'Line' | Defines the type of series used to visualize the data. Supported types include:
| |
| visible | boolean | true | Controls the visibility of the series on the chart.
When set to |
| width | number | 1 | Defines the stroke width of the series, in pixels. This controls the thickness of the line type series. |
| xAxisName | string | null | null | Specifies the name of the horizontal axis associated with the series.
Requires the |
| xField | string | '' | Specifies the name of the field in the data source that maps values to the x-axis of the chart. This property is essential for identifying which data dimension should be plotted horizontally, such as categories, timestamps, or numerical values. |
| yAxisName | string | null | null | Specifies the name of the vertical axis associated with the series. Requires the |
| yField | string | '' | Specifies the name of the field in the data source that provides the values to be plotted along the y-axis. This property is used to map vertical data points in the chart, such as numerical values or metrics. |
| zOrder | number | 0 | Determines the rendering order of the series within the chart. Series with higher |