5.20231.904
- 5.20231.904
- Preparing search index...
- The search index is not available
AnnotationLayer Class
Heirarchy
- AnnotationLayer
Constructors
constructor
- new
Annotation Layer(chart: FlexChartCore, options?: any): AnnotationLayer
-
Initializes a new instance of the AnnotationLayer class.
Parameters
-
chart: FlexChartCore
A chart to which the AnnotationLayer is attached.
-
Optional options: any
A JavaScript object containing initialization data for AnnotationLayer.
Returns AnnotationLayer
-
Properties
items
items: ObservableArray
Gets the collection of annotation elements in the AnnotationLayer.
Methods
getItem
- get
Item(name: string): AnnotationBase
-
Gets an annotation element by name in the AnnotationLayer.
Parameters
-
name: string
The annotation's name.
Returns AnnotationBase
-
getItems
- get
Items(name: string): Array<AnnotationBase>
-
Gets the annotation elements by name in the AnnotationLayer.
Parameters
-
name: string
The annotations' name.
Returns Array<AnnotationBase>
-
Represents an annotation layer for FlexChart and FinancialChart.
The AnnotationLayer contains a collection of various annotation elements: texts, lines, images, rectangles etc. To use the AnnotationLayer, create annotations and push them to the layer's items property.