---
title: "Candlestick Series"
enterprise: true
framework: javascript
version: "14.1.0"
---

# Candlestick Series

A Candlestick Series shows open and close data with bars, and high and low data with wicks.

## Simple Candlestick

#### Simple Candlestick

```ts
import {
  AgChartOptions,
  AgCharts,
  AnimationModule,
  CandlestickSeriesModule,
  ContextMenuModule,
  CrosshairModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
  OrdinalTimeAxisModule,
} from "ag-charts-enterprise";
import { getData } from "./data";

ModuleRegistry.registerModules([
  AnimationModule,
  CandlestickSeriesModule,
  CrosshairModule,
  LegendModule,
  NumberAxisModule,
  OrdinalTimeAxisModule,
  ContextMenuModule,
]);

const options: AgChartOptions = {
  data: getData(),
  title: {
    text: "S&P 500 Index",
  },
  subtitle: {
    text: "Daily High and Low Prices",
  },
  footnote: {
    text: "1 Aug 2023 - 1 Nov 2023",
  },
  series: [
    {
      type: "candlestick",
      xKey: "date",
      xName: "Date",
      lowKey: "low",
      highKey: "high",
      openKey: "open",
      closeKey: "close",
    },
  ],
};

options.container = document.getElementById("myChart");

const chart = AgCharts.create(options);
```

[Live example: Simple Candlestick](https://www.ag-grid.com/charts/typescript/candlestick-series/examples/simple-candlestick)

To create a Candlestick Series, use the `candlestick` series type.

```js
{
    series: [
        {
            type: 'candlestick',
            xKey: 'date',
            lowKey: 'low',
            openKey: 'open',
            closeKey: 'close',
            highKey: 'high',
        },
    ],
}
```

In this configuration:

- `xKey` sets the candlestick's x value.
- `lowKey` maps to the low/min value.
- `openKey` maps to the open value.
- `closeKey` maps to the close value.
- `highKey` maps to the high/max value.

## Customisation

#### Candlestick Customisations

```ts
import {
  AgChartOptions,
  AgCharts,
  AnimationModule,
  CandlestickSeriesModule,
  ContextMenuModule,
  CrosshairModule,
  LegendModule,
  ModuleRegistry,
  NumberAxisModule,
  OrdinalTimeAxisModule,
} from "ag-charts-enterprise";
import { getData } from "./data";

ModuleRegistry.registerModules([
  AnimationModule,
  CandlestickSeriesModule,
  CrosshairModule,
  LegendModule,
  NumberAxisModule,
  OrdinalTimeAxisModule,
  ContextMenuModule,
]);

const options: AgChartOptions = {
  data: getData(),
  title: {
    text: "Dow Jones Industrial Average",
  },
  subtitle: {
    text: "Candlestick Patterns",
  },
  footnote: {
    text: "1 Minute",
  },
  series: [
    {
      type: "candlestick",
      xKey: "date",
      xName: "Time",
      lowKey: "low",
      highKey: "high",
      openKey: "open",
      closeKey: "close",
      item: {
        up: {
          fill: "transparent",
          stroke: "#2b5c95",
          wick: {
            strokeWidth: 2,
          },
        },
        down: {
          fill: "#5090dc",
          stroke: "#2b5c95",
          wick: {
            strokeWidth: 2,
          },
        },
      },
    },
  ],
  axes: {
    x: {
      type: "ordinal-time",
      label: {
        format: "%H:%M",
      },
    },
    y: {
      type: "number",
      position: "right",
      label: {
        formatter: ({ value }) => Number(value).toLocaleString(),
      },
      crosshair: {
        label: {
          format: ",.2f",
        },
      },
    },
  },
};

options.container = document.getElementById("myChart");

const chart = AgCharts.create(options);
```

[Live example: Candlestick Customisations](https://www.ag-grid.com/charts/typescript/candlestick-series/examples/candlestick-customisations)

Series items are customised via the `item` configuration object.

Data items with a closing value higher than the opening value are considered as `up`, and those with a closing value lower than the opening value are `down`.

The properties `item.up` and `item.down` control the display of rising and falling series items.

Candlestick wicks inherit series item styles but can be individually customised. Here, the `wick` property on `item.up` and `item.down` is used to customise the wick line styles of the rising and falling candlestick items.

```js
{
    series: [
        {
            type: 'candlestick',
            // ...
            item: {
                up: {
                    fill: 'transparent',
                    stroke: '#2b5c95',
                    wick: {
                        strokeWidth: 2,
                    },
                },
                down: {
                    fill: '#5090dc',
                    stroke: '#2b5c95',
                    wick: {
                        strokeWidth: 2,
                    },
                },
            },
        },
    ],
}
```

## API Reference

#### Candlestick Series

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| type (required) | 'candlestick' |  | Configuration for the Candlestick Series. |
| xKey (required) | DatumKey |  | xKey as specified on series options. |
| openKey (required) | DatumKey |  | The key to use to retrieve open values from the data. |
| closeKey (required) | DatumKey |  | The key to use to retrieve close values from the data. |
| highKey (required) | DatumKey |  | The key to use to retrieve high values from the data. |
| lowKey (required) | DatumKey |  | The key to use to retrieve low values from the data. |
| tooltip | AgSeriesTooltip |  | Series-specific tooltip configuration. |
| tooltip.enabled | boolean |  | Whether to show tooltips when the series are hovered over. |
| tooltip.showArrow | boolean |  | The tooltip arrow is displayed by default, unless the container restricts it or a position offset is provided. To always display the arrow, set `showArrow` to `true`. To remove the arrow, set `showArrow` to `false`. |
| tooltip.range | PixelSize \| 'exact' \| 'nearest' \| 'area' |  | Range from a point that triggers the tooltip to show. Each series type uses its own default; typically this is `'nearest'` for marker-based series and `'exact'` for shape-based series. |
| tooltip.position | AgTooltipPositionOptions |  | The position of the tooltip. Each series type uses its own default; typically this is `'node'` for marker-based series and `'pointer'` for shape-based series. |
| tooltip.position.anchorTo | AgTooltipAnchorTo |  | The element or point to position the tooltip relative to. |
| tooltip.position.placement | AgTooltipPlacement \| AgTooltipPlacement[] |  | The positioning of the tooltip in relation to the element it's anchored to. Multiple values can be provided as a fallback mechanism for the case the tooltip does not fit inside the chart. |
| tooltip.position.xOffset | PixelSize |  | The horizontal offset in pixels for the position of the tooltip. |
| tooltip.position.yOffset | PixelSize |  | The vertical offset in pixels for the position of the tooltip. |
| tooltip.position.offset | PixelSize |  | The distance in pixels between the tooltip and its anchor point, applied in the placement direction.  Default: `12` (`0` when `anchorTo` is `'chart'`). |
| tooltip.interaction | AgSeriesTooltipInteraction |  | Configuration for tooltip interaction. |
| tooltip.interaction.enabled (required) | boolean |  | Set to `true` to keep the tooltip open when the mouse is hovering over it, and enable clicking tooltip text |
| tooltip.renderer | Renderer |  | Function used to create the content for tooltips. |
| itemStyler | Styler |  | Function used to return formatting for individual columns, based on the given parameters. |
| highlight | AgMultiSeriesHighlightOptions |  | Configuration for highlighting when a series or legend item is hovered over. |
| highlight.highlightedSeries | AgCandlestickHighlightStyleOptions |  | Options for the highlighted series. |
| highlight.highlightedSeries.opacity | number |  | The opacity of the whole series (line, fill, labels and markers, if any) |
| highlight.highlightedSeries.wick | AgCandlestickWickOptions |  | Options to style chart's wicks |
| highlight.highlightedSeries.wick.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| highlight.highlightedSeries.wick.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| highlight.highlightedSeries.wick.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| highlight.highlightedSeries.wick.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| highlight.highlightedSeries.wick.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| highlight.highlightedSeries.cornerRadius | PixelSize |  | Apply rounded corners to each bar. |
| highlight.highlightedSeries.fill | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor \| AgGradientColor \| AgPatternColor \| AgImageFill |  | The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill. |
| highlight.highlightedSeries.fillOpacity | Opacity |  | The opacity of the fill colour. |
| highlight.highlightedSeries.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| highlight.highlightedSeries.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| highlight.highlightedSeries.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| highlight.highlightedSeries.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| highlight.highlightedSeries.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| highlight.unhighlightedSeries | AgCandlestickHighlightStyleOptions |  | Options for the un-highlighted series when there is an active highlight. |
| highlight.unhighlightedSeries.opacity | number |  | The opacity of the whole series (line, fill, labels and markers, if any) |
| highlight.unhighlightedSeries.wick | AgCandlestickWickOptions |  | Options to style chart's wicks |
| highlight.unhighlightedSeries.wick.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| highlight.unhighlightedSeries.wick.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| highlight.unhighlightedSeries.wick.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| highlight.unhighlightedSeries.wick.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| highlight.unhighlightedSeries.wick.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| highlight.unhighlightedSeries.cornerRadius | PixelSize |  | Apply rounded corners to each bar. |
| highlight.unhighlightedSeries.fill | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor \| AgGradientColor \| AgPatternColor \| AgImageFill |  | The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill. |
| highlight.unhighlightedSeries.fillOpacity | Opacity |  | The opacity of the fill colour. |
| highlight.unhighlightedSeries.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| highlight.unhighlightedSeries.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| highlight.unhighlightedSeries.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| highlight.unhighlightedSeries.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| highlight.unhighlightedSeries.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| highlight.bringToFront | boolean | true | Show this series in front when highlighted. |
| highlight.enabled | boolean |  | Set to `false` to disable highlighting. |
| highlight.highlightedItem | AgCandlestickHighlightStyleOptions |  | Options for the highlighted item. |
| highlight.highlightedItem.opacity | number |  | The opacity of the whole series (line, fill, labels and markers, if any) |
| highlight.highlightedItem.wick | AgCandlestickWickOptions |  | Options to style chart's wicks |
| highlight.highlightedItem.wick.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| highlight.highlightedItem.wick.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| highlight.highlightedItem.wick.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| highlight.highlightedItem.wick.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| highlight.highlightedItem.wick.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| highlight.highlightedItem.cornerRadius | PixelSize |  | Apply rounded corners to each bar. |
| highlight.highlightedItem.fill | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor \| AgGradientColor \| AgPatternColor \| AgImageFill |  | The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill. |
| highlight.highlightedItem.fillOpacity | Opacity |  | The opacity of the fill colour. |
| highlight.highlightedItem.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| highlight.highlightedItem.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| highlight.highlightedItem.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| highlight.highlightedItem.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| highlight.highlightedItem.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| highlight.unhighlightedItem | AgCandlestickHighlightStyleOptions |  | Options for the un-highlighted items when there is an active highlight. |
| highlight.unhighlightedItem.opacity | number |  | The opacity of the whole series (line, fill, labels and markers, if any) |
| highlight.unhighlightedItem.wick | AgCandlestickWickOptions |  | Options to style chart's wicks |
| highlight.unhighlightedItem.wick.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| highlight.unhighlightedItem.wick.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| highlight.unhighlightedItem.wick.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| highlight.unhighlightedItem.wick.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| highlight.unhighlightedItem.wick.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| highlight.unhighlightedItem.cornerRadius | PixelSize |  | Apply rounded corners to each bar. |
| highlight.unhighlightedItem.fill | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor \| AgGradientColor \| AgPatternColor \| AgImageFill |  | The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill. |
| highlight.unhighlightedItem.fillOpacity | Opacity |  | The opacity of the fill colour. |
| highlight.unhighlightedItem.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| highlight.unhighlightedItem.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| highlight.unhighlightedItem.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| highlight.unhighlightedItem.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| highlight.unhighlightedItem.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| showInMiniChart | boolean |  | Whether to include the series in the Mini Chart. |
| cursor | string |  | The cursor to use for hovered markers. This config is identical to the CSS `cursor` property. |
| context | ContextDefault |  | Context object to use in callbacks. |
| selection | AgSelectionOptions |  | Configuration for data selection. |
| selection.enabled | boolean |  | Set to `true` to enable the data-selection on this series. |
| selection.containment | 'any' \| 'all' | chart.selection.containment | Override the drag-to-select containment rule for this series. |
| selection.selectedItem | AgSelectionStyleOptions |  | Styling options for selected items. |
| selection.selectedItem.opacity | Opacity |  | The opacity of the whole series (line, fill, labels and markers, if any) |
| selection.selectedItem.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| selection.selectedItem.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| selection.selectedItem.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| selection.selectedItem.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| selection.selectedItem.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| selection.selectedItem.fill | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor \| AgGradientColor \| AgPatternColor \| AgImageFill |  | The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill. |
| selection.selectedItem.fillOpacity | Opacity |  | The opacity of the fill colour. |
| selection.unselectedItem | AgSelectionStyleOptions |  | Styling options for unselected items. |
| selection.unselectedItem.opacity | Opacity |  | The opacity of the whole series (line, fill, labels and markers, if any) |
| selection.unselectedItem.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| selection.unselectedItem.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| selection.unselectedItem.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| selection.unselectedItem.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| selection.unselectedItem.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| selection.unselectedItem.fill | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor \| AgGradientColor \| AgPatternColor \| AgImageFill |  | The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill. |
| selection.unselectedItem.fillOpacity | Opacity |  | The opacity of the fill colour. |
| selection.unselectedSeries | AgSelectionStyleOptions |  | Styling options for series with no selections when there is at least one other selected series. |
| selection.unselectedSeries.opacity | Opacity |  | The opacity of the whole series (line, fill, labels and markers, if any) |
| selection.unselectedSeries.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| selection.unselectedSeries.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| selection.unselectedSeries.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| selection.unselectedSeries.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| selection.unselectedSeries.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| selection.unselectedSeries.fill | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor \| AgGradientColor \| AgPatternColor \| AgImageFill |  | The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill. |
| selection.unselectedSeries.fillOpacity | Opacity |  | The opacity of the fill colour. |
| nodeClickRange | PixelSize \| 'exact' \| 'nearest' \| 'area' |  | Range from a node that a click triggers the listener. |
| listeners | AgSeriesListeners |  | A map of event names to event listeners. |
| listeners.seriesNodeClick | Listener |  | The listener to call when a node (marker, column, bar, tile or a pie sector) in the series is clicked. |
| listeners.seriesNodeDoubleClick | Listener |  | The listener to call when a node (marker, column, bar, tile or a pie sector) in the series is double-clicked. |
| item | AgCandlestickSeriesItem |  | Configuration used for the series items. |
| item.up | AgCandlestickSeriesItemOptions |  | Configuration for the rising series items. |
| item.up.wick | AgCandlestickWickOptions |  | Options to style chart's wicks |
| item.up.wick.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| item.up.wick.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| item.up.wick.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| item.up.wick.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| item.up.wick.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| item.up.cornerRadius | PixelSize |  | Apply rounded corners to each bar. |
| item.up.fill | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor \| AgGradientColor \| AgPatternColor \| AgImageFill |  | The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill. |
| item.up.fillOpacity | Opacity |  | The opacity of the fill colour. |
| item.up.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| item.up.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| item.up.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| item.up.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| item.up.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| item.down | AgCandlestickSeriesItemOptions |  | Configuration for the falling series items. |
| item.down.wick | AgCandlestickWickOptions |  | Options to style chart's wicks |
| item.down.wick.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| item.down.wick.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| item.down.wick.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| item.down.wick.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| item.down.wick.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| item.down.cornerRadius | PixelSize |  | Apply rounded corners to each bar. |
| item.down.fill | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor \| AgGradientColor \| AgPatternColor \| AgImageFill |  | The colour for filling shapes. A colour string, or an object for a gradient, pattern, or image fill. |
| item.down.fillOpacity | Opacity |  | The opacity of the fill colour. |
| item.down.stroke | CssColor \| AgColorRef \| AgColorRefMixOnto \| AgColorRefMixOntoColor |  | The colour for the stroke. |
| item.down.strokeWidth | PixelSize |  | The width of the stroke in pixels. |
| item.down.strokeOpacity | Opacity |  | The opacity of the stroke colour. |
| item.down.lineDash | PixelSize[] |  | An array specifying the length in pixels of alternating dashes and gaps. |
| item.down.lineDashOffset | PixelSize |  | The initial offset of the dashed line in pixels. |
| id | string | auto-generated value | Primary identifier for the series. This is provided as `seriesId` in user callbacks to differentiate multiple series. Auto-generated ids are subject to future change without warning, if your callbacks need to vary behaviour by series please supply your own unique `id` value. |
| data | DatumDefault[] |  | The data to use when rendering the series. If this is not supplied, data must be set on the chart instead. |
| visible | boolean |  | Whether to display the series. |
| showInLegend | boolean |  | Whether to include the series in the legend. |
| xKeyAxis | string | 'x' | The key of the x-axis to which this series is bound. |
| yKeyAxis | string | 'y' | The key of the y-axis to which this series is bound. |
| xName | string |  | xName as specified on series options. |
| yName | string |  | yName as specified on series options. |
| openName | string |  | A human-readable description of open values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. |
| closeName | string |  | A human-readable description of close values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. |
| highName | string |  | A human-readable description of high values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. |
| lowName | string |  | A human-readable description of low values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. |