StripLineSettings API in JavaScript Chart API control

The StripLineSettings class provides configuration options for strip lines in a chart.

Properties

border

BorderModel

The border property allows customization of the border for the strip line. It includes options to set the color and width of the border.

color

string

The color property specifies the color of the strip line.

Defaults to ‘#808080’

dashArray

string

Specifies the pattern of dashes and gaps used to render the strip line.

Defaults to null

end

Object | number | Date

Specifies the ending value of the strip line.

Defaults to null

horizontalAlignment

Anchor

Defines the position of the strip line text horizontally. Available options are:

• Start: Places the strip line text at the start.
• Middle: Places the strip line text in the middle.
• End: Places the strip line text at the end.

Defaults to ‘Middle’

imageUrl

string

Specifies the URL of the background image for the strip line. The image will be displayed as the background.

Defaults to ”

isRepeat

boolean

Specifies whether the strip line is repeated at regular intervals along the axis.

Defaults to false

isSegmented

boolean

Specifies whether the strip line is segmented.

Defaults to false

opacity

number

Specifies the opacity for the strip line.

Defaults to 1

repeatEvery

Object | number | Date

Specifies the interval at which the strip line is repeated.

Defaults to null

repeatUntil

Object | number | Date

Specifies the maximum value of the interval at which the strip line is repeated.

Defaults to null

rotation

number

Defines the degree of rotation applied to the text on the strip line.

Defaults to null

segmentAxisName

string

The name of the axis where the strip line segment is applied.

Defaults to null

segmentEnd

Object | number | Date

Specifies where a new segment of the strip line on the axis ends.

Defaults to null

segmentStart

Object | number | Date

Specifies where a new segment of the strip line on the axis begins.

Defaults to null

size

number

Specifies the size of the strip line when starting from the origin.

Defaults to null

sizeType

SizeType

The sizeType property specifies how the size of the strip line is determined.

Defaults to Auto

start

Object | number | Date

Specifies the starting value of the strip line.

Defaults to null

startFromAxis

boolean

If set to true, the strip line is rendered from the axis origin.

Defaults to false

text

string

Defines the text to be displayed on the strip line.

Defaults to ”

textStyle

FontModel

The textStyle property enables customization of the text appearance on the strip line.

verticalAlignment

Anchor

Defines the position of the strip line text vertically. Available options are:

• Start: Places the strip line text at the start.
• Middle: Places the strip line text in the middle.
• End: Places the strip line text at the end.

Defaults to ‘Middle’

visible

boolean

If set to true, the strip line on the axis will render.

Defaults to true

zIndex

ZIndex

Specifies the order of the strip line. The options are:

• Behind: Places the strip line behind the series elements.
• Over: Places the strip line over the series elements.

Defaults to ‘Behind’