WjFlexChartAnnotationText Class

File
wijmo.angular2.js
Module
wijmo/wijmo.angular2.chart.annotation
Base Class
Text
Show
   

Angular 2 component for the Text control.

The wj-flex-chart-annotation-text component must be contained in a WjFlexChartAnnotationLayer component.

Use the wj-flex-chart-annotation-text component to add Text controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.

The WjFlexChartAnnotationText component is derived from the Text control and inherits all its properties, events and methods.

The wj-flex-chart-annotation-text component may contain a WjFlexChartDataPoint child component.

Constructor

Properties

Methods

Constructor

constructor

constructor(options?): Text

Initializes a new instance of the Text annotation class.

Parameters
Inherited From
Text
Returns
Text

Properties

attachment

Gets or sets the attachment of the annotation.

Inherited From
AnnotationBase
Type
AnnotationAttachment

initialized

This event is triggered after the component has been initialized by Angular, that is all bound properties have been assigned and child components (if any) have been initialized.

Type
EventEmitter

isInitialized

Indicates whether the component has been initialized by Angular. Changes its value from false to true right before triggering the initialized event.

Type
boolean

isVisible

Gets or sets the visibility of the annotation.

Inherited From
AnnotationBase
Type
boolean

name

Gets or sets the name of the annotation.

Inherited From
AnnotationBase
Type
string

offset

Gets or sets the offset of the annotation from the point.

Inherited From
AnnotationBase
Type
Point

point

Gets or sets the point of the annotation. The coordinates of points depends on the attachment property. See AnnotationAttachment for further description.

Inherited From
AnnotationBase
Type
DataPoint

pointIndex

Gets or sets the data point index of the annotation. Applies only when the attachment property is set to DataIndex.

Inherited From
AnnotationBase
Type
number

position

Gets or sets the position of the annotation. The position is relative to the point.

Inherited From
AnnotationBase
Type
AnnotationPosition

seriesIndex

Gets or sets the data series index of the annotation. Applies only when the attachment property is set to DataIndex.

Inherited From
AnnotationBase
Type
number

style

Gets or sets the style of the annotation.

Inherited From
AnnotationBase
Type
any

text

Gets or sets the text of the annotation.

Inherited From
Text
Type
string

tooltip

Gets or sets the tooltip of the annotation.

Inherited From
AnnotationBase
Type
string

wjProperty

Gets or sets a name of a property that this component is assigned to. Default value is 'items'.

Type
string

Methods

created

created(): void

If you create a custom component inherited from a Wijmo component, you can override this method and perform necessary initializations that you usually do in a class constructor. This method is called in the last line of a Wijmo component constructor and allows you to not declare your custom component's constructor at all, thus preventing you from a necessity to maintain constructor parameters and keep them in synch with Wijmo component's constructor parameters.

Returns
void

destroy

destroy(): void

Destroy this annotation

Inherited From
AnnotationBase
Returns
void

render

render(engine: IRenderEngine): void

Render this annotation.

Parameters
Inherited From
AnnotationBase
Returns
void