DurationAxis

Type class

Creates a duration axis.

Click here for more info

Sources

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

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

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

// DurationAxis 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.DurationAxis
 * --------------------------------------------------------
 */

Inheritance

DurationAxis extends ValueAxis.

DurationAxis is not extended by any other symbol.

Settings

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

autoZoom
#

Type undefined | false | true

Default true

Inherited from IValueAxisSettings

If set to false, the axis won't be auto-zoomed to a selection (this works only if the other axis is a DateAxis or a CategoryAxis).

IMPORTANT: This setting will be ignored if both X and Y axes are a ValueAxis.

@since 5.2.20

background
#

Type Graphics

Inherited from IContainerSettings

Background element.

Click here for more info

baseUnit
#

Type TimeUnit

Default "second"

A base unit (granularity) of data.

Used to indicate what are the base units of your data.

Available options: "millisecond", "second" (default), "minute", "hour", "day", "week", "month", and "year".

Click here for more info

baseValue
#

Type undefined | number

Default 0

Inherited from IValueAxisSettings

Base value, which indicates the threshold between "positive" and "negative" values.

Click here for more info

bullet
#

Type undefined | ( root: Root, axis: Axis, dataItem: DataItem) => AxisBullet

Inherited from IAxisSettings

A function that will be used to create bullets on each cell.

Click here for more info

calculateTotals
#

Type undefined | false | true

Inherited from IValueAxisSettings

If your series relies on dynamically calculated values, like value changes, percents, or total sums, set this to true.

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.

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.

end
#

Type undefined | number

Inherited from IAxisSettings

The initial relative zoom end position of the axis.

E.g. stting it to 0.9 will pre-zoom axis to 10% from the end.

Click here for more info

exportable
#

Type undefined | false | true

Inherited from ISpriteSettings

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

extraMax
#

Type undefined | number

Inherited from IValueAxisSettings

Relative extension to the automatically-calculated maximum value of the axis scale.

E..g. 0.1 will extend the scale by 10%, so if max value is 1000, the axis will now show maximum value of 1100.

Click here for more info

extraMin
#

Type undefined | number

Inherited from IValueAxisSettings

Relative extension to the automatically-calculated minimum value of the axis scale.

E..g. 0.1 will extend the scale by 10%, so if max value is 1000 and minimum value is 0, the new minimum value will be -100.

Click here for more info

extraTooltipPrecision
#

Type undefined | number

Inherited from IValueAxisSettings

If set, will use greater precision for the axis fooltip than the one for axis' actual labels.

E.g. if axis displays labels with one decimal (1.0, 1.1, 1.2) setting this setting to 1 would allow two decimals in axis tooltip, e.g. 1.15.

Click here for more info

fillRule
#

Type undefined | ( dataItem: DataItem) => void

Inherited from IValueAxisSettings

A function that can be used to specify how to configure axis fills.

Click here for more info

fixAxisSize
#

Type undefined | false | true

Default true

Inherited from IAxisSettings

If set to true (default) the axis width will stay constant across all zooms, even if actual length of all visible labels changes.

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

height
#

Type number | Percent | null

Inherited from ISpriteSettings

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

html
#

Type undefined | string

Inherited from IContainerSettings

HTML content of the container.

Click here for more info
@since 5.2.11

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.

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

logarithmic
#

Type undefined | false | true

Inherited from IValueAxisSettings

If set to true axis will use logarithmic scale.

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

maskContent
#

Type undefined | false | true

Inherited from IContainerSettings

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

max
#

Type undefined | number

Inherited from IValueAxisSettings

Override maximum value for the axis scale.

NOTE: the axis might modify the maximum value to fit into its scale better, unless strictMinMax is set to true.

Click here for more info

maxDeviation
#

Type undefined | number

Default 0.1

Inherited from IAxisSettings

A relative distance the axis is allowed to be zoomed/panned beyond its actual scope.

Click here for more info

maxHeight
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed height in pixels.

maxPrecision
#

Type undefined | number

Inherited from IValueAxisSettings

Maximum number of decimals to allow in axis labels.

This setting not only affects formatting of the labels, but also where and how many grid/labels are placed on the axis.

Click here for more info

maxWidth
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed width in pixels.

maxZoomCount
#

Type undefined | number

Inherited from IAxisSettings

Maximum number of axis elements to show at a time.

E.g. for a CategoryAxis that would be number of categories.

For a DateAxis it would be number of baseInterval.

The axis will not allow to be zoomed out beyond this number.

Click here for more info

maxZoomFactor
#

Type number | null

Default 1000

Inherited from IAxisSettings

Maximum number of times the scope of the axis could auto-zoom-in.

This is to prevent axis jumping too drastically when scrolling/zooming.

min
#

Type undefined | number

Inherited from IValueAxisSettings

Override minimum value for the axis scale.

NOTE: the axis might modify the minimum value to fit into its scale better, unless strictMinMax is set to true.

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.

minZoomCount
#

Type undefined | number

Inherited from IAxisSettings

Minimum number of axis elements to show at a time.

E.g. for a CategoryAxis that would be number of categories.

For a DateAxis it would be number of baseInterval.

The axis will not allow to be zoomed in beyond this number.

Click here for more info

numberFormat
#

Type undefined | string

Inherited from IValueAxisSettings

Number format to use for axis labels.

If not set, will use format set in global number formatter.

Click here for more info

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.

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.

panX
#

Type undefined | false | true

Inherited from IAxisSettings

If set to false the axis will be exempt when chart is panned horizontally, and will keep its current position.`

Click here for more info

panY
#

Type undefined | false | true

Inherited from IAxisSettings

If set to false the axis will be exempt when chart is panned vertically, and will keep its current position.`

Click here for more info

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.

renderer
#

Type R

Inherited from IAxisSettings

A renderer object which is responsible of rendering visible axis elements.

Click here for more info

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.

scale
#

Type undefined | number

Inherited from ISpriteSettings

Scale.

Setting to a value less than 1 will shrink object.

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

Default true

Inherited from IAxisSettings

Should tooltip snap to the tooltipLocation (true) or follow cursor.

start
#

Type undefined | number

Inherited from IAxisSettings

The initial relative zoom start position of the axis.

E.g. stting it to 0.1 will pre-zoom axis to 10% from the start.

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.

strictMinMax
#

Type undefined | false | true

Inherited from IValueAxisSettings

Force axis scale to be precisely at values as set in min and/or max.

In case min and/or max is not set, the axis will fix its scale to precise lowest and highest values available through all of the series attached to it.

This effectively locks the axis from auto-zooming itself when chart is zoomed in.

If you need to zoom to actual low/high values within currently visible scope, use strictMinMaxSelection instead.

Use extraMin and extraMax to add extra "padding".

Click here for more info

strictMinMaxSelection
#

Type undefined | false | true

Inherited from IValueAxisSettings

Force axis to auto-zoom to exact lowest and highest values from attached series' data items within ucurrently visible range.

This is a good feature when your series is plotted from derivative values, like valueYChangeSelection as it helps to avoid frequent jumping of series to adjusted min and max of the axis.

Use extraMin and extraMax to add extra "padding".

@since 5.1.11

syncWithAxis
#

Type ValueAxis

Inherited from IValueAxisSettings

This setting can be set to an instance of another ValueAxis.

If set the grid of this axis will be synced with grid of the target axis.

NOTE: this is not 100% guaranteed to work. In some rare cases perfect sync might not be possible.

Click here for more info

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 IAxisSettings

Tooltip element to use for axis.

tooltipHTML
#

Type undefined | string

Inherited from ISpriteSettings

HTML content to show in a tooltip when hovered.

@since 5.2.11

tooltipLocation
#

Type undefined | number

Default 0.5

Inherited from IAxisSettings

tooltipLocation indicates which relative place to snap to: 0 beginning, 0.5 - middle, 1 - end.

tooltipNumberFormat
#

Type string | NumberFormatOptions

Inherited from IValueAxisSettings

A numeric format used for numbers displayed in axis tooltip.

Click here for more info

tooltipPosition
#

Type "fixed" | "pointer"

Inherited from ISpriteSettings

Tooltip position.

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.

treatZeroAs
#

Type undefined | number

Inherited from IValueAxisSettings

Treat zero values as some other value.

Useful in situations where zero would result in error, i.e. logarithmic scale.

Click here for more info

userData
#

Type any

Inherited from IEntitySettings

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

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.

y
#

Type number | Percent | null

Inherited from ISpriteSettings

Y position relative to parent.

zoomX
#

Type undefined | false | true

Inherited from IAxisSettings

If set to false the axis will be exempt when chart is zoomed horizontally, and will keep its current zoom/position.`

Click here for more info

zoomY
#

Type undefined | false | true

Inherited from IAxisSettings

If set to false the axis will be exempt when chart is zoomed vertically, and will keep its current zoom/position.`

Click here for more info

There are 98 inherited items currently hidden from this list.

Private settings

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

Read about private settings.

durationFormat
#

Read only

Type string

A format to used by axis to format its labels.

@readonly

htmlElement
#

Read only

Type HTMLDivElement

Inherited from IContainerPrivate

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

max
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

Calculated current maximum value of the axis scale.

@readonly

maxFinal
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

A maximum value of the axis scale.

Can be useful in cases where axis zoom is currently being animated, and max is reflecting current intermediate value, whereas maxFinal will show target value.

@readonly

min
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

Calculated current minimum value of the axis scale.

@readonly

minFinal
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

A minimum value of the axis scale.

Can be useful in cases where axis zoom is currently being animated, and min is reflecting current intermediate value, whereas minFinal will show target value.

@readonly

selectionMax
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

Calculated maximum value of the currently viewable (zoomed) scope.

@readonly

selectionMaxFinal
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

A target maximum value of the viewable value scope.

Can be useful in cases where axis zoom is currently being animated, and selectionMax is reflecting current intermediate value, whereas selectionMaxFinal will show target value.

@readonly

selectionMin
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

Calculated minimum value of the currently viewable (zoomed) scope.

@readonly

selectionMinFinal
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

A target minimum value of the viewable value scope.

Can be useful in cases where axis zoom is currently being animated, and selectionMin is reflecting current intermediate value, whereas selectionMinFinal will show target value.

@readonly

selectionStepFinal
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

When selection step changes, it might change during axis zoom animation.

selectionStepFinal will show what step will be when animation is finished.

@readonly

showingTooltip
#

Read only

Type undefined | false | true

Inherited from ISpritePrivate

Is element currently showing a tooltip?

step
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

Value step between grid lines.

@readonly

stepDecimalPlaces
#

Read only

Type undefined | number

Inherited from IValueAxisPrivate

Decimal places used when formatting axis labels.

@readonly

tooltipPosition
#

Read only

Type undefined | number

Inherited from IAxisPrivate

Saves position to which tooltip points.

tooltipTarget
#

Read only

Type Graphics

Inherited from ISpritePrivate

An element tooltip should inherit its colors from.

There are 15 inherited items currently hidden from this list.

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity

axisHeader
#

Type Container

Default new Container

Inherited from Axis

A container above the axis that can be used to add additional stuff into it. For example a legend, label, or an icon.

Click here for more info

axisRanges
#

Type List

Default new List()

Inherited from Axis

A list of axis ranges.

Click here for more info

bulletsContainer
#

Type Container

Default new Container

Inherited from Axis

A Container that holds all the axis bullet elements.

chart
#

Type XYChart | undefined

Inherited from Axis

A referenece to the the chart the axis belongs to.

children
#

Type Children

Default new Children(this)

Inherited from Container

List of Container's child elements.

className
#

Static

Type string

Default "DurationAxis"

classNames
#

Static

Type Array

Default "DurationAxis", "ValueAxis", "Axis", "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

ghostLabel
#

Type AxisLabel

Inherited from Axis

A control label that is invisible but is used to keep width the width of the axis constant.

Click here for more info

gridContainer
#

Type Container

Default Container.new()

Inherited from Axis

A Container that holds all the axis grid and fill elements.

inited
#

Type boolean

Default false

Inherited from Component

Indicates if the component has already been initialized.

labelsContainer
#

Type Container

Default Container.new()

Inherited from Axis

A Container that holds all the axis label elements.

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

series
#

Type Array

Inherited from Axis

A list of series using this axis.

states
#

Type States

Default new States(this)

Inherited from Entity

template
#

Type Template | undefined

Inherited from Entity

@todo needs description

topGridContainer
#

Type Container

Default Container.new()

Inherited from Axis

A Container that holds axis grid elements which goes above the series.

uid
#

Type number

Default ++counter

Inherited from Settings

Unique ID.

There are 21 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.

basePosition()

#

Returns number

Inherited from ValueAxis

Returns relative position of axis' baseValue.

baseValue()

#

Returns number

Inherited from ValueAxis

Base value of the ValueAxis, which determines positive and negative values.

compositeOpacity()

#

Returns number

Inherited from Sprite

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

@since 5.2.11

coordinateToPosition(

coordinate: number

)

#

Returns number

Inherited from Axis

Converts pixel coordinate to a relative position on axis.

createAxisRange(

axisDataItem: DataItem

)

#

Returns DataItem

Inherited from Axis

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

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

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

getSeriesItem(

series: XYSeries,
position: number

)

#

Returns DataItem | undefined

Inherited from ValueAxis

Returns a data item from series that is closest to the position.

getTooltip()

#

Returns Tooltip | undefined

Inherited from Sprite

Returns Tooltip used for this element.

getTooltipText(

position: number

)

#

Returns string | undefined

Returns text to be used in an axis tooltip for specific relative position.

getX(

value: number,
location: number,
baseValue: number

)

#

Returns any

Inherited from ValueAxis

Returns X coordinate in pixels corresponding to specific value.

getY(

value: number,
location: number,
baseValue: number

)

#

Returns any

Inherited from ValueAxis

Returns X coordinate in pixels corresponding to specific value.

height()

#

Returns number

Inherited from Sprite

Returns height of this element in pixels.

hide(

duration?: undefined | number

)

#

Returns Promise

Inherited from Sprite

Hides the element and returns a Promise which completes when all hiding animations are finished.

series.hide().then(function(ev) {
  console.log("Series finished hiding");
})
series.hide().then(function(ev) {
  console.log("Series finished hiding");
})

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

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

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

positionToValue(

position: number

)

#

Returns number

Inherited from ValueAxis

Converts a relative position to a corresponding numeric value from axis scale.

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

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 Sprite

Shows currently hidden element and returns a Promise which completes when all showing animations are finished.

series.show().then(function(ev) {
  console.log("Series is now fully visible");
})
series.show().then(function(ev) {
  console.log("Series is now fully visible");
})

showTooltip(

point?: IPoint

)

#

Returns void

Inherited from Sprite

Shows element's Tooltip.

toAxisPosition(

position: number

)

#

Returns number

Inherited from Axis

Converts relative position of the plot area to relative position of the axis with zoom taken into account.

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.

updateTooltip()

#

Returns void

Inherited from Axis

Can be called when axis zoom changes and you need to update tooltip position.

valueToPosition(

value: number

)

#

Returns number

Inherited from ValueAxis

Convers value to a relative position on axis.

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.

zoom(

start: number,
end: number,
duration?: undefined | number,
priority?: "start" | "end"

)

#

Returns Animation | Animation | undefined

Inherited from Axis

Zooms the axis to relative locations.

Both start and end are relative: 0 means start of the axis, 1 - end.

zoomToValues(

start: number,
end: number,
duration?: undefined | number

)

#

Returns void

Inherited from ValueAxis

Zooms the axis to specific start and end values.

Optional duration specifies duration of zoom animation in milliseconds.

There are 61 inherited items currently hidden from this list.

Events

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

Read about adding event handlers.

#blur

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

Inherited from ISpriteEvents

Invoked when element loses focus.

#boundschanged

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

Inherited from ISpriteEvents

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

#click

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

Inherited from ISpriteEvents

Invoked when element is clicked or tapped.

#dataitemchanged

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

Inherited from ISpriteEvents

Invoked when element's data item changes.

#datavalidated

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

Inherited from IComponentEvents

#dblclick

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

Inherited from ISpriteEvents

Invoked when element is doubleclicked or tapped twice quickly.

#dragged

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

Inherited from ISpriteEvents

Invoked when element ois being dragged.

#dragstart

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

Inherited from ISpriteEvents

Invoked when element dragging starts.

#dragstop

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

Inherited from ISpriteEvents

Invoked when element dragging stops.

#focus

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

Inherited from ISpriteEvents

Invoked when element gains focus.

#globalpointermove

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

Inherited from ISpriteEvents

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 ISpriteEvents

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 ISpriteEvents

Invoked when element is clicked with the middle mouse button.

#pointerdown

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

Inherited from ISpriteEvents

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

#pointerout

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

Inherited from ISpriteEvents

Invoked when pointer moves outside the element.

#pointerover

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

Inherited from ISpriteEvents

Invoked when pointer moves over the element.

#pointerup

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

Inherited from ISpriteEvents

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

#positionchanged

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

Inherited from ISpriteEvents

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

#rightclick

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

Inherited from ISpriteEvents

Invoked when element is clicked width the right mouse button.

#wheel

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

Inherited from ISpriteEvents

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

There are 20 inherited items currently hidden from this list.