ConeSeries

Type class

Defines Series for a cone graph.

@see IConeSeriesEvents for a list of available Events
@see IConeSeriesAdapters for a list of available Adapters
@todo Example

Sources

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

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

/**
 * --------------------------------------------------------
 * Import from: "charts.ts"
 * Use like: am4charts.ConeSeries
 * --------------------------------------------------------
 */
import * as am4charts from "@amcharts/amcharts4/charts";

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

Inheritance

ConeSeries extends ColumnSeries.

ConeSeries is not extended by any other symbol.

Properties

adapter
#

Type ...

Inherited from Sprite

Holds Adapter.

@see This link for more info about Adapters

align
#

Type ...

Inherited from Sprite

Controls horizontal alignment of the element.

This is used by parent Container when layouting its children.

alwaysShowTooltip
#

Type ...

Inherited from Sprite

DEPRECATION NOTICE: This setting is deprecated in favor of a more flexible setting: showTooltipOn. Please use showTooltipOn = "always" instead.

Indicates if this element should display a tooltip permanently.

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

@default false
@since 4.5.4
@deprecated Use showTooltipOn = "always" instead

animations
#

Type ...

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 Series

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

@default true

axisRanges
#

Type List < AxisDataItem >

Inherited from Series

A list of axis ranges for this series.

background
#

Type ...

Inherited from Container

An element to use as container background.

baseAxis
#

Type ...

Inherited from XYSeries

The main (base) axis.

This is the axis that series fills will go to, or grow animations will happen from.

baseSprite
#

Type ...

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

bullets
#

Type ...

Inherited from Series

A list of bullets that will be added to each and every items in the series.

You can push any object that is a descendant of a Sprite here. All items added to this list will be copied and used as a bullet on all data items, including their properties, events, etc.

@see This link for more info about the concept of Bullets

calculatePercent
#

Type boolean

Default false

Inherited from Series

Most of the series use absolute values. However sometimes various calculated percent values are need, e.g. item's percent representation across all values in series, etc.

It's a resource-intensive operation, so it is disabled by default.

If you need percents to be calculated, e.g. for showing them in tooltips, or creating 100% stacks, this setting needs to be set to true.

NOTE: PieChart, which relies on slice percentages, has this automatically set to true.

@default false

chart
#

Type ...

Inherited from Series

Chart series is used on.

children
#

Type ...

Inherited from Container

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

clickable
#

Type ...

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.

clustered
#

Type ...

Inherited from ColumnSeries

Cluster this series columns?

Setting to false will make columns overlap with other series.

@default true

columns
#

Type ...

Inherited from ColumnSeries

A list of column elements in the series.

config
#

Type ...

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

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

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

Inherited from Sprite

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

@default false

currentDataSetId
#

Type ...

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

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

cursorHoverEnabled
#

Type ...

Inherited from XYSeries

Indicates if series should apply hover state on bullets/columns/etc when cursor is over the data item.

If set to true (default) and chart cursor is enabled on th chart, hovering over date/category will trigger hover states on related Series items like bullets and columns.

@default true
@since 4.2.2

cursorOptions
#

Type ...

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

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

Inherited from XYSeries

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

If set to true (default), the tooltips set for all series item's elements like columns and bullets will be automatically shown when XYCursor passes over category/date, even if its not hovered directly over the item.

Set this to false to disable such behavior and display item-specific tooltips only when hovered directly over them

@default true

data
#

Type ...

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

Inherited from Component

Holds data field names.

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

dataItem
#

Type ...

Inherited from Sprite

A DataItem to use as element's data source.

@todo Review type

dataItems
#

Type ...

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

Inherited from Component

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

@see This link for more on loading external data

dateFormatter
#

Type ...

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

Inherited from Sprite

Returns a SpriteState object for "default" state.

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

disabled
#

Type ...

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

Inherited from Sprite

Returns DOM element reference associated with this element.

@readonly

draggable
#

Type ...

Inherited from Sprite

Controls if the element is draggable.

dropFromOpenState
#

Type ...

Inherited from ColumnSeries

A state to apply to a column when close value is lower than open value.

Can be used to differentiate appearance based on value relations.

NOTE: this will work only if at least one axis is ValueAxis.

@readonly You can modify state object, but can't overwrite it

dropFromPreviousState
#

Type ...

Inherited from ColumnSeries

A state to apply to a column when its value is lower value of a previous column.

Can be used to differentiate appearance based on value relations.

@readonly You can modify state object, but can't overwrite it

dummyData
#

Type any

Inherited from Sprite

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

durationFormatter
#

Type ...

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

Inherited from Sprite

A horizontal offset for the element in pixels.

Can be negative value for offset to the left.

dy
#

Type ...

Inherited from Sprite

A vertical offset for the element in pixels.

Can be negative value for offset upwards.

element
#

Type ...

Inherited from Sprite

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

All other sub-elements are created in it.

end
#

Type ...

Inherited from Component

End of the current data range (zoom).

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

events
#

Type ...

Inherited from Sprite

Event dispatcher.

@see This link for more info about Events

excludeFromTotal
#

Type ...

Inherited from XYSeries

Indicates if series' values should be excluded when calculating totals.

@default false
@since 4.4.9

exportable
#

Type ...

Inherited from Sprite

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

@default true

exporting
#

Type ...

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

fill
#

Type ...

Inherited from Sprite

Element's fill color or pattern.

fillModifier
#

Type ...

Inherited from Sprite

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

fillOpacity
#

Type ...

Inherited from Sprite

Element's fill opacity.

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

filters
#

Type ...

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

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

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

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

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

Inherited from Container

Font weight to use for text.

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

globalScale
#

Type ...

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.

groupFields
#

Type ...

Inherited from XYSeries

Indicates which of the series' dataFields to calculate aggregate values for.

Available data fields for all XYSeries are:

valueX, valueY, openValueX, and openValueY.

CandlestickSeries adds:

lowValueX, lowValueY, highValueX, and highValueY.

Available options:

"open", "close", "low", "high", "average", "sum".

Defaults are as follows:

  • valueX: "close"
  • valueY: "close"
  • openValueX: "open"
  • openValueY: "open"
  • lowValueX: "low"
  • lowValueY: "low"
  • highValueX: "high"
  • highValueY: "high" Is required only if data being plotted on a DateAxis and its groupData is set to true.
let dateAxis = chart.xAxes.push(new am4charts.DateAxis());
dateAxis.groupData = true;

let valueAxis = chart.xAxes.push(new am4charts.valueAxis());

let series = chart.series.push(new am4charts.LineSeries());
series.dataFields.dateX = "date";
series.dataFields.valueY = "value";
series.groupFields.valueY = "average";
var dateAxis = chart.xAxes.push(new am4charts.DateAxis());
dateAxis.groupData = true;

var valueAxis = chart.xAxes.push(new am4charts.valueAxis());

var series = chart.series.push(new am4charts.LineSeries());
series.dataFields.dateX = "date";
series.dataFields.valueY = "value";
series.groupFields.valueY = "average";
{
  // ...
  "xAxes": [{
    "type": "DateAxis",
    "groupData": true
  }],
  "yAxes": [{
    "type": "ValueAxis"
  }],
  "series": [{
    "type": "LineSeries",
    "dataFields": {
      "dateX": "date",
      "valueY": "value"
    },
    "groupFields": {
      "valueY": "average"
    }
  }]
}

The above setup will ensure, that if there are many data items within selected range, they will be grouped into aggregated data points, using average value of all the values.

For example if we have 2 years worth of daily data (~700 data items), when fully zoomed out, the chart would show ~100 data items instead: one for each week in those two years.

Grouping will occur automatically, based on current selection range, and will change dynamically when user zooms in/out the chart.

@see This link for more information about dynamic data item grouping.
@since 4.7.0

hasFocused
#

Type boolean

Default false

Inherited from Container

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

heatRules
#

Type ...

Inherited from Series

A list of heat rules to apply to series' elements based on the value of the data item.

Heat rules can be any "numeric" (including Color) property, and can also be applied to child objects of series, like columns, bullets, etc.

E.g.:

series.heatRules.push({
 "target": series.columns.template,
 "property": "fill",
 "min": am4core.color("#F5DBCB"),
 "max": am4core.color("#ED7B84"),
 "dataField": "valueY"
});
series.heatRules.push({
 "target": series.columns.template,
 "property": "fill",
 "min": am4core.color("#F5DBCB"),
 "max": am4core.color("#ED7B84"),
 "dataField": "valueY"
});
{
 // ...
 "series": [{
   "type": "ColumnSeries",
   "heatRules": [{
     "target": "columns.template",
     "property": "fill",
     "min": "#F5DBCB",
     "max": "#ED7B84",
     "dataField": "valueY"
   }]
 }]
}

@see This link for more about heat rules

height
#

Type ...

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

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.

hiddenInLegend
#

Type ...

Inherited from Series

Should the series be hidden in legend?

hiddenState
#

Type ...

Inherited from Sprite

Returns a SpriteState object for "hidden" state.

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

hideTooltipWhileZooming
#

Type ...

Inherited from XYSeries

Indicates if series' tooltip should be hidden while series axis range is animating (zooming).

@default true
@since 4.7.16

hitOptions
#

Type ...

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

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

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

Inherited from Sprite

Returns Sprite's hover options.

@see IHoverOptions for available options.

hoverable
#

Type ...

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

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

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.

ignoreMinMax
#

Type ...

Inherited from Series

Should this series excluded from the axis scale calculations?

@default false

inert
#

Type ...

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

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

Inherited from Sprite

Returns true if Sprite has already finished initializing.

innerHeight
#

Type ...

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

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

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

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

Inherited from Sprite

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

isDown
#

Type ...

Inherited from Sprite

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

isDragged
#

Type ...

Inherited from Sprite

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

isFocused
#

Type ...

Inherited from Sprite

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

isHidden
#

Type ...

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

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

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)

itemReaderText
#

Type ...

Inherited from Series

Screen reader text to be applied to each individual data item, such as bullets, columns or slices.

The template can contain field reference meta codes, i.e. {dateX}, {valueY}, etc.

Any text formatting options, e.g. [bold] will be ignored.

keyboardOptions
#

Type ...

Inherited from Sprite

Returns elements keyboard options.

language
#

Type ...

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

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

legendDataItem
#

Type ...

Inherited from Series

Legend data item that corresponds to this series.

legendSettings
#

Type LegendSettings

Default new LegendSettings()

Inherited from Series

Settings for the appearance of the related legend items.

mainDataSet
#

Type ...

Inherited from Component

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

@since 4.7.0

map
#

Type ...

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

Inherited from Sprite

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

marginLeft
#

Type ...

Inherited from Sprite

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

marginRight
#

Type ...

Inherited from Sprite

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

marginTop
#

Type ...

Inherited from Sprite

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

maskBullets
#

Type ...

Inherited from XYSeries

Indicates if series' bullets should be masked.

@default true
@since 4.7.17

maxColumns
#

Type ...

Inherited from Container

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

maxHeight
#

Type ...

Inherited from Sprite

Maximum allowed height for the element in pixels.

maxWidth
#

Type ...

Inherited from Sprite

Maximum allowed width for the element in pixels.

maxZoomCount
#

Type ...

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

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.

measuredHeight
#

Type ...

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

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

minBulletDistance
#

Type ...

Inherited from Series

Minimal distance between data points in pixels.

If distance gets smaller than this, bullets are turned off to avoid overlapping.

0 (zero) disables this behavior.

IMPORTANT: This setting will work only when Series' base axis is CategoryAxis or DateAxis. If base axis is ValueAxis the setting will be ignored, because it would be a huge overhead to measure distance between each and every bullet.

@default

minHeight
#

Type ...

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

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

Inherited from Component

Use this for CategoryAxis or DateAxis.

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

@default 1

modal
#

Type ...

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

Inherited from Sprite

Mouse options.

Enables controlling options related to the mouse, for example sensitivity of its mouse wheel.

E.g. the below will reduce chart's wheel-zoom speed to half its default speed:

chart.plotContainer.mouseOptions.sensitivity = 0.5;
chart.plotContainer.mouseOptions.sensitivity = 0.5;
{
  // ...
  "plotContainer": {
    "mouseOptions": {
      "sensitivity": 0.5
    }
  }
}

name
#

Type ...

Inherited from Series

Series' name.

nonScaling
#

Type ...

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

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

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

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

Inherited from Sprite

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

@readonly

outerWidth
#

Type ...

Inherited from Sprite

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

@readonly

paddingBottom
#

Type ...

Inherited from Sprite

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

paddingLeft
#

Type ...

Inherited from Sprite

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

paddingRight
#

Type ...

Inherited from Sprite

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

paddingTop
#

Type ...

Inherited from Sprite

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

parent
#

Type ...

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

Inherited from Sprite

Path of Sprite element

pixelHeight
#

Type ...

Inherited from Sprite

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

@readonly

pixelMarginBottom
#

Type ...

Inherited from Sprite

Returns current bottom margin in pixels.

@readonly

pixelMarginLeft
#

Type ...

Inherited from Sprite

Returns current left margin in pixels.

@readonly

pixelMarginRight
#

Type ...

Inherited from Sprite

Returns current right margin in pixels.

@readonly

pixelMarginTop
#

Type ...

Inherited from Sprite

Returns current top margin in pixels.

@readonly

pixelPaddingBottom
#

Type ...

Inherited from Sprite

Returns current bottom padding in pixels.

@readonly

pixelPaddingLeft
#

Type ...

Inherited from Sprite

Returns current left padding in pixels.

@readonly

pixelPaddingRight
#

Type ...

Inherited from Sprite

Returns current right padding in pixels.

@readonly

pixelPaddingTop
#

Type ...

Inherited from Sprite

Returns current top padding in pixels.

@readonly

pixelPerfect
#

Type ...

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

Inherited from Sprite

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

@readonly

pixelX
#

Type ...

Inherited from Sprite

Returns element's current absolute X coordinate in pixels.

@readonly

pixelY
#

Type ...

Inherited from Sprite

Returns element's current absolute Y coordinate in pixels.

@readonly

plugins
#

Type ...

Inherited from Sprite

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

@since 4.2.2

popups
#

Type ...

Inherited from Sprite

A list of popups for this chart.

preloader
#

Type ...

Inherited from Container

A Preloader instance to be used when Container is busy.

properties
#

Type ...

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

Inherited from Sprite

Screen reader description of the element.

readerHidden
#

Type ...

Inherited from Sprite

Controls if element should be hidden from screen readers.

@see This link for more information

readerOrientation
#

Type ...

Inherited from Sprite

Orientation of the element.

@since 4.7.16

readerTitle
#

Type ...

Inherited from Sprite

Screen reader title of the element.

readerValueNow
#

Type ...

Inherited from Sprite

Current value of the element.

@since 4.7.16

readerValueText
#

Type ...

Inherited from Sprite

Text representation of the current value of the element.

@since 4.7.16

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

Inherited from Sprite

Returns current relative bottom margin.

@readonly

relativeMarginLeft
#

Type ...

Inherited from Sprite

Returns current relative left margin.

@readonly

relativeMarginRight
#

Type ...

Inherited from Sprite

Returns current relative right margin.

@readonly

relativeMarginTop
#

Type ...

Inherited from Sprite

Returns current relative top margin.

@readonly

relativePaddingBottom
#

Type ...

Inherited from Sprite

Returns current relative bottom padding.

@readonly

relativePaddingLeft
#

Type ...

Inherited from Sprite

Returns current relative left padding.

@readonly

relativePaddingRight
#

Type ...

Inherited from Sprite

Returns current relative right padding.

@readonly

relativePaddingTop
#

Type ...

Inherited from Sprite

Returns current relative top padding.

@readonly

relativeX
#

Type ...

Inherited from Sprite

Returns element's current relative X coordinate in Percent.

relativeY
#

Type ...

Inherited from Sprite

Returns element's current relative Y coordinate in Percent.

@readonly

resizable
#

Type ...

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

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

Inherited from Container

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

@default false

riseFromOpenState
#

Type ...

Inherited from ColumnSeries

A state to apply to a column when close value is same or higher than open value.

Can be used to differentiate appearance based on value relations.

NOTE: this will work only if at least one axis is ValueAxis.

@readonly You can modify state object, but can't overwrite it

riseFromPreviousState
#

Type ...

Inherited from ColumnSeries

A state to apply to a column when its value is same or higher than value of a previous column.

Can be used to differentiate appearance based on value relations.

@readonly You can modify state object, but can't overwrite it

role
#

Type ...

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

Inherited from Sprite

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

rtl
#

Type ...

Inherited from Sprite

An RTL (right-to-left) setting.

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

scale
#

Type ...

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

setStateOnChildren
#

Type ...

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

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

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

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.

showTooltipOn
#

Type ...

Inherited from Sprite

Indicates when tooltip needs to be shown on this element:

  • "hover" (default) - Tooltip will be shown when element is hovered on.
  • "hit" - Tooltip will be shown when element is clicked/tapped. Tooltip will be hidden when clicked/tapped anywhere else.
  • "always" - Tooltip will be shown on the element permanently.

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

series.columns.template.showTooltipOn = "always";
series.columns.template.showTooltipOn = "always";
{
  // ...
  "series": [{
    // ...
    "columns": {
      "showTooltipOn": "always"
    }
  }]
}

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

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

@default "hover"
@since 4.7.9

simplifiedProcessing
#

Type boolean

Default false

Inherited from Series

When chart/series' data is processed, all kinds of derivative values are calculated. E.g. sum, min, max, change, etc. This is a potentially time-consuming operation, especially prominent in data-heavy charts.

If your chart does not need those values, and you have a lot of data, setting this to true might give a dramatic increase in initial chart load speed.

Please note, regular column and line series usage scenarios do not require derivative values. Those come into play only when you do advanced functionality like coloring segments of charts in different colors depending on change between open and close values, have stacked series, or display any of the derived values, like percent, in tooltips or bullets.

@default false

skipFocusThreshold
#

Type number

Default 20

Inherited from Series

Normally series items are focusable using keyboard, so that people can select them with a TAB key. However, if there are a lot of data points on screen it might be long and useless to tab through all o fthem.

This is where skipFocusThreshold comes in. If there are more items than the value set here, we will not make those focusable and rather let screen reader software rely on the series summary, or authors provide alternative detailed information display, such as HTML table.

Different series might have different threshold defaults.

skipRangeEvent
#

Type boolean

Default false

Inherited from Component

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

snapTooltip
#

Type ...

Inherited from XYSeries

Should the nearest tooltip be shown if no data item is found on the current cursor position? In order this to work, you should set snapTooltip = false on the series baseAxis.

@default false

stacked
#

Type ...

Inherited from XYSeries

Can items from this series be included into stacks?

Note: proper stacking is only possible if series have the same number of data items. To ensure this, don't set data directly on series but do this on chart instead.

@default false

start
#

Type ...

Inherited from Component

Start of the current data range (zoom).

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

states
#

Type ...

Inherited from Sprite

Returns a collection of element's available SpriteState entries.

@see SpriteState

stroke
#

Type ...

Inherited from Sprite

Element's stroke (outline) color or pattern.

strokeDasharray
#

Type ...

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

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

Inherited from Sprite

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

@see This link for more info on stroke-linecap

strokeLinejoin
#

Type ...

Inherited from Sprite

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

@see This link for more info on stroke-linejoin

strokeModifier
#

Type ...

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

Inherited from Sprite

Stroke (outline) opacity.

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

strokeWidth
#

Type ...

Inherited from Sprite

Stroke (outline) thickness in pixels.

svgContainer
#

Type ...

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

Inherited from Sprite

Returns element's swipe gesture options.

swipeable
#

Type ...

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

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

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

Inherited from Container

A text decoration to use for text.

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

togglable
#

Type ...

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.

tooltip
#

Type ...

Inherited from Sprite

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

tooltipColorSource
#

Type ...

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

Inherited from Sprite

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

@see Tooltip
@see DataItem

tooltipHTML
#

Type ...

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

Inherited from Sprite

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

Position

tooltipText
#

Type ...

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

Inherited from Sprite

X coordinate the Tooltip should be shown at.

tooltipY
#

Type ...

Inherited from Sprite

Y coordinate the Tooltip should be shown at.

trackable
#

Type ...

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

Inherited from BaseObject

Returns object's internal unique ID.

url
#

Type ...

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

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

Inherited from Sprite

Controls vertical alignment of the element.

This is used by parent Container when layouting its children.

verticalCenter
#

Type ...

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

Inherited from Sprite

Sets visibility of the element.

Returns current visibility of the element.

wheelable
#

Type ...

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

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

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.

xAxis
#

Type ...

Inherited from XYSeries

X axis the series is attached to.

y
#

Type ...

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.

yAxis
#

Type ...

Inherited from XYSeries

Y axis the series is attached to.

zIndex
#

Type ...

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

Inherited from Component

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

There are 244 inherited items currently hidden from this list.

Methods

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

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.

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

bind(

property: Key,
source: S,
modifier?: ( value: ...) => ...

)

#

Returns void

Inherited from Sprite

bindDataField(

field: Key,
value: ...

)

#

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.

constructor()

#

Returns ConeSeries

Constructor

copyFrom(

source: this

)

#

Returns void

Inherited from ColumnSeries

Copies all properties from another instance of ColumnSeries.

createChild(

classType: { }

)

#

Returns T

Inherited from Container

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

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

fitsToBounds(

point: IPoint

)

#

Returns boolean

Inherited from Container

Checks if point is within bounds of a container.

getAxisField(

axis: Axis

)

#

Returns string

Inherited from XYSeries

Returns axis data field to use.

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.

getPoint(

dataItem: XYSeriesDataItem,
xKey: string,
yKey: string,
locationX?: number,
locationY?: number,
stackKeyX?: string,
stackKeyY?: string

)

#

Returns IPoint

Inherited from XYSeries

Returns an IPoint coordinates of the specific Serie's data point.

getPropertyValue(

propertyName: Key

)

#

Returns ...

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 Animation

Inherited from XYSeries

Hides series.

hideTooltip()

#

Returns void

Inherited from XYSeries

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

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.

raiseCriticalError(

e: Error

)

#

Returns void

Inherited from Series

Displays a modal or console message with error, and halts any further processing of this element.

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

Sets visibility property:

  • true - visible
  • false - hidden

show(

duration?: number

)

#

Returns Animation

Inherited from XYSeries

Shows hidden series.

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

showTooltipAtDataItem(

dataItem: ...

)

#

Returns IPoint

Inherited from XYSeries

Shows series tooltip at specific dataItem.

showTooltipAtPosition(

xPosition: number,
yPosition: number

)

#

Returns IPoint

Inherited from XYSeries

Shows series tooltip at specific position.

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.

updateStacking()

#

Returns void

Inherited from XYSeries

This method must be called if you update Series' data fields that might affect stacking of the series.

Since individual dataField changes are not being monitored, you need todo it manually for changes to take affect.

@since 4.7.21

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.

There are 61 inherited items currently hidden from this list.

Events

ConeSeries does not have any events.

Adapters

#align

Param Align

Inherited from ISpriteProperties

#alwaysShowTooltip

Param boolean

Inherited from ISpriteProperties

#clickable

Param boolean

Inherited from ISpriteProperties

#clustered

Param boolean

Inherited from IColumnSeriesProperties

Cluster this series columns?

Setting to false will make columns overlap with other series.

@default true

#contentAlign

Param Align

Inherited from IContainerProperties

Horizontal alignment of Container's items.

#contextMenuDisabled

Param boolean

Inherited from ISpriteProperties

#criticalError

Param Error

Inherited from ISpriteAdapters

#cursorHoverEnabled

Param boolean

Inherited from IXYSeriesProperties

Indicates if series should apply hover state on bullets/columns/etc when cursor is over the data item.

@default true

#cursorOptions

Param ICursorOptions

Inherited from ISpriteAdapters

#cursorTooltipEnabled

Param boolean

Inherited from IXYSeriesProperties

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

@default true

#data

Param any[]

Inherited from IComponentAdapters

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

#dataContextValue

Param { dataItem: DataItem,
  field: string,
  value: any }

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

#excludeFromTotal

Param boolean

Inherited from IXYSeriesProperties

Indicates if series' values should be excluded when calculating totals.

@default false

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

#globalScale

Param number

Inherited from ISpriteAdapters

#height

Param number | Percent

Inherited from ISpriteProperties

#hidden

Param boolean

Inherited from ISpriteProperties

#hiddenInLegend

Param boolean

Inherited from ISeriesProperties

Should series be hidden in chart's legend?

#hideTooltipWhileZooming

Param boolean

Inherited from IXYSeriesProperties

Indicates if series' tooltip should be hidden while series axis range is animating (zooming)

@since 4.7.16
@default true

#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

#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

#itemReaderText

Param string

Inherited from ISeriesAdapters

Applied to the name used by screen readers.

#keyboardOptions

Param IKeyboardOptions

Inherited from ISpriteAdapters

#layout

Param ContainerLayout

Inherited from IContainerProperties

Container layout.

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

@default "absolute"

#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

#maskBullets

Param boolean

Inherited from IXYSeriesProperties

Should series bullets be masked?

@default true
@since 4.7.17

#maxColumns

Param number

Inherited from IContainerProperties

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

#maxHeight

Param number

Inherited from ISpriteProperties

#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

#minBulletDistance

Param number

Inherited from ISeriesProperties

Minimal distance between data points in pixels.

If distance gets smaller than this, bullets are turned off to avoid overlapping.

0 (zero) disables this behavior.

@default 0

#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

#name

Param string

Inherited from ISeriesProperties

Series' name.

#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

#readerOrientation

Param string

Inherited from ISpriteProperties

#readerTitle

Param string

Inherited from ISpriteProperties

#readerValueNow

Param string

Inherited from ISpriteProperties

#readerValueText

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

#showTooltipOn

Param "hover" | "hit" | "always"

Inherited from ISpriteProperties

#snapTooltip

Param boolean

Inherited from IXYSeriesProperties

Should the nearest tooltip be shown if no data item is found on the current cursor position

@default false

#stacked

Param boolean

Inherited from IXYSeriesProperties

Can items from this series be included into stacks?

@default false

#start

Param number

Inherited from IComponentAdapters

#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

#tooltipHTML

Param string

Inherited from ISpriteProperties

#tooltipPosition

Param "fixed" | "pointer"

Inherited from ISpriteProperties

#tooltipText

Param string

Inherited from ISpriteProperties

#tooltipX

Param number | Percent

Inherited from ISpriteProperties

#tooltipY

Param number | Percent

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