ISpriteEvents

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

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

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

Invoked just before Sprite is disposed.

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

Invoked before Sprite is validated.

@todo Description (check)

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

Invoked when sprite is disabled

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

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

Param SpritePointerTypeEvent & SpriteShiftEvent & SpritePointEvent & { event: MouseEvent | TouchEvent | KeyboardEvent,
  startPoint: IPoint,
  type: "dragged",
  target: Target }

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.

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

Invoked when sprite is enabled

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

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

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

Invoked when visible Sprite is hidden.

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

Invoked when Sprite is clicked or touched.

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

Invoked when Sprite is initialized.

Param { previousHeight: number,
  previousWidth: number,
  type: "maxsizechanged",
  target: Target }

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

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

Invoked when a sprite is added to a parent

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

Invoked when position of the Sprite changes.

Param { property: string,
  type: "propertychanged",
  target: Target }

Invoked when property of the Sprite changes.

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

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.

Param { type: "removedfromqueue",
  target: Target }

Invoked when chart is shown if am4core.options.queue = true or/and am4core.options.onlyShowOnViewport = true.

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

Invoked when hidden Sprite is shown.

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

Invoked when size of the Sprite changes.

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

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

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

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

Param { dummyData: string,
  type: "transformed",
  target: Target }

@todo Description

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

Invoked when Sprite completes transition to a SpriteState.

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

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

@todo Description (check)

Param { visible: boolean,
  type: "visibilitychanged",
  target: Target }

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

Param SpritePointEvent & SpriteShiftEvent & { event: WheelEvent,
  type: "wheel",
  target: Target }

Invoked when user turns mouse wheel while over the Sprite.

Param SpritePointEvent & SpriteShiftEvent & { event: WheelEvent,
  type: "wheeldown",
  target: Target }

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

Param SpritePointEvent & SpriteShiftEvent & { event: WheelEvent,
  type: "wheelleft",
  target: Target }

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

Param SpritePointEvent & SpriteShiftEvent & { event: WheelEvent,
  type: "wheelright",
  target: Target }

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

Param SpritePointEvent & SpriteShiftEvent & { event: WheelEvent,
  type: "wheelup",
  target: Target }

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

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

Invoked when zIndex of a sprite is changed