v5.20192.624
|

WjFlexChartLineMarker Class

Angular 2 component for the wijmo.chart.LineMarker control.

The wj-flex-line-marker component must be contained in one of the following components: wijmo.angular2.chart.WjFlexChart or wijmo.angular2.chart.finance.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.

Hierarchy

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 = LineMarkerAlignment.Left;
// set the alignment to the left top.
marker.alignment = LineMarkerAlignment.Left | LineMarkerAlignment.Top;

chart

Gets the FlexChart object that owns the LineMarker.

content

content: Function

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

dragContent

dragContent: boolean

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

dragLines

dragLines: boolean

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

dragThreshold

dragThreshold: number

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

horizontalPosition

horizontalPosition: number

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 LineMarkerInteraction.Move or LineMarkerInteraction.Drag, the horizontal position of the marker is calculated automatically based on the pointer's position.

initialized

initialized: EventEmitter<any>

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.

interaction

Gets or sets the interaction mode of the LineMarker.

isInitialized

isInitialized: boolean

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

isVisible

isVisible: boolean

Gets or sets the visibility of the LineMarker.

lines

Gets or sets the visibility of the LineMarker lines.

positionChangedNg

positionChangedNg: EventEmitter<any>

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.

seriesIndex

seriesIndex: number

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 LineMarkerInteraction.Move or LineMarkerInteraction.Drag.

verticalPosition

verticalPosition: number

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 LineMarkerInteraction.Move or LineMarkerInteraction.Drag, the vertical position of the LineMarker is calculated automatically based on the pointer's position.

wjProperty

wjProperty: string

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

x

x: number

Gets the current x-value as chart data coordinates.

y

y: number

Gets the current y-value as chart data coordinates.

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

remove

  • remove(): void
  • Removes the LineMarker from the chart.

    Returns void

Events

positionChanged

positionChanged: Event

Occurs after the LineMarker's position changes.