Sprite – amCharts 4 Documentation

Type class

Sprite represents any displayable element.

This is the main class that encapsulates every object on the chart.

If it's an element that is to be displayed on the screen at some point, its class must extend Sprite class.

Sprite class represents the a hierarchical structure. Every object that extends Sprite can have children, that would inherit their properties, such as language, formatters, etc.

SpriteState
ISpriteEvents for a list of available events
ISpriteAdapters for a list of available Adapters

@todo Review child elements that need to go into _disposers

Sources

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

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

/**
 * --------------------------------------------------------
 * Import from: "core.ts"
 * Use like: am4core.Sprite
 * --------------------------------------------------------
 */
import * as am4core from "@amcharts/amcharts4/core";

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

/**
 * --------------------------------------------------------
 * Include via: <script src="core.js"></script>
 * Access items like: am4.Sprite
 * --------------------------------------------------------
 */

Inheritance

Sprite extends BaseObjectEvents.

Sprite is extended by PointedShape, Polyline, Rectangle, Container, Grid, Tick, AxisFill, AxisLine, RoundedRectangle, Line, IWavedShape, Circle, Trapezoid, Triangle, Polygon, Image, Star, ForceDirectedLink.

Properties

adapter #	Type `Adapter` < `this`, `ISpriteAdapters` > Holds Adapter. Click here for more info about Adapters
align #	Type `Align` Controls horizontal alignment of the element. This is used by parent `Container` when layouting its children.
alwaysShowTooltip #	Type `boolean` Default `false` 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
animations #	Type `Array` < `Animation` > Returns a list elements's animations currently being played. If the list has not been initialized it is created.
appeared #	Type `boolean` Default `false` 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` 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.
baseSprite #	Type `$type.Optional` < `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
clickable #	Type `boolean` 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.
cloneTooltip #	Type `boolean` Default `true` 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.
clonedFrom #	Type `$type.Optional` < `this` > Inherited from `BaseObject` Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed.
config #	Type `object` Inherited from `BaseObject` Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc. Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations.
configField #	Type `$type.Optional` < `string` > 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.
contextMenuDisabled #	Type `boolean` Default `false` Should element prevent context menu to be displayed, e.g. when right-clicked?
cursorDownStyle #	Type `Array` < `IStyleProperty` > A shortcut to setting mouse cursor when button is pressed down. Example: series.slices.template.cursorDownStyle = am4core.MouseCursorStyle.grabbing; series.slices.template.cursorDownStyle = am4core.MouseCursorStyle.grabbing; { // ... "series": { // ... "slices": { "cursorDownStyle": "grabbing" } } }
cursorOptions #	Type `ICursorOptions` 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
cursorOverStyle #	Type `Array` < `IStyleProperty` > 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" } } }
dataItem #	Type `$type.Optional` A `DataItem` to use as element's data source. @todo Review type
dateFormatter #	Type `DateFormatter` 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
defaultState #	Type `SpriteState` < `ISpriteProperties`, `ISpriteAdapters` > Returns a `SpriteState` object for "default" state. This is a shortcut to `this.states.getKey("default")`.
disabled #	Type `boolean` Controls if element is disabled. A disabled element is hidden, and is removed from any processing, layout calculations, and generally treated as if it does not exist. The element itself is not destroyed, though. Setting this back to `false`, will "resurrect" the element.
dom #	Type `SVGSVGElement` Returns DOM element reference associated with this element. @readonly
draggable #	Type `boolean` Controls if the element is draggable.
dummyData #	Type `any` A property which you can use to store any data you want.
durationFormatter #	Type `DurationFormatter` 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
dx #	Type `number` A horizontal offset for the element in pixels. Can be negative value for offset to the left.
dy #	Type `number` A vertical offset for the element in pixels. Can be negative value for offset upwards.
element #	Type `Optional` < `AMElement` > The main element for this Sprite, usually an SVG `<g>`. All other sub-elements are created in it.
events #	Type `SpriteEventDispatcher` < `AMEvent` < `this`, `ISpriteEvents` > > Event dispatcher. Click here for more info about Events
exportable #	Type `boolean` Default `true` If set to `false` this element will be omitted when exporting the chart to an image.
exporting #	Type `Export` 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
fill #	Type `$type.Optional` < `Color` \| `Pattern` \| `LinearGradient` \| `RadialGradient` > Element's fill color or pattern.
fillModifier #	Type `ColorModifier` `ColorModifier` that can be used to modify color and pattern of the element's fill, e.g. create gradients.
fillOpacity #	Type `number` Element's fill opacity. Opacity ranges from 0 (fully transparent) to 1 (fully opaque).
filters #	Type `List` < `Filter` > 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.
focusable #	Type `Optional` < `boolean` > Default `undefined (auto)` 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.
globalScale #	Type `number` 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` Holds Sprite's main SVG group (`<g>`) element. Other Sprite's elements are all placed in this group.
height #	Type `number` \| `Percent` 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.
hidden #	Type `boolean` If a sprite has `showOnInit = true`, it will animate from "hidden" to "default" state when initialized. To prevent this but keep `showOnInit = true`, you can set `sprite.hidden = true`.
hiddenState #	Type `SpriteState` < `ISpriteProperties`, `ISpriteAdapters` > Returns a `SpriteState` object for "hidden" state. This is a shortcut to `this.states.getKey("hidden")`.
hitOptions #	Type `IHitOptions` Returns Sprite's click (hit) options. Click (hit) options control things like double-click, timeouts, etc. `IHitOptions` for available options.
horizontalCenter #	Type `HorizontalCenter` Controls which part of the element to treat as a horizontal center. The setting will be used when positioning, resizing and rotating the element.
hoverOnFocus #	Type `boolean` Default `false` 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.
hoverOptions #	Type `IHoverOptions` Returns Sprite's hover options. `IHoverOptions` for available options.
hoverable #	Type `boolean` Default `false` Controls if the element is hoverable (hover events are registered). Use `over` and `out` events, to watch for those respective actions.
htmlContainer #	Type `$type.Optional` < `HTMLElement` > An HTML element to be used when placing wrapper element (`<div>`) for the whole chart. This is the same for all elements within the same chart.
id #	Type `string` 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.
inert #	Type `boolean` Default `false` 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.
inertiaOptions #	Type `Dictionary` < `InertiaTypes`, `IInertiaOptions` > Returns element's options to be used for inertia. This setting is inheritable, meaning that if not set directly, it will search in all its ascendants until very top. Inertia is used only if element's `inert` is set to `true`. "Inert" element, when dragged and released, will carry the momentum of the movement, and will continue moving in the same drag direction, gradually reducing in speed until finally stops. Check `IInertiaOptions` for how you tweak inertia animations.
inited #	Type `boolean` Returns `true` if Sprite has already finished initializing.
innerHeight #	Type `number` Returns element's measured inner height in pixels. Inner height is actual available space for content, e.g. element's height minus vertical padding. @readonly
innerWidth #	Type `number` Returns element's measured inner width in pixels. Inner width is actual available space for content, e.g. element's width minus horizontal padding. @readonly
interactions #	Type `InteractionObject` Returns (creates if necessary) an `InteractionObject` associated with this element. `InteractionObject` is used to attach all kinds of user-interactions to the element, e.g. click/touch, dragging, hovering, and similar events.
interactionsEnabled #	Type `boolean` Setting this to `false` will effectively disable all interactivity on the element.
isActive #	Type `boolean` Indicates if this element is currently active (toggled on) or not (toggled off).
isDown #	Type `boolean` Indicates if this element has any pointers (mouse or touch) pressing down on it.
isDragged #	Type `boolean` Returns indicator if this element is being dragged at the moment.
isFocused #	Type `boolean` Indicates if this element is focused (possibly by tab navigation).
isHidden #	Type `boolean` 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` If `sprite.hide()` is called and we have "hidden" state and `transitionDuration > 0`, we set `isHiding` flag to `true` in order to avoid restarting animations in case `hide()` method is called multiple times.
isHover #	Type `boolean` 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`.
isResized #	Type `boolean` Returns indicator if this element is being resized at the moment.
isShowing #	Type `boolean` Default `false` 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)
keyboardOptions #	Type `IKeyboardOptions` Returns elements keyboard options.
language #	Type `Language` 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.
map #	Type `Dictionary` < `string`, `any` > Returns a `Dictionary` which maps object ids with their respective objects. Can be used to retrieve any object by id, e.g.: console.log(mySprite.map.getKey("myid")); console.log(mySprite.map.getKey("myid"));
marginBottom #	Type `number` \| `Percent` Bottom margin - absolute (px) or relative (`Percent`).
marginLeft #	Type `number` \| `Percent` Left margin - absolute (px) or relative (`Percent`).
marginRight #	Type `number` \| `Percent` Right margin - absolute (px) or relative (`Percent`).
marginTop #	Type `number` \| `Percent` Top margin - absolute (px) or relative (`Percent`).
maxHeight #	Type `number` Maximum allowed height for the element in pixels.
maxWidth #	Type `number` Maximum allowed width for the element in pixels.
measuredHeight #	Type `number` Returns elements's measured height in pixels. A measured height is actual height of contents plus `paddingTop` and `paddingBottom`, relative to sprite parent, meaning that rotation and scale taken into account. @readonly
measuredWidth #	Type `number` 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
minHeight #	Type `Optional` < `number` > Minimum height for the element in pixels. Set to `undefined` to remove the limit.
minWidth #	Type `Optional` < `number` > Minimum width of the element in pixels. Set to `undefined` to remove the limit.
modal #	Type `Optional` < `Modal` > 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
mouseOptions #	Type `IMouseOptions` 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 } } }
nonScaling #	Type `boolean` Controls if element should keep constant size and not scale even if there is space available, or it does not fit.
nonScalingStroke #	Type `boolean` Controls if the element's stroke (outline) should remain keep constant thicnkess and do not scale when the whole element is resized.
numberFormatter #	Type `NumberFormatter` 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
opacity #	Type `number` Element's opacity. Opacity setting can range from 0 (fully transparent) to 1 (fully opaque). ATTENTION: It is highly not recommended to use `opacity` directly on the element. The charts use `opacity` to hide/show elements, so your setting might be lost if element is hidden and then later shown. Instead use methods `hide()` and `show()` to completely toggle off and on the element. Or, use properties `fillOpacity` and `strokeOpacity`, if you need to make the element semi-transparent.
outerHeight #	Type `number` Returns element's measured height plus its top and bottom margins in pixels. @readonly
outerWidth #	Type `number` Returns element's measured width plus its left and right margins in pixels. @readonly
paddingBottom #	Type `number` \| `Percent` Bottom padding - absolute (px) or relative (`Percent`).
paddingLeft #	Type `number` \| `Percent` Left padding - absolute (px) or relative (`Percent`).
paddingRight #	Type `number` \| `Percent` Right padding - absolute (px) or relative (`Percent`).
paddingTop #	Type `number` \| `Percent` Top padding - absolute (px) or relative (`Percent`).
parent #	Type `Optional` < `Container` > Elements' parent `Container`.
path #	Type `string` Path of Sprite element
pixelHeight #	Type `number` Returns element's height in pixels. For actual height use measuredHeight property. @readonly
pixelMarginBottom #	Type `number` Returns current bottom margin in pixels. @readonly
pixelMarginLeft #	Type `number` Returns current left margin in pixels. @readonly
pixelMarginRight #	Type `number` Returns current right margin in pixels. @readonly
pixelMarginTop #	Type `number` Returns current top margin in pixels. @readonly
pixelPaddingBottom #	Type `number` Returns current bottom padding in pixels. @readonly
pixelPaddingLeft #	Type `number` Returns current left padding in pixels. @readonly
pixelPaddingRight #	Type `number` Returns current right padding in pixels. @readonly
pixelPaddingTop #	Type `number` Returns current top padding in pixels. @readonly
pixelPerfect #	Type `boolean` Controls if SVG vectors should be drawn with "pixel" precision, producing perfectly crisp lines on retina displays. Setting this to `true` might improve visual quality, but may have a negative effect on performance. Different elements use different default setting for `pixelPerfect`. We recommend leaving this at their default settings, unless there's a specific need.
pixelWidth #	Type `number` Returns element's width in pixels, if width was set. For actual width use measuredWidth property. @readonly
pixelX #	Type `number` Returns element's current absolute X coordinate in pixels. @readonly
pixelY #	Type `number` Returns element's current absolute Y coordinate in pixels. @readonly
plugins #	Type `List` < `IPlugin` > A list of plugins (objects that implement `IPlugin` interface) attached to this object. @since 4.2.2
popups #	Type `Optional` < `ListTemplate` < `Popup` > > A list of popups for this chart.
properties #	Type `ISpriteProperties` Holds values for Sprite's properties.
propertyFields #	Type `object` 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`
readerDescription #	Type `string` Screen reader description of the element.
readerHidden #	Type `boolean` Controls if element should be hidden from screen readers. Click here for more information
readerOrientation #	Type `string` Orientation of the element. @since 4.7.16
readerTitle #	Type `string` Screen reader title of the element.
readerValueNow #	Type `string` Current value of the element. @since 4.7.16
readerValueText #	Type `string` Text representation of the current value of the element. @since 4.7.16
realFill #	Type `Color` \| `Pattern` \| `LinearGradient` \| `RadialGradient` 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` A reference to a real stroke object. Sometimes might be useful to modify gradient (when fill is color but we have a FillModifier).
relativeMarginBottom #	Type `number` Returns current relative bottom margin. @readonly
relativeMarginLeft #	Type `number` Returns current relative left margin. @readonly
relativeMarginRight #	Type `number` Returns current relative right margin. @readonly
relativeMarginTop #	Type `number` Returns current relative top margin. @readonly
relativePaddingBottom #	Type `number` Returns current relative bottom padding. @readonly
relativePaddingLeft #	Type `number` Returns current relative left padding. @readonly
relativePaddingRight #	Type `number` Returns current relative right padding. @readonly
relativePaddingTop #	Type `number` Returns current relative top padding. @readonly
relativeX #	Type `number` Returns element's current relative X coordinate in `Percent`.
relativeY #	Type `number` Returns element's current relative Y coordinate in `Percent`. @readonly
resizable #	Type `boolean` 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.
role #	Type `Roles` A WAI-ARIA role for the element. Click here for more information on WAI-ARIA roles
rollOutDelay #	Type `number` Default `0` Time in milliseconds after which rollout event happens when user rolls-out of the sprite. This helps to avoid flickering in some cases.
rotation #	Type `number` 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.
rtl #	Type `boolean` 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.
scale #	Type `number` 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.
shapeRendering #	Type `ShapeRendering` Default `"auto"` An SVG-specific `shape-rendering` value. `shape-rendering` controls how vector graphics are drawn and rendered. Click here for more information about `shape-rendering`
shouldClone #	Type `boolean` Default `true` Indicates whether this sprite should be cloned when cloning its parent container. We set this to `false` in those cases when a sprite is created by the class, so that when cloning a duplicate sprite would not appear.
showOnInit #	Type `boolean` If this is set to `true`, Sprite, when inited will be instantly hidden ("hidden" state applied) and then shown ("default" state applied). If your "default" state's `transitionDuration > 0` this will result in initial animation from "hidden" state to "default" state. If you need a Sprite which has `showOnInit = true` not to be shown initially, set `sprite.hidden = true`. Setting `sprite.visible = false` will not prevent the animation and the sprite will be shown.
showSystemTooltip #	Type `boolean` 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 `"hover"` \| `"hit"` \| `"always"` Default `"hover"` 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
states #	Type `DictionaryTemplate` < `string`, `SpriteState` < `ISpriteProperties`, `ISpriteAdapters` > > Returns a collection of element's available `SpriteState` entries. `SpriteState`
stroke #	Type `Color` \| `Pattern` \| `LinearGradient` \| `RadialGradient` Element's stroke (outline) color or pattern.
strokeDasharray #	Type `string` 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`
strokeDashoffset #	Type `number` 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`
strokeLinecap #	Type `"butt"` \| `"square"` \| `"round"` A `stroke-linecap` to indicate how line ends are drawn. Click here for more info on `stroke-linecap`
strokeLinejoin #	Type `"miter"` \| `"round"` \| `"bevel"` A `stroke-linejoin` to indicate how line ends are drawn. Click here for more info on `stroke-linejoin`
strokeModifier #	Type `ColorModifier` `ColorModifier` that can be used to modify color and pattern of the element's stroke (outline), e.g. create gradients.
strokeOpacity #	Type `number` Stroke (outline) opacity. The values may range from 0 (fully transparent) to 1 (fully opaque).
strokeWidth #	Type `number` Stroke (outline) thickness in pixels.
svgContainer #	Type `$type.Optional` < `SVGContainer` > HTML container (`<div>`) which is used to place chart's `<svg>` element in. Sets HTML container to add SVG and other chart elements to.
swipeOptions #	Type `ISwipeOptions` Returns element's swipe gesture options.
swipeable #	Type `boolean` Controls if element is swipeable. Swipable element will invoke `swipe`, `swipeleft` and `swiperight` events, when quick horizontal drag action is performed with either mouse or touch. Please note that combining swipe and drag is possible, however will incur a slight but noticeable delay in drag start.
tabindex #	Type `number` 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.
togglable #	Type `boolean` 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 `$type.Optional` < `Tooltip` > A `Tooltip` object to be used when displayed rollover information for the element.
tooltipColorSource #	Type `$type.Optional` < `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`
tooltipDataItem #	Type `DataItem` A `DataItem` to use when populating content for the element's `Tooltip`. `Tooltip` `DataItem`
tooltipHTML #	Type `string` An HTML template to be used to populate `Tooltip` contents. If element has `tooltipDataItem` or `dataItem` set, this will be parsed for any data values to be replaced with the values from respective data items.
tooltipPosition #	Type `"fixed"` \| `"pointer"` Specifies if `Tooltip` should follow the mouse or touch pointer or stay at the fixed position. Position
tooltipText #	Type `string` 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`
tooltipX #	Type `number` \| `Percent` X coordinate the `Tooltip` should be shown at.
tooltipY #	Type `number` \| `Percent` Y coordinate the `Tooltip` should be shown at.
trackable #	Type `boolean` Indicates if the element is trackable (mouse position over it is reported to event listeners). Will invoke `track` events whenever pointer (cursor) changes position while over element. Please note, touch devices will also invoke `track` events when touch point is moved while holding down on a trackable element.
uid #	Type `string` Inherited from `BaseObject` Returns object's internal unique ID.
url #	Type `$type.Optional` < `string` > Click-through URL for this element. If set, clicking/tapping this element will open the new URL in a target window/tab as set by `urlTarget`. Please note that URL will be parsed by data placeholders in curly brackets, to be populated from data. E.g.: series.columns.template.url = "https://www.google.com/search?q={category.urlEncode()}"; series.columns.template.url = "https://www.google.com/search?q={category.urlEncode()}"; { // ... "series": [{ // ... "columns": { "url": "https://www.google.com/search?q={category.urlEncode()}" } }] }
urlTarget #	Type `string` Target to use for URL clicks: _blank _self (default) _parent _top Name of the window/frame Ignored if `url` is not set.
userClassName #	Type `string` 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
valign #	Type `VerticalAlign` Controls vertical alignment of the element. This is used by parent `Container` when layouting its children.
verticalCenter #	Type `VerticalCenter` Controls which part of the element to treat as a vertical center. The setting will be used when positioning, resizing and rotating the element.
visible #	Type `boolean` Indicates if element is current visible (`true`) or hidden (`false`).
wheelable #	Type `boolean` Indicates if the element can be interacted with mouse wheel. Will invoke `wheel`, `wheelup`, `wheeldown`, `wheelleft`, and `wheelright` events when using mouse wheel over the element.
width #	Type `number` \| `Percent` 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.
x #	Type `number` \| `Percent` Element's absolute or relative X coordinate. If setting both X and Y, please consider using `moveTo()` method instead, as it will be faster to set both coordinates at once.
y #	Type `number` \| `Percent` Element's absolute or relative Y coordinate. If setting both X and Y, please consider using `moveTo()` method instead, as it will be faster to set both coordinates at once.
zIndex #	Type `number` 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".
There are 3 inherited items currently hidden from this list.

Methods

animate( animationOptions: `ISpriteAnimationOptions[]` \| `ISpriteAnimationOptions`, duration: `number`, easing?: ( value: `number`) => `number` ) #	Returns `Animation` Creates and starts an `Animation` with given `animationOptions`. `Animation` for additional information about available options
appear() #	Returns `void` 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` > 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: `this[""]`) => `this[""]` ) #	Returns `void`
clone( cloneId?: `string` ) #	Returns `this` Inherited from `BaseObject` Makes a copy of this object and returns the clone. Try to avoid cloning complex objects like chart, create new instances if you need them.
closeAllPopups() #	Returns `void` Closes all currently open popup windows
closeModal() #	Returns `void` Hides modal window if there is one currently open.
constructor() #	Returns `Sprite` Constructor: Creates initial node Sets default properties Creates required default states Inits accessibility
copyFrom( source: `this` ) #	Returns `void` Copies all parameters from another `Sprite`.
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.
dispose() #	Returns `void` Destroys this object and all related data.
getCurrentThemes() #	Returns `ITheme[]` Returns theme(s) used by this object either set explicitly on this element, inherited from parent, or inherited from `System`.
getPixelX( value: `number` \| `Percent` ) #	Returns `number` 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` 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.
getPropertyValue( propertyName: `Key` ) #	Returns `[""]` 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` 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` 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` Converts element's local coordinates to the coordinates within the main chart container.
hide( duration?: `number` ) #	Returns `$type.Optional` < `Animation` > Hides the element, by applying `hidden` state. Has no effect if element is already hidden. If `duration` is not specified, it will use default. While element is fading out, its `isHiding` property will resolve to `true`. When element is hidden, its `visible` property will resolve to `false`.
hideTooltip( duration?: `number` ) #	Returns `void` Hides element's `Tooltip`. `Tooltip`
hitTest( sprite: `Sprite` ) #	Returns `boolean` Checks if the this element has any of its parts overlapping with another element. @todo Description (review)
insertAfter( sprite: `Sprite` ) #	Returns `Sprite` Insert this element after sibling element.
insertBefore( sprite: `Sprite` ) #	Returns `Sprite` Insert this element before sibling element.
invalidate() #	Returns `void` 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.
isDisposed() #	Returns `boolean` Inherited from `BaseObject` Returns if this object has been already been disposed.
isInTransition() #	Returns `boolean` Returns `true` if Sprite is currently transiting from one state/value to another.
isInteractive() #	Returns `boolean` Returns true if interactions object was created. Mostly used just to avoid creating interactions object if not needed.
isReady() #	Returns `boolean` 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` 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` 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` > Opens a modal window with specific content (`text` parameter) and, optionally, `title`. The `text` parameter can contain HTML content. `Modal` for more information about using Modal windows
openPopup( text: `string`, title?: `string` ) #	Returns `Optional` < `Popup` > 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` Sets padding for the element in pixels.
setPropertyValue( property: `Key`, value: `any`, invalidate?: `boolean`, transform?: `boolean` ) #	Returns `boolean` 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` < `ISpriteProperties`, `ISpriteAdapters` > , transitionDuration?: `number`, easing?: ( value: `number`) => `number` ) #	Returns `$type.Optional` < `Animation` > Applies a `SpriteState` on this element. The first parameter can either be a name 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, i.e. are in the `properties` array. `SpriteState`
setVisibility( value: `boolean` ) #	Returns `void` Sets `visibility` property: `true` - visible `false` - hidden
show( duration?: `number` ) #	Returns `$type.Optional` < `Animation` > Reveals hidden element. Has no effect if element is already visible. If `duration` is not specified, it will use default.
showTooltip( point?: `IPoint` ) #	Returns `boolean` Shows the element's `Tooltip`. A tooltip will be populated using text templates in either `tooltipHTML` or `tooltipText` as well as data in `tooltipDataItem`. `Tooltip`
toBack() #	Returns `void` Moves the element to the very bottom in the element order, so that it appears behind other elements.
toFront() #	Returns `void` Moves the element to the very top in element order, so that it appears in front of other elements.
There are 4 inherited items currently hidden from this list.

animate(

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

)

Returns Animation

Creates and starts an Animation with given animationOptions.

Animation for additional information about available options

appear()

Returns void

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 >

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: this[""]) => this[""]

)

Returns void

clone(

cloneId?: string

)

Returns this

Inherited from BaseObject

Makes a copy of this object and returns the clone. Try to avoid cloning complex objects like chart, create new instances if you need them.

closeAllPopups()

Returns void

Closes all currently open popup windows

closeModal()

Returns void

Hides modal window if there is one currently open.

constructor()

Returns Sprite

Constructor:

Creates initial node
Sets default properties
Creates required default states
Inits accessibility

copyFrom(

source: this

)

Returns void

Copies all parameters from another Sprite.

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.

dispose()

Returns void

Destroys this object and all related data.

getCurrentThemes()

Returns ITheme[]

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

getPixelX(

value: number | Percent

)

Returns number

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

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.

getPropertyValue(

propertyName: Key

)

Returns [""]

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

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

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

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

hide(

duration?: number

)

Returns $type.Optional < Animation >

Hides the element, by applying hidden state.

Has no effect if element is already hidden.

If duration is not specified, it will use default.

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

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

hideTooltip(

duration?: number

)

Returns void

Hides element's Tooltip.

Tooltip

hitTest(

sprite: Sprite

)

Returns boolean

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

@todo Description (review)

insertAfter(

sprite: Sprite

)

Returns Sprite

Insert this element after sibling element.

insertBefore(

sprite: Sprite

)

Returns Sprite

Insert this element before sibling element.

invalidate()

Returns void

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.

isDisposed()

Returns boolean

Inherited from BaseObject

Returns if this object has been already been disposed.

isInTransition()

Returns boolean

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

isInteractive()

Returns boolean

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

isReady()

Returns boolean

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

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

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 >

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

The text parameter can contain HTML content.

Modal for more information about using Modal windows

openPopup(

text: string,
title?: string

)

Returns Optional < Popup >

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

Sets padding for the element in pixels.

setPropertyValue(

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

)

Returns boolean

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 < ISpriteProperties, ISpriteAdapters > ,
transitionDuration?: number,
easing?: ( value: number) => number

)

Returns $type.Optional < Animation >

Applies a SpriteState on this element.

The first parameter can either be a name 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, i.e. are in the properties array.

SpriteState

setVisibility(

value: boolean

)

Returns void

Sets visibility property:

true - visible
false - hidden

show(

duration?: number

)

Returns $type.Optional < Animation >

Reveals hidden element.

Has no effect if element is already visible.

If duration is not specified, it will use default.

showTooltip(

point?: IPoint

)

Returns boolean

Shows the element's Tooltip.

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

Tooltip

toBack()

Returns void

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

toFront()

Returns void

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

There are 4 inherited items currently hidden from this list.

Events

#appeared	Param { type: `"appeared"`, target: `this` } Invoked when `Sprite` appears. Sprite appears when `sprite.appear()` method is called and show animation is finished.
#beforedisposed	Param { type: `"beforedisposed"`, target: `this` } Invoked just before Sprite is disposed.
#beforevalidated	Param { type: `"beforevalidated"`, target: `this` } Invoked before `Sprite` is validated. @todo Description (check)
#blur	Param { event: `FocusEvent`, type: `"blur"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when `focusable` object loses focus, e.g. by clicking outside it or pressing TAB button to focus on the next focusable object.
#disabled	Param { type: `"disabled"`, target: `this` } Invoked when sprite is disabled
#doublehit	Param `SpritePointerTypeEvent` & `SpritePointEvent` & `SpriteMouseTouchEvent` & { type: `"doublehit"`, target: `this` } Invoked when `Sprite` is clicked or touched twice in rapid succession.
#down	Param `PointerTypeEvent` & `PointerEvent` & `MouseTouchEvent` & { type: `"down"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when the mouse button is pressed or touch starts.
#drag	Param `PointerTypeEvent` & `ShiftEvent` & `PointEvent` & { event: `MouseEvent` \| `TouchEvent` \| `KeyboardEvent`, startPoint: `IPoint`, type: `"drag"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when `draggable` object is being dragged. (using mouse, touch or keyboard)
#dragged	Param `SpritePointerTypeEvent` & `SpriteShiftEvent` & `SpritePointEvent` & { event: `MouseEvent` \| `TouchEvent` \| `KeyboardEvent`, startPoint: `IPoint`, type: `"dragged"`, target: `this` } Invoked when `draggable` object is being dragged. (using mouse, touch or keyboard). This is simmilar but different then `"drag"` event in that it kicks in after `"drag"` which modifies `Sprite` coordinates. This allows doing own manipulations and corrections to element positions.
#dragstart	Param `PointerTypeEvent` & { event: `MouseEvent` \| `TouchEvent` \| `KeyboardEvent`, type: `"dragstart"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when `draggable` object dragging starts. This event is not invoked immediatelly after `down`, but only if there's a movement of the pointer.
#dragstop	Param `PointerTypeEvent` & { event: `MouseTouchEvent` \| `KeyboardEvent`, type: `"dragstop"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when `draggable` object is released. This event will not fire if position of the object did not change.
#enabled	Param { type: `"enabled"`, target: `this` } Invoked when sprite is enabled
#focus	Param { event: `FocusEvent`, type: `"focus"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when `focusable` object gains focus, e.g. by using TAB button.
#globalscalechanged	Param { type: `"globalscalechanged"`, target: `this` } Invoked when the global scale changed, meaning that scale of `Sprite` or any of its ascendants changed.
#hidden	Param { type: `"hidden"`, target: `this` } Invoked when visible `Sprite` is hidden.
#hit	Param `SpritePointerTypeEvent` & `SpritePointEvent` & `SpriteMouseTouchEvent` & { type: `"hit"`, target: `this` } Invoked when `Sprite` is clicked or touched.
#inited	Param { type: `"inited"`, target: `this` } Invoked when `Sprite` is initialized.
#input	Param { event: `KeyboardEvent`, type: `"input"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked whenever information changes in the textual input elements, like `<input>`, `<textarea>`, etc.
#keydown	Param { event: `KeyboardEvent`, type: `"keydown"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when the key is pressed on the keyboard.
#keypress	Param { event: `KeyboardEvent`, type: `"keypress"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when the key generates a "press", e.g. pressing and holding a letter key will generate repeated "keypress" events.
#keyup	Param { event: `KeyboardEvent`, type: `"keyup"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when the key is released on the keyboard.
#maxsizechanged	Param { previousHeight: `number`, previousWidth: `number`, type: `"maxsizechanged"`, target: `this` } Invoked when maximum available size of the Sprite changes, i.e. when the size of parent container changes.
#out	Param `PointerTypeEvent` & `MouseTouchEvent` & `PointerEvent` & { type: `"out"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when mouse cursor moves out of `hoverable` object or it is no longer touched. NOTE: this event might not always contains `pointer` parameter as event might be triggered by API?
#over	Param `PointerTypeEvent` & `MouseTouchEvent` & `PointerEvent` & { type: `"over"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when mouse cursor moves over `hoverable` object or it is touched. NOTE: this event might not always contains `pointer` parameter as event might be triggered by API?
#parentset	Param { type: `"parentset"`, target: `this` } Invoked when a sprite is added to a parent
#positionchanged	Param { type: `"positionchanged"`, target: `this` } Invoked when position of the `Sprite` changes.
#propertychanged	Param { property: `string`, type: `"propertychanged"`, target: `this` } Invoked when property of the `Sprite` changes.
#ready	Param { type: `"ready"`, target: `this` } Invoked when `Sprite` is becomes ready, that is it has finished all calculations and building itself. For `Container` object (and all those inheriting it, including charts) this event will fire when all children become ready.
#removedfromqueue	Param { type: `"removedfromqueue"`, target: `this` } Invoked when chart is shown if `am4core.options.queue = true` or/and `am4core.options.onlyShowOnViewport = true`.
#resize	Param `PointerTypeEvent` & `ScaleEvent` & `MouseTouchEvent` & { point1: `IPoint`, point2: `IPoint`, startPoint1: `IPoint`, startPoint2: `IPoint`, type: `"resize"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when `resizable` object is being resized either by mouse or touch pinch gesture.
#rightclick	Param { type: `"rightclick"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when right mouse button is clicked on the object.
#shown	Param { type: `"shown"`, target: `this` } Invoked when hidden `Sprite` is shown.
#sizechanged	Param { type: `"sizechanged"`, target: `this` } Invoked when size of the Sprite changes.
#swipe	Param `PointerTypeEvent` & `MouseTouchEvent` & { type: `"swipe"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when user performs "swiping" gesture (quick horizontal movement) on the object, either using mouse or touch.
#swipeleft	Param `PointerTypeEvent` & `MouseTouchEvent` & { type: `"swipeleft"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when user performs "swiping" gesture towards left.
#swiperight	Param `PointerTypeEvent` & `MouseTouchEvent` & { type: `"swiperight"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when user performs "swiping" gesture towards right.
#toggled	Param { type: `"toggled"`, target: `this` } Invoked when `togglable` Sprite is being toggled on and off. (its `isActive` property is being changed)
#track	Param `SpritePointerTypeEvent` & `SpritePointEvent` & `SpritePointerEvent` & `SpriteMouseTouchEvent` & { type: `"track"`, target: `this` } Invoked when pointer (mouse cursor or touch point) moves over `trackable` `Sprite`.
#transformed	Param { dummyData: `string`, type: `"transformed"`, target: `this` } @todo Description
#transitionended	Param { type: `"transitionended"`, target: `this` } Invoked when Sprite completes transition to a `SpriteState`.
#up	Param `PointerTypeEvent` & `PointerEvent` & `MouseTouchEvent` & { type: `"up"`, target: `this` } Inherited from `IInteractionObjectEvents` Invoked when the mouse button is released or touch ends.
#validated	Param { type: `"validated"`, target: `this` } Invoked when `Sprite` is validated. (on init or after update) @todo Description (check)
#visibilitychanged	Param { visible: `boolean`, type: `"visibilitychanged"`, target: `this` } Invoked when visibility of the `Sprite` changes. (from visible to hidden, and vice versa)
#wheel	Param `SpritePointEvent` & `SpriteShiftEvent` & { event: `WheelEvent`, type: `"wheel"`, target: `this` } Invoked when user turns mouse wheel while over the `Sprite`.
#wheeldown	Param `SpritePointEvent` & `SpriteShiftEvent` & { event: `WheelEvent`, type: `"wheeldown"`, target: `this` } Invoked when user turns mouse wheel downwards while over the `Sprite`.
#wheelleft	Param `SpritePointEvent` & `SpriteShiftEvent` & { event: `WheelEvent`, type: `"wheelleft"`, target: `this` } Invoked when user turns mouse wheel leftwards while over the `Sprite`.
#wheelright	Param `SpritePointEvent` & `SpriteShiftEvent` & { event: `WheelEvent`, type: `"wheelright"`, target: `this` } Invoked when user turns mouse wheel rightwards while over the `Sprite`.
#wheelup	Param `SpritePointEvent` & `SpriteShiftEvent` & { event: `WheelEvent`, type: `"wheelup"`, target: `this` } Invoked when user turns mouse wheel upwards while over the `Sprite`.
#zIndexChanged	Param { type: `"zIndexChanged"`, target: `this` } Invoked when zIndex of a sprite is changed
There are 18 inherited items currently hidden from this list.

Adapters

#align	Param `Align` Inherited from `ISpriteProperties`
#alwaysShowTooltip	Param `boolean` Inherited from `ISpriteProperties`
#clickable	Param `boolean` Inherited from `ISpriteProperties`
#contextMenuDisabled	Param `boolean` Inherited from `ISpriteProperties`
#criticalError	Param `Error`
#cursorOptions	Param `ICursorOptions`
#disabled	Param `boolean` Inherited from `ISpriteProperties`
#draggable	Param `boolean` Inherited from `ISpriteProperties`
#dx	Param `number` Inherited from `ISpriteProperties`
#dy	Param `number` Inherited from `ISpriteProperties`
#fill	Param `Color` \| `LinearGradient` \| `RadialGradient` \| `Pattern` Inherited from `ISpriteProperties`
#fillModifier	Param `ColorModifier` Inherited from `ISpriteProperties`
#fillOpacity	Param `number` Inherited from `ISpriteProperties`
#focusable	Param `boolean` Inherited from `ISpriteProperties`
#globalScale	Param `number`
#height	Param `number` \| `Percent` Inherited from `ISpriteProperties`
#hidden	Param `boolean` Inherited from `ISpriteProperties`
#hitOptions	Param `IHitOptions`
#horizontalCenter	Param `HorizontalCenter` Inherited from `ISpriteProperties`
#hoverOnFocus	Param `boolean` Inherited from `ISpriteProperties`
#hoverOptions	Param `IHoverOptions`
#hoverable	Param `boolean` Inherited from `ISpriteProperties`
#id	Param `string` Inherited from `ISpriteProperties`
#inert	Param `boolean` Inherited from `ISpriteProperties`
#inertiaOptions	Param `Dictionary` < `InertiaTypes`, `IInertiaOptions` >
#innerHeight	Param `number`
#innerWidth	Param `number`
#interactionsEnabled	Param `boolean` Inherited from `ISpriteProperties`
#isActive	Param `boolean` Inherited from `ISpriteProperties`
#isHover	Param `boolean` Inherited from `ISpriteProperties`
#keyboardOptions	Param `IKeyboardOptions`
#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`
#maxHeight	Param `number` Inherited from `ISpriteProperties`
#maxWidth	Param `number` Inherited from `ISpriteProperties`
#maxX	Param `number` Inherited from `ISpriteProperties`
#maxY	Param `number` Inherited from `ISpriteProperties`
#measuredHeight	Param `number`
#measuredWidth	Param `number`
#minHeight	Param `number` Inherited from `ISpriteProperties`
#minWidth	Param `number` Inherited from `ISpriteProperties`
#minX	Param `number` Inherited from `ISpriteProperties`
#minY	Param `number` Inherited from `ISpriteProperties`
#mouseOptions	Param `IMouseOptions`
#nonScaling	Param `boolean` Inherited from `ISpriteProperties`
#nonScalingStroke	Param `boolean` Inherited from `ISpriteProperties`
#opacity	Param `number` Inherited from `ISpriteProperties`
#outerHeight	Param `number`
#outerWidth	Param `number`
#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`
#pixelMarginBottom	Param `number`
#pixelMarginLeft	Param `number`
#pixelMarginRight	Param `number`
#pixelMarginTop	Param `number`
#pixelPerfect	Param `boolean` Inherited from `ISpriteProperties`
#pixelWidth	Param `number`
#pixelX	Param `number`
#pixelY	Param `number`
#populateString	Param `string`
#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`
#relativeMarginBottom	Param `number`
#relativeMarginLeft	Param `number`
#relativeMarginRight	Param `number`
#relativeMarginTop	Param `number`
#relativeWidth	Param `number`
#relativeX	Param `number`
#relativeY	Param `number`
#resizable	Param `boolean` Inherited from `ISpriteProperties`
#role	Param `Roles` Inherited from `ISpriteProperties`
#rotation	Param `number` Inherited from `ISpriteProperties`
#scale	Param `number` Inherited from `ISpriteProperties`
#shapeRendering	Param `ShapeRendering` Inherited from `ISpriteProperties`
#showOnInit	Param `boolean` Inherited from `ISpriteProperties`
#showTooltipOn	Param `"hover"` \| `"hit"` \| `"always"` Inherited from `ISpriteProperties`
#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`
#swipeable	Param `boolean` Inherited from `ISpriteProperties`
#tabindex	Param `number` Inherited from `ISpriteProperties`
#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`
#userClassName	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 89 inherited items currently hidden from this list.