IWavedShape

Type Adapter < this, ISpriteAdapters >

Inherited from Sprite

Holds Adapter.

Click here for more info about Adapters

Type Align

Inherited from Sprite

Controls horizontal alignment of the element.

This is used by parent Container when layouting its children.

Type boolean

Default false

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.

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

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.

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

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.

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

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.

Type boolean

Default true

Inherited from Sprite

When cloning a sprite, if the template has it's own tooltip assigned, this tooltip is also cloned by default.

This is not good for cpu and sometimes you might only need one single tooltip for all clones. Set this to false in order not to clone tooltip.

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.

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.

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.

Type boolean

Default false

Inherited from Sprite

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

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

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.

ICursorOptions for a list of available options

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

Type $type.Optional

Inherited from Sprite

A DataItem to use as element's data source.

@todo Review type

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.

DateFormatter for more info on dates formatting

Type SpriteState < ISpriteProperties, ISpriteAdapters >

Inherited from Sprite

Returns a SpriteState object for "default" state.

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

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.

Type SVGSVGElement

Inherited from Sprite

Returns DOM element reference associated with this element.

@readonly

Type boolean

Inherited from Sprite

Controls if the element is draggable.

Type any

Inherited from Sprite

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

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.

DurationFormatter for more info on durations

Type number

Inherited from Sprite

A horizontal offset for the element in pixels.

Can be negative value for offset to the left.

Type number

Inherited from Sprite

A vertical offset for the element in pixels.

Can be negative value for offset upwards.

Type Optional < AMElement >

Inherited from Sprite

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

All other sub-elements are created in it.

Type SpriteEventDispatcher < AMEvent < this, ISpriteEvents > >

Inherited from Sprite

Event dispatcher.

Click here for more info about Events

Type boolean

Default true

Inherited from Sprite

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

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.

Click here for more info about exporting

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

Inherited from Sprite

Element's fill color or pattern.

Type ColorModifier

Inherited from Sprite

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

Type number

Inherited from Sprite

Element's fill opacity.

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

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.

Type Optional < boolean >

Default undefined (auto)

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.

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

Type Group

Inherited from Sprite

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

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.

NOTE: height is an accessor, which allows setting height in pixels or percent. It is a sort of a "shortcut" for the users. Actual renderer does not ever use it. It uses either pixelHeight or percentHeight, so if you need to add an adapter for height add it for either of the two properties - whichever suits your requirements.

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.

Type SpriteState < ISpriteProperties, ISpriteAdapters >

Inherited from Sprite

Returns a SpriteState object for "hidden" state.

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

Type IHitOptions

Inherited from Sprite

Returns Sprite's click (hit) options.

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

IHitOptions for available options.

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.

Type boolean

Default false


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.

Type IHoverOptions

Inherited from Sprite

Returns Sprite's hover options.

IHoverOptions for available options.

Type boolean

Default false

Inherited from Sprite

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

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

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.

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.

Type boolean

Default false

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.

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.

Type boolean

Inherited from Sprite

Returns true if Sprite has already finished initializing.

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

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

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.

Type boolean

Inherited from Sprite

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

Type boolean

Inherited from Sprite

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

Type boolean

Inherited from Sprite

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

Type boolean

Inherited from Sprite

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

Type boolean

Inherited from Sprite

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

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.

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.

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.

You can force element to be "hovered" manually, by setting this property to true.

Type boolean

Inherited from Sprite

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

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)

Type IKeyboardOptions

Inherited from Sprite

Returns elements keyboard options.

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.

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

Type number | Percent

Inherited from Sprite

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

Type number | Percent

Inherited from Sprite

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

Type number | Percent

Inherited from Sprite

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

Type number | Percent

Inherited from Sprite

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

Type number

Inherited from Sprite

Maximum allowed height for the element in pixels.

Type number

Inherited from Sprite

Maximum allowed width for the element in pixels.

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

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

Type Optional < number >

Inherited from Sprite

Minimum height for the element in pixels.

Set to undefined to remove the limit.

Type Optional < number >

Inherited from Sprite

Minimum width of the element in pixels.

Set to undefined to remove the limit.

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.

Modal for more information about using Modal windows

Type IMouseOptions

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

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.

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.

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.

NumberFormatter for more info on formatting numbers

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.

Type number

Inherited from Sprite

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

@readonly

Type number

Inherited from Sprite

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

@readonly

Type number | Percent

Inherited from Sprite

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

Type number | Percent

Inherited from Sprite

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

Type number | Percent

Inherited from Sprite

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

Type number | Percent

Inherited from Sprite

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

Type Optional < Container >

Inherited from Sprite

Elements' parent Container.

Type string

Inherited from Sprite

Path of Sprite element

Type number

Inherited from Sprite

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

@readonly

Type number

Inherited from Sprite

Returns current bottom margin in pixels.

@readonly

Type number

Inherited from Sprite

Returns current left margin in pixels.

@readonly

Type number

Inherited from Sprite

Returns current right margin in pixels.

@readonly

Type number

Inherited from Sprite

Returns current top margin in pixels.

@readonly

Type number

Inherited from Sprite

Returns current bottom padding in pixels.

@readonly

Type number

Inherited from Sprite

Returns current left padding in pixels.

@readonly

Type number

Inherited from Sprite

Returns current right padding in pixels.

@readonly

Type number

Inherited from Sprite

Returns current top padding in pixels.

@readonly

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.

Type number

Inherited from Sprite

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

@readonly

Type number

Inherited from Sprite

Returns element's current absolute X coordinate in pixels.

@readonly

Type number

Inherited from Sprite

Returns element's current absolute Y coordinate in pixels.

@readonly

Type List < IPlugin >

Inherited from Sprite

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

@since 4.2.2

Type Optional < ListTemplate < Popup > >

Inherited from Sprite

A list of popups for this chart.

Type ISpriteProperties

Inherited from Sprite

Holds values for Sprite's properties.

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.

SpriteState

Type string

Inherited from Sprite

Screen reader description of the element.

Type boolean

Inherited from Sprite

Controls if element should be hidden from screen readers.

Click here for more information

Type string

Inherited from Sprite

Orientation of the element.

@since 4.7.16

Type string

Inherited from Sprite

Screen reader title of the element.

Type string

Inherited from Sprite

Current value of the element.

@since 4.7.16

Type string

Inherited from Sprite

Text representation of the current value of the element.

@since 4.7.16

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

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

Type number

Inherited from Sprite

Returns current relative bottom margin.

@readonly

Type number

Inherited from Sprite

Returns current relative left margin.

@readonly

Type number

Inherited from Sprite

Returns current relative right margin.

@readonly

Type number

Inherited from Sprite

Returns current relative top margin.

@readonly

Type number

Inherited from Sprite

Returns current relative bottom padding.

@readonly

Type number

Inherited from Sprite

Returns current relative left padding.

@readonly

Type number

Inherited from Sprite

Returns current relative right padding.

@readonly

Type number

Inherited from Sprite

Returns current relative top padding.

@readonly

Type number

Inherited from Sprite

Returns element's current relative X coordinate in Percent.

Type number

Inherited from Sprite

Returns element's current relative Y coordinate in Percent.

@readonly

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.

Type Roles

Inherited from Sprite

A WAI-ARIA role for the element.

Click here for more information on WAI-ARIA roles

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.

Type number

Inherited from Sprite

Rotation of the element in degrees. (0-360)Note: For convenience purposes, negative values (for counter-clockwise rotation) and values exceeding 360 can also be used.

Type boolean

Inherited from Sprite

An RTL (right-to-left) setting.

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

If you set this on a top-level chart object, it will be used for all child elements, e.g. labels, unless they have their own rtl setting set directly on them.

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.

Type ShapeRendering

Default "auto"

Inherited from Sprite

An SVG-specific shape-rendering value.

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

Click here for more information about shape-rendering

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.

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.

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.

Type "hover" | "hit" | "always"

Default "hover"

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

@since 4.7.9

Type DictionaryTemplate < string, SpriteState < ISpriteProperties, ISpriteAdapters > >

Inherited from Sprite

Returns a collection of element's available SpriteState entries.

SpriteState

Type Color | Pattern | LinearGradient | RadialGradient

Inherited from Sprite

Element's stroke (outline) color or pattern.

Type string

Inherited from Sprite

A stroke-dasharray for the stroke (outline).

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

Click here for more info on stroke-dasharray

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.

Click here for more info on stroke-dashoffset

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

Inherited from Sprite

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

Click here for more info on stroke-linecap

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

Inherited from Sprite

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

Click here for more info on stroke-linejoin

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.

Type number

Inherited from Sprite

Stroke (outline) opacity.

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

Type number

Inherited from Sprite

Stroke (outline) thickness in pixels.

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.

Type ISwipeOptions

Inherited from Sprite

Returns element's swipe gesture options.

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.

Type number

Inherited from Sprite

Sets or returns TAB index.

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.

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.

Type $type.Optional < Tooltip >

Inherited from Sprite

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

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.

Tooltip
Sprite

Type DataItem

Inherited from Sprite

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

Tooltip
DataItem

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.

Type "fixed" | "pointer"

Inherited from Sprite

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

Position

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.

TextFormatter

Type number | Percent

Inherited from Sprite

X coordinate the Tooltip should be shown at.

Type number | Percent

Inherited from Sprite

Y coordinate the Tooltip should be shown at.

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.

Type string

Inherited from BaseObject

Returns object's internal unique ID.

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()}"
    }
  }]
}

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.

Type string

Inherited from Sprite

A custom class name to set on the element.

If set, the value will be added to element's class attribute.

@since 4.9.11

Type VerticalAlign

Inherited from Sprite

Controls vertical alignment of the element.

This is used by parent Container when layouting its children.

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.

Type boolean

Inherited from Sprite

Indicates if element is current visible (true) or hidden (false).

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.

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.

NOTE: width is an accessor, which allows setting width in pixels or percent. It is a sort of a "shortcut" for the users. Actual renderer does not ever use it. It uses either pixelWidth or percentWidth, so if you need to add an adapter for width add it for either of the two properties - whichever suits your requirements.

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.

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.

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