AverageSeries

Type class

Data item

AverageSeries uses data items of type IAverageSeriesDataItem.

Sources

AverageSeries can be used (imported) via one of the following packages.

// Import AverageSeries
import * as am5stock from "@amcharts/amcharts5/stock";

// Create AverageSeries
am5stock.AverageSeries.new(root, {
  // ... config if applicable
});
<!-- Load AverageSeries -->
<script src="stock.js"></script>

<script>
// Create AverageSeries
am5stock.AverageSeries.new(root, {
  // ... config if applicable
});
</script>

Inheritance

AverageSeries extends SimpleLineSeries.

AverageSeries is not extended by any other symbol.

Settings

Set these settings on a AverageSeries object using its set() and setAll() methods.

Read about settings concept.

active
#

Type undefined | false | true

Inherited from ISpriteSettings

Indicates if element is currently active.

autoGapCount
#

Type undefined | number

Default 1.1

Inherited from ILineSeriesSettings

If there are more than autoGapCount base time intervals (e.g. days) with no data, the line will break and will display gap.

Click here for more info

background
#

Type Graphics

Inherited from IContainerSettings

Background element.

Click here for more info

baseAxis
#

Type IXYAxis

Inherited from IXYSeriesSettings

Base axis for the series.

A base axis will dictate direction series plot.

Click here for more info

blur
#

Type undefined | number

Inherited from ISpriteSettings

Apply blur filter.

Ranges of values in pixels: 0 to X.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

brightness
#

Type undefined | number

Inherited from ISpriteSettings

Modifty visual brightness.

Range of values: 0 to 1.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

calculateAggregates
#

Type undefined | false | true

Inherited from ISeriesSettings

If set to true, series will calculate aggregate values, e.g. change percent, high, low, etc.

Do not enable unless you are using such aggregate values in tooltips, display data fields, heat rules, or similar.

categoryXField
#

Type undefined | string

Inherited from IXYSeriesSettings

Input data field for X category.

Click here for more info

categoryYField
#

Type undefined | string

Inherited from IXYSeriesSettings

Input data field for Y category.

Click here for more info

centerX
#

Type number | Percent

Inherited from ISpriteSettings

X coordinate of the center of the element relative to itself.

Center coordinates will affect placement as well as rotation pivot point.

centerY
#

Type number | Percent

Inherited from ISpriteSettings

Y coordinate of the center of the element relative to itself.

Center coordinates will affect placement as well as rotation pivot point.

connect
#

Type undefined | false | true

Default true

Inherited from ILineSeriesSettings

If set to true the line will connect over "gaps" - categories or time intervals with no data.

Click here for more info

contrast
#

Type undefined | number

Inherited from ISpriteSettings

Modify contrast.

Range of values: 0 to 1.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

crisp
#

Type undefined | false | true

Default false

Inherited from ISpriteSettings

If set to true, an element will try to draw itself in such way, that it looks crisp on screen, with minimal anti-aliasing.

It will round x/y position so it is positioned fine "on pixel".

It will also adjust strokeWidth based on device pixel ratio or zoom, so the line might look thinner than expected.

NOTE: this is might not universally work, especially when set on several objects that are supposed to fit perfectly with each other.

@since 5.3.0

cursorOverStyle
#

Type undefined | string

Inherited from ISpriteSettings

A named mouse cursor style to show when hovering this element.

Click here for more info

customValueField
#

Type undefined | string

Inherited from ISeriesSettings

A key to look up in data for a numeric customValue of the data item.

Usually used for storing additional numeric information and heat rules.

dateFormatter
#

Type DateFormatter | undefined

Inherited from ISpriteSettings

An instance of DateFormatter that should be used instead of global formatter object.

Click here for more info

disabled
#

Type undefined | false | true

Inherited from ISpriteSettings

Indicates if element is disabled.

draggable
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true, user will be able to drag this element. It will also disable default drag events over the area of this element.

durationFormatter
#

Type DurationFormatter | undefined

Inherited from ISpriteSettings

An instance of DurationFormatter that should be used instead of global formatter object.

Click here for more info

dx
#

Type undefined | number

Inherited from ISpriteSettings

Horizontal shift in pixels. Can be negative to shift leftward.

dy
#

Type undefined | number

Inherited from ISpriteSettings

Vertical shift in pixels. Can be negative to shift upward.

excludeFromTotal
#

Type undefined | false | true

Default false

Inherited from IXYSeriesSettings

Exclude series values when calculating totals for category/interval.

exportable
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to false this element will not appear in exported snapshots of the chart.

field
#

Type "open" | "value" | "low" | "high"

Default "value"

Inherited from IDrawingSeriesSettings

Value field to use when snapping data or calculating averages/regresions/etc.

fill
#

Type Color

Inherited from ISeriesSettings

Series fill color.

Click here for more info

fillColor
#

Type Color

Inherited from IDrawingSeriesSettings

Color of the fills.

fillOpacity
#

Type undefined | number

Inherited from IDrawingSeriesSettings

Opacity of the fills (0-1).

fillPattern
#

Type Pattern

Inherited from ISeriesSettings

Series fill pattern.

Click here for more info
@since 5.10.0

forceHidden
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true the element will be hidden regardless of visible or even if show() is called.

forceInactive
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true the element will be inactive - absolutely oblivious to all interactions, even if there are related events set, or the interactive: true is set.

@since 5.0.21

groupDataCallback
#

Type undefined | ( dataItem: DataItem, interval: ITimeInterval) => void

Inherited from IXYSeriesSettings

A custom function to call when grouping data items.

Click here for more info
@since 5.1.11

groupDataDisabled
#

Type undefined | false | true

Inherited from IXYSeriesSettings

If set to true data items for this series won't be grouped even if the groupData: true is set on a related DateAxis.

@since 5.0.19

groupDataWithOriginals
#

Type undefined | false | true

Default false

Inherited from IXYSeriesSettings

If set to true, when data is grouped, the originals setting of the group data items will be populated by the original (source) data items that fall into the group.

Please note that if groupDataCallback is set, this setting is ignored as originals will always be included, regardless of the value.

@since 5.1.11

heatRules
#

Type IHeatRule[]

Inherited from ISeriesSettings

A list of heat rules to apply on series elements.

Click here for more info

height
#

Type number | Percent | null

Inherited from ISpriteSettings

Element's absolute height in pixels (numeric value) or relative height to parent (Percent);

highLocationX
#

Type undefined | number

Default 0.5

Inherited from IXYSeriesSettings

Horizontal location of the high data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

highLocationY
#

Type undefined | number

Default 0.5

Inherited from IXYSeriesSettings

Vertical location of the high data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

highValueXField
#

Type undefined | string

Inherited from IXYSeriesSettings

Input data field for X high value.

Click here for more info

highValueXGrouped
#

Type "open" | "close" | "high" | "high" | "average" | "sum" | "extreme"

Inherited from IXYSeriesSettings

Indicates what aggregate value to use for collective data item, when aggregating X high values from several data items.

highValueXShow
#

Type "highValueXWorking" | "highValueXChange" | "highValueXChangePercent" | "highValueXChangeSelection" | "highValueXChangeSelectionPercent" | "highValueXChangePrevious" | "highValueXChangePreviousPercent"

Inherited from IXYSeriesSettings

Display data field for X high value.

highValueYField
#

Type undefined | string

Inherited from IXYSeriesSettings

Input data field for Y high value.

Click here for more info

highValueYGrouped
#

Type "open" | "close" | "high" | "high" | "average" | "sum" | "extreme"

Inherited from IXYSeriesSettings

Indicates what aggregate value to use for collective data item, when aggregating X high values from several data items.

highValueYShow
#

Type "highValueYWorking" | "highValueYChange" | "highValueYChangePercent" | "highValueYChangeSelection" | "highValueYChangeSelectionPercent" | "highValueYChangePrevious" | "highValueYChangePreviousPercent"

Inherited from IXYSeriesSettings

Display data field for Y low value.

html
#

Type undefined | string

Inherited from IContainerSettings

HTML content of the container.

Click here for more info
@since 5.2.11

hue
#

Type undefined | number

Inherited from ISpriteSettings

Rotate HUE colors in degrees.

Range of values: 0 to 360.

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

id
#

Type undefined | string

Inherited from IEntitySettings

A custom string ID for the element.

If set, element can be looked up via am5.registry.entitiesById.

Will raise error if an element with the same ID already exists.

idField
#

Type undefined | string

Inherited from ISeriesSettings

A key to look up in data for an id of the data item.

ignoreMinMax
#

Type undefined | false | true

Default false

Inherited from IXYSeriesSettings

If set to true this series will be ignored when calculating scale of the related axes.

interactive
#

Type undefined | false | true

Inherited from ISpriteSettings

Should this element accept user interaction events?

interactiveChildren
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true all descendants - not just direct children, but every element in it - will become "interactive".

interpolationDuration
#

Type undefined | number

Inherited from IComponentSettings

A duration of the animation from one setting value to another, in milliseconds.

Click here for more info

interpolationEasing
#

Type $ease.Easing

Inherited from IComponentSettings

Easing function to use for cross setting value animations.

Click here for more info

invert
#

Type undefined | number

Inherited from ISpriteSettings

Invert colors.

Range of values: 0 (no changes) to 1 (completely inverted colors).

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

isMeasured
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to false element will not be measured and cannot participate in layout schemes.

layer
#

Type undefined | number

Inherited from ISpriteSettings

Numeric layer to put element in.

Elements with higher number will appear in front of the ones with lower numer.

If not set, will inherit layer from its ascendants.

layerMargin
#

Type IMargin

Inherited from ISpriteSettings

Margins for the layer.

Can be used to make the layer larger/or smaller than default chart size.

@since @5.2.39

layout
#

Type Layout | null

Inherited from IContainerSettings

A method to layout

Click here for more info

legendDataItem
#

Type DataItem

Inherited from ISeriesSettings

A data item representing series in a Legend.

@readonly

legendLabelText
#

Type undefined | string

Inherited from ISeriesSettings

A text template to be used for label in legend.

legendRangeLabelText
#

Type undefined | string

Inherited from IXYSeriesSettings

Text to use for series legend label when no particular category/interval is selected.

legendRangeValueText
#

Type undefined | string

Inherited from IXYSeriesSettings

Text to use for series legend value label when no particular category/interval is selected.

legendValueText
#

Type undefined | string

Inherited from ISeriesSettings

A text template to be used for value label in legend.

locationX
#

Type undefined | number

Default 0.5

Inherited from IXYSeriesSettings

Horizontal location of the data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

Click here for more info

locationY
#

Type undefined | number

Default 0.5

Inherited from IXYSeriesSettings

Vertical location of the data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

Click here for more info

lowLocationX
#

Type undefined | number

Default 0.5

Inherited from IXYSeriesSettings

Horizontal location of the low data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

lowLocationY
#

Type undefined | number

Default 0.5

Inherited from IXYSeriesSettings

Vertical location of the low data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

lowValueXField
#

Type undefined | string

Inherited from IXYSeriesSettings

Input data field for X low value.

Click here for more info

lowValueXGrouped
#

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"

Inherited from IXYSeriesSettings

Indicates what aggregate value to use for collective data item, when aggregating X low values from several data items.

lowValueXShow
#

Type "lowValueXWorking" | "lowValueXChange" | "lowValueXChangePercent" | "lowValueXChangeSelection" | "lowValueXChangeSelectionPercent" | "lowValueXChangePrevious" | "lowValueXChangePreviousPercent"

Inherited from IXYSeriesSettings

Display data field for X low value.

lowValueYField
#

Type undefined | string

Inherited from IXYSeriesSettings

Input data field for Y low value.

Click here for more info

lowValueYGrouped
#

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"

Inherited from IXYSeriesSettings

Indicates what aggregate value to use for collective data item, when aggregating Y low values from several data items.

lowValueYShow
#

Type "lowValueYWorking" | "lowValueYChange" | "lowValueYChangePercent" | "lowValueYChangeSelection" | "lowValueYChangeSelectionPercent" | "lowValueYChangePrevious" | "lowValueYChangePreviousPercent"

Inherited from IXYSeriesSettings

Display data field for Y low value.

marginBottom
#

Type undefined | number

Inherited from ISpriteSettings

Bottom margin in pixels.

marginLeft
#

Type undefined | number

Inherited from ISpriteSettings

Left margin in pixels.

marginRight
#

Type undefined | number

Inherited from ISpriteSettings

Right margin in pixels.

marginTop
#

Type undefined | number

Inherited from ISpriteSettings

Top margin in pixels.

mask
#

Type Graphics | null

Inherited from IContainerSettings

An element to use as a container's mask (clipping region).

Click here for more info

maskBullets
#

Type undefined | false | true

Inherited from IXYSeriesSettings

If set to true, series bullets will be masked by plot area.

maskContent
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true all content going outside the bounds of the container will be clipped.

maxHeight
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed height in pixels.

maxWidth
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed width in pixels.

minBulletDistance
#

Type undefined | number

Inherited from IXYSeriesSettings

Minimal distance between data items in pixels.

If data items are closer than this, bullets are turned off to avoid overcrowding.

Click here for more info

minDistance
#

Type undefined | number

Default 0

Inherited from ILineSeriesSettings

Allows simplifying the line with many points.

If set, the series will skip points that are closer than X pixels to each other.

With many data points, this allows having smoother, less cluttered lines.

@since 5.2.7

minHeight
#

Type number | null

Inherited from ISpriteSettings

Minimum allowed height in pixels.

minWidth
#

Type number | null

Inherited from ISpriteSettings

Minimum allowed width in pixels.

name
#

Type undefined | string

Inherited from ISeriesSettings

Name of the series.

numberFormatter
#

Type NumberFormatter | undefined

Inherited from ISpriteSettings

An instance of NumberFormatter that should be used instead of global formatter object.

Click here for more info

opacity
#

Type undefined | number

Inherited from ISpriteSettings

Opacity. 0 - fully transparent; 1 - fully opaque.

openCategoryXField
#

Type undefined | string

Inherited from IXYSeriesSettings

Display data field for X category.

Click here for more info

openCategoryYField
#

Type undefined | string

Inherited from IXYSeriesSettings

Display data field for Y category.

Click here for more info

openLocationX
#

Type undefined | number

Default 0.5

Inherited from IXYSeriesSettings

Horizontal location of the open data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

openLocationY
#

Type undefined | number

Default 0.5

Inherited from IXYSeriesSettings

Vertical location of the open data point relative to its cell.

0 - beginning, 0.5 - middle, 1 - end.

openValueXField
#

Type undefined | string

Inherited from IXYSeriesSettings

Input data field for X open value.

Click here for more info

openValueXGrouped
#

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"

Inherited from IXYSeriesSettings

Display data field for Y open value.

Click here for more info

openValueXShow
#

Type "openValueXWorking" | "openValueXChange" | "openValueXChangePercent" | "openValueXChangeSelection" | "openValueXChangeSelectionPercent" | "openValueXChangePrevious" | "openValueXChangePreviousPercent"

Inherited from IXYSeriesSettings

Display data field for X open value.

Click here for more info

openValueYField
#

Type undefined | string

Inherited from IXYSeriesSettings

Input data field for X open value.

Click here for more info

openValueYGrouped
#

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"

Inherited from IXYSeriesSettings

Display data field for Y open value.

Click here for more info

openValueYShow
#

Type "openValueYWorking" | "openValueYChange" | "openValueYChangePercent" | "openValueYChangeSelection" | "openValueYChangeSelectionPercent" | "openValueYChangePrevious" | "openValueYChangePreviousPercent"

Inherited from IXYSeriesSettings

Display data field for Y open value.

Click here for more info

paddingBottom
#

Type undefined | number

Inherited from IContainerSettings

Bottom padding in pixels.

paddingLeft
#

Type undefined | number

Inherited from IContainerSettings

Left padding in pixels.

paddingRight
#

Type undefined | number

Inherited from IContainerSettings

Right padding in pixels.

paddingTop
#

Type undefined | number

Inherited from IContainerSettings

Top padding in pixels.

position
#

Type "absolute" | "relative"

Inherited from ISpriteSettings

Positioning of the element.

"absolute" means element will not participate in parent layout scheme, and will be positioned solely accoridng its x and y settings.

reverseChildren
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true its children will be laid out in opposite order.

@since 5.1.1

rotation
#

Type undefined | number

Inherited from ISpriteSettings

Rotation in degrees.

saturate
#

Type undefined | number

Inherited from ISpriteSettings

Modify saturation.

Range of values in pixels: 0 to X.

  • 0 - grayscale
  • 1 - no changes
  • >1 - more saturated IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

scale
#

Type undefined | number

Inherited from ISpriteSettings

Scale.

Setting to a value less than 1 will shrink object.

selectorPadding
#

Type undefined | number

Default 5

Inherited from IDrawingSeriesSettings

Padding of a selector rectangle (how many pixels will be added to each side around the drawing when it's selected)

sepia
#

Type undefined | number

Inherited from ISpriteSettings

Apply sepia filter.

Range of values: 0 (no changes) to 1 (complete sepia).

IMPORTANT: This setting is not supported in Safari browsers.

Click here for more info
@since 5.5.0

sequencedDelay
#

Type undefined | number

Inherited from ISeriesSettings

A delay in milliseconds to wait before starting animation of next data item.

Click here for more info

sequencedInterpolation
#

Type undefined | false | true

Inherited from ISeriesSettings

If set to true the series initial animation will be played item by item rather than all at once.

Click here for more info

series
#

Type XYSeries

Inherited from IDrawingSeriesSettings

XYSeries used for drawing.

seriesTooltipTarget
#

Type "series" | "bullet"

Default "series"

Inherited from IXYSeriesSettings

Whether series' tooltip should inherit its color from series or its first bullet.

setStateOnChildren
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true, applying a state on a container will also apply the same state on its children.

Click here for more info

showExtension
#

Type undefined | false | true

Default true

Inherited from ISimpleLineSeriesSettings

Show a dotted line extending from both ends of the drawn line.

showTooltipOn
#

Type "hover" | "always" | "click"

Default "hover"

Inherited from ISpriteSettings

Defines when tooltip is shown over the element.

Available options:

  • "hover" (default) - tooltip is shown when element is hovered by a pointer or touched. It is hidden as soon as element is not hovered anymore, or touch occurs outside it.
  • "always" - a tooltip will always be shown over the element, without any interactions. Please note that if you need to show tooltips for multiple elements at the same time, you need to explicitly create a Tooltip instance and set element's tooltip setting with it.
  • '"click"' - a tooltip will only appear when target element is clicked/tapped. Tooltip will hide when clicking anywhere else on the page.

Click here for more info
@since 5.0.16

snapTooltip
#

Type undefined | false | true

Inherited from IXYSeriesSettings

If set to true XYCursor will show closest data item from series even if it is outside currently hovered date axis interval.

This setting is relevant only if baseAxis is a date axis.

stackToNegative
#

Type undefined | false | true

Inherited from IXYSeriesSettings

Whether to stack negative values from zero (true) or from whatever previous series value is (false).

Click here for more info

stacked
#

Type undefined | false | true

Inherited from IXYSeriesSettings

If set to true series will be stacked to other series that also have this setting set to true.

NOTE: for series stack properly, all stacked series must have same number of data items with the same timestamp/category.

Click here for more info

stateAnimationDuration
#

Type undefined | number

Inherited from IEntitySettings

Duration of transition from one state to another.

stateAnimationEasing
#

Type $ease.Easing

Inherited from IEntitySettings

Easing of transition from one state to another.

stroke
#

Type Color

Inherited from ISeriesSettings

Series stroke color.

Click here for more info

strokeColor
#

Type Color

Inherited from IDrawingSeriesSettings

Color of the lines/borders.

strokeDasharray
#

Type Array

Inherited from IDrawingSeriesSettings

Dash information for lines/borders.

strokeOpacity
#

Type undefined | number

Inherited from IDrawingSeriesSettings

Opacity of the lines/borders (0-1).

strokeWidth
#

Type undefined | number

Inherited from IDrawingSeriesSettings

Width of the lines/borders in pixels.

templateField
#

Type undefined | string

Inherited from ISpriteSettings

Allows binding element's settings to data.

Click here for more info

themeTags
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

These tags only apply to this object, not any children.

Click here for more info

themes
#

Type Array

Inherited from IEntitySettings

A list of themes applied to the element.

toggleKey
#

Type "disabled" | "active" | "none" | undefined

Inherited from ISpriteSettings

If set, element will toggle specified boolean setting between true and false when clicked/touched.

tooltip
#

Type Tooltip

Inherited from ISpriteSettings

Tooltip instance.

tooltipDataItem
#

Type DataItem

Inherited from IXYSeriesSettings

A DataItem that is being used for current tooltip, e.g. by a chart cursor.

@since 5.1.2

tooltipHTML
#

Type undefined | string

Inherited from ISpriteSettings

HTML content to show in a tooltip when hovered.

@since 5.2.11

tooltipPosition
#

Type "fixed" | "pointer"

Inherited from ISpriteSettings

Tooltip position.

tooltipPositionX
#

Type "open" | "value" | "low" | "high"

Default "value"

Inherited from IXYSeriesSettings

Indicates horizontal position at which to show series' tooltip at.

@since 5.0.16

tooltipPositionY
#

Type "open" | "value" | "low" | "high"

Default "value"

Inherited from IXYSeriesSettings

Indicates vertical position at which to show series' tooltip at.

@since 5.0.16

tooltipText
#

Type undefined | string

Inherited from ISpriteSettings

Text to show in a tooltip when hovered.

tooltipX
#

Type number | Percent

Inherited from ISpriteSettings

Tooltip pointer X coordinate relative to the element itself.

tooltipY
#

Type number | Percent

Inherited from ISpriteSettings

Tooltip pointer Y coordinate relative to the element itself.

userData
#

Type any

Inherited from IEntitySettings

A storage for any custom user data that needs to be associated with the element.

valueField
#

Type undefined | string

Inherited from ISeriesSettings

A key to look up in data for a numeric value of the data item.

Some series use it to display its elements. It can also be used in heat rules.

valueXField
#

Type undefined | string

Inherited from IXYSeriesSettings

Input data field for X value.

Click here for more info

valueXGrouped
#

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"

Inherited from IXYSeriesSettings

Indicates what aggregate value to use for collective data item, when aggregating X values from several data items.

Click here for more info

valueXShow
#

Type "valueXWorking" | "valueXChange" | "valueXChangePercent" | "valueXChangeSelection" | "valueXChangeSelectionPercent" | "valueXChangePrevious" | "valueXChangePreviousPercent" | "valueXTotal" | "valueXTotalPercent" | "valueXSum"

Inherited from IXYSeriesSettings

Display data field for X value.

Click here for more info

valueYField
#

Type undefined | string

Inherited from IXYSeriesSettings

Input data field for Y value.

Click here for more info

valueYGrouped
#

Type "open" | "close" | "low" | "high" | "average" | "sum" | "extreme"

Inherited from IXYSeriesSettings

Indicates what aggregate value to use for collective data item, when aggregating X values from several data items.

Click here for more info

valueYShow
#

Type "valueYWorking" | "valueYChange" | "valueYChangePercent" | "valueYChangeSelection" | "valueYChangeSelectionPercent" | "valueYChangePrevious" | "valueYChangePreviousPercent" | "valueYTotal" | "valueYTotalPercent" | "valueYSum"

Inherited from IXYSeriesSettings

Display data field for Y value.

Click here for more info

verticalScrollbar
#

Type Scrollbar

Inherited from IContainerSettings

Setting this to an instance of Scrollbar will enable vertical scrolling of content if it does not fit into the Container.

Click here for more info

visible
#

Type undefined | false | true

Inherited from ISpriteSettings

Is element visible?

wheelable
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true, mouse wheel events will be triggered over the element. It will also disable page scrolling using mouse wheel when pointer is over the element.

width
#

Type number | Percent | null

Inherited from ISpriteSettings

Element's absolute width in pixels (numeric value) or relative width to parent (Percent);

x
#

Type number | Percent | null

Inherited from ISpriteSettings

X position relative to parent.

xAxis
#

Type DateAxis

Inherited from IDrawingSeriesSettings

X-Axis.

y
#

Type number | Percent | null

Inherited from ISpriteSettings

Y position relative to parent.

yAxis
#

Type ValueAxis

Inherited from IDrawingSeriesSettings

Y-axis.

There are 157 inherited items currently hidden from this list.

Private settings

These are read-only settings accessible from a AverageSeries object using its getPrivate() method.

Read about private settings.

adjustedStartIndex
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

allowChangeSnap
#

Read only

Type undefined | false | true

Inherited from IDrawingSeriesPrivate

baseValueSeries
#

Read only

Type Series

Inherited from ISeriesPrivate

customValueAbsoluteSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueAverage
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueClose
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueCount
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueHigh
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueLow
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueOpen
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

customValueSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

doNotUpdateLegend
#

Read only

Type undefined | false | true

Inherited from IXYSeriesPrivate

endIndex
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

focusable
#

Read only

Type undefined | false | true

Inherited from ISpritePrivate

If set to false, its tabindex will be set to -1, so it does not get focused with TAB, regardless whether its public setting focusable is set to true.

@since 5.3.16

highValueXAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXhigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueXhighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYhigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

highValueYhighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

htmlElement
#

Read only

Type HTMLDivElement

Inherited from IContainerPrivate

A <div> element used for HTML content of the Container.

lowValueXAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXlow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueXlowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYlow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

lowValueYlowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

maxX
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

maxY
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

minX
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

minY
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXOpen
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXOpenSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueXSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYOpen
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYOpenSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

openValueYSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

outOfSelection
#

Read only

Type undefined | false | true

Inherited from IXYSeriesPrivate

selectionMaxX
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

selectionMaxY
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

selectionMinX
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

selectionMinY
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

showingTooltip
#

Read only

Type undefined | false | true

Inherited from ISpritePrivate

Is element currently showing a tooltip?

startIndex
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

tooltipTarget
#

Read only

Type Graphics

Inherited from ISpritePrivate

An element tooltip should inherit its colors from.

trustBounds
#

Read only

Type undefined | false | true

Inherited from ISpritePrivate

If set to true, the sprite will check if a mouse pointer is within its bounds before dispatching pointer events.

This helps to solve ghost tooltips problem that sometimes appear while moving the pointer over interactive objects.

This is set to true by default on Rectangle and Circle.

@since 5.5.0

valueAbsoluteSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueAverage
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueClose
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueCount
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueHigh
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueLow
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueOpen
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueSum
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

valueXAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXOpen
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXOpenSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueXSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYAbsoluteSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYAbsoluteSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYAverage
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYAverageSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYClose
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYCloseSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYCount
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYCountSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYHigh
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYHighSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYLow
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYLowSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYOpen
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYOpenSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYSum
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

valueYSumSelection
#

Read only

Type undefined | number

Inherited from IXYSeriesPrivate

There are 164 inherited items currently hidden from this list.

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity

axisRanges
#

Type List

Default new List()

Inherited from XYSeries

A list of axis ranges that affect the series.

Click here for more info

bullets
#

Type List

Default new List()

Inherited from Series

List of bullets to use for the series.

Click here for more info

bulletsContainer
#

Type Container

Default Container.new()

Inherited from Series

A Container series' bullets are stored in.

chart
#

Type XYChart | undefined

Inherited from XYSeries

children
#

Type Children

Default new Children(this)

Inherited from Container

List of Container's child elements.

circles
#

Type ListTemplate

Default this.addDisposer(new ListTemplate(
Template.new({
  
}),

() => Circle._new(this._root,
{
  

},
[this.circles.template]),

))

Inherited from DrawingSeries

className
#

Static

Type string

Default "AverageSeries"

classNames
#

Static

Type Array

Default "AverageSeries", "SimpleLineSeries", "DrawingSeries", "LineSeries", "XYSeries", "Series", "Component", "Container", "Sprite", "Entity"

data
#

Type ListData

Inherited from Component

Component's data.

Click here for more info

dataItem
#

Type DataItem | undefined

Inherited from Sprite

A DataItem used for this element.

NOTE: data item is being assigned automatically in most cases where it matters. Use this accessor to set data item only if you know what you're doing.

dataItems
#

Type Array

Inherited from Component

A list of component's data items.

enableDispose
#

Type boolean

Default true

Inherited from Settings

If this is set to false then disposing does nothing, it's a no-op.

events
#

Type SpriteEventDispatcher

Inherited from Sprite

fills
#

Type ListTemplate

Default new ListTemplate<Graphics>

Inherited from LineSeries

A TemplateList of all segment fills in series.

fills.template can be used to set default settings for all segment fills, or to change on existing ones.

grips
#

Type ListTemplate

Default this.addDisposer(new ListTemplate(
Template.new({
  
}),

() => Container._new(this._root,
{
  
themeTags: ["grip"],
  
setStateOnChildren: true,
  
draggable: true

},
[this.grips.template]),

))

Inherited from DrawingSeries

hitLines
#

Type ListTemplate

Default this.addDisposer(new ListTemplate(
Template.new({
  
}),

() => Line._new(this._root,
{
  
},
[this.hitLines.template])
))

Inherited from SimpleLineSeries

inited
#

Type boolean

Default false

Inherited from Component

Indicates if the component has already been initialized.

lines
#

Type ListTemplate

Default this.addDisposer(new ListTemplate(
Template.new({
  
}),

() => Line._new(this._root,
{
  
},
[this.lines.template])
))

Inherited from SimpleLineSeries

mainContainer
#

Type Container

Default Container.new()

Inherited from XYSeries

A Container that us used to put series' elements in.

mainDataItems
#

Type Array

Inherited from XYSeries

A list of series's main (ungrouped) data items.

outerCircles
#

Type ListTemplate

Default this.addDisposer(new ListTemplate(
Template.new({
  
}),

() => Circle._new(this._root,
{
  
themeTags: ["outline"]

},
[this.outerCircles.template]),

))

Inherited from DrawingSeries

parent
#

Type Container | undefined

Inherited from Sprite

Parent Container of this element.

root
#

Type Root

Inherited from Entity

An instance of Root object.

@readonly
@since 5.0.6

selectors
#

Type ListTemplate

Default this.addDisposer(new ListTemplate(
Template.new({
  
}),

() => Rectangle._new(this._root,
{
  
themeTags: ["selector"]

},
[this.selectors.template]),

))

Inherited from DrawingSeries

states
#

Type States

Default new States(this)

Inherited from Entity

strokes
#

Type ListTemplate

Default new ListTemplate<Graphics>

Inherited from LineSeries

A TemplateList of all line segments in series.

strokes.template can be used to set default settings for all line segments, or to change on existing ones.

template
#

Type Template | undefined

Inherited from Entity

@todo needs description

uid
#

Type number

Default ++counter

Inherited from Settings

Unique ID.

There are 27 inherited items currently hidden from this list.

Methods

addBullet(

dataItem: DataItem,
bullet: Bullet

)

#

Returns void

Inherited from Series

Adds bullet directly to a data item.

Please note: method accepts Bullet instance as a paramter, not a reference to a function.

You should add Bullet instance, not a method like you do it on series.

Click here for more info
@since 5.6.0

addLine(

point: IPoint

)

#

Returns void

Inherited from SimpleLineSeries

Adds a line drawing.

Supported tools: "Horizontal Line", "Horizontal Ray", "Vertical Line".

@since 5.10.2

addPoints(

point: IPoint,
index: number

)

#

Returns void

Inherited from SimpleLineSeries

allChildren()

#

Returns Array

Inherited from Container

animate(

options: AnimationOptions

)

#

Returns Animation

Inherited from Settings

Animates setting values from current/start values to new ones.

Click here for more info

appear(

duration?: undefined | number,
delay?: undefined | number

)

#

Returns Promise

Inherited from Sprite

Plays initial reveal animation regardless if element is currently hidden or visible.

cancelDrawing()

#

Returns void

Inherited from DrawingSeries

Cancels current drawing

@since 5.9.0

clearDrawings()

#

Returns void

Inherited from DrawingSeries

compositeOpacity()

#

Returns number

Inherited from Sprite

Returns an actual opacity of the element, taking into account all parents.

@since 5.2.11

compositeRotation()

#

Returns number

Inherited from Sprite

Returns an actual roation of the element, taking into account all parents.

@since 5.9.2

compositeScale()

#

Returns number

Inherited from Sprite

Returns an actual scale of the element, taking into account all parents.

@since 5.9.2

createAxisRange(

axisDataItem: DataItem

)

#

Returns ILineSeriesAxisRange

Inherited from XYSeries

Creates and returns an axis range object.

Click here for more info

deleteDrawing(

id: string

)

#

Returns void

Inherited from DrawingSeries

Deletes a series' drawing by ids ID.

@since 5.9.0

deleteSelected()

#

Returns void

Inherited from DrawingSeries

Deletes all currently selected drawings on this series.

@since 5.9.0

depth()

#

Returns number

Inherited from Sprite

Returns depth (how deep in the hierachy of the content tree) of this element.

disableDrawing()

#

Returns void

Inherited from DrawingSeries

disableErasing()

#

Returns void

Inherited from DrawingSeries

dispose()

#

Returns void

Inherited from Settings

Disposes this object.

disposeDataItem(

dataItem: DataItem

)

#

Returns void

Inherited from SimpleLineSeries

disposeIndex(

index: number

)

#

Returns void

Inherited from DrawingSeries

Disposes a drawing with the specified index.

@since 5.7.7

eachChildren(

f: ( child: Sprite) => void

)

#

Returns void

Inherited from Container

enableDrawing()

#

Returns void

Inherited from DrawingSeries

enableDrawingSelection(

value: boolean

)

#

Returns void

Inherited from SimpleLineSeries

enableErasing()

#

Returns void

Inherited from DrawingSeries

endIndex()

#

Returns number

Inherited from DrawingSeries

get(

key: Key,
fallback: F

)

#

Returns NonNullable | F

Inherited from Entity

Returns settings value for the specified key.

If there is no value, fallback is returned instead (if set).

Click here for more info

getContext(

id: string

)

#

Returns any

Inherited from DrawingSeries

getDataItemById(

id: string

)

#

Returns DataItem | undefined

Inherited from Series

Looks up and returns a data item by its ID.

getDateFormatter()

#

Returns DateFormatter

Inherited from Sprite

Returns an instance of DateFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getDurationFormatter()

#

Returns DurationFormatter

Inherited from Sprite

Returns an instance of DurationFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getIndex(

id: string

)

#

Returns number | null

Inherited from DrawingSeries

Returns index of a drawing with the specific ID, or null if not found.

@since 5.8.4

getNumberFormatter()

#

Returns NumberFormatter

Inherited from Sprite

Returns an instance of NumberFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getTooltip()

#

Returns Tooltip | undefined

Inherited from Sprite

Returns Tooltip used for this element.

has(

key: Key

)

#

Returns boolean

Inherited from Settings

Returns true if the setting exists.

Click here for more info

height()

#

Returns number

Inherited from Sprite

Returns height of this element in pixels.

hide(

duration?: undefined | number

)

#

Returns Promise

Inherited from XYSeries

Hides series.

hideDataItem(

dataItem: DataItem,
duration?: undefined | number

)

#

Returns Promise

Inherited from XYSeries

Hides series's data item.

hideTooltip()

#

Returns void

Inherited from XYSeries

hover()

#

Returns void

Inherited from Sprite

Simulate hover over element.

indexToDrawingId(

index: number

)

#

Returns string | undefined

Inherited from DrawingSeries

innerHeight()

#

Returns number

Inherited from Container

Returns container's inner height (height without padding) in pixels.

innerWidth()

#

Returns number

Inherited from Container

Returns container's inner width (width without padding) in pixels.

isDisposed()

#

Returns boolean

Inherited from Settings

Returns true if this element is disposed.

isDragging()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently being dragged.

isFocus()

#

Returns boolean

Inherited from Sprite

Returns true if this element does currently have focus.

isHidden()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently hidden.

isHiding()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently animating to a hidden state.

isHover()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently hovered by a pointer.

isShowing()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently animating to a default state.

isType(

type: string

)

#

Returns this

Inherited from Entity

Checks if element is of certain class (or inherits one).

isVisible()

#

Returns boolean

Inherited from Sprite

Returns false if if either public or private setting visible is set to false, or forceHidden is set to true.

isVisibleDeep()

#

Returns boolean

Inherited from Sprite

Same as isVisible(), except it checks all ascendants, too.

@since 5.2.7

makeDataItem(

data: IAverageSeriesDataItem,
dataContext?: any

)

#

Returns DataItem

Inherited from Component

Creates a new data item and processes it.

markDirtyDrawings()

#

Returns void

Inherited from DrawingSeries

markDirtyKey(

key: Key

)

#

Returns void

Inherited from Sprite

Marks some setting as dirty. Could be used to trigger adapter.

markDirtyValues(

_dataItem?: DataItem

)

#

Returns void

Inherited from Component

Forces a repaint of the element which relies on data.

@since 5.0.21

maxHeight()

#

Returns number

Inherited from Sprite

Returns maximum allowed height of this element in pixels.

maxWidth()

#

Returns number

Inherited from Sprite

Returns maximum allowed width of this element in pixels.

new(

root: Root,
settings: ITSettings,
template?: Template

)

#

Static

Returns T

Inherited from Entity

Use this method to create an instance of this class.

Click here for more info

off(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

#

Returns void

Inherited from Settings

Removes a callback for when value of a setting changes.

Click here for more info
@since 5.9.2

offPrivate(

key: Key,
callback?: undefined | ( value: [""], target: this, key: Key) => void

)

#

Returns void

Inherited from Settings

Removes a callback for when value of a private setting changes.

Click here for more info
@since 5.9.2

on(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of settings changes or is set.

Click here for more info

onPrivate(

key: Key,
callback: ( value: [""], target: this, key: Key) => void

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of private settings changes or is set.

Click here for more info

pushDataItem(

data: IAverageSeriesDataItem,
dataContext?: any

)

#

Returns DataItem

Inherited from Component

Adds new explicit data item to series.

remove(

key: Key

)

#

Returns void

Inherited from Entity

Removes a setting value for the specified key.

Click here for more info

removeAll()

#

Returns void

Inherited from Settings

Removes all keys;

Click here for more info

resetExtremes()

#

Returns void

Inherited from XYSeries

Resets cached axis scale values.

scrollToChild(

child: Sprite

)

#

Returns void

Inherited from Container

If scrolling is enabled on the Container (by adding verticalScrollbar) the Container will scroll in such way so that target element becomes visible if its currently outside of view.

@since 5.10.5

selectDrawing(

id: string,
keepSelection?: undefined | false | true

)

#

Returns void

Inherited from DrawingSeries

Selects series' drawing by its ID.

@since 5.9.0

set(

key: Key,
value: Value

)

#

Returns Value

Inherited from Entity

Sets a setting value for the specified key, and returns the same value.

Click here for more info

setAll(

settings: Partial

)

#

Returns void

Inherited from Settings

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

setInteractive(

value: boolean

)

#

Returns void

Inherited from SimpleLineSeries

setTimeout(

fn: () => void,
delay: number

)

#

Returns IDisposer

Inherited from Entity

Creates and returns a "disposable" timeout.

show(

duration?: undefined | number

)

#

Returns Promise

Inherited from XYSeries

Shows hidden series.

showDataItem(

dataItem: DataItem,
duration?: undefined | number

)

#

Returns Promise

Inherited from XYSeries

Shows series's data item.

showDataItemTooltip(

dataItem: DataItem | undefined

)

#

Returns void

Inherited from XYSeries

Shows a tooltip for specific data item.

showTooltip(

point?: IPoint

)

#

Returns void

Inherited from Sprite

Shows element's Tooltip.

startIndex()

#

Returns number

Inherited from DrawingSeries

toBack()

#

Returns void

Inherited from Sprite

Moves sprite to the beginning of the parent's children array.

Depending on layout setting of the parten container, it may effect the positioning or overlapping order of the elements.

toFront()

#

Returns void

Inherited from Sprite

Moves sprite to the end of the parent's children array.

Depending on layout setting of the parten container, it may effect the positioning or overlapping order of the elements.

toGlobal(

point: IPoint

)

#

Returns IPoint

Inherited from Sprite

Converts X/Y coordinate within this element to a global coordinate.

toLocal(

point: IPoint

)

#

Returns IPoint

Inherited from Sprite

Converts global X/Y coordinate to a coordinate within this element.

toggleDrawing(

enabled?: undefined | false | true

)

#

Returns void

Inherited from DrawingSeries

unhover()

#

Returns void

Inherited from Sprite

Simulate unhover over element.

unselectAllDrawings()

#

Returns number

Inherited from DrawingSeries

Unselects all currently selected drawings on this series.

@since 5.9.0

unselectDrawing(

id: string

)

#

Returns void

Inherited from DrawingSeries

Unselects series' drawing by its ID.

@since 5.9.0

unselectDrawings()

#

Returns number

Inherited from DrawingSeries

Unselects all currently selected drawings of this series.

@since 5.9.0

width()

#

Returns number

Inherited from Sprite

Returns width of this element in pixels.

x()

#

Returns number

Inherited from Sprite

Returns element's actual X position in pixels.

y()

#

Returns number

Inherited from Sprite

Returns element's actual Y position in pixels.

There are 90 inherited items currently hidden from this list.

Events

Add event handlers to AverageSeries object using its events.on() method.

Read about adding event handlers.

#blur

Param { originalEvent: FocusEvent,
  target: Sprite,
  type: "blur",
  target: this }

Inherited from XYSeries

Invoked when element loses focus.

#boundschanged

Param { type: "boundschanged",
  target: this }

Inherited from XYSeries

Invoked when element's bounds change due to any manipulation to it.

#click

Param { type: "click",
  target: this }

Inherited from XYSeries

Invoked when element is clicked or tapped.

#dataitemchanged

Param { newDataItem: DataItem | undefined,
  oldDataItem: DataItem | undefined,
  type: "dataitemchanged",
  target: this }

Inherited from XYSeries

Invoked when element's data item changes.

#datasetchanged

Param { id: string,
  type: "datasetchanged",
  target: this }

Inherited from XYSeries

Kicks in when axis starts using different data set, e.g. data of different granularit on DateAxis.

@since 5.1.1

#datavalidated

Param { type: "datavalidated",
  target: this }

Inherited from XYSeries

#dblclick

Param { type: "dblclick",
  target: this }

Inherited from XYSeries

Invoked when element is doubleclicked or tapped twice quickly.

#dragged

Param { type: "dragged",
  target: this }

Inherited from XYSeries

Invoked when element ois being dragged.

#dragstart

Param { type: "dragstart",
  target: this }

Inherited from XYSeries

Invoked when element dragging starts.

#dragstop

Param { type: "dragstop",
  target: this }

Inherited from XYSeries

Invoked when element dragging stops.

#focus

Param { originalEvent: FocusEvent,
  target: Sprite,
  type: "focus",
  target: this }

Inherited from XYSeries

Invoked when element gains focus.

#globalpointermove

Param { type: "globalpointermove",
  target: this }

Inherited from XYSeries

Invoked when pointer is moving anywhere in the window, even outside of the element or even chart area.

#globalpointerup

Param { type: "globalpointerup",
  target: this }

Inherited from XYSeries

Invoked when pointer button is released or touch stops in the window, even outside of the element or even chart area.

#middleclick

Param { type: "middleclick",
  target: this }

Inherited from XYSeries

Invoked when element is clicked with the middle mouse button.

#pointerdown

Param { type: "pointerdown",
  target: this }

Inherited from XYSeries

Invoked when pointer button is pressed or touch starts over the element.

#pointerout

Param { type: "pointerout",
  target: this }

Inherited from XYSeries

Invoked when pointer moves outside the element.

#pointerover

Param { type: "pointerover",
  target: this }

Inherited from XYSeries

Invoked when pointer moves over the element.

#pointerup

Param { type: "pointerup",
  target: this }

Inherited from XYSeries

Invoked when pointer button is released or touch stops over the element.

#positionchanged

Param { type: "positionchanged",
  target: this }

Inherited from XYSeries

Invoked when element's position (X/Y) changes.

#rightclick

Param { type: "rightclick",
  target: this }

Inherited from XYSeries

Invoked when element is clicked width the right mouse button.

#wheel

Param { originalEvent: WheelEvent,
  point: IPoint,
  type: "wheel",
  target: this }

Inherited from XYSeries

Invoked when mouse wheel is spinned while pointer is over the element.

There are 21 inherited items currently hidden from this list.