| Client-Side API Reference > FlexChart > wijmo.chart.analytics > Waterfall Class |
constructor(options?): Waterfall
Initializes a new instance of the Waterfall class.
A JavaScript object containing initialization data for the Waterfall Series.
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.
Gets or sets the name of the property that contains Y values for the series.
Gets or sets the name of the property that contains X values for the series.
Gets the ICollectionView object that contains the data for this series.
Gets or sets a value of the property that contains the label of the intermediate total bar; it should be an array or a string. The property should work with showIntermediateTotal and intermediateTotalPositions property.
Gets or sets a value of the property that contains the index for positions of the intermediate total bar. The property should work with showIntermediateTotal and intermediateTotalLabels property.
Gets or sets the array or ICollectionView object that contains the series data.
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.
Gets or sets a value that determines whether to show the intermediate total bar. The property should work with intermediateTotalPositions and intermediateTotalLabels property.
Gets or sets a value that determines the value of the start bar. If start is null, start bar will not show.
Gets or sets the waterfall styles.
The following styles are supported:
start: Specifies the style of the start column.
total: Specifies the style of the total column.
intermediateTotal: Specifies the style of the intermediate total column.
falling: Specifies the style of the falling columns.
rising: Specifies the style of the rising columns.
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'
}
}
Gets or sets the shape of marker to use for each data point in the series. Applies to Scatter, LineSymbols, and SplineSymbols chart types.
Gets or sets the size(in pixels) of the symbols used to render this Series. Applies to Scatter, LineSymbols, and SplineSymbols chart types.
Gets or sets the series symbol style. Applies to Scatter, LineSymbols, and SplineSymbols chart types.
Gets or sets an enumerated value indicating whether and where the series appears.
drawLegendItem(engine: IRenderEngine, rect: Rect, index: number): void
Draw a legend item at the specified position.
The rendering engine to use.
The position of the legend item.
Index of legend item(for series with multiple legend items).
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.
The current rectangle of chart. This parameter is optional.
The calculated rectangle of chart. This parameter is optional.
getPlotElement(pointIndex: number): any
Gets the plot element that corresponds to the specified point index.
The index of the data point.
hitTest(pt: any, y?: number): HitTestInfo
Gets a HitTestInfo object with information about the specified point.
The point to investigate, in window coordinates.
The Y coordinate of the point (if the first parameter is a number).
legendItemLength(): number
Returns number of series items in the legend.
measureLegendItem(engine: IRenderEngine, index: number): Size
Measures height and width of the legend item.
The rendering engine to use.
Index of legend item(for series with multiple legend items).
onRendered(engine: IRenderEngine): void
Raises the rendered event.
The IRenderEngine object used to render the series.
onRendering(engine: IRenderEngine, index: number, count: number): boolean
Raises the rendering event.
The IRenderEngine object used to render the series.
The index of the series to render.
Total number of the series to render.
Represents a Waterfall series of FlexChart.
The Waterfall series is normally used to demonstrate how the starting position either increases or decreases through a series of changes.