ICategoryAxisEvents

Type interface

Defines events for CategoryAxis.

Sources

ICategoryAxisEvents is an interface: it describes a shape of data and is not imported on its own.

Inheritance

ICategoryAxisEvents extends IAxisEvents.

ICategoryAxisEvents is not extended by any other symbol.

Properties

62 inherited items

#appeared

Type objectInherited from ISpriteEvents

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

#beforedatavalidated

Type objectInherited from IComponentEvents

Invoked just before element is validated (after changes).

#beforedisposed

Type objectInherited from ISpriteEvents

Invoked just before Sprite is disposed.

#beforevalidated

Type objectInherited from ISpriteEvents

Invoked before Sprite is validated.

#blur

Type { event: FocusEvent }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.

#childadded

Type { newValue: Sprite }Inherited from IContainerEvents

Invoked when a child Sprite is added to Container.

#childremoved

Type { oldValue: Sprite }Inherited from IContainerEvents

Invoked when a child Sprite is removed from

#dataitemsvalidated

Type objectInherited from IComponentEvents

Invoked when value(s) of the element's data items are validated.

#datarangechanged

Type objectInherited from IComponentEvents

Invoked when range of the currently selected data is validated.

#datavalidated

Type objectInherited from IComponentEvents

Invoked when the raw data for the component changes.

#disabled

Type objectInherited from ISpriteEvents

Invoked when sprite is disabled

#doublehit

Type SpritePointerTypeEvent & SpritePointEvent & SpriteMouseTouchEventInherited from ISpriteEvents

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

#down

Type PointerTypeEvent & PointerEvent & MouseTouchEventInherited from IInteractionObjectEvents

Invoked when the mouse button is pressed or touch starts.

#drag

Type PointerTypeEvent & ShiftEvent & PointEvent & { event: MouseEvent | TouchEvent | KeyboardEvent, startPoint: IPoint }Inherited from IInteractionObjectEvents

Invoked when draggable object is being dragged. (using mouse, touch or keyboard)

#dragged

Type SpritePointerTypeEvent & SpriteShiftEvent & SpritePointEvent & { event: MouseEvent | TouchEvent | KeyboardEvent, startPoint: IPoint }Inherited from ISpriteEvents

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

Type PointerTypeEvent & { event: MouseEvent | TouchEvent | KeyboardEvent }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

Type PointerTypeEvent & { event: MouseTouchEvent | KeyboardEvent }Inherited from IInteractionObjectEvents

Invoked when draggable object is released. This event will not fire if position of the object did not change.

#enabled

Type objectInherited from ISpriteEvents

Invoked when sprite is enabled

#endchanged

Type objectInherited from IComponentEvents

Invoked when end position changesPlease note that endhanged event is dispatched immediately after zoom occurs, so some related properties (e.g. maxZoomed on ValueAxis) might not be yet updated.

Use startendchanged event instead if you need to rely on updated zoom-related values.

#focus

Type { event: FocusEvent }Inherited from IInteractionObjectEvents

Invoked when focusable object gains focus, e.g. by using TAB button.

#globalscalechanged

Type objectInherited from ISpriteEvents

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

#hidden

Type objectInherited from ISpriteEvents

Invoked when visible Sprite is hidden.

#hit

Type SpritePointerTypeEvent & SpritePointEvent & SpriteMouseTouchEventInherited from ISpriteEvents

Invoked when Sprite is clicked or touched.

#inited

Type objectInherited from ISpriteEvents

Invoked when Sprite is initialized.

#input

Type { event: KeyboardEvent }Inherited from IInteractionObjectEvents

Invoked whenever information changes in the textual input elements, like <input>, <textarea>, etc.

#keydown

Type { event: KeyboardEvent }Inherited from IInteractionObjectEvents

Invoked when the key is pressed on the keyboard.

#keypress

Type { event: KeyboardEvent }Inherited from IInteractionObjectEvents

Invoked when the key generates a "press", e.g. pressing and holding a letter key will generate repeated "keypress" events.

#keyup

Type { event: KeyboardEvent }Inherited from IInteractionObjectEvents

Invoked when the key is released on the keyboard.

#layoutvalidated

Type objectInherited from IContainerEvents

invoked when layout of the container is validated

#lengthchanged

Type objectInherited from IAxisEvents

Invoked when available axis lenght changes, e.g. after resizing the whole chart.

#maxsizechanged

Type { previousHeight: number, previousWidth: number }Inherited from ISpriteEvents

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

#out

Type PointerTypeEvent & MouseTouchEvent & PointerEventInherited 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

Type PointerTypeEvent & MouseTouchEvent & PointerEventInherited 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

Type objectInherited from ISpriteEvents

Invoked when a sprite is added to a parent

#positionchanged

Type objectInherited from ISpriteEvents

Invoked when position of the Sprite changes.

#propertychanged

Type { property: string }Inherited from ISpriteEvents

Invoked when property of the Sprite changes.

#rangechangeended

Type objectInherited from IComponentEvents

Invoked when range change animation ends

#rangechangestarted

Type objectInherited from IComponentEvents

Invoked when range change animation starts

#ready

Type objectInherited from ISpriteEvents

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

Type objectInherited from ISpriteEvents

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

#resize

Type PointerTypeEvent & ScaleEvent & MouseTouchEvent & { point1: IPoint, point2: IPoint, startPoint1: IPoint, startPoint2: IPoint }Inherited from IInteractionObjectEvents

Invoked when resizable object is being resized either by mouse or touch pinch gesture.

#rightclick

Type MouseTouchEventInherited from IInteractionObjectEvents

Invoked when right mouse button is clicked on the object.

#shown

Type objectInherited from ISpriteEvents

Invoked when hidden Sprite is shown.

#sizechanged

Type objectInherited from ISpriteEvents

Invoked when size of the Sprite changes.

#startchanged

Type objectInherited from IComponentEvents

Invoked when start position changes.

Please note that startchanged event is dispatched immediately after zoom occurs, so some related properties (e.g. minZoomed on ValueAxis) might not be yet updated.

Use startendchanged event instead if you need to rely on updated zoom-related values.

#startendchanged

Type objectInherited from IComponentEvents

Invoked when start or end position changes, unlike startchanged/endchanged this event is fired not immediately but at the end of a cycle.

#swipe

Type PointerTypeEvent & MouseTouchEventInherited from IInteractionObjectEvents

Invoked when user performs "swiping" gesture (quick horizontal movement) on the object, either using mouse or touch.

#swipeleft

Type PointerTypeEvent & MouseTouchEventInherited from IInteractionObjectEvents

Invoked when user performs "swiping" gesture towards left.

#swiperight

Type PointerTypeEvent & MouseTouchEventInherited from IInteractionObjectEvents

Invoked when user performs "swiping" gesture towards right.

#toggled

Type objectInherited from ISpriteEvents

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

#track

Type SpritePointerTypeEvent & SpritePointEvent & SpritePointerEvent & SpriteMouseTouchEventInherited from ISpriteEvents

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

#transformed

Type { dummyData: string }Inherited from ISpriteEvents

#transitionended

Type objectInherited from ISpriteEvents

Invoked when Sprite completes transition to a SpriteState.

#up

Type PointerTypeEvent & PointerEvent & MouseTouchEventInherited from IInteractionObjectEvents

Invoked when the mouse button is released or touch ends.

#validated

Type objectInherited from ISpriteEvents

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

#visibilitychanged

Type { visible: boolean }Inherited from ISpriteEvents

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

#wheel

Type SpritePointEvent & SpriteShiftEvent & { event: WheelEvent }Inherited from ISpriteEvents

Invoked when user turns mouse wheel while over the Sprite.

#wheeldown

Type SpritePointEvent & SpriteShiftEvent & { event: WheelEvent }Inherited from ISpriteEvents

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

#wheelleft

Type SpritePointEvent & SpriteShiftEvent & { event: WheelEvent }Inherited from ISpriteEvents

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

#wheelright

Type SpritePointEvent & SpriteShiftEvent & { event: WheelEvent }Inherited from ISpriteEvents

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

#wheelup

Type SpritePointEvent & SpriteShiftEvent & { event: WheelEvent }Inherited from ISpriteEvents

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

#zIndexChanged

Type objectInherited from ISpriteEvents

Invoked when zIndex of a sprite is changed