WjFlexChartWaterfall Class

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

Angular 2 component for the Waterfall control.

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

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

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

Constructor

Properties

Methods

Events

Constructor

constructor

constructor(options?: any): Waterfall

Initializes a new instance of the Waterfall class.

Parameters
Inherited From
Waterfall
Returns
Waterfall

Properties

altStyle

Gets or sets the alternate style for the series.

The alternate style is used for negative values in Bar, Column, and Scatter charts; and for rising values in financial chart types like Candlestick, LineBreak, EquiVolume etc.

The default value for this property is null, which causes the series to use the default style.

Inherited From
SeriesBase
Type
any

asyncBindings

Allows you to override the global WjOptions.asyncBindings setting for this specific component. See the WjOptions.asyncBindings property description for details.

Type
boolean

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

connectorLines

Gets or sets a value that determines whether to show connector lines.

Inherited From
Waterfall
Type
boolean

cssClass

Gets or sets the series CSS class.

Inherited From
SeriesBase
Type
string

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

intermediateTotalLabels

Gets or sets the name of the property that contains labels for the intermediate total bars. This should be an array or a string.

This property works with the showIntermediateTotal and intermediateTotalPositions properties.

Inherited From
Waterfall
Type
any

intermediateTotalPositions

Gets or sets a value of the property that contains the index for positions of the intermediate total bars.

This property works with the showIntermediateTotal and intermediateTotalLabels properties.

Inherited From
Waterfall
Type
number[]

interpolateNulls

Gets or sets a value that determines whether to interpolate null values in the data.

If true, the series interpolates the value of any missing data based on neighboring points. If false, it leaves a break in lines and areas at the points with null values.

The default value for this property is false.

Inherited From
SeriesBase
Type
boolean

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

itemFormatter

Gets or sets the item formatter function that allows you to customize the appearance of the series.

The property overrides the chart's itemFormatter itemFormatter.

Inherited From
SeriesBase
Type
Function

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

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

relativeData

Gets or sets a value that determines whether the given data represents absolute or relative values (differences).

Inherited From
Waterfall
Type
boolean

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

showIntermediateTotal

Gets or sets a value that determines whether to show intermediate total bars.

This property works with intermediateTotalPositions and intermediateTotalLabels properties.

Inherited From
Waterfall
Type
boolean

showTotal

Gets or sets a value that determines whether to show the total bar at the end of the chart.

Inherited From
Waterfall
Type
boolean

start

Gets or sets a value that determines the value of the start bar. If start is null, the start bar will not be shown.

Inherited From
Waterfall
Type
number

startLabel

Gets or sets the label of the start bar.

Inherited From
Waterfall
Type
string

style

Gets or sets the series style.

Inherited From
SeriesBase
Type
any

styles

Gets or sets the Waterfall styles.

The following styles are supported:

  1. start: Specifies the style of the start column.
  2. total: Specifies the style of the total column.
  3. intermediateTotal: Specifies the style of the intermediate total column.
  4. falling: Specifies the style of the falling columns.
  5. rising: Specifies the style of the rising columns.
  6. connectorLines: Specifies the style of the connectorLines.

waterfall.styles = {
  start: { fill: 'blue', stroke: 'blue' },
  total: { fill: 'yellow', stroke: 'yellow' },
  falling: { fill: 'red', stroke: 'red' },
  rising: { fill: 'green', stroke: 'green' },
  connectorLines: { stroke: 'blue', 'stroke-dasharray': '10, 10' }
}
Inherited From
Waterfall
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.

The default value for this property is Marker.Dot.

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.

The default value for this property is 10 pixels.

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

tooltipContent

Gets or sets the series specific tooltip content.

The property overrides the content of chart tooltip wijmo.chart.ChartTooltip.Content.

Inherited From
SeriesBase
Type
any

totalLabel

Gets or sets the label of the total bar.

Inherited From
Waterfall
Type
string

visibility

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

The default value for this property is SeriesVisibility.Visible.

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

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

dataToPoint

dataToPoint(pt: Point): Point

Converts a Point from series data coordinates to control coordinates.

Parameters
Inherited From
SeriesBase
Returns
Point

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 the 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

initialize

initialize(options: any): void

Initializes the series by copying the properties from a given object.

Parameters
Inherited From
SeriesBase
Returns
void

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

pointToData

pointToData(pt: Point): Point

Converts a Point from control coordinates to series data coordinates.

Parameters
Inherited From
SeriesBase
Returns
Point

Events

rendered

Occurs when series is rendered.

Inherited From
SeriesBase
Arguments
IRenderEngine

rendering

Occurs when series is rendering.

Inherited From
SeriesBase
Arguments
EventArgs