Sprite

Type class

Base class of all visual elements.

Sources

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

TypeScript
JavaScript

// Import Sprite
import * as am5 from "@amcharts/amcharts5";

// Create Sprite
am5.Sprite.new(root, {
  // ... config if applicable
});

<!-- Load Sprite -->
<script src="index.js"></script>

<script>
// Create Sprite
am5.Sprite.new(root, {
  // ... config if applicable
});
</script>

Inheritance

Sprite extends Entity.

Sprite is extended by Container, Graphics, Picture.

Settings

Set these settings on a Sprite object using its set() and setAll() methods. Read about settings concept.

active

Type undefined | false | true

Applies the element's "active" state while true.

appearDelay

Type undefined | numberDefault 0Since 5.21.0

Milliseconds to wait before the autoAppear animation starts. The element stays hidden until then.

appearDuration

Type undefined | numberSince 5.21.0

Duration of the autoAppear animation, in milliseconds. Without it, the element's stateAnimationDuration is used.

ariaChecked

Type undefined | false | true

aria-checked setting.

This setting is ignored unless role is one of the following:

"checkbox"
"option"
"radio"
"menuitemcheckbox"
"menuitemradio"
"treeitem" On a toggle "button" (one with toggleKey) it is exposed as aria-pressed.

ariaControls

Type undefined | string

aria-controls setting.

ariaCurrent

Type undefined | stringSince 5.9.8

aria-current setting.

More info: https://w3c.github.io/aria/#aria-current

ariaExpanded

Type undefined | false | trueSince 5.21.0

aria-expanded setting: whether the content the element shows or hides (e.g. a task's subtasks, a node's children) is shown.

More info: https://w3c.github.io/aria/#aria-expanded

ariaHidden

Type undefined | false | true

aria-hidden setting.

ariaLabel

Type undefined | string

Label for the element to use for screen readers.

More info: Accessibility: screen reader

ariaLive

Type AriaLive

aria-live setting.

ariaOrientation

Type undefined | string

aria-orientation setting.

ariaSelected

Type undefined | false | trueSince 5.9.8

aria-selected setting.

More info: https://w3c.github.io/aria/#aria-selected

ariaValueMax

Type undefined | string

aria-valuemax setting.

ariaValueMin

Type undefined | string

aria-valuemin setting.

ariaValueNow

Type undefined | string

aria-valuenow setting.

ariaValueText

Type undefined | string

aria-valuetext setting.

autoAppear

Type undefined | false | trueDefault falseSince 5.21.0

Plays the element's reveal animation, as appear() does, when it is first drawn: a chart fades in, a series grows its columns or lines from the base. A series waits for its first data. It plays once: data updates do not replay it, but turning the setting off and on again does.

Elements made from a template play as each one is made.

An element that starts hidden (visible: false, or hidden in code before it is drawn) stays hidden. An animations entry on the same setting, such as a pulsing opacity, keeps playing.

This is how a JSON config gets the opening animation, as a config cannot call appear().

chart.setAll({ autoAppear: true, appearDuration: 1000, appearDelay: 100 });
series.setAll({ autoAppear: true, appearDuration: 1000 });

chart.setAll({ autoAppear: true, appearDuration: 1000, appearDelay: 100 });
series.setAll({ autoAppear: true, appearDuration: 1000 });

More info: Animations

blur

Type undefined | numberSince 5.5.0

Blur radius in pixels, from 0 (no blur) up.

IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

brightness

Type undefined | numberSince 5.5.0

Brightness.

0 - completely black
1 - no changes (default)
>1 - brighter IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

centerX

Type number | Percent

The point of the element that is placed at its x position, and that it rotates and scales around: pixels from its left edge, or a percent of its width.

centerY

Type number | Percent

The point of the element that is placed at its y position, and that it rotates and scales around: pixels from its top edge, or a percent of its height.

clickAnnounceText

Type undefined | stringSince 5.10.8

If set, the text will be read out (announced) by a screen reader when focused element is "clicked" (by pressing ENTER or SPACE).

contrast

Type undefined | numberSince 5.5.0

Contrast.

0 - completely gray
1 - no changes (default)
>1 - more contrast IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

crisp

Type undefined | false | trueDefault falseSince 5.3.0

Draws the element sharply, with minimal anti-aliasing: its position is rounded to whole pixels, and strokeWidth is adjusted to the device pixel ratio, so lines may look thinner than expected.

NOTE: it may not work well on several elements that are meant to fit together exactly.

cursorOverStyle

Type undefined | string

CSS cursor to show while the pointer is over the element, e.g.

"pointer".

More info: https://developer.mozilla.org/en-US/docs/Web/CSS/cursor

dateFormatter

Type DateFormatter | undefined

A DateFormatter to use for this element instead of the root's.

More info: /v5/concepts/using-formatters/

disabled

Type undefined | false | true

Applies the element's "disabled" state while true. It changes only the look: the element still responds to the pointer.

draggable

Type undefined | false | true

Lets the user drag the element. Touches that start on it no longer scroll the page.

durationFormatter

Type DurationFormatter | undefined

A DurationFormatter to use for this element instead of the root's.

More info: /v5/concepts/using-formatters/

dx

Type undefined | number

Horizontal shift in pixels. Can be negative to shift leftward.

dy

Type undefined | number

Vertical shift in pixels. Can be negative to shift upward.

exportable

Type undefined | false | true

If false, the element is left out of exported images of the chart.

focusable

Type undefined | false | true

Can element be focused, i.e. selected using TAB key.

More info: Accessibility: focusing elements

focusableGroup

Type string | numberSince 5.0.6

An identifier by which to group common elements into focusable groups.

If set, only the first element in he group will be focusable via TAB key.

When it is selected, the rest of the elements in the same group can be selected using arrow keys.

It allows users to TAB-through chart elements quickly without the need to TAB into each and every element.

It's up to implementer of the charts to provide meaningful ariaLabel to the element, which advertises this capability and provides adequate instructions.

More info: Accessibility: grouping focusable elements

forceHidden

Type undefined | false | true

Hides the element whatever its visible setting, even when show() is called.

forceInactive

Type undefined | false | trueSince 5.0.21

Makes the element and its children ignore the pointer, even with interactive: true or event listeners set.

height

Type number | Percent | null

Height in pixels, or a Percent of the parent's inner height. In a vertical layout, a percent height is a share of the height the other children leave.

hoverOnFocus

Type undefined | false | true

Simulate hover on an element when it gains focus, including changing hover appearance and displaying a tooltip if applicable.

More info: Accessibility: focusing elements

hue

Type undefined | numberSince 5.5.0

Rotates the hue of all colors by this many degrees, from 0 to 360.

IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

interactive

Type undefined | false | true

Makes the element respond to the pointer. Adding a pointer event listener to it turns this on.

invert

Type undefined | numberSince 5.5.0

Color inversion, from 0 (no changes) to 1 (fully inverted colors).

IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

isMeasured

Type undefined | false | trueDefault true

If false, the element's bounds are not measured, so it takes no part in its parent's layout or size.

layer

Type undefined | number

Layer to draw the element on: elements on higher layers show in front of those on lower ones. If not set, the element is on its parent's layer.

layerMargin

Type IMarginSince @5.2.39

Margins in pixels that make the element's layer larger than the chart, or, when negative, smaller.

marginBottom

Type undefined | number

Bottom margin in pixels.

marginLeft

Type undefined | number

Left margin in pixels.

marginRight

Type undefined | number

Right margin in pixels.

marginTop

Type undefined | number

Top margin in pixels.

maxHeight

Type number | null

Maximum allowed height in pixels.

maxWidth

Type number | null

Maximum allowed width in pixels.

minHeight

Type number | null

Minimum allowed height in pixels.

minWidth

Type number | null

Minimum allowed width in pixels.

numberFormatter

Type NumberFormatter | undefined

A NumberFormatter to use for this element instead of the root's.

More info: /v5/concepts/using-formatters/

opacity

Type undefined | numberDefault 1

Opacity, from 0 (transparent) to 1 (opaque).

The theme's "default" state has opacity: 1, so show(), and leaving a state that changes opacity, bring it back to 1, not to a value set here. To come back to another value, set it in the "default" state too:

sprite.states.create("default", { opacity: 0.5 }).

position

Type "absolute" | "relative"Default "relative"

Positioning of the element.

"absolute" leaves the element out of its parent's layout and size: it is placed by its x and y only.

role

Type Role

Element's role.

More info: Accessibility: roles

rotation

Type undefined | numberDefault 0

Rotation in degrees, clockwise, around the point set by centerX and centerY.

saturate

Type undefined | numberSince 5.5.0

Saturation.

0 - grayscale
1 - no changes (default)
>1 - more saturated IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

scale

Type undefined | numberDefault 1

Scale, around the point set by centerX and centerY: below 1 shrinks the element, above 1 enlarges it.

sepia

Type undefined | numberSince 5.5.0

Sepia tone, from 0 (no changes) to 1 (full sepia).

IMPORTANT: This setting is not supported in Safari browsers.

More info: Filters

showTooltipOn

Type "hover" | "always" | "click"Default "hover"Since 5.0.16

When the element's tooltip shows:

"hover" (default) - while the pointer is over the element, or after a tap on it until a tap elsewhere.
"always" - all the time. To show tooltips of several elements at once, give each its own Tooltip (tooltip).
"click" - after a click or tap on the element, until a click anywhere else on the page.

More info: Tooltips: sticky tooltips

tabindexOrder

Type undefined | number

An internal order by which focusable elements will be selected within the chart.

More info: Accessibility: focusing elements

templateField

Type undefined | string

Field in the data item's data object that holds settings for this element, applied over its template's.

More info: Template fields

toggleKey

Type "disabled" | "active" | "none" | undefined

Setting that a click or tap toggles between true and false:

"active" or "disabled". "none" turns toggling off.

tooltip

Type Tooltip

The Tooltip to show for the element. If not set, the nearest parent's is used.

tooltipHTML

Type undefined | stringSince 5.2.11

HTML content of the element's tooltip, shown in place of tooltipText.

tooltipPosition

Type "fixed" | "pointer"Default "fixed"

Where the tooltip points: "fixed" at tooltipX and tooltipY, or "pointer" at the pointer, following it.

tooltipText

Type undefined | string

Text of the element's tooltip. It can hold data placeholders, such as {value}.

tooltipX

Type number | PercentDefault am5.percent(50)

Where on the element the tooltip points, horizontally: pixels from its left edge, or a percent of its width.

tooltipY

Type number | PercentDefault am5.percent(50)

Where on the element the tooltip points, vertically: pixels from its top edge, or a percent of its height.

visible

Type undefined | false | trueDefault true

Whether the element is shown. Unlike show() and hide(), it does not animate.

wheelable

Type undefined | false | true

Makes the element receive mouse wheel events. While the pointer is over it, the wheel no longer scrolls the page.

width

Type number | Percent | null

Width in pixels, or a Percent of the parent's inner width. In a horizontal layout, a percent width is a share of the width the other children leave.

x

Type number | Percent | null

X position in the parent: pixels from its left edge, or a Percent of its inner width, measured from inside its left padding.

y

Type number | Percent | null

Y position in the parent: pixels from its top edge, or a Percent of its inner height, measured from inside its top padding.

9 inherited items

animations

Type ArrayInherited from IEntitySettingsSince 5.20.8

Animations the element plays on its own, described as data - so they can be set from a JSON config and saved with it.

Each one animates a setting of the element (or, with target: "dataItem", a value of its data item - a map point's positionOnLine, say). They start when the setting is applied, restart when it changes, and stop when the element is disposed. A saved config keeps what was configured, never a value caught half way through an animation.

sprite.set("animations", [
  { key: "rotation", to: 360, duration: 4000, loops: 0 },
  { key: "scale", from: 1, to: 1.3, duration: 800, loops: 0, yoyo: true, easing: "sine" }
]);

id

Type undefined | stringInherited from IEntitySettings

A unique ID for looking the element up in root.entitiesById. Setting an ID that another element already has throws an error.

ignoreThemes

Type undefined | false | trueDefault falseInherited from IEntitySettingsSince 5.15.6

Ignores themes: no theme rule applies to the element, not even one of the default theme.

stateAnimationDuration

Type undefined | numberDefault 0Inherited from IEntitySettings

How long, in milliseconds, a switch from one state to another animates.

0 switches at once.

stateAnimationEasing

Type $ease.EasingDefault out(cubic)Inherited from IEntitySettings

Easing of the animated switch from one state to another.

themes

Type ArrayInherited from IEntitySettings

Themes applied to the element and everything inside it.

themeTags

Type ArrayInherited from IEntitySettings

Tags that theme rules can target. They also count for the element's children, so a rule can match a child by a tag of its parent.

More info: Themes

themeTagsSelf

Type ArrayInherited from IEntitySettings

Tags that theme rules can target, like themeTags, but only for this element, not its children.

More info: Themes

userData

Type anyInherited from IEntitySettings

Any data of your own to keep with the element.

Private settings

These are read-only settings accessible from a Sprite object using its getPrivate() method. Read about private settings.

focusable

Read onlyType undefined | false | trueSince 5.3.16

If set to false, its tabindex will be set to -1, so it does not get focused with TAB, regardless whether its public setting focusable is set to true.

lastTooltipCoords

Read onlyType IPointSince 5.11.3

The last point the tooltip was shown at, so it is not shown again at the same place.

showingTooltip

Read onlyType undefined | false | true

true while the element shows its tooltip.

tooltipTarget

Read onlyType Graphics

An element whose tooltip point and colors the tooltip uses, in place of this element's.

trustBounds

Read onlyType undefined | false | trueSince 5.5.0

Checks that the pointer is within the element's bounds before dispatching "pointerover". This prevents ghost tooltips that sometimes appear while the pointer moves over interactive elements.

It is true by default on Rectangle and Circle.

Properties

className

StaticType stringDefault "Sprite"

classNames

StaticType ArrayDefault Entity.classNames.concat([Sprite.className])

dataItem

Type DataItem | undefined

The element's DataItem, or, if it has none, its nearest parent's.

NOTE: data items are assigned automatically in most cases where it matters. Set one only if you know what you are doing.

events

Type SpriteEventDispatcher

parent

Type Container | undefined

Parent Container of this element.

virtualParent

Type Container | undefined

6 inherited items

adapters

Type AdaptersDefault new Adapters(this)Inherited from Entity

enableDispose

Type booleanDefault trueInherited from Settings

Set to false to make dispose() do nothing.

root

Type RootInherited from EntitySince 5.0.6

The Root the object belongs to.

states

Type StatesDefault new States(this)Inherited from Entity

template

Type Template | undefinedInherited from Entity

A Template applied to the object. Its settings apply where the object has none set of its own.

uid

Type numberDefault ++counterInherited from Settings

A unique number, given to each object as it is created.

Methods

appear(duration?: undefined | number, delay?: undefined | number)

Returns Promise

Plays the reveal animation: hides the element at once, then shows it, whether it was hidden or not.

compositeOpacity()

Returns numberSince 5.2.11

Returns the element's opacity multiplied by those of all its parents.

compositeRotation()

Returns numberSince 5.9.2

Returns the element's rotation plus those of all its parents, in degrees.

compositeScale()

Returns numberSince 5.9.2

Returns the element's scale multiplied by those of all its parents.

depth()

Returns number

Returns how deep the element is in the tree: the number of parents it has.

getDateFormatter()

Returns DateFormatter

Returns the DateFormatter of the element: its own dateFormatter, or else the one of the Root.

More info: /v5/concepts/using-formatters/

getDurationFormatter()

Returns DurationFormatter

Returns the DurationFormatter of the element: its own durationFormatter, or else the one of the Root.

More info: /v5/concepts/using-formatters/

getNumberFormatter()

Returns NumberFormatter

Returns the NumberFormatter of the element: its own numberFormatter, or else the one of the Root.

More info: /v5/concepts/using-formatters/

getTooltip()

Returns Tooltip | undefined

Returns the element's Tooltip: its own tooltip, or else the nearest parent's.

height()

Returns number

Returns the element's height in pixels.

hide(duration?: undefined | number)

Returns Promise

Hides the element and returns a Promise that resolves when its hiding animations finish.

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

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

hideTooltip()

Returns Promise | undefined

Hides the element's Tooltip.

hover()

Returns void

Hovers the element as if the pointer were over it: applies its hover state and shows its tooltip.

isDragging()

Returns boolean

Returns true while the element is being dragged.

isFocus()

Returns boolean

Returns true if this element does currently have focus.

isHidden()

Returns boolean

Returns true if the element was hidden with hide(), even while its hiding animation still plays. For the visible setting, use isVisible().

isHiding()

Returns boolean

Returns true while the element's hiding animation plays.

isHover()

Returns boolean

Returns true if the pointer is over the element.

isShowing()

Returns boolean

Returns true while the element's showing animation plays.

isVisible()

Returns boolean

Returns false if either the public or the private setting visible is false, or forceHidden is true.

isVisibleDeep()

Returns booleanSince 5.2.7

Same as isVisible(), except it checks all ascendants, too.

markDirtyKey(key: Key)

Returns void

Marks a setting as changed, so the element reads it again, running its adapters, on the next frame.

maxHeight()

Returns number

Returns the most height the element may take, in pixels: its maxHeight, a fixed height, or else its parent's inner height.

maxWidth()

Returns number

Returns the most width the element may take, in pixels: its maxWidth, a fixed width, or else its parent's inner width.

show(duration?: undefined | number)

Returns Promise

Shows the element and returns a Promise that resolves when its showing animations finish.

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

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

showTooltip(point?: IPoint)

Returns Promise | undefined

Shows the element's Tooltip. Does nothing if the element has no tooltipText or tooltipHTML.

toBack()

Returns void

Moves the element to the start of its parent's children, so it is drawn under its siblings, or, in a layout, placed first.

toFront()

Returns void

Moves the element to the end of its parent's children, so it is drawn over its siblings, or, in a layout, placed last.

toGlobal(point: IPoint)

Returns IPoint

Converts a point within the element to a point relative to the root.

toLocal(point: IPoint)

Returns IPoint

Converts a point relative to the root to a point within the element.

unhover()

Returns void

Ends a hover, as if the pointer left the element: hides its tooltip and takes it out of its hover state.

width()

Returns number

Returns the element's width in pixels.

x()

Returns number

Returns the element's X position in pixels, relative to its parent, without dx.

y()

Returns number

Returns the element's Y position in pixels, relative to its parent, without dy.

22 inherited items

animate(options: AnimationOptions)

Returns AnimationInherited from Settings

Animates a setting from its current value (or from) to to. The setting jumps to from at once. With duration 0, or no value to start from, it is set to to at once and the returned animation is already stopped.

More info: Animations: animating settings

dispose()

Returns voidInherited from Settings

Disposes the object, freeing everything it holds. A disposed object can't be used again.

get(key: Key, fallback: F)

Returns NonNullable | FInherited from Entity

Returns the value of setting key, run through any adapters, or fallback if it is not set.

More info: Settings

has(key: Key)

Returns booleanInherited from Settings

Returns true if setting key is set.

More info: Settings

isDisposed()

Returns booleanInherited from Settings

Returns true if the object has been disposed.

isType(type: string)

Returns thisInherited from Entity

Returns true if the object is of class type or extends it.

new(root: Root, settings: ITSettings, template?: Template)

StaticReturns TInherited from Entity

Creates an instance of the class. Use it instead of new Class().

More info: Getting started: new element syntax

off(key: Key, callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with on(). Without callback, removes all of them for key.

More info: Events: settings value change

offDebounced(key: Key, callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from Settings

Removes a callback added with onDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

offDebouncedPrivate(key: Key, callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from Settings

Removes a callback added with onPrivateDebounced(). Without callback, removes all of them for key.

More info: Events: settings value change

offPrivate(key: Key, callback?: undefined | (value: [""], target: this, key: Key) => void)

Returns voidInherited from SettingsSince 5.9.2

Removes a callback added with onPrivate(). Without callback, removes all of them for key.

More info: Events: settings value change

on(key: Key, callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from Settings

Calls callback each time the value of setting key changes or is removed. Setting the same value again does not call it.

More info: Events: settings value change

once(key: Key, callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from SettingsSince 5.20.4

Like on(), but the callback is removed after it is called once.

More info: Events: settings value change

onceDebounced(key: Key, callback: (value: [""], target: this, key: Key) => void, debounceDelay: number)

Returns IDisposerInherited from SettingsSince 5.20.4

Like onDebounced(), but the callback is removed after it is called once.

More info: Events: settings value change

onDebounced(key: Key, callback: (value: [""], target: this, key: Key) => void, debounceDelay: number)

Returns IDisposerInherited from Settings

Like on(), but waits until setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

onPrivate(key: Key, callback: (value: [""], target: this, key: Key) => void)

Returns IDisposerInherited from Settings

Calls callback each time the value of private setting key changes.

More info: Events: settings value change

onPrivateDebounced(key: Key, callback: (value: [""], target: this, key: Key) => void, debounceDelay: number)

Returns IDisposerInherited from Settings

Like onPrivate(), but waits until private setting key has not changed for debounceDelay milliseconds, then calls callback once with the latest value.

More info: Events: settings value change

remove(key: Key)

Returns voidInherited from Entity

Removes the value set for setting key. The setting goes back to the value from a theme or template, if one has it.

More info: Settings

removeAll()

Returns voidInherited from Settings

Removes all settings, as remove() does for each one.

More info: Settings

set(key: Key, value: Value)

Returns ValueInherited from Entity

Sets setting key to value and returns value. A value set this way overrides themes and templates, and stops any animation of the setting.

More info: Settings

setAll(settings: Partial)

Returns voidInherited from Settings

Sets several settings at once, from an object of key-value pairs.

More info: Settings

setTimeout(fn: () => void, delay: number)

Returns IDisposerInherited from Entity

Calls fn after delay milliseconds, unless the object is disposed first. Disposing the returned disposer cancels it.

Events

Add event handlers to Sprite object using its events.on() method. Read about adding event handlers.

blur

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

Invoked when element loses focus.

boundschanged

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

The element's bounds changed.

click

Param { type: "click", target: Sprite } & ISpritePointerEvent

The element was clicked or tapped. A press and release more than 5 pixels apart is not a click.

dataitemchanged

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

The element's data item changed.

dblclick

Param { type: "dblclick", target: Sprite } & ISpritePointerEvent

The element was double-clicked or double-tapped. Also dispatched on its parents.

dragged

Param { type: "dragged", target: Sprite } & ISpritePointerEvent

The element moved while being dragged.

dragstart

Param { type: "dragstart", target: Sprite } & ISpritePointerEvent

Dragging of the element started: the pointer moved more than 5 pixels after pressing on it.

dragstop

Param { type: "dragstop", target: Sprite } & ISpritePointerEvent

Dragging of the element stopped.

focus

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

Invoked when element gains focus.

globalpointerdown

Param { type: "globalpointerdown", target: Sprite } & ISpritePointerEvent

A pointer button was pressed, or a touch started, anywhere in the window, even outside the chart.

globalpointermove

Param { type: "globalpointermove", target: Sprite } & ISpritePointerEvent

The pointer moved anywhere in the window, even outside the chart.

globalpointerup

Param { type: "globalpointerup", target: Sprite } & ISpritePointerEvent

A pointer button was released, or a touch ended, anywhere in the window, even outside the chart.

middleclick

Param { type: "middleclick", target: Sprite } & ISpritePointerEvent

The element was clicked with the middle mouse button.

pointerdown

Param { type: "pointerdown", target: Sprite } & ISpritePointerEvent

A pointer button was pressed, or a touch started, over the element. Also dispatched on its parents.

pointerout

Param { type: "pointerout", target: Sprite } & ISpritePointerEvent

The pointer left the element.

pointerover

Param { type: "pointerover", target: Sprite } & ISpritePointerEvent

The pointer moved over the element.

pointerup

Param { type: "pointerup", target: Sprite } & ISpritePointerEvent

A pointer button was released, or a touch ended, over the element.

positionchanged

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

The element's position changed.

rightclick

Param { type: "rightclick", target: Sprite } & ISpritePointerEvent

The element was clicked with the right mouse button.

wheel

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

The mouse wheel turned while the pointer was over the element. Also dispatched on its parents.