SmoothedXLineSeries

Type class

Smoothed line series suitable for horizontal plots.

Click here for more info

Sources

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

// SmoothedXLineSeries is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Import from: "xy.ts"
 * Use like: am5xy.SmoothedXLineSeries
 * --------------------------------------------------------
 */
import * as am5xy from "@amcharts/amcharts5/xy";

// SmoothedXLineSeries is available in all of the following modules.
// You only need to import one of them.

/**
 * --------------------------------------------------------
 * Include via: <script src="xy.js"></script>
 * Access items like: am5xy.SmoothedXLineSeries
 * --------------------------------------------------------
 */

Inheritance

SmoothedXLineSeries extends LineSeries.

SmoothedXLineSeries is not extended by any other symbol.

Settings

Set these settings on a SmoothedXLineSeries 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

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

cursorOverStyle
#

Type undefined | string

Inherited from ISpriteSettings

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

Click here for more info

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.

fill
#

Type Color

Inherited from ISeriesSettings

Series fill color.

Click here for more info

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

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

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);

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

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.

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

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

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.

rotation
#

Type undefined | number

Inherited from ISpriteSettings

Rotation in degrees.

scale
#

Type undefined | number

Inherited from ISpriteSettings

Scale.

Setting to a value less than 1 will shrink object.

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

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

showTooltipOn
#

Type "hover" | "always"

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

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

templateField
#

Type undefined | string

Inherited from ISpriteSettings

Allows binding element's settings to data.

Click here for more info

tension
#

Type undefined | number

Default 0.5

A tension force for the smoothing (0-1). The smaller the value the more curvy the line will be.

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.

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

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 IXYAxis

Inherited from IXYSeriesSettings

X axis series uses.

y
#

Type number | Percent | null

Inherited from ISpriteSettings

Y position relative to parent.

yAxis
#

Type IXYAxis

Inherited from IXYSeriesSettings

Y axis series uses.

There are 113 inherited items currently hidden from this list.

Private settings

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

Read about private settings.

endIndex
#

Read only

Type undefined | number

Inherited from ISeriesPrivate

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

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.

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 84 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.

className
#

Static

Type string

Default "SmoothedXLineSeries"

classNames
#

Static

Type Array

Default "SmoothedXLineSeries", "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.

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.

inited
#

Type boolean

Default false

Inherited from Component

Indicates if the component has already been initialized.

mainContainer
#

Type Container

Default Container.new()

Inherited from XYSeries

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

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

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 19 inherited items currently hidden from this list.

Methods

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.

createAxisRange(

axisDataItem: DataItem

)

#

Returns ILineSeriesAxisRange

Inherited from XYSeries

Creates and returns an axis range object.

Click here for more info

depth()

#

Returns number

Inherited from Sprite

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

dispose()

#

Returns void

Inherited from Settings

Disposes this object.

eachChildren(

f: ( child: Sprite) => void

)

#

Returns void

Inherited from Container

endIndex()

#

Returns number

Inherited from Series

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

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

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.

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 Sprite

Hides element's Tooltip.

hover()

#

Returns void

Inherited from Sprite

Simulate hover over element.

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).

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

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

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

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

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 Series

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.

unhover()

#

Returns void

Inherited from Sprite

Simulate unhover over element.

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 53 inherited items currently hidden from this list.

Events

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

Read about adding event handlers.

#blur

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

Inherited from Series

Invoked when element loses focus.

#boundschanged

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

Inherited from Series

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

#click

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

Inherited from Series

Invoked when element is clicked or tapped.

#dataitemchanged

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

Inherited from Series

Invoked when element's data item changes.

#datavalidated

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

Inherited from Series

#dblclick

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

Inherited from Series

Invoked when element is doubleclicked or tapped twice quickly.

#dragged

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

Inherited from Series

Invoked when element ois being dragged.

#dragstart

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

Inherited from Series

Invoked when element dragging starts.

#dragstop

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

Inherited from Series

Invoked when element dragging stops.

#focus

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

Inherited from Series

Invoked when element gains focus.

#globalpointermove

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

Inherited from Series

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 Series

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 Series

Invoked when element is clicked with the middle mouse button.

#pointerdown

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

Inherited from Series

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

#pointerout

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

Inherited from Series

Invoked when pointer moves outside the element.

#pointerover

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

Inherited from Series

Invoked when pointer moves over the element.

#pointerup

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

Inherited from Series

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

#positionchanged

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

Inherited from Series

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

#rightclick

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

Inherited from Series

Invoked when element is clicked width the right mouse button.

#wheel

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

Inherited from Series

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

There are 20 inherited items currently hidden from this list.