- Preparing search index...
- The search index is not available
Envelopes Class
Heirarchy
-
OverlayIndicatorBase
- Envelopes
Constructors
Properties
Methods
Events
Constructors
constructor
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.
axisX
Gets or sets the X-axis for the series.
axisY
Gets or sets the Y-axis for the series.
binding
Gets or sets the name of the property that contains Y values for the series.
bindingX
Gets or sets the name of the property that contains X values for the series.
chart
Gets the FlexChart object that owns this series.
collectionView
Gets the ICollectionView object that contains the data for this series.
cssClass
Gets or sets the series CSS class.
hostElement
Gets the series host element.
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.
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 wijmo.chart.FlexChart.itemFormatter.
itemsSource
Gets or sets the array or ICollectionView object that contains the series data.
legendElement
Gets the series element in the legend.
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.
period
Gets or sets the period for the calculation as an integer value.
size
Gets or set the size of the moving average envelopes. The default value is 2.5 percent (0.025).
style
Gets or sets the series style.
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.
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.
symbolStyle
Gets or sets the series symbol style.
Applies to Bar, Column, Scatter, LineSymbols, and SplineSymbols chart types.
tooltipContent
Gets or sets the series specific tooltip content.
The property overrides the content of chart tooltip content.
type
Gets or sets the moving average type for the envelopes. The default value is Simple.
visibility
Gets or sets an enumerated value indicating whether and where the series appears.
The default value for this property is SeriesVisibility.Visible.
Methods
dataToPoint
getPlotElement
-
Gets the plot element that corresponds to the specified point index.
Parameters
-
pointIndex: number
The index of the data point.
Returns any
-
hitTest
-
Gets a HitTestInfo object with information about the specified point.
Parameters
-
pt: any
The point to investigate, in window coordinates.
-
Optional y: number
The Y coordinate of the point (if the first parameter is a number).
Returns HitTestInfo
-
initialize
-
Initializes the series by copying the properties from a given object.
Parameters
-
options: any
JavaScript object containing initialization data for the series.
Returns void
-
onRendered
-
Raises the rendered event.
Parameters
-
engine: IRenderEngine
The IRenderEngine object used to render the series.
Returns void
-
onRendering
-
Raises the rendering event.
Parameters
-
engine: IRenderEngine
The IRenderEngine object used to render the series.
-
index: number
The index of the series to render.
-
count: number
Total number of the series to render.
Returns boolean
-
pointToData
Events
rendered
Occurs when series is rendered.
rendering
Occurs when series is rendering.
Represents a Moving Average Envelopes overlay series for the FinancialChart.
Moving average envelopes are moving averages set above and below a standard moving average. The amount above/below the standard moving average is percentage based and dictated by the size property.