WjFlexChartLineMarker Class

File
wijmo.angular2.js
Module
wijmo/wijmo.angular2.chart
Base Class
LineMarker
Show
   

Angular 2 component for the LineMarker control.

The wj-flex-line-marker component must be contained in one of the following components: WjFlexChart or WjFinancialChart.

Use the wj-flex-line-marker component to add LineMarker controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.

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

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(chart: FlexChartCore, options?): LineMarker

Initializes a new instance of the LineMarker class.

Parameters
Inherited From
LineMarker
Returns
LineMarker

Properties

alignment

Gets or sets the alignment of the LineMarker content.

By default, the LineMarker shows to the right, at the bottom of the target point. Use '|' to combine alignment values.

// set the alignment to the left.
marker.alignment = wijmo.chart.LineMarkerAlignment.Left;

// set the alignment to the left top.
marker.alignment = wijmo.chart.LineMarkerAlignment.Left | wijmo.chart.LineMarkerAlignment.Top;
Inherited From
LineMarker
Type
LineMarkerAlignment

chart

Gets the FlexChart object that owns the LineMarker.

Inherited From
LineMarker
Type
FlexChartCore

content

Gets or sets the content function that allows you to customize the text content of the LineMarker.

Inherited From
LineMarker
Type
Function

dragContent

Gets or sets a value indicating whether the content of the marker is draggable when the interaction mode is "Drag."

Inherited From
LineMarker
Type
boolean

dragLines

Gets or sets a value indicating whether the lines are linked when the horizontal or vertical line is dragged when the interaction mode is "Drag."

Inherited From
LineMarker
Type
boolean

dragThreshold

Gets or sets the maximum distance from the horizontal or vertical line that the marker can be dragged.

Inherited From
LineMarker
Type
number

horizontalPosition

Gets or sets the horizontal position of the LineMarker relative to the plot area.

Its value range is (0, 1). If the value is null or undefined and interaction is set to wijmo.chart.LineMarkerInteraction.Move or wijmo.chart.LineMarkerInteraction.Drag, the horizontal position of the marker is calculated automatically based on the pointer's position.

Inherited From
LineMarker
Type
number

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

interaction

Gets or sets the interaction mode of the LineMarker.

Inherited From
LineMarker
Type
LineMarkerInteraction

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 LineMarker.

Inherited From
LineMarker
Type
boolean

lines

Gets or sets the visibility of the LineMarker lines.

Inherited From
LineMarker
Type
LineMarkerLines

positionChangedNg

Angular (EventEmitter) version of the Wijmo positionChanged event for programmatic access. Use this event name if you want to subscribe to the Angular version of the event in code. In template bindings use the conventional positionChanged Wijmo event name.

Type
EventEmitter

seriesIndex

Gets or sets the index of the series in the chart in which the LineMarker appears. This takes effect when the interaction property is set to wijmo.chart.LineMarkerInteraction.Move or wijmo.chart.LineMarkerInteraction.Drag.

Inherited From
LineMarker
Type
number

verticalPosition

Gets or sets the vertical position of the LineMarker relative to the plot area.

Its value range is (0, 1). If the value is null or undefined and interaction is set to wijmo.chart.LineMarkerInteraction.Move or wijmo.chart.LineMarkerInteraction.Drag, the vertical position of the LineMarker is calculated automatically based on the pointer's position.

Inherited From
LineMarker
Type
number

wjProperty

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

Type
string

x

Gets the current x-value as chart data coordinates.

Inherited From
LineMarker
Type
number

y

Gets the current y-value as chart data coordinates.

Inherited From
LineMarker
Type
number

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

onPositionChanged

onPositionChanged(point: Point): void

Raises the positionChanged event.

Parameters
Inherited From
LineMarker
Returns
void

remove

remove(): void

Removes the LineMarker from the chart.

Inherited From
LineMarker
Returns
void

Events

positionChanged

Occurs after the LineMarker's position changes.

Inherited From
LineMarker
Arguments
Point