Skip to main content

ChartGridLines

Configures the appearance of horizontal and vertical grid lines within the chart.

Properties

  • color - The color of a grid line.
  • dash_pattern - Defines dash effect of the line.
  • interval - The interval between grid lines.
  • width - The width of a grid line.

Methods

  • copy - Returns a copy of this object with the specified properties overridden.

Properties​

colorclass-attributeinstance-attribute​

color: ColorValue | None = None

The color of a grid line.

dash_patternclass-attributeinstance-attribute​

dash_pattern: list[int] | None = None

Defines dash effect of the line. The value is a circular list of dash offsets and lengths. For example, the list [5, 10] would result in dashes 5 pixels long followed by blank spaces 10 pixels long. By default, a solid line is drawn.

intervalclass-attributeinstance-attribute​

interval: Number | None = None

The interval between grid lines.

widthclass-attributeinstance-attribute​

width: Number = 2.0

The width of a grid line.

Methods​

copy​

copy(
    interval: Number | None = None,
    color: ColorValue | None = None,
    width: Number | None = None,
    dash_pattern: list[int] | None = None,
) -> ChartGridLines

Returns a copy of this object with the specified properties overridden.