DurationAxis

Type class

Used to create an axis that shows time durations.

// Create the axis
let xAxis = chart.xAxes.push(new am4charts.DurationAxis());

// Set settings
xAxis.title.text = "Time";
// Create the axis
var valueAxis = chart.xAxes.push(new am4charts.DurationAxis());

// Set settings
valueAxis.title.text = "Time";
"xAxes": [{
  "type": "DurationAxis",
  "title": {
    "text": "Time"
  }
}]

@see This link for mor information about duration formatters.
@see IDurationAxisEvents for a list of available Events
@see IDurationAxisAdapters for a list of available Adapters

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: "charts.ts"
 * Use like: am4charts.DurationAxis
 * --------------------------------------------------------
 */
import * as am4charts from "@amcharts/amcharts4/charts";

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

/**
 * --------------------------------------------------------
 * Include via: <script src="charts.js"></script>
 * Access items like: am4charts.DurationAxis
 * --------------------------------------------------------
 */

Inheritance

DurationAxis extends ValueAxis.

DurationAxis is not extended by any other symbol.

Properties

adapter
#

Type Adapter < this, IDurationAxisAdapters >

Inherited from Sprite

Holds Adapter.

@see This link for more info about Adapters

align
#

Type Align

Inherited from Sprite

Controls horizontal alignment of the element.

This is used by parent Container when layouting its children.

alwaysShowTooltip
#

Type boolean

Inherited from Sprite

Indicates if this element should display a tooltip permanently.

Useful, if you want to show permanent tooltips on some items.

For example, if you would like to show tooltips on all of the columns of a ColumnSeries:

series.columns.template.alwaysShowTooltip = true;
series.columns.template.alwaysShowTooltip = true;
{
  // ...
  "series": [{
    // ...
    "columns": {
      "alwaysShowTooltip": true
    }
  }]
}

It can even be set to display on a selected columns via propertyFields:

series.columns.template.propertyFields.alwaysShowTooltip = "tooltip";
series.columns.template.propertyFields.alwaysShowTooltip = "tooltip";
{
  // ...
  "series": [{
    // ...
    "columns": {
      "propertyFields": {
        "alwaysShowTooltip": "tooltip"
      }
    }
  }]
}

@default false
@since 4.5.4

animations
#

Type Array < Animation >

Inherited from Sprite

Returns a list elements's animations currently being played.

If the list has not been initialized it is created.

appeared
#

Type boolean

Default false

Inherited from Sprite

A read-only flag which indicates if a sprite has completed its initial animation (if showOnInit = true).

In case showOnInit = false, appeared is set to true on init.

@readonly

applyOnClones
#

Type boolean

Default false

Inherited from Sprite

Specifies if property changes on this object should be propagated to the objects cloned from this object.

This setting affects property changes *after* cloning, since at the moment of cloning all of properties from source object are copied to the clone anyway.

@default false

autoDispose
#

Type boolean

Default true

Inherited from Axis

Specifies if axis should be automatically disposed when removing from chart's axis list.

@default true

axisBreaks
#

Type SortedListTemplate < ValueAxisBreak >

Inherited from Axis

A list of axis breaks on this Axis.

axisDurationFormat
#

Type string

Axis date format chosen dynamically based on min/max and baseUnit.

@readonly

axisFullLength
#

Type number

Inherited from Axis

Full length of the axis, in pixels.

@readonly

axisLength
#

Type number

Inherited from Axis

Actual axis length in pixels.

axisRanges
#

Type ListTemplate < DurationAxisDataItem >

Inherited from Axis

A list of axis ranges for this Axis.

background
#

Type Sprite

Inherited from Container

An element to use as container background.

baseSprite
#

Type $type.Optional < Sprite >

Inherited from Sprite

Returns the mail chart object that this element belongs to.

In most cases it will mean the chart object.

Can be used to retrieve chart object in various events and adapters.

chart.seriesContainer.events.on("hit", function(ev) {
  console.log(ev.target.baseSprite);
});
chart.seriesContainer.events.on("hit", function(ev) {
  console.log(ev.target.baseSprite);
});
{
  // ...
  "seriesContainer": {
    "events": {
      "hit": function(ev) {
        console.log(ev.target.baseSprite);
      }
    }
  }
}

@readonly

baseUnit
#

Type TimeUnit

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", "year".

@default "second"

baseValue
#

Type number

Inherited from ValueAxis

A base value.

This is a threshold value that will divide "positive" and "negative" value ranges.

Other scale-related functionality also depend on base value. E.g. stacks, value-dependent coloring, etc.

calculateTotals
#

Type boolean

Default false

Inherited from ValueAxis

As calculating totals is expensive operation and not often needed, we don't do it by default.

In case you use totalPercent or total in your charts, this must be set to true.

@default false
@see This link For using calculateTotals for 100% stacked series.
@see This link For using calculateTotals in labels.

chart
#

Type XYChart

Inherited from ValueAxis

A reference to chart the axis is for.

children
#

Type List < Sprite >

Inherited from Container

Returns a list of the child Sprite elements contained in this Container.

clickable
#

Type boolean

Inherited from Sprite

Indicates if the element is clickable.

Some type of the elements, like buttons are clickable by default.

Most of the elements are not clickable by default.

Use hit, doublehit, up, down, toggled events to watch for respective click/touch actions.

clonedFrom
#

Type $type.Optional < this >

Inherited from BaseObject

Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed.

config
#

Type object

Inherited from BaseObject

Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc.

Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations.

configField
#

Type $type.Optional < string >

Inherited from Sprite

A field in data context of element's dataItem that holds config values for this element.

This is a very powerful feature, allowing changing virtually any setting, including those for element's children, for the element via data.

Example data:

{
  "value": 100,
  "config": {
    "fill": "#F00"
  }
}

If you set element's configField = "config", the element for this specific data point will have a red fill.

contentAlign
#

Type Align

Inherited from Container

Horizontal alignment of the elements for the horizontal Container.

This is used when Container is larger than the height of all its children.

contentHeight
#

Type number

Inherited from Container

Height (in pixels) of the actual content in the Container.

Please note that it might be bigger than height of the Container.

@readonly

contentValign
#

Type VerticalAlign

Inherited from Container

Vertical alignment of the elements for the vertical Container.

This is used when Container is larger than the height of all its children.

contentWidth
#

Type number

Inherited from Container

Width (in pixels) of the actual content in the Container.

Please note that it might be bigger than width of the Container.

@readonly

contextMenuDisabled
#

Type boolean

Inherited from Sprite

Should element prevent context menu to be displayed, e.g. when right-clicked?

@default false

currentDataSetId
#

Type string

Inherited from Component

Returns id of the currently used data set, or undefined if main data set is in use.

@since 4.7.0

cursorDownStyle
#

Type Array < IStyleProperty >

Inherited from Sprite

A shortcut to setting mouse cursor when button is pressed down.

Example:

series.slices.template.cursorDownStyle = am4core.MouseCursorStyle.grabbing;
series.slices.template.cursorDownStyle = am4core.MouseCursorStyle.grabbing;
{
  // ...
  "series": {
    // ...
    "slices": {
      "cursorDownStyle": "grabbing"
    }
  }
}

cursorOptions
#

Type ICursorOptions

Inherited from Sprite

Returns element's cursor options.

Cursor options usually define cursor style for various states of the hovered element.

Elements inherit cursorOptions from their parents if they don't have them set explicitly.

@see ICursorOptions for a list of available options

cursorOverStyle
#

Type Array < IStyleProperty >

Inherited from Sprite

A shortcut to setting mouse cursor on hover.

Example:

series.slices.template.cursorOverStyle = am4core.MouseCursorStyle.pointer;
series.slices.template.cursorOverStyle = am4core.MouseCursorStyle.pointer;
{
  // ...
  "series": {
    // ...
    "slices": {
      "cursorOverStyle": "pointer"
    }
  }
}

cursorTooltipEnabled
#

Type boolean

Inherited from Axis

Indicates if axis should display a tooltip for chart's cursor.

data
#

Type any[]

Inherited from Component

Sets source (raw) data for the element. The "data" is always an Array of objects.

Returns element's source (raw) data.

dataFields
#

Type IDurationAxisDataFields

Inherited from Component

Holds data field names.

Data fields define connection beween DataItem and actual properties in raw data.

dataItem
#

Type DurationAxisDataItem

Inherited from Sprite

A DataItem to use as element's data source.

@todo Review type

dataItems
#

Type OrderedListTemplate < DurationAxisDataItem >

Inherited from Component

Returns a list of source DataItem objects currently used in the chart.

dataProvider
#

Type $type.Optional < Component >

Inherited from Component

A Component which provides data to this component (like Chart provides data for Series).

dataSource
#

Type DataSource

Inherited from Component

A DataSource to be used for loading Component's data.

@see This link for more on loading external data

dateFormatter
#

Type DateFormatter

Inherited from Sprite

A DateFormatter instance.

This is used to format dates, e.g. on a date axes, balloons, etc.

chart.dateFormatter.dateFormat = "yyyy-MM-dd";
chart.dateFormatter.dateFormat = "yyyy-MM-dd";
{
  // ...
  "dateFormatter": {
    "dateFormat": "yyyy-MM-dd"
  }
}

You can set a separate instance of formatter for each individual element. However that would be unnecessary overhead as all elements would automatically inherit formatter from their parents, all the way up to the chart itself.

@see DateFormatter for more info on dates formatting

defaultState
#

Type SpriteState < IDurationAxisProperties, IDurationAxisAdapters >

Inherited from Sprite

Returns a SpriteState object for "default" state.

This is a shortcut to this.states.getKey("default").

disabled
#

Type boolean

Inherited from Sprite

Controls if element is disabled.

A disabled element is hidden, and is removed from any processing, layout calculations, and generally treated as if it does not exist.

The element itself is not destroyed, though. Setting this back to false, will "resurrect" the element.

dom
#

Type SVGSVGElement

Inherited from Sprite

Returns DOM element reference associated with this element.

@readonly

draggable
#

Type boolean

Inherited from Sprite

Controls if the element is draggable.

dummyData
#

Type any

Inherited from Sprite

A property which you can use to store any data you want.

durationFormatter
#

Type DurationFormatter

Inherited from Sprite

A DurationFormatter instance.

This is used to format numbers as durations, e.g. on a value axes.

You can set a separate instance of formatter for each individual element. However that would be unnecessary overhead as all elements would automatically inherit formatter from their parents, all the way up to the chart itself.

@see DurationFormatter for more info on durations

dx
#

Type number

Inherited from Sprite

A horizontal offset for the element in pixels.

Can be negative value for offset to the left.

dy
#

Type number

Inherited from Sprite

A vertical offset for the element in pixels.

Can be negative value for offset upwards.

element
#

Type Optional < AMElement >

Inherited from Sprite

The main element for this Sprite, usually an SVG <g>.

All other sub-elements are created in it.

end
#

Type number

Inherited from Component

End of the current data range (zoom).

These are relative values from 0 (beginning) to 1 (end).

endLocation
#

Type number

Inherited from Axis

Axis end location. Works on Date/Category axis, doesn't work on Value axis.

  • 0 - None of the last cell is shown. (don't do that)
  • 0.5 - Half of the last cell is shown.
  • 1 - Full last cell is shown.

events
#

Type SpriteEventDispatcher < AMEvent < this, IDurationAxisEvents > >

Inherited from Sprite

Event dispatcher.

@see This link for more info about Events

exportable
#

Type boolean

Inherited from Sprite

If set to false this element will be omitted when exporting the chart to an image.

@default true

exporting
#

Type Export

Inherited from Sprite

An Export instance.

Used to access API of the chart export functionality.

If exporting is not set, the element inherits Export instance from its parents.

Upon request, if no parent has such instance, a new one is created, using default settings, what in most cases is just enough.

@see This link for more info about exporting

extraMax
#

Type number

Inherited from ValueAxis

Allows relatively adjusting maximum value of the axis' scale.

The value is relative to the actual range of values currently displayed on the axis.

E.g.: 0.5 will mean half of the current range. If we have axis displaying from 100 to 200, we will now have axis displaying from 100 to 250 because we asked to expand maximum value by 50% (0.5).

extraMin
#

Type number

Inherited from ValueAxis

Allows relatively adjusting minimum value of the axis' scale.

The value is relative to the actual range of values currently displayed on the axis.

E.g.: 0.5 will mean half of the current range. If we have axis displaying from 100 to 200, we will now have axis displaying from 50 to 200 because we asked to expand minimum value by 50% (0.5).

fill
#

Type $type.Optional < Color | Pattern | LinearGradient | RadialGradient >

Inherited from Sprite

Element's fill color or pattern.

fillModifier
#

Type ColorModifier

Inherited from Sprite

ColorModifier that can be used to modify color and pattern of the element's fill, e.g. create gradients.

fillOpacity
#

Type number

Inherited from Sprite

Element's fill opacity.

Opacity ranges from 0 (fully transparent) to 1 (fully opaque).

filters
#

Type List < Filter >

Inherited from Sprite

Returns list of SVG filters (effects) applied to element. If the filter list is not yet initilized, creates and returns an empty one.

Note, not all filters combine well with one another. We recommend using one filter per sprite.

fixedWidthGrid
#

Type boolean

Inherited from Container

Controls if the grid of the Container should use fixed width. Fixed width grid will divide available space to all its columns/rows equally, without adapting to actual child sizes or size requirements.

@default false

focusable
#

Type Optional < boolean >

Inherited from Sprite

Controls if the element can gain focus.

Focusable element will be selectable via TAB key.

Please note, clicking it with a mouse or touching will not add focus to it.

Focused element will show a system-specific highlight, which might ruin the overal look. This is why we don't focus element on click/touch.

A default setting varies for different elements. By default all elements are not focusable, except certain items like buttons, legend items, etc.

@default undefined (auto)

fontFamily
#

Type string

Inherited from Container

Font family to be used for the text.

Parts of the text may override this setting using in-line formatting.

fontSize
#

Type any

Inherited from Container

Font size to be used for the text. The size can either be numeric, in pixels, or other measurements.

Parts of the text may override this setting using in-line formatting.

fontWeight
#

Type FontWeight

Inherited from Container

Font weight to use for text.

Parts of the text may override this setting using in-line formatting.

ghostLabel
#

Type AxisLabel

Inherited from Axis

Ghost label is used to prevent chart shrinking/expanding when zooming or when data is invalidated. You can set custom text on it so that it would be bigger/smaller,

globalScale
#

Type number

Inherited from Sprite

Returns element's current "global" scale.

Scale values accumulate over hierarchy of elements.

E.g. if a Container has scale = 2 and it's child has a scale = 2, the child's globalScale will be 4. (a multitude of 2 x 2)

@readonly

group
#

Type Group

Inherited from Sprite

Holds Sprite's main SVG group (<g>) element. Other Sprite's elements are all placed in this group.

hasFocused
#

Type boolean

Default false

Inherited from Container

Indicates if this container contains any focused elements, including itself.

height
#

Type number | Percent

Inherited from Sprite

Element's absolute or relative height.

The height can either be absolute, set in numeric pixels, or relative, set in Percent.

Relative height will be calculated using closest measured ancestor Container.

hidden
#

Type boolean

Inherited from Sprite

If a sprite has showOnInit = true, it will animate from "hidden" to "default" state when initialized. To prevent this but keep showOnInit = true, you can set sprite.hidden = true.

hiddenState
#

Type SpriteState < IDurationAxisProperties, IDurationAxisAdapters >

Inherited from Sprite

Returns a SpriteState object for "hidden" state.

This is a shortcut to this.states.getKey("hidden").

hitOptions
#

Type IHitOptions

Inherited from Sprite

Returns Sprite's click (hit) options.

Click (hit) options control things like double-click, timeouts, etc.

@see IHitOptions for available options.

horizontalCenter
#

Type HorizontalCenter

Inherited from Sprite

Controls which part of the element to treat as a horizontal center.

The setting will be used when positioning, resizing and rotating the element.

hoverOnFocus
#

Type boolean

Inherited from Sprite

If set to true, this element will also trigger "over" event with all the related consequences, like "hover" state being applied and tooltip being shown.

Useful as an accessibility feature to display rollover tooltips on items selected via keyboard.

@default false

hoverOptions
#

Type IHoverOptions

Inherited from Sprite

Returns Sprite's hover options.

@see IHoverOptions for available options.

hoverable
#

Type boolean

Inherited from Sprite

Controls if the element is hoverable (hover events are registered).

Use over and out events, to watch for those respective actions.

@default false

htmlContainer
#

Type $type.Optional < HTMLElement >

Inherited from Sprite

An HTML element to be used when placing wrapper element (<div>) for the whole chart.

This is the same for all elements within the same chart.

id
#

Type string

Inherited from Sprite

Element's user-defined ID.

Will throw an Error if there already is an object with the same ID.

Please note that above check will be performed withing the scope of the current chart instance. It will not do checks across other chart instances or in globally in DOM.

Make sure the IDs are unique.

includeRangesInMinMax
#

Type boolean

Inherited from ValueAxis

If set to true, values of axis ranges will be included when calculating range of values / scale of the ValueAxis.

@default false
@since 4.4.9

inert
#

Type boolean

Inherited from Sprite

Controls if the element should use inertia when interacted with.

"Inert" element, when dragged and released, will carry the momentum of the movement, and will continue moving in the same drag direction, gradually reducing in speed until finally stops.

@default false

inertiaOptions
#

Type Dictionary < InertiaTypes, IInertiaOptions >

Inherited from Sprite

Returns element's options to be used for inertia. This setting is inheritable, meaning that if not set directly, it will search in all its ascendants until very top.

Inertia is used only if element's inert is set to true.

"Inert" element, when dragged and released, will carry the momentum of the movement, and will continue moving in the same drag direction, gradually reducing in speed until finally stops.

Check IInertiaOptions for how you tweak inertia animations.

inited
#

Type boolean

Inherited from Sprite

Returns true if Sprite has already finished initializing.

innerHeight
#

Type number

Inherited from Sprite

Returns element's measured inner height in pixels.

Inner height is actual available space for content, e.g. element's height minus vertical padding.

@readonly

innerWidth
#

Type number

Inherited from Sprite

Returns element's measured inner width in pixels.

Inner width is actual available space for content, e.g. element's width minus horizontal padding.

@readonly

interactions
#

Type InteractionObject

Inherited from Sprite

Returns (creates if necessary) an InteractionObject associated with this element.

InteractionObject is used to attach all kinds of user-interactions to the element, e.g. click/touch, dragging, hovering, and similar events.

interactionsEnabled
#

Type boolean

Inherited from Sprite

Setting this to false will effectively disable all interactivity on the element.

interpolationDuration
#

Type number

Default 0

Inherited from Component

If set to a non-zero number the element will "animate" data values of its children.

This will happen on first load and whenever data values change.

Enabling interpolation will mean that elements will transit smoothly into new values rather than updating instantly.

@default
@see This link for more info about animations

interpolationEasing
#

Type ( value: number) => number

Default $ease.cubicOut

Inherited from Component

An easing function to use for interpolating values when transiting from one source value to another.

@default cubicOut
@see This link for more info about animations
@see Ease

isActive
#

Type boolean

Inherited from Sprite

Indicates if this element is currently active (toggled on) or not (toggled off).

isDown
#

Type boolean

Inherited from Sprite

Indicates if this element has any pointers (mouse or touch) pressing down on it.

isDragged
#

Type boolean

Inherited from Sprite

Returns indicator if this element is being dragged at the moment.

isFocused
#

Type boolean

Inherited from Sprite

Indicates if this element is focused (possibly by tab navigation).

isHidden
#

Type boolean

Inherited from Sprite

If sprite.hide() is called, we set isHidden to true when sprite is hidden.

This was added becaus hidden state might have visibility set to true and so there would not be possible to find out if a sprite is technically hidden or not.

isHiding
#

Type boolean

Default false

Inherited from Sprite

If sprite.hide() is called and we have "hidden" state and transitionDuration > 0, we set isHiding flag to true in order to avoid restarting animations in case hide() method is called multiple times.

isHover
#

Type boolean

Inherited from Sprite

Indicates if this element has a mouse pointer currently hovering over it, or if it has any touch pointers pressed on it.

Returns indicator if this element has a mouse pointer currently hovering over it, or if it has any touch pointers pressed on it.

isResized
#

Type boolean

Inherited from Sprite

Returns indicator if this element is being resized at the moment.

isShowing
#

Type boolean

Default false

Inherited from Sprite

This property indicates if Sprite is currently being revealed from hidden state. This is used to prevent multiple calls to sprite.show() to restart reveal animation. (if enabled)

keepSelection
#

Type boolean

Inherited from ValueAxis

Indicates if a current selection (zoom) should be kept across data updates.

If your axis is zoomed while chart's data is updated, the axis will try to retain the same start and end values.

You can also use this to initially pre-zoom axis:

axis.keepSelection = true;
axis.start = 0.5;
axis.end = 0.7;
axis.keepSelection = true;
axis.start = 0.5;
axis.end = 0.7;
{
  "xAxes": [{
    // ...
    "keepSelection": true,
    "start": 0.5,
    "end": 0.7
  }]
}

The above will start the chart zoomed from the middle of the actual scope to 70%.

@since 4.1.1
@default flase

keyboardOptions
#

Type IKeyboardOptions

Inherited from Sprite

Returns elements keyboard options.

language
#

Type Language

Inherited from Sprite

A Language instance to use for translations.

Normally it is enough to set language for the top-most element - chart.

All other element child elements will automatically re-use that language object.

layout
#

Type ContainerLayout

Inherited from Container

Container layout.

Options: "absolute" (default), "vertical", "horizontal", "grid", "none". "none" is quite the same as "absolute" - the objects will be positioned at their x, y coordinates, the difference is that with "absolute" you can still use align/valign for children and with "none" you can not.

Use "none" as much as you can as it's most cpu-saving layout.

@default "absolute"

layoutInvalid
#

Type boolean

Default false

Inherited from Container

logarithmic
#

Type boolean

Inherited from ValueAxis

Indicates if this axis should use a logarithmic scale.

Please note that logarithmic axis can only accommodate values bigger than zero.

Having zero or negative values will result in error and failure of the whole chart.

mainDataSet
#

Type OrderedListTemplate < DurationAxisDataItem >

Inherited from Component

Returns reference to "main" data set (unaggregated data as it was supplied in data).

@since 4.7.0

map
#

Type Dictionary < string, any >

Inherited from Sprite

Returns a Dictionary which maps object ids with their respective objects.

Can be used to retrieve any object by id, e.g.:

console.log(mySprite.map.getKey("myid"));
console.log(mySprite.map.getKey("myid"));

marginBottom
#

Type number | Percent

Inherited from Sprite

Bottom margin - absolute (px) or relative (Percent).

marginLeft
#

Type number | Percent

Inherited from Sprite

Left margin - absolute (px) or relative (Percent).

marginRight
#

Type number | Percent

Inherited from Sprite

Right margin - absolute (px) or relative (Percent).

marginTop
#

Type number | Percent

Inherited from Sprite

Top margin - absolute (px) or relative (Percent).

max
#

Type number

Inherited from ValueAxis

A maximum value for the axis scale.

This value might be auto-adjusted by the Axis in order to accomodate the grid nicely, i.e. plot area is divided by grid in nice equal cells.

The above might be overridden by strictMinMax which will force exact user-defined min and max values to be used for scale.

maxColumns
#

Type Optional < number >

Inherited from Container

Maximum number of columns (when using "grid" layout).

maxDefined
#

Type number

Inherited from ValueAxis

Max value as defined by user's code, not auto-calculated.

@readonly

maxHeight
#

Type number

Inherited from Sprite

Maximum allowed height for the element in pixels.

maxPrecision
#

Type number

Inherited from ValueAxis

Maximum number of decimals to allow when placing grid lines and labels on axis.

Set it to 0 (zero) to force integer-only axis labels.

maxWidth
#

Type number

Inherited from Sprite

Maximum allowed width for the element in pixels.

maxZoomCount
#

Type number

Inherited from Component

Use this for CategoryAxis or DateAxis.

Limits how many categories or base intervals can be shown at the same time.

If there are more items in the chart, the chart will auto-zoom.

@default 0 (no limit)
@since 4.6.2

maxZoomFactor
#

Type number

Inherited from Component

Max available zoomFactor.

The element will not allow zoom to occur beyond this factor.

DateAxis and CategoryAxis calculate this atutomatically so that category axis could be zoomed to one category and date axis allows to be zoomed up to one base interval.

In case you want to restrict category or date axis to be zoomed to more than one category or more than one base interval, use minZoomCount property (set it to > 1).

Default value of ValueAxis's maxZoomFactor is 1000.

Feel free to modify it to allow bigger zoom or to restrict zooming.

maxZoomed
#

Type number

Inherited from ValueAxis

A biggest value in axis scale within current zoom.

measuredHeight
#

Type number

Inherited from Sprite

Returns elements's measured height in pixels.

A measured height is actual height of contents plus paddingTop and paddingBottom, relative to sprite parent, meaning that rotation and scale taken into account.

@readonly

measuredWidth
#

Type number

Inherited from Sprite

Returns element's measured width in pixels.

A measured width is actual width of contents plus paddingRight and* paddingLeft, relative to sprite parent, meaning that rotation and scale is taken into account.

@readonly

min
#

Type number

Inherited from ValueAxis

A minimum value for the axis scale.

This value might be auto-adjusted by the Axis in order to accomodate the grid nicely, i.e. plot area is divided by grid in nice equal cells.

The above might be overridden by strictMinMax which will force exact user-defined min and max values to be used for scale.

minDefined
#

Type number

Inherited from ValueAxis

Min value as defined by user's code, not auto-calculated.

@readonly

minHeight
#

Type Optional < number >

Inherited from Container

Minimum height (px) for the Container. A container will not auto-shrink beyond this value, even if child elements are smaller.

minWidth
#

Type Optional < number >

Inherited from Container

Minimum width (px) for the Container. A container will not auto-shrink beyond this value, even if child elements are smaller.

minZoomCount
#

Type number

Inherited from Component

Use this for CategoryAxis or DateAxis.

Allows restricting zoom in beyond certain number of categories or base intervals.

@default 1

minZoomed
#

Type number

Inherited from ValueAxis

A smallest value in axis scale within current zoom.

modal
#

Type Optional < Modal >

Inherited from Sprite

Returns a Modal instance, associated with this chart.

(elements top parent)Accessing modal does not make it appear. To make a modal appear, use showModal() method.

@see Modal for more information about using Modal windows

mouseOptions
#

Type IMouseOptions

Inherited from Sprite

Returns elements mouse options.

nonScaling
#

Type boolean

Inherited from Sprite

Controls if element should keep constant size and not scale even if there is space available, or it does not fit.

nonScalingStroke
#

Type boolean

Inherited from Sprite

Controls if the element's stroke (outline) should remain keep constant thicnkess and do not scale when the whole element is resized.

numberFormatter
#

Type NumberFormatter

Inherited from Sprite

A NumberFormatter instance.

This is used to format numbers.

chart.numberFormatter.numberFormat = "#,###.#####";
chart.numberFormatter.numberFormat = "#,###.#####";
{
  // ...
  "numberFormatter": {
    "numberFormat": "#,###.#####"
  }
}

You can set a separate instance of formatter for each individual element. However that would be unnecessary overhead as all elements would automatically inherit formatter from their parents, all the way up to the chart itself.

@see NumberFormatter for more info on formatting numbers

opacity
#

Type number

Inherited from Sprite

Element's opacity.

Opacity setting can range from 0 (fully transparent) to 1 (fully opaque).

ATTENTION: It is highly not recommended to use opacity directly on the element. The charts use opacity to hide/show elements, so your setting might be lost if element is hidden and then later shown.

Instead use methods hide() and show() to completely toggle off and on the element.

Or, use properties fillOpacity and strokeOpacity, if you need to make the element semi-transparent.

outerHeight
#

Type number

Inherited from Sprite

Returns element's measured height plus its top and bottom margins in pixels.

@readonly

outerWidth
#

Type number

Inherited from Sprite

Returns element's measured width plus its left and right margins in pixels.

@readonly

paddingBottom
#

Type number | Percent

Inherited from Sprite

Bottom padding - absolute (px) or relative (Percent).

paddingLeft
#

Type number | Percent

Inherited from Sprite

Left padding - absolute (px) or relative (Percent).

paddingRight
#

Type number | Percent

Inherited from Sprite

Right padding - absolute (px) or relative (Percent).

paddingTop
#

Type number | Percent

Inherited from Sprite

Top padding - absolute (px) or relative (Percent).

parent
#

Type Optional < Container >

Inherited from Sprite

Elements' parent Container.

parsingStepDuration
#

Type number

Default 50

Inherited from Component

A duration (ms) of each data parsing step. A Component parses its data in chunks in order to avoid completely freezing the machine when large data sets are used. This setting will control how many milliseconds should pass when parsing data until parser stops for a brief moment to let other processes catch up.

path
#

Type string

Inherited from Sprite

Path of Sprite element

pixelHeight
#

Type number

Inherited from Sprite

Returns element's height in pixels. For actual height use measuredHeight property.

@readonly

pixelMarginBottom
#

Type number

Inherited from Sprite

Returns current bottom margin in pixels.

@readonly

pixelMarginLeft
#

Type number

Inherited from Sprite

Returns current left margin in pixels.

@readonly

pixelMarginRight
#

Type number

Inherited from Sprite

Returns current right margin in pixels.

@readonly

pixelMarginTop
#

Type number

Inherited from Sprite

Returns current top margin in pixels.

@readonly

pixelPaddingBottom
#

Type number

Inherited from Sprite

Returns current bottom padding in pixels.

@readonly

pixelPaddingLeft
#

Type number

Inherited from Sprite

Returns current left padding in pixels.

@readonly

pixelPaddingRight
#

Type number

Inherited from Sprite

Returns current right padding in pixels.

@readonly

pixelPaddingTop
#

Type number

Inherited from Sprite

Returns current top padding in pixels.

@readonly

pixelPerfect
#

Type boolean

Inherited from Sprite

Controls if SVG vectors should be drawn with "pixel" precision, producing perfectly crisp lines on retina displays.

Setting this to true might improve visual quality, but may have a negative effect on performance.

Different elements use different default setting for pixelPerfect.

We recommend leaving this at their default settings, unless there's a specific need.

pixelWidth
#

Type number

Inherited from Sprite

Returns element's width in pixels, if width was set. For actual width use measuredWidth property.

@readonly

pixelX
#

Type number

Inherited from Sprite

Returns element's current absolute X coordinate in pixels.

@readonly

pixelY
#

Type number

Inherited from Sprite

Returns element's current absolute Y coordinate in pixels.

@readonly

plugins
#

Type List < IPlugin >

Inherited from Sprite

A list of plugins (objects that implement IPlugin interface) attached to this object.

@since 4.2.2

popups
#

Type Optional < ListTemplate < Popup > >

Inherited from Sprite

A list of popups for this chart.

preloader
#

Type $type.Optional < Preloader >

Inherited from Container

A Preloader instance to be used when Container is busy.

properties
#

Type IDurationAxisProperties

Inherited from Sprite

Holds values for Sprite's properties.

propertyFields
#

Type object

Inherited from Sprite

A collection of key/value pairs that can be used to bind specific Sprite properties to DataItem.

For example: fill property can be bound to myCustomColor field in DataItem. The Sprite will automatically get the value for fill from its DataItem.

Can be set for each SpriteState individually to override default bindings.

@see SpriteState

rangeChangeDuration
#

Type number

Default 0

Inherited from Component

Whenever selected scope changes (chart is zoomed or panned), for example by interaction from a Scrollbar, or API, a chart needs to reposition its contents.

rangeChangeDuration influences how this is performed.

If set to zero (0), the change will happen instantenously.

If set to non-zero value, the chart will gradually animate into new position for the set amount of milliseconds.

@default
@see This link for more info about animations

rangeChangeEasing
#

Type ( value: number) => number

Default $ease.cubicOut

Inherited from Component

An easing function to use for range change animation.

@see Ease
@see This link for more info about animations

readerDescription
#

Type string

Inherited from Sprite

Screen reader description of the element.

readerHidden
#

Type boolean

Inherited from Sprite

Controls if element should be hidden from screen readers.

@see This link for more information

readerTitle
#

Type string

Inherited from Sprite

Screen reader title of the element.

realFill
#

Type Color | Pattern | LinearGradient | RadialGradient

Inherited from Sprite

A reference to a real fill object. Sometimes might be useful to modify gradient (when fill is color but we have FillModifier).

realStroke
#

Type Color | Pattern | LinearGradient | RadialGradient

Inherited from Sprite

A reference to a real stroke object. Sometimes might be useful to modify gradient (when fill is color but we have a FillModifier).

relativeMarginBottom
#

Type number

Inherited from Sprite

Returns current relative bottom margin.

@readonly

relativeMarginLeft
#

Type number

Inherited from Sprite

Returns current relative left margin.

@readonly

relativeMarginRight
#

Type number

Inherited from Sprite

Returns current relative right margin.

@readonly

relativeMarginTop
#

Type number

Inherited from Sprite

Returns current relative top margin.

@readonly

relativePaddingBottom
#

Type number

Inherited from Sprite

Returns current relative bottom padding.

@readonly

relativePaddingLeft
#

Type number

Inherited from Sprite

Returns current relative left padding.

@readonly

relativePaddingRight
#

Type number

Inherited from Sprite

Returns current relative right padding.

@readonly

relativePaddingTop
#

Type number

Inherited from Sprite

Returns current relative top padding.

@readonly

relativeX
#

Type number

Inherited from Sprite

Returns element's current relative X coordinate in Percent.

relativeY
#

Type number

Inherited from Sprite

Returns element's current relative Y coordinate in Percent.

@readonly

renderer
#

Type T

Inherited from Axis

An AxisRenderer to be used to render this Axis.

Please note that most of the settings, related to Axis' appearance are set via its renderer. Not directly on the Axis.

E.g.:

axis.renderer.inside = true;
axis.renderer.minLabelPosition = 0.1;
axis.renderer.maxLabelPosition = 0.9;
axis.renderer.inside = true;
axis.renderer.minLabelPosition = 0.1;
axis.renderer.maxLabelPosition = 0.9;

@see This link for more info

resizable
#

Type boolean

Inherited from Sprite

Indicates if this element is resizable.

Enabling resize will turn on various interactions on the element. Their actual functionality will depend on other properties.

If the element also draggable, resize will only happen with two points of contact on a touch device.

If the element is not draggable, resize can be performed with just one point of contact, touch or mouse.

Will invoke resize event every time the size of the element changes.

responsive
#

Type Responsive

Inherited from Component

A Responsive instance to be used when applying conditional property values.

NOTE: Responsive features are currently in development and may not work as expected, if at all.

reverseOrder
#

Type Optional < boolean >

Inherited from Container

If set to true, the children of the container will be drawn in reverse order.

@default false

role
#

Type Roles

Inherited from Sprite

A WAI-ARIA role for the element.

@see This link for more information on WAI-ARIA roles

rollOutDelay
#

Type number

Default 0

Inherited from Sprite

Time in milliseconds after which rollout event happens when user rolls-out of the sprite. This helps to avoid flickering in some cases.

rotation
#

Type number

Inherited from Sprite

Rotation of the element in degrees. (0-360)

rtl
#

Type boolean

Inherited from Sprite

An RTL (right-to-left) setting.

RTL may affect alignment, text, and other visual properties.

scale
#

Type number

Inherited from Sprite

Scale of the element.

The scale is set from 0 (element reduced to nothing) to 1 (default size).

  • 2 will mean element is increased twice.
  • 0.5 - reduced by 50%.

Etc.

sequencedInterpolation
#

Type boolean

Default true

Inherited from Component

Indicates whether transition between data item's values should start and play out all at once, or with a small delay (as defined by sequencedInterpolationDelay) for each subsequent data item.

@default true
@see This link for more info about animations

sequencedInterpolationDelay
#

Type number

Default 0

Inherited from Component

A delay (ms) to wait between animating each subsequent data item's interpolation animation.

Relative only if sequencedInterpolation = true.

@default
@see This link for more info about animations

series
#

Type List < XYSeries >

Inherited from ValueAxis

A list of Series that are using this Axis.

setStateOnChildren
#

Type boolean

Inherited from Container

Specifies if, when state is applied on this container, the same state should be applied to container's children as well as background.

@default false

setStateOnSprites
#

Type Sprite[]

Default []

Inherited from Container

An array of references to elements the state should be set, when it is set on this element.

shapeRendering
#

Type ShapeRendering

Inherited from Sprite

An SVG-specific shape-rendering value.

shape-rendering controls how vector graphics are drawn and rendered.

@see This link for more information about shape-rendering
@default "auto"

shouldClone
#

Type boolean

Default true

Inherited from Sprite

Indicates whether this sprite should be cloned when cloning its parent container. We set this to false in those cases when a sprite is created by the class, so that when cloning a duplicate sprite would not appear.

showOnInit
#

Type boolean

Inherited from Sprite

If this is set to true, Sprite, when inited will be instantly hidden ("hidden" state applied) and then shown ("default" state applied).

If your "default" state's transitionDuration > 0 this will result in initial animation from "hidden" state to "default" state.

If you need a Sprite which has showOnInit = true not to be shown initially, set sprite.hidden = true. Setting sprite.visible = false will not prevent the animation and the sprite will be shown.

showSystemTooltip
#

Type boolean

Inherited from Sprite

Indicates whether the element should attempt to construct itself in a way so that system tooltip is shown if its readerTitle is set.

skipRangeEvent
#

Type boolean

Default false

Inherited from Component

If set to true, changing data range in element will not trigger daterangechanged event.

start
#

Type number

Inherited from Component

Start of the current data range (zoom).

These are relative values from 0 (beginning) to 1 (end).

startLocation
#

Type number

Inherited from Axis

Axis start location. Works on Date/Category axis, doesn't work on Value axis.

  • 0 - Full first cell is shown.
  • 0.5 - Half of first cell is shown.
  • 1 - None of the first cell is visible. (you probably don't want that)

states
#

Type DictionaryTemplate < string, SpriteState < IDurationAxisProperties, IDurationAxisAdapters > >

Inherited from Sprite

Returns a collection of element's available SpriteState entries.

@see SpriteState

step
#

Type number

Inherited from ValueAxis

Current calculated delta in values between two adjacent grid lines (step).

This is a read-only value and cannot be used to set actual step.

@readonly
@see This link For more information about modifying density of labels

strictMinMax
#

Type boolean

Inherited from ValueAxis

Indicates whether to blindly use exact min and max values set by user when generating Axis scale.

If not set, the Axis might slightly adjust those values to accomodate a better looking grid.

NOTE: if min and max are not set, setting strictMinMax to true will result in fixing the scale of the axis to actual lowest and highest values in the series within currently selected scope.

@default false

stroke
#

Type Color | Pattern | LinearGradient | RadialGradient

Inherited from Sprite

Element's stroke (outline) color or pattern.

strokeDasharray
#

Type string

Inherited from Sprite

A stroke-dasharray for the stroke (outline).

"Dasharray" allows setting rules to make lines dashed, dotted, etc.

@see This link for more info on stroke-dasharray

strokeDashoffset
#

Type number

Inherited from Sprite

A stroke-dashoffset for the stroke (outline).

"Dashoffset" allows setting the start position of the dashes if strokeDasharray is used.

@see This link for more info on stroke-dashoffset

strokeLinecap
#

Type "butt" | "square" | "round"

Inherited from Sprite

A stroke-linecap to indicate how line ends are drawn.

@see This link for more info on stroke-linecap

strokeLinejoin
#

Type "miter" | "round" | "bevel"

Inherited from Sprite

A stroke-linejoin to indicate how line ends are drawn.

@see This link for more info on stroke-linejoin

strokeModifier
#

Type ColorModifier

Inherited from Sprite

ColorModifier that can be used to modify color and pattern of the element's stroke (outline), e.g. create gradients.

strokeOpacity
#

Type number

Inherited from Sprite

Stroke (outline) opacity.

The values may range from 0 (fully transparent) to 1 (fully opaque).

strokeWidth
#

Type number

Inherited from Sprite

Stroke (outline) thickness in pixels.

svgContainer
#

Type $type.Optional < SVGContainer >

Inherited from Sprite

HTML container (<div>) which is used to place chart's <svg> element in.

Sets HTML container to add SVG and other chart elements to.

swipeOptions
#

Type ISwipeOptions

Inherited from Sprite

Returns element's swipe gesture options.

swipeable
#

Type boolean

Inherited from Sprite

Controls if element is swipeable.

Swipable element will invoke swipe, swipeleft and swiperight events, when quick horizontal drag action is performed with either mouse or touch.

Please note that combining swipe and drag is possible, however will incur a slight but noticeable delay in drag start.

tabindex
#

Type number

Inherited from Sprite

Sets TAB index.

Returns current TAB index for focusable item.

Tab index maintains the order in which focusable elements gain focus when TAB key is pressed.

Please note, tab index is not local to the chart. It affects the whole of the page, including non-SVG elements. Maintain extreme causion when setting tab indexes, as it affects the user experience for the whole web page.

tapTimeout
#

Type number

Default 3000

Inherited from Container

If tapToActivate is used, this setting will determine how long the chart will stay in "active" mode.

@default 3000
@since 4.4.0

tapToActivate
#

Type boolean

Inherited from Container

If set to true the chart's regular touch functionality will be suspended so that the whole page it is located in remains scrollable, even when swiping over the chart's body.

User will need to tap the chart in order to activate its regular touch functionality.

The chart will remain "active" as long as user keeps interacting with the chart. After tapTimeout milliseconds the chart will return to its "protected" mode.

@default false
@since 4.4.0
@see This link For more information.

textDecoration
#

Type TextDecoration

Inherited from Container

A text decoration to use for text.

Parts of the text may override this setting using in-line formatting.

title
#

Type Label

Inherited from Axis

A reference to a Label element which serves as a title to the axis.

When axis is created it aleready has an element, so you can just modify it.

Or you can replace it with your own instance of Label.

togglable
#

Type boolean

Inherited from Sprite

Indicates if element can be toggled on and off by subsequent clicks/taps.

Togglable element will alternate its isActive property between true and false with each click.

toggleZoomOutButton
#

Type boolean

Inherited from Axis

Normally, when axis is zoomed in, a zoom out button is shown by a chart, and vice versa: when axis is zoomed out completely, zoom out button is hidden.

Setting this to false will disable this behavior. Zooming in our out this axis will not reveal or hide zoom out button.

@default true
@since 4.6.2

tooltip
#

Type $type.Optional < Tooltip >

Inherited from Sprite

A Tooltip object to be used when displayed rollover information for the element.

tooltipColorSource
#

Type $type.Optional < Sprite >

Inherited from Sprite

A Sprite or sprite template to use when getting colors for tooltip. If a template is set, tooltip will look for a clone in tooltipDataItem.sprites. If no clone is found, then template colors will be used.

@see Tooltip
@see Sprite

tooltipDataItem
#

Type DataItem

Inherited from Sprite

A DataItem to use when populating content for the element's Tooltip.

@see Tooltip
@see DataItem

tooltipDurationFormat
#

Type string

A special duration format to apply axis tooltips.

Will use same format as for labels, if not set.

@see This link for mor information.

tooltipHTML
#

Type string

Inherited from Sprite

An HTML template to be used to populate Tooltip contents.

If element has tooltipDataItem or dataItem set, this will be parsed for any data values to be replaced with the values from respective data items.

tooltipPosition
#

Type "fixed" | "pointer"

Inherited from Sprite

Specifies if Tooltip should follow the mouse or touch pointer or stay at the fixed position.

Position

tooltipText
#

Type string

Inherited from Sprite

A text template to be used to populate Tooltip's contents.

If element has tooltipDataItem or dataItem set, this will be parsed for any data values to be replaced with the values from respective data items.

This template will also be parsed for any special formatting tags.

@see TextFormatter

tooltipX
#

Type number

Inherited from Sprite

X coordinate the Tooltip should be shown at.

tooltipY
#

Type number

Inherited from Sprite

Y coordinate the Tooltip should be shown at.

trackable
#

Type boolean

Inherited from Sprite

Indicates if the element is trackable (mouse position over it is reported to event listeners).

Will invoke track events whenever pointer (cursor) changes position while over element.

Please note, touch devices will also invoke track events when touch point is moved while holding down on a trackable element.

uid
#

Type string

Inherited from BaseObject

Returns object's internal unique ID.

url
#

Type $type.Optional < string >

Inherited from Sprite

Click-through URL for this element.

If set, clicking/tapping this element will open the new URL in a target window/tab as set by urlTarget.

Please note that URL will be parsed by data placeholders in curly brackets, to be populated from data. E.g.:

series.columns.template.url = "https://www.google.com/search?q={category.urlEncode()}";
series.columns.template.url = "https://www.google.com/search?q={category.urlEncode()}";
{
  // ...
  "series": [{
    // ...
    "columns": {
      "url": "https://www.google.com/search?q={category.urlEncode()}"
    }
  }]
}

urlTarget
#

Type string

Inherited from Sprite

Target to use for URL clicks:

  • _blank
  • _self (default)
  • _parent
  • _top
  • Name of the window/frame Ignored if url is not set.

valign
#

Type VerticalAlign

Inherited from Sprite

Controls vertical alignment of the element.

This is used by parent Container when layouting its children.

verticalCenter
#

Type VerticalCenter

Inherited from Sprite

Controls which part of the element to treat as a vertical center.

The setting will be used when positioning, resizing and rotating the element.

visible
#

Type boolean

Inherited from Sprite

Sets visibility of the element.

Returns current visibility of the element.

wheelable
#

Type boolean

Inherited from Sprite

Indicates if the element can be interacted with mouse wheel.

Will invoke wheel, wheelup, wheeldown, wheelleft, and wheelright events when using mouse wheel over the element.

width
#

Type number | Percent

Inherited from Sprite

Element's absolute or relative width.

The width can either be absolute, set in numeric pixels, or relative, set in Percent.

Relative width will be calculated using closest measured ancestor Container.

x
#

Type number | Percent

Inherited from Sprite

Element's absolute or relative X coordinate.

If setting both X and Y, please consider using moveTo() method instead, as it will be faster to set both coordinates at once.

y
#

Type number | Percent

Inherited from Sprite

Element's absolute or relative Y coordinate.

If setting both X and Y, please consider using moveTo() method instead, as it will be faster to set both coordinates at once.

zIndex
#

Type number

Inherited from Sprite

A "zIndex" of the element.

"zIndex" determines the order of how elements are placed over each other.

Higher "zIndex" will mean the element will be draw on top of elements with lower "zIndexes".

zoomFactor
#

Type number

Inherited from Component

A current zoom factor (0-1). 1 meaning fully zoomed out. (showing all of the available data)

There are 238 inherited items currently hidden from this list.

Methods

constructor()

#

Returns DurationAxis

Constructor

addData(

rawDataItem: Object | Object[],
removeCount?: number

)

#

Returns void

Inherited from Component

Adds one or several (array) of data items to the existing data.

animate(

animationOptions: ISpriteAnimationOptions[] | ISpriteAnimationOptions,
duration: number,
easing?: ( value: number) => number

)

#

Returns Animation

Inherited from Sprite

Creates and starts an Animation with given animationOptions.

@see Animation for additional information about available options

anyToPoint(

value: number

)

#

Returns IOrientationPoint

Inherited from ValueAxis

Converts a numeric value to orientation (x, y, angle) point on axis

anyToPosition(

value: number

)

#

Returns number

Inherited from ValueAxis

Converts a numeric value to relative position on axisAn alias to valueToPosition().

appear()

#

Returns void

Inherited from Sprite

Hides the chart instantly and then shows it. If defaultState.transitionDuration > 0, this will result an animation in which properties of hidden state will animate to properties of visible state.

appendDataItem(

dataItem: DurationAxisDataItem

)

#

Returns void

Inherited from Axis

Adds a data item to the Axis.

applyCurrentState(

duration?: number

)

#

Returns $type.Optional < Animation >

Inherited from Sprite

Applies proper state based on the condition of the element. A condition is deducted in this order:

  • "hover" if Sprite has currently any pointers over it
  • "down" if Sprite has any pointers (touch or mouse) currently pressed over it
  • "focus" if Sprite has currently got focus (accessibility)
  • "hidden" if Sprite is currently hiddenReturns an Animation object, which is handling gradual transition from current values of properties, to the new target state(s).

bindDataField(

field: Key,
value: IDurationAxisDataFields[Key]

)

#

Returns void

Inherited from Component

Binds a data element's field to a specific field in raw data.

For example, for the very basic column chart you'd want to bind a value field to a field in data, such as price.

Some more advanced Components, like CandlestickSeries need several data fields bound to data, such as ones for open, high, low and close values.

@todo Example

clone()

#

Returns this

Inherited from Component

Returns a clone of this element.

closeAllPopups()

#

Returns void

Inherited from Sprite

Closes all currently open popup windows

closeModal()

#

Returns void

Inherited from Sprite

Hides modal window if there is one currently open.

copyFrom(

source: this

)

#

Returns void

Copies all properties and related data from a different instance of Axis.

createChild(

classType: object

)

#

Returns T

Inherited from Container

Creates a new element of specific type and assigns as a child to the Container.

createSeriesRange(

series: XYSeries

)

#

Returns DurationAxisDataItem

Inherited from Axis

Creates a data item for a Series range.

deepInvalidate()

#

Returns void

Inherited from Container

Invalidates the whole element, including layout AND all its child elements.

As this will essentially force all elements to redraw, use only if absolutely necessary.

dispatch(

eventType: Key,
data?: any

)

#

Returns void

Inherited from BaseObjectEvents

Dispatches an event using own event dispatcher. Will automatically populate event data object with event type and target (this element).

It also checks if there are any handlers registered for this sepecific event.

dispatchImmediately(

eventType: Key,
data?: any

)

#

Returns void

Inherited from BaseObjectEvents

Works like dispatch, except event is triggered immediately, without waiting for the next frame cycle.

dispatchReady()

#

Returns void

Inherited from Container

Dispatches ready event. Dispatches when all children are ready.

dispose()

#

Returns void

Inherited from Component

Destroys this object and all related data.

disposeChildren()

#

Returns void

Inherited from Container

Removes and destroys all Container's children.

To remove children from Container without destroying them, use removeChildren().

fillRule(

dataItem: DurationAxisDataItem

)

#

Returns void

Inherited from ValueAxis

Holds reference to a function that accepts a DataItem as parameter.

It can either return a fill opacity for a fill, or manipulate data item directly, to create various highlighting scenarios.

fitsToBounds(

point: IPoint

)

#

Returns boolean

Inherited from Container

Checks if point is within bounds of a container.

formatLabel(

value: number,
format?: string

)

#

Returns string

Formats the value according to axis' own DurationFormatter.

getCurrentThemes()

#

Returns ITheme[]

Inherited from Sprite

Returns theme(s) used by this object either set explicitly on this element, inherited from parent, or inherited from System.

getDataSource(

property: string

)

#

Returns DataSource

Inherited from Component

Returns (creates if necessary) a DataSource bound to any specific property.

For example if I want to bind data to an external JSON file, I'd create a DataSource for it.

getPixelX(

value: number | Percent

)

#

Returns number

Inherited from Sprite

Returns an X coordinate in pixel within the element.

If number is passed in as parameter, the same number will be returned back.

If Percent is passed in, it will be recalculated to pixels.

getPixelY(

value: number | Percent

)

#

Returns number

Inherited from Sprite

Returns an Y coordinate in pixel within the element.

If number is passed in as parameter, the same number will be returned back.

If Percent is passed in, it will be recalculated to pixels.

getPositionLabel(

position: number

)

#

Returns string

Inherited from ValueAxis

Returns value based on position.

Please note that position represents position within axis which may be zoomed and not correspond to Cursor's position.

To convert Cursor's position to Axis' position use toAxisPosition() method.

@see This link For more information about cursor tracking.

getPositionX(

dataItem: XYSeriesDataItem,
key: string,
location?: number,
stackKey?: string,
range?: IRange

)

#

Returns number

Inherited from ValueAxis

Returns the X coordinate for series' data item's value.

@since 4.5.14

getPositionY(

dataItem: XYSeriesDataItem,
key: string,
location?: number,
stackKey?: string,
range?: IRange

)

#

Returns number

Inherited from ValueAxis

Returns relative position on axis for series' data item's value.

@since 4.5.14

getPropertyValue(

propertyName: Key

)

#

Returns IDurationAxisProperties[Key]

Inherited from Sprite

Returns element's property value.

Will check if there are any bindings with DataItem.

Will also apply any adapters bound to propertyName.

getRelativeX(

value: number | Percent

)

#

Returns number

Inherited from Sprite

Returns relative (percent) value of the X coordindate within this element.

A relative value is a hundredth of a percent. So 100% would result in a 1 as relative value.

getRelativeY(

value: number | Percent

)

#

Returns number

Inherited from Sprite

Returns relative (percent) value of the Y coordindate within this element.

A relative value is a hundredth of a percent. So 100% would result in a 1 as relative value.

getSvgPoint(

point: IPoint

)

#

Returns IPoint

Inherited from Sprite

Converts element's local coordinates to the coordinates within the main chart container.

hide(

duration?: number

)

#

Returns $type.Optional < Animation >

Inherited from Sprite

Hides the element, by applying hidden state.

Has no effect if element is already hidden.

If duration is not specified, it will use default.

While element is fading out, its isHiding property will resolve to true.

When element is hidden, its visible property will resolve to false.

hideTooltip(

duration?: number

)

#

Returns void

Inherited from Axis

Hides element's Tooltip.

@see Tooltip

hitTest(

sprite: Sprite

)

#

Returns boolean

Inherited from Sprite

Checks if the this element has any of its parts overlapping with another element.

@todo Description (review)

insertAfter(

sprite: Sprite

)

#

Returns Sprite

Inherited from Sprite

Insert this element after sibling element.

insertBefore(

sprite: Sprite

)

#

Returns Sprite

Inherited from Sprite

Insert this element before sibling element.

invalidate()

#

Returns void

Inherited from Container

Invalidates element.

Object will be redrawn during the next update cycle.

Please note that in most cases elements will auto-invalidate when needed. If everything works, DO NOT use this method. Use it only if some changes do not take otherwise.

invalidateLabels()

#

Returns void

Inherited from Container

When fontSize of fontFamily changes we need to hard-invalidate all Labels of this container to position them properly.

invalidateRawData()

#

Returns void

Inherited from Component

If you want to have a smooth transition from one data values to another, you change your raw data and then you must call this method.

then instead of redrawing everything, the chart will check raw data and smoothly transit from previous to new data

invalidateSeries()

#

Returns void

Inherited from Axis

Invalidates series of this axis.

isDisposed()

#

Returns boolean

Inherited from BaseObject

Returns if this object has been already been disposed.

isInTransition()

#

Returns boolean

Inherited from Sprite

Returns true if Sprite is currently transiting from one state/value to another.

isInteractive()

#

Returns boolean

Inherited from Sprite

Returns true if interactions object was created. Mostly used just to avoid creating interactions object if not needed.

isReady()

#

Returns boolean

Inherited from Sprite

Returns true if Sprite has already finished initializing and is ready.

If this object is a Container it will wait for all of its children are ready before becoming ready itself and firing a "ready" event.

margin(

top: number,
right: number,
bottom: number,
left: number

)

#

Returns Sprite

Inherited from Sprite

Sets all four margins for the element at once.

Margins are set in pixels.

moveTo(

point: IPoint,
rotation?: number,
scale?: number,
isDragged?: boolean

)

#

Returns void

Inherited from Sprite

Moves the element to a specified coordinates.

Using this method is preferred method of moving element, as it saves some CPU processing power over setting x and y properties separately.

The method respects element's center settings. The element will be positioned so that point coordinates come in whatever "center" of the element is, as set in horizontalCenter and verticalCenter.

Besides moving the element, you can also at the same time scale and rotate the element.

openModal(

text: string,
title?: string

)

#

Returns Optional < Modal >

Inherited from Sprite

Opens a modal window with specific content (text parameter) and, optionally, title.

The text parameter can contain HTML content.

@see Modal for more information about using Modal windows

openPopup(

text: string,
title?: string

)

#

Returns Optional < Popup >

Inherited from Sprite

Creates, opens, and returns a new Popup window.

text can be any valid HTML.

title is currently not supported.

padding(

top: number,
right: number,
bottom: number,
left: number

)

#

Returns Sprite

Inherited from Sprite

Sets padding for the element in pixels.

pointToPosition(

point: IPoint

)

#

Returns number

Inherited from ValueAxis

Converts pixel coordinates to a relative position. (0-1)

positionToAngle(

position: number

)

#

Returns number

Inherited from Axis

Converts a relative position to angle. (for circular axes)

positionToValue(

position: number

)

#

Returns number

Inherited from ValueAxis

Converts an relative position to a corresponding value within axis' scale.

reinit()

#

Returns void

Inherited from Component

Invalidates the whole element, including all its children, causing complete re-parsing of data and redraw.

Use sparingly!

removeChildren()

#

Returns void

Inherited from Container

Removes all Container's children without actually destroying them.

To destroy children use disposeChildren() instead.

removeData(

count: $type.Optional < number >

)

#

Returns void

Inherited from Component

Removes elements from the beginning of data

setPropertyValue(

property: Key,
value: any,
invalidate?: boolean,
transform?: boolean

)

#

Returns boolean

Inherited from Sprite

Sets elements's property value. Will also propagate the same property value on all element's clones.

@todo Review propagation to clones. Right now we simply check if clone is disposed before setting the same property on it. It's better to remove from clone list altogether.

setState(

value: string | SpriteState < IDurationAxisProperties, IDurationAxisAdapters > ,
transitionDuration?: number,
easing?: ( value: number) => number

)

#

Returns $type.Optional < Animation >

Inherited from Container

Applies a SpriteState on this element.

The first parameter can either be a name of the state or a SpriteState instance.

When run, this method will apply SVG properties defined in a SpriteState, but only those that are relevant to this particular element, that is are listed in its respective properties array.

@see SpriteState

setVisibility(

value: boolean

)

#

Returns void

Inherited from Sprite

Sets visibility property:

  • true - visible
  • false - hidden

show(

duration?: number

)

#

Returns $type.Optional < Animation >

Inherited from Sprite

Reveals hidden element.

Has no effect if element is already visible.

If duration is not specified, it will use default.

showTooltip(

point?: IPoint

)

#

Returns boolean

Inherited from Sprite

Shows the element's Tooltip.

A tooltip will be populated using text templates in either tooltipHTML or tooltipText as well as data in tooltipDataItem.

@see Tooltip

showTooltipAt(

value: number

)

#

Returns void

Inherited from ValueAxis

Shows Axis tooltip at specific value

showTooltipAtPosition(

position: number,
local?: boolean

)

#

Returns void

Inherited from Axis

Shows Axis tooltip at specific relative position within Axis. (0-1)

toAxisPosition(

position: number

)

#

Returns number

Inherited from Axis

Converts relative position (0-1) to Axis position with zoom level and inversed taken into account.

toBack()

#

Returns void

Inherited from Sprite

Moves the element to the very bottom in the element order, so that it appears behind other elements.

toFront()

#

Returns void

Inherited from Sprite

Moves the element to the very top in element order, so that it appears in front of other elements.

toGlobalPosition(

position: number

)

#

Returns number

Inherited from Axis

Converts position on the axis with zoom level and inversed taken into account to global position.

valueToPoint(

value: number

)

#

Returns IOrientationPoint

Inherited from ValueAxis

Converts a numeric value to orientation point (x, y, angle) on axis

valueToPosition(

value: number

)

#

Returns number

Inherited from ValueAxis

Converts a numeric value to relative position on axis.

xToValue(

x: number

)

#

Returns number

Inherited from ValueAxis

Converts an X coordinate to a relative value in axis' scale.

yToValue(

y: number

)

#

Returns number

Inherited from ValueAxis

Converts an Y coordinate to a relative value in axis' scale.

zoom(

range: IRange,
skipRangeEvent: boolean,
instantly: boolean,
declination?: number

)

#

Returns IRange

Inherited from Component

Sets current zoom.

The range uses relative values from 0 to 1, with 0 marking beginning and 1 marking end of the available data range.

This method will not have any effect when called on a chart object.

Since the chart can have a number of axes and series, each with its own data, the meaning of "range" is very ambiguous.

To zoom the chart use zoom* methods on its respective axes.

zoomToIndexes(

startIndex: number,
endIndex: number,
skipRangeEvent?: boolean,
instantly?: boolean

)

#

Returns void

Inherited from Component

Zooms to specific data items using their index in data.

This method will not have any effect when called on a chart object.

Since the chart can have a number of axes and series, each with its own data, the meaning of "index" is very ambiguous.

To zoom the chart use zoom* methods on its respective axes.

zoomToValues(

startValue: number,
endValue: number,
skipRangeEvent?: boolean,
instantly?: boolean

)

#

Returns void

Inherited from ValueAxis

Zooms axis to specific values.

There are 74 inherited items currently hidden from this list.

Events

#appeared

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

Inherited from ISpriteEvents

Invoked when Sprite appears. Sprite appears when sprite.appear() method is called and show animation is finished.

#beforedatavalidated

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

Inherited from IComponentEvents

Invoked just before element is validated (after changes).

#beforedisposed

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

Inherited from ISpriteEvents

Invoked just before Sprite is disposed.

#beforevalidated

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

Inherited from ISpriteEvents

Invoked before Sprite is validated.

@todo Description (check)

#blur

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

Inherited from IInteractionObjectEvents

Invoked when focusable object loses focus, e.g. by clicking outside it or pressing TAB button to focus on the next focusable object.

#childadded

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

Inherited from IContainerEvents

Invoked when a child Sprite is added to Container.

#childremoved

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

Inherited from IContainerEvents

Invoked when a child Sprite is removed from

#dataitemsvalidated

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

Inherited from IComponentEvents

Invoked when value(s) of the element's data items are validated.

#datarangechanged

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

Inherited from IComponentEvents

Invoked when range of the currently selected data is validated.

@todo: change to datarangevalidated?

#datavalidated

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

Inherited from IComponentEvents

Invoked when the raw data for the component changes.

#disabled

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

Inherited from ISpriteEvents

Invoked when sprite is disabled

#doublehit

Param SpritePointerTypeEvent & SpritePointEvent & SpriteMouseTouchEvent & { type: "doublehit",
  target: this }

Inherited from ISpriteEvents

Invoked when Sprite is clicked or touched twice in rapid succession.

#down

Param PointerTypeEvent & PointerEvent & MouseTouchEvent & { type: "down",
  target: this }

Inherited from IInteractionObjectEvents

Invoked when the mouse button is pressed or touch starts.

#drag

Param PointerTypeEvent & ShiftEvent & PointEvent & { type: "drag",
  target: this }

Inherited from IInteractionObjectEvents

Invoked when draggable object is being dragged. (using mouse, touch or keyboard)

#dragged

Param SpritePointerTypeEvent & SpriteShiftEvent & SpritePointEvent & { type: "dragged",
  target: this }

Inherited from ISpriteEvents

Invoked when draggable object is being dragged. (using mouse, touch or keyboard).

This is simmilar but different then "drag" event in that it kicks in after "drag" which modifies Sprite coordinates. This allows doing own manipulations and corrections to element positions.

#dragstart

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

Inherited from IInteractionObjectEvents

Invoked when draggable object dragging starts. This event is not invoked immediatelly after down, but only if there's a movement of the pointer.

#dragstop

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

Inherited from IInteractionObjectEvents

Invoked when draggable object is released. This event will not fire if position of the object did not change.

#enabled

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

Inherited from ISpriteEvents

Invoked when sprite is enabled

#endchanged

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

Inherited from IComponentEvents

Invoked when end position changes

#extremeschanged

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

Inherited from IValueAxisEvents

Invoked when start/end coordinates of the axis change.

#focus

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

Inherited from IInteractionObjectEvents

Invoked when focusable object gains focus, e.g. by using TAB button.

#globalscalechanged

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

Inherited from ISpriteEvents

Invoked when the global scale changed, meaning that scale of Sprite or any of its ascendants changed.

#hidden

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

Inherited from ISpriteEvents

Invoked when visible Sprite is hidden.

#hit

Param SpritePointerTypeEvent & SpritePointEvent & SpriteMouseTouchEvent & { type: "hit",
  target: this }

Inherited from ISpriteEvents

Invoked when Sprite is clicked or touched.

#hold

Param PointerTypeEvent & PointerEvent & MouseTouchEvent & { type: "hold",
  target: this }

Inherited from IInteractionObjectEvents

Invoked when mouse or touch pointer is held down over object for some time.

#inited

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

Inherited from ISpriteEvents

Invoked when Sprite is initialized.

#input

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

Inherited from IInteractionObjectEvents

Invoked whenever information changes in the textual input elements, like <input>, <textarea>, etc.

#keydown

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

Inherited from IInteractionObjectEvents

Invoked when the key is pressed on the keyboard.

#keypress

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

Inherited from IInteractionObjectEvents

Invoked when the key generates a "press", e.g. pressing and holding a letter key will generate repeated "keypress" events.

#keyup

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

Inherited from IInteractionObjectEvents

Invoked when the key is released on the keyboard.

#lengthchanged

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

Inherited from IAxisEvents

Invoked when available axis lenght changes, e.g. after resizing the whole chart.

#maxsizechanged

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

Inherited from ISpriteEvents

Invoked when maximum available size of the Sprite changes, i.e. when the size of parent container changes.

#out

Param PointerTypeEvent & MouseTouchEvent & PointerEvent & { type: "out",
  target: this }

Inherited from IInteractionObjectEvents

Invoked when mouse cursor moves out of hoverable object or it is no longer touched.

#over

Param PointerTypeEvent & MouseTouchEvent & PointerEvent & { type: "over",
  target: this }

Inherited from IInteractionObjectEvents

Invoked when mouse cursor moves over hoverable object or it is touched.

#parentset

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

Inherited from ISpriteEvents

Invoked when a sprite is added to a parent

#positionchanged

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

Inherited from ISpriteEvents

Invoked when position of the Sprite changes.

#propertychanged

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

Inherited from ISpriteEvents

Invoked when property of the Sprite changes.

#rangechangeended

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

Inherited from IComponentEvents

Invoked when range change animation ends

#rangechangestarted

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

Inherited from IComponentEvents

Invoked when range change animation starts

#ready

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

Inherited from ISpriteEvents

Invoked when Sprite is becomes ready, that is it has finished all calculations and building itself.

For Container object (and all those inheriting it, including charts) this event will fire when all children become ready.

#resize

Param PointerTypeEvent & ScaleEvent & MouseTouchEvent & { type: "resize",
  target: this }

Inherited from IInteractionObjectEvents

Invoked when resizable object is being resized either by mouse or touch pinch gesture.

#rightclick

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

Inherited from IInteractionObjectEvents

Invoked when right mouse button is clicked on the object.

#selectionextremeschanged

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

Inherited from IValueAxisEvents

Invoked when selection/zoom on axis occurs and start/end coordinates change.

#shown

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

Inherited from ISpriteEvents

Invoked when hidden Sprite is shown.

#sizechanged

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

Inherited from ISpriteEvents

Invoked when size of the Sprite changes.

#startchanged

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

Inherited from IComponentEvents

Invoked when start position changes

#startendchanged

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

Inherited from IComponentEvents

Invoked when start or end position changes, unlike startchanged/endchanged this event is fired not immediately but at the end of a cycle.

#swipe

Param PointerTypeEvent & MouseTouchEvent & { type: "swipe",
  target: this }

Inherited from IInteractionObjectEvents

Invoked when user performs "swiping" gesture (quick horizontal movement) on the object, either using mouse or touch.

#swipeleft

Param PointerTypeEvent & MouseTouchEvent & { type: "swipeleft",
  target: this }

Inherited from IInteractionObjectEvents

Invoked when user performs "swiping" gesture towards left.

#swiperight

Param PointerTypeEvent & MouseTouchEvent & { type: "swiperight",
  target: this }

Inherited from IInteractionObjectEvents

Invoked when user performs "swiping" gesture towards right.

#toggled

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

Inherited from ISpriteEvents

Invoked when togglable Sprite is being toggled on and off. (its isActive property is being changed)

#track

Param SpritePointerTypeEvent & SpritePointEvent & SpritePointerEvent & SpriteMouseTouchEvent & { type: "track",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer (mouse cursor or touch point) moves over trackable Sprite.

#transformed

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

Inherited from ISpriteEvents

@todo Description

#transitionended

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

Inherited from ISpriteEvents

Invoked when Sprite completes transition to a SpriteState.

#up

Param PointerTypeEvent & PointerEvent & MouseTouchEvent & { type: "up",
  target: this }

Inherited from IInteractionObjectEvents

Invoked when the mouse button is released or touch ends.

#validated

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

Inherited from ISpriteEvents

Invoked when Sprite is validated. (on init or after update)

@todo Description (check)

#visibilitychanged

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

Inherited from ISpriteEvents

Invoked when visibility of the Sprite changes. (from visible to hidden, and vice versa)

#wheel

Param SpritePointEvent & SpriteShiftEvent & { type: "wheel",
  target: this }

Inherited from ISpriteEvents

Invoked when user turns mouse wheel while over the Sprite.

#wheeldown

Param SpritePointEvent & SpriteShiftEvent & { type: "wheeldown",
  target: this }

Inherited from ISpriteEvents

Invoked when user turns mouse wheel downwards while over the Sprite.

#wheelleft

Param SpritePointEvent & SpriteShiftEvent & { type: "wheelleft",
  target: this }

Inherited from ISpriteEvents

Invoked when user turns mouse wheel leftwards while over the Sprite.

#wheelright

Param SpritePointEvent & SpriteShiftEvent & { type: "wheelright",
  target: this }

Inherited from ISpriteEvents

Invoked when user turns mouse wheel rightwards while over the Sprite.

#wheelup

Param SpritePointEvent & SpriteShiftEvent & { type: "wheelup",
  target: this }

Inherited from ISpriteEvents

Invoked when user turns mouse wheel upwards while over the Sprite.

#zIndexChanged

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

Inherited from ISpriteEvents

Invoked when zIndex of a sprite is changed

There are 63 inherited items currently hidden from this list.

Adapters

#align

Param Align

Inherited from ISpriteProperties

#alwaysShowTooltip

Param boolean

Inherited from ISpriteProperties

#clickable

Param boolean

Inherited from ISpriteProperties

#contentAlign

Param Align

Inherited from IContainerProperties

Horizontal alignment of Container's items.

#contextMenuDisabled

Param boolean

Inherited from ISpriteProperties

#criticalError

Param Error

Inherited from ISpriteAdapters

#cursorOptions

Param ICursorOptions

Inherited from ISpriteAdapters

#cursorTooltipEnabled

Param boolean

Inherited from IAxisProperties

Indicates if cusor's tooltip should be shown on this Axis.

#data

Param any[]

Inherited from IComponentAdapters

Applied to chart's data before it is retrieved for use.

#dataContextValue

Param object

Inherited from IComponentAdapters

Applied after Component retrieves data value from data context (raw data), but before it is provided to DataItem.

#disabled

Param boolean

Inherited from ISpriteProperties

#draggable

Param boolean

Inherited from ISpriteProperties

#dx

Param number

Inherited from ISpriteProperties

#dy

Param number

Inherited from ISpriteProperties

#end

Param number

Inherited from IComponentAdapters

#endLocation

Param number

Inherited from IAxisProperties

Axis end location.

  • 0 - None of the last cell is shown. (don't do that)
  • 0.5 - Half of the last cell is shown.
  • 1 - Full last cell is shown.

@param Location (0-1)

#extraMax

Param number

Inherited from IValueAxisProperties

#extraMin

Param number

Inherited from IValueAxisProperties

#fill

Param Color | LinearGradient | RadialGradient | Pattern

Inherited from ISpriteProperties

#fillModifier

Param ColorModifier

Inherited from ISpriteProperties

#fillOpacity

Param number

Inherited from ISpriteProperties

#fixedWidthGrid

Param boolean

Inherited from IContainerProperties

If set to true, all columns of the container with layout type "grid" will be equally sized.

@default false

#focusable

Param boolean

Inherited from ISpriteProperties

#fontFamily

Param string

Inherited from IContainerProperties

Font family for the text.

#fontSize

Param number

Inherited from IContainerProperties

Font size for the text.

#fontWeight

Param FontWeight

Inherited from IContainerProperties

Default font weight.

@default "normal"

#getTooltipText

Param string

Inherited from IAxisAdapters

Applied to the tooltip text before it is shown.

#globalScale

Param number

Inherited from ISpriteAdapters

#height

Param number | Percent

Inherited from ISpriteProperties

#hidden

Param boolean

Inherited from ISpriteProperties

#hitOptions

Param IHitOptions

Inherited from ISpriteAdapters

#horizontalCenter

Param HorizontalCenter

Inherited from ISpriteProperties

#hoverOnFocus

Param boolean

Inherited from ISpriteProperties

#hoverOptions

Param IHoverOptions

Inherited from ISpriteAdapters

#hoverable

Param boolean

Inherited from ISpriteProperties

#id

Param string

Inherited from ISpriteProperties

#includeRangesInMinMax

Param boolean

Inherited from IValueAxisProperties

#inert

Param boolean

Inherited from ISpriteProperties

#inertiaOptions

Param Dictionary < InertiaTypes, IInertiaOptions >

Inherited from ISpriteAdapters

#innerHeight

Param number

Inherited from ISpriteAdapters

#innerWidth

Param number

Inherited from ISpriteAdapters

#interactionsEnabled

Param boolean

Inherited from ISpriteProperties

#isActive

Param boolean

Inherited from ISpriteProperties

#isHover

Param boolean

Inherited from ISpriteProperties

#keepSelection

Param boolean

Inherited from IValueAxisProperties

#keyboardOptions

Param IKeyboardOptions

Inherited from ISpriteAdapters

#layout

Param ContainerLayout

Inherited from IContainerProperties

Container layout.

Options: "absolute" (default), "vertical", "horizontal", or "grid".

@default "absolute"

#logarithmic

Param boolean

Inherited from IValueAxisProperties

#marginBottom

Param number

Inherited from ISpriteProperties

#marginLeft

Param number

Inherited from ISpriteProperties

#marginRight

Param number

Inherited from ISpriteProperties

#marginTop

Param number

Inherited from ISpriteProperties

#mask

Param Sprite

Inherited from ISpriteAdapters

#maxColumns

Param number

Inherited from IContainerProperties

Maximum number of columns (when using "grid" layout).

#maxHeight

Param number

Inherited from ISpriteProperties

#maxPrecision

Param number

Inherited from IValueAxisProperties

#maxWidth

Param number

Inherited from ISpriteProperties

#maxX

Param number

Inherited from ISpriteProperties

#maxY

Param number

Inherited from ISpriteProperties

#maxZoomCount

Param number

Inherited from IComponentProperties

Use this for CategoryAxis or DateAxis.

Limits how many categories or base intervals can be shown at the same time.

If there are more items in the chart, the chart will auto-zoom.

@default 0 (no limit)

#maxZoomFactor

Param number

Inherited from IComponentProperties

Maximum zoom factor of a component.

#measuredHeight

Param number

Inherited from ISpriteAdapters

#measuredWidth

Param number

Inherited from ISpriteAdapters

#minHeight

Param number

Inherited from ISpriteProperties

#minWidth

Param number

Inherited from ISpriteProperties

#minX

Param number

Inherited from ISpriteProperties

#minY

Param number

Inherited from ISpriteProperties

#minZoomCount

Param number

Inherited from IComponentProperties

Use this for CategoryAxis or DateAxis.

Allows restricting zoom in beyond certain number of categories or base intervals.

The chart will not zoom in beyond this number of items.

@default 1

#mouseOptions

Param IMouseOptions

Inherited from ISpriteAdapters

#nonScaling

Param boolean

Inherited from ISpriteProperties

#nonScalingStroke

Param boolean

Inherited from ISpriteProperties

#opacity

Param number

Inherited from ISpriteProperties

#outerHeight

Param number

Inherited from ISpriteAdapters

#outerWidth

Param number

Inherited from ISpriteAdapters

#paddingBottom

Param number

Inherited from ISpriteProperties

#paddingLeft

Param number

Inherited from ISpriteProperties

#paddingRight

Param number

Inherited from ISpriteProperties

#paddingTop

Param number

Inherited from ISpriteProperties

#path

Param string

Inherited from ISpriteProperties

#pixelHeight

Param number

Inherited from ISpriteAdapters

#pixelMarginBottom

Param number

Inherited from ISpriteAdapters

#pixelMarginLeft

Param number

Inherited from ISpriteAdapters

#pixelMarginRight

Param number

Inherited from ISpriteAdapters

#pixelMarginTop

Param number

Inherited from ISpriteAdapters

#pixelPerfect

Param boolean

Inherited from ISpriteProperties

#pixelWidth

Param number

Inherited from ISpriteAdapters

#pixelX

Param number

Inherited from ISpriteAdapters

#pixelY

Param number

Inherited from ISpriteAdapters

#populateString

Param string

Inherited from ISpriteAdapters

#readerChecked

Param boolean

Inherited from ISpriteProperties

#readerControls

Param string

Inherited from ISpriteProperties

#readerDescribedBy

Param string

Inherited from ISpriteProperties

#readerDescription

Param string

Inherited from ISpriteProperties

#readerHidden

Param boolean

Inherited from ISpriteProperties

#readerLabelledBy

Param string

Inherited from ISpriteProperties

#readerLive

Param AriaLive

Inherited from ISpriteProperties

#readerTitle

Param string

Inherited from ISpriteProperties

#relativeHeight

Param number

Inherited from ISpriteAdapters

#relativeMarginBottom

Param number

Inherited from ISpriteAdapters

#relativeMarginLeft

Param number

Inherited from ISpriteAdapters

#relativeMarginRight

Param number

Inherited from ISpriteAdapters

#relativeMarginTop

Param number

Inherited from ISpriteAdapters

#relativeWidth

Param number

Inherited from ISpriteAdapters

#relativeX

Param number

Inherited from ISpriteAdapters

#relativeY

Param number

Inherited from ISpriteAdapters

#resizable

Param boolean

Inherited from ISpriteProperties

#reverseOrder

Param boolean

Inherited from IContainerProperties

If set to true, the children of the container will be drawn in reverse order.

@default false

#role

Param Roles

Inherited from ISpriteProperties

#rotation

Param number

Inherited from ISpriteProperties

#scale

Param number

Inherited from ISpriteProperties

#setStateOnChildren

Param boolean

Inherited from IContainerProperties

Specifies if, when state is applied on this container, the same state should be applied to container's children as well as background.

@default false

#shapeRendering

Param ShapeRendering

Inherited from ISpriteProperties

#showOnInit

Param boolean

Inherited from ISpriteProperties

#start

Param number

Inherited from IComponentAdapters

#startLocation

Param number

Inherited from IAxisProperties

Axis start location.

  • 0 - None of the first cell is shown. (don't do that)
  • 0.5 - Half of the first cell is shown.
  • 1 - Full first cell is shown.

@param Location (0-1)

#strictMinMax

Param boolean

Inherited from IValueAxisProperties

#stroke

Param Color | LinearGradient | RadialGradient | Pattern

Inherited from ISpriteProperties

#strokeDasharray

Param string

Inherited from ISpriteProperties

#strokeDashoffset

Param number

Inherited from ISpriteProperties

#strokeLinecap

Param "butt" | "square" | "round"

Inherited from ISpriteProperties

#strokeLinejoin

Param "miter" | "round" | "bevel"

Inherited from ISpriteProperties

#strokeModifier

Param ColorModifier

Inherited from ISpriteProperties

#strokeOpacity

Param number

Inherited from ISpriteProperties

#strokeWidth

Param number

Inherited from ISpriteProperties

#swipeOptions

Param ISwipeOptions

Inherited from ISpriteAdapters

#swipeable

Param boolean

Inherited from ISpriteProperties

#tabindex

Param number

Inherited from ISpriteProperties

#textDecoration

Param TextDecoration

Inherited from IContainerProperties

Default font decoration.

@default "none"

#togglable

Param boolean

Inherited from ISpriteProperties

#toggleZoomOutButton

Param boolean

Inherited from IAxisProperties

Normally, when axis is zoomed in, a zoom out button is shown by a chart, and vice versa: when axis is zoomed out completely, zoom out button is hidden.

Setting this to false will disable this behavior. Zooming in our out this axis will not reveal or hide zoom out button.

@default true

#tooltipHTML

Param string

Inherited from ISpriteProperties

#tooltipPosition

Param "fixed" | "pointer"

Inherited from ISpriteProperties

#tooltipText

Param string

Inherited from ISpriteProperties

#tooltipX

Param number

Inherited from ISpriteProperties

#tooltipY

Param number

Inherited from ISpriteProperties

#trackable

Param boolean

Inherited from ISpriteProperties

#url

Param string

Inherited from ISpriteProperties

#urlTarget

Param string

Inherited from ISpriteProperties

#valign

Param VerticalAlign

Inherited from ISpriteProperties

#verticalCenter

Param VerticalCenter

Inherited from ISpriteProperties

#visible

Param boolean

Inherited from ISpriteProperties

#wheelable

Param boolean

Inherited from ISpriteProperties

#width

Param number | Percent

Inherited from ISpriteProperties

#x

Param number | Percent

Inherited from ISpriteProperties

#y

Param number | Percent

Inherited from ISpriteProperties

#zIndex

Param number

Inherited from ISpriteProperties

There are 146 inherited items currently hidden from this list.