Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChartPlotBandAnnotation

A band annotation. The band specifies a horizontal or vertical range of specific axis.

Hierarchy

Index

Properties

axisId

axisId: string

The axis to which this annotation belongs.

fillColor

fillColor: string

The vertical band fill.

hidden

hidden: boolean

Indicates whether the annotation is visible.

maxValue

maxValue: any

The max value of range used when positioning the annotation.

minValue

minValue: any

The min value of range used when positioning the annotation.

strokeColor

strokeColor: string

The stroke's fill color

strokeDashPattern

strokeDashPattern: string

The dash patterns of the stroke. An string with numbers that specify the lengths of the painted segments and unpainted segments, respectively, of the dash pattern. For example, the string "2, 3"" sets a dash pattern that alternates between a 2-user-space-unit-long painted segment and a 3-user-space-unit-long unpainted segment. The string "1, 3, 4, 2"" sets the pattern to a 1-unit painted segment, a 3-unit unpainted segment, a 4-unit painted segment, and a 2-unit unpainted segment.

strokeWidth

strokeWidth: number

The stroke's width.

zPosition

zPosition: string

Determines the z-order position of the annotation. Every annotation can be positioned below or above the series collection. Use values exported from ChartAnnotationZPosition

Static axisIdProperty

axisIdProperty: Property

Identifies the axisID dependency property.

Static fillColorProperty

fillColorProperty: Property

Identifies the fillColor dependency property.

Static hiddenProperty

hiddenProperty: Property

Identifies the hidden dependency property.

Static maxValueProperty

maxValueProperty: Property

Identifies the maxValue dependency property.

Static minValueProperty

minValueProperty: Property

Identifies the minValue dependency property.

Static strokeColorProperty

strokeColorProperty: Property

Identifies the strokeColor dependency property.

Static strokeDashPatternProperty

strokeDashPatternProperty: Property

Identifies the strokeDashPattern dependency property.

Static strokeWidthProperty

strokeWidthProperty: Property

Identifies the strokeWidth dependency property.

Static zPositionProperty

zPositionProperty: Property

Identifies the zPosition dependency property.

Generated using TypeDoc