ChartStripLineProps
Configures the properties for customizing strip lines on a chart axis. Strip lines are used to highlight specific vertical or horizontal ranges in the plot area, making it easier to visualize key thresholds, targets, or events.
Props
The following table outlines the props for the ChartStripLineProps:
| Name | Type | Default | Description |
|---|---|---|---|
| range | { shouldStartFromAxis: false, start: null, end: null, size: null, sizeType: 'Auto' } | Specifies the range and dimensions of the strip line on the axis. This object defines where the strip line begins, its width or height, and how its size is calculated, forming the core of the highlighted region. | |
| repeat | { enable: false, every: null, until: null } | Configures repeating strip lines that recur at a regular interval. This is useful for highlighting patterns, such as weekends on a date-time axis or alternating bands for every 'n' units on a numeric axis. | |
| segment | { enable: false, start: null, end: null, axisName: null } | Configures a segmented strip line that is rendered only within the specified range of another axis. This enables the creation of conditional highlights that are visible only when a data point falls within a specific range on two different axes. | |
| style | { color: '#808080', opacity: 1, dashArray: '', imageUrl: '', border: { color: '', width: 1, dashArray: '' }, zIndex: 'Behind' } | Customizes the visual appearance of the strip line, including its background and border. You can set properties like color, opacity, background images, and dash patterns to make the strip line stand out or blend in with the chart's design. | |
| text | { content: '', style: { color: '', fontFamily: '', fontSize: '', fontStyle: '', fontWeight: '', opacity: 1 }, rotation: null, hAlign: 'Center', vAlign: 'Center' } | Configures the text displayed within the strip line. This allows you to add descriptive labels or annotations directly on the highlighted range, with options to control text content, styling, rotation, and alignment. | |
| visible | boolean | false | Enables the visibility of strip lines on the chart.
When set to |