WjFlexChartYFunctionSeries Class

File
wijmo.angular2.js
Module
wijmo/wijmo.angular2.chart.analytics
Base Class
YFunctionSeries
Show
   

Angular 2 component for the YFunctionSeries control.

The wj-flex-chart-y-function-series component must be contained in one of the following components: WjFlexChart or WjFinancialChart.

Use the wj-flex-chart-y-function-series component to add YFunctionSeries controls to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2 Markup.

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

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(options?): YFunctionSeries

Initializes a new instance of the YFunctionSeries class.

Parameters
Inherited From
YFunctionSeries
Returns
YFunctionSeries

Properties

altStyle

Gets or sets the alternative style for the series. The values from this property will be used for negative values in Bar, Column, and Scatter charts; and for rising values in financial chart types like Candlestick, LineBreak, EquiVolume etc.

If no value is provided, the default styles will be used.

Inherited From
SeriesBase
Type
any

axisX

Gets or sets the x-axis for the series.

Inherited From
SeriesBase
Type
Axis

axisY

Gets or sets the y-axis for the series.

Inherited From
SeriesBase
Type
Axis

binding

Gets or sets the name of the property that contains Y values for the series.

Inherited From
SeriesBase
Type
string

bindingX

Gets or sets the name of the property that contains X values for the series.

Inherited From
SeriesBase
Type
string

chart

Gets the FlexChart object that owns this series.

Inherited From
SeriesBase
Type
FlexChartCore

collectionView

Gets the ICollectionView object that contains the data for this series.

Inherited From
SeriesBase
Type
ICollectionView

cssClass

Gets or sets the series CSS class.

Inherited From
SeriesBase
Type
string

func

Gets or sets the function used to calculate Y value.

Inherited From
YFunctionSeries
Type
Function

hostElement

Gets the series host element.

Inherited From
SeriesBase
Type
SVGGElement

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

itemsSource

Gets or sets the array or ICollectionView object that contains the series data.

Inherited From
SeriesBase
Type
any

legendElement

Gets the series element in the legend.

Inherited From
SeriesBase
Type
SVGGElement

max

Gets or sets the maximum value of the parameter for calculating a function.

Inherited From
FunctionSeries
Type
number

min

Gets or sets the minimum value of the parameter for calculating a function.

Inherited From
FunctionSeries
Type
number

name

Gets or sets the series name.

The series name is displayed in the chart legend. Any series without a name does not appear in the legend.

Inherited From
SeriesBase
Type
string

renderedNg

Angular (EventEmitter) version of the Wijmo rendered 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 rendered Wijmo event name.

Type
EventEmitter

renderingNg

Angular (EventEmitter) version of the Wijmo rendering 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 rendering Wijmo event name.

Type
EventEmitter

sampleCount

Gets or sets the sample count for function calculation. The property doesn't apply for MovingAverage.

Inherited From
TrendLineBase
Type
number

style

Gets or sets the series style.

Inherited From
SeriesBase
Type
any

symbolMarker

Gets or sets the shape of marker to use for each data point in the series. Applies to Scatter, LineSymbols, and SplineSymbols chart types.

Inherited From
SeriesBase
Type
Marker

symbolSize

Gets or sets the size(in pixels) of the symbols used to render this Series. Applies to Scatter, LineSymbols, and SplineSymbols chart types.

Inherited From
SeriesBase
Type
number

symbolStyle

Gets or sets the series symbol style. Applies to Scatter, LineSymbols, and SplineSymbols chart types.

Inherited From
SeriesBase
Type
any

visibility

Gets or sets an enumerated value indicating whether and where the series appears.

Inherited From
SeriesBase
Type
SeriesVisibility

wjProperty

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

Type
string

Methods

approximate

approximate(x: number): number

Gets the approximate y value from the given x value.

Parameters
Inherited From
YFunctionSeries
Returns
number

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

drawLegendItem

drawLegendItem(engine: IRenderEngine, rect: Rect, index: number): void

Draw a legend item at the specified position.

Parameters
Inherited From
SeriesBase
Returns
void

getDataRect

getDataRect(currentRect?: Rect, calculatedRect?: Rect): Rect

Returns series bounding rectangle in data coordinates.

If getDataRect() returns null, the limits are calculated automatically based on the data values.

Parameters
Inherited From
SeriesBase
Returns
Rect

getPlotElement

getPlotElement(pointIndex: number): any

Gets the plot element that corresponds to the specified point index.

Parameters
Inherited From
SeriesBase
Returns
any

hitTest

hitTest(pt: any, y?: number): HitTestInfo

Gets a HitTestInfo object with information about the specified point.

Parameters
Inherited From
SeriesBase
Returns
HitTestInfo

legendItemLength

legendItemLength(): number

Returns number of series items in the legend.

Inherited From
SeriesBase
Returns
number

measureLegendItem

measureLegendItem(engine: IRenderEngine, index: number): Size

Measures height and width of the legend item.

Parameters
Inherited From
SeriesBase
Returns
Size

onRendered

onRendered(engine: IRenderEngine): void

Raises the rendered event.

Parameters
Inherited From
SeriesBase
Returns
void

onRendering

onRendering(engine: IRenderEngine, index: number, count: number): boolean

Raises the rendering event.

Parameters
Inherited From
SeriesBase
Returns
boolean

Events

rendered

Occurs when series is rendered.

Inherited From
SeriesBase
Arguments
IRenderEngine

rendering

Occurs when series is rendering.

Inherited From
SeriesBase
Arguments
EventArgs