Skip to content

Clip Indicator Config

Configure the band marking plot edges that have data hidden behind them (applies when chart.type is xy).

Every property is optional and falls back to its default. Property anchors are stable: link to any entry as #clipIndicator.propertyName, and to a member of a nested property as #clipIndicator.propertyName.memberName.

front

Whether the clip indicator should be shown in front (true) or behind (false) the series shapes.

  • Default: true
  • Validation: should be a boolean

hatch

The diagonal hatch filling the clip indicator band (use null for a flat fill instead).

  • Default: { spacing: 6, lineWidth: 2 }
  • Validation: should be an object with any of the properties { lineWidth, spacing } or be equal to null

hatch.lineWidth

The thickness (in pixels) of each hatch line; at or above spacing the hatch closes up into a flat fill.

  • Default: 2
  • Validation: should be a number >= to 0

hatch.spacing

The distance (in pixels) between neighbouring hatch lines.

  • Default: 6
  • Validation: should be a number >= to 0

label

The text shown in the clip indicator band, and the band's accessible name (use null for no label; the band is still shown).

  • Default: "Clipped"
  • Validation: should be a string or be equal to null

labelPadding

The space (in pixels) between the clip indicator label and the edges of its band, which also determines the band depth when size is "auto".

  • Default: 2
  • Validation: should be a number >= to 0

size

The depth (in pixels) of the clip indicator band (use "auto" to size it from the label plus labelPadding on both sides).

  • Default: "auto"
  • Validation: should be a number >= to 0 or be equal to "auto"

style

The styles to apply to the clip indicator band, whose fillColor draws the hatch when one is set (strokeColor, strokeOpacity, strokeWidth, fillColor, fillOpacity (use null for none)).

  • Default:
    • { strokeColor: "currentColor", strokeOpacity: 0.4, strokeWidth: 1, strokeDashArray: null, fillColor: "currentColor", fillOpacity: 0.4 } — when hatch is set
    • { strokeColor: null, strokeOpacity: 0, strokeWidth: null, strokeDashArray: null, fillColor: "currentColor", fillOpacity: 0.15 } — when hatch is null
  • Validation: should be an object with any of the properties { fillColor, fillOpacity, strokeColor, strokeDashArray, strokeOpacity, strokeWidth }

style.fillColor

The color of the fill: use null to leave the svg fill attribute unset so that css can supply it, "none" to switch the fill off, or "currentColor" to follow the host page's css color.

  • Default: none
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null

style.fillOpacity

The opacity (0 - 1) of the fill, or null to leave the svg fill-opacity attribute unset.

  • Default: none
  • Validation: should be a number >= to 0 and <= 1 or be equal to null

style.strokeColor

The color of the stroke (outline): use null to leave the svg stroke attribute unset so that css can supply it, "none" to switch the stroke off, or "currentColor" to follow the host page's css color.

  • Default: none
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null

style.strokeDashArray

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: none
  • Validation: should be a valid dash array or be equal to null

style.strokeOpacity

The opacity (0 - 1) of the stroke, or null to leave the svg stroke-opacity attribute unset.

  • Default: none
  • Validation: should be a number >= to 0 and <= 1 or be equal to null

style.strokeWidth

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: none
  • Validation: should be a number >= to 0 or be equal to null

textStyle

The styles to apply to the clip indicator label (strokeColor, strokeOpacity, strokeWidth, fillColor, fillOpacity (use null for none)).

textStyle.fillColor

The color of the fill: use null to leave the svg fill attribute unset so that css can supply it, "none" to switch the fill off, or "currentColor" to follow the host page's css color.

  • Default: "currentColor"
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null

textStyle.fillOpacity

The opacity (0 - 1) of the fill, or null to leave the svg fill-opacity attribute unset.

  • Default: 0.7
  • Validation: should be a number >= to 0 and <= 1 or be equal to null

textStyle.strokeColor

The color of the stroke (outline): use null to leave the svg stroke attribute unset so that css can supply it, "none" to switch the stroke off, or "currentColor" to follow the host page's css color.

  • Default: null
  • Validation: should be a valid svg color (or "none" / "currentColor") or be equal to null

textStyle.strokeDashArray

The dash array pattern of the stroke (e.g. "5, 5"), or null for a solid stroke.

  • Default: null
  • Validation: should be a valid dash array or be equal to null

textStyle.strokeOpacity

The opacity (0 - 1) of the stroke, or null to leave the svg stroke-opacity attribute unset.

  • Default: 0
  • Validation: should be a number >= to 0 and <= 1 or be equal to null

textStyle.strokeWidth

The width (in pixels) of the stroke, or null to leave the svg stroke-width attribute unset.

  • Default: null
  • Validation: should be a number >= to 0 or be equal to null

visible

Whether to mark the plot edges that have data hidden behind them, which happens when an axis min or max excludes some of the values.

  • Default:
    • false — when chart.type is pie
    • true — when chart.type is xy
  • Validation: should be a boolean

Released under the MIT License.