API / Configuration / AxisPlotShape
Defined in: src/core/types/chart/axis.ts:301
Extends
Properties
| Property | Type | Description |
|---|---|---|
color? |
string |
The color of the plot line (hex, rgba). |
custom? |
any |
Custom data associated with the plot line/band, accessible in tooltip renderer args. |
label? |
object |
- |
label.padding? |
number |
The pixel padding for label. Default 5 |
label.qa? |
string |
Can be used for the UI automated test. It is assigned as a data-qa attribute to an element. |
label.style? |
Partial<BaseTextStyle> |
- |
label.text |
string |
- |
layerPlacement? |
PlotLayerPlacement |
Place the line behind or above the chart. |
opacity? |
number |
Individual opacity for the line. Default 1 |
renderer |
(args: object) => string |
Custom SVG content renderer. Called with the pixel coordinates of the shape and the plot area dimensions. Must return a string of valid SVG markup that will be inserted inside a <g> container positioned at the shape's axis value. Example renderer: ({plotHeight}) => |
value |
string | number |
The position of the shape in axis units. Can be a number or a string (e.g., a category). When representing a date, the value must be a timestamp (number of milliseconds since Unix epoch). |
Previous
Next