MapChart

Type class

Sources

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

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

/**
 * --------------------------------------------------------
 * Import from: "map.ts"
 * Use like: am5map.MapChart
 * --------------------------------------------------------
 */
import * as am5map from "@amcharts/amcharts5/map";

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

/**
 * --------------------------------------------------------
 * Include via: <script src="map.js"></script>
 * Access items like: am5map.MapChart
 * --------------------------------------------------------
 */

Inheritance

MapChart extends SerialChart.

MapChart is not extended by any other symbol.

Settings

Set these settings on a MapChart object using its set() and setAll() methods.

Read about settings concept.

active
#

Type undefined | false | true

Inherited from ISpriteSettings

Indicates if element is currently active.

animationDuration
#

Type undefined | number

Duration of zoom/pan animations, in milliseconds.

animationEasing
#

Type undefined | ( t: Time) => Time

Default am5.ease.out($ease.cubic)

An easing function to use for zoom/pan animations.

Click here for more info

background
#

Type Graphics

Inherited from IContainerSettings

Background element.

Click here for more info

centerMapOnZoomOut
#

Type undefined | false | true

Default true

Setting true means that the map will automatically center itself (or go to homeGeoPoint if set) when fully zoomed out.

false would mean that zoom out will be centered around the mouse cursor (when zooming using wheel), or current map position.

@since 5.2.1

centerX
#

Type number | Percent

Inherited from ISpriteSettings

X coordinate of the center of the element relative to itself.

Center coordinates will affect placement as well as rotation pivot point.

centerY
#

Type number | Percent

Inherited from ISpriteSettings

Y coordinate of the center of the element relative to itself.

Center coordinates will affect placement as well as rotation pivot point.

colors
#

Type ColorSet

Inherited from ISerialChartSettings

A ColorSet to use when asigning colors for series.

Click here for more info

cursorOverStyle
#

Type undefined | string

Inherited from ISpriteSettings

A named mouse cursor style to show when hovering this element.

Click here for more info

dateFormatter
#

Type DateFormatter | undefined

Inherited from ISpriteSettings

An instance of DateFormatter that should be used instead of global formatter object.

Click here for more info

disabled
#

Type undefined | false | true

Inherited from ISpriteSettings

Indicates if element is disabled.

draggable
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true, user will be able to drag this element. It will also disable default drag events over the area of this element.

durationFormatter
#

Type DurationFormatter | undefined

Inherited from ISpriteSettings

An instance of DurationFormatter that should be used instead of global formatter object.

Click here for more info

dx
#

Type undefined | number

Inherited from ISpriteSettings

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

dy
#

Type undefined | number

Inherited from ISpriteSettings

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

exportable
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to false this element will not appear in exported snapshots of the chart.

forceHidden
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true the element will be hidden regardless of visible or even if show() is called.

forceInactive
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true the element will be inactive - absolutely oblivious to all interactions, even if there are related events set, or the interactive: true is set.

@since 5.0.21

height
#

Type number | Percent | null

Inherited from ISpriteSettings

Element's absolute height in pixels (numeric value) or relative height to parent (Percent);

homeGeoPoint
#

Type IGeoPoint

Initial coordinates to center map on load or goHome() call.

Click here for more info

homeZoomLevel
#

Type undefined | number

Initial/home zoom level.

Click here for more info

html
#

Type undefined | string

Inherited from IContainerSettings

HTML content of the container.

Click here for more info
@since 5.2.11

id
#

Type undefined | string

Inherited from IEntitySettings

A custom string ID for the element.

If set, element can be looked up via am5.registry.entitiesById.

Will raise error if an element with the same ID already exists.

interactive
#

Type undefined | false | true

Inherited from ISpriteSettings

Should this element accept user interaction events?

interactiveChildren
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true all descendants - not just direct children, but every element in it - will become "interactive".

isMeasured
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to false element will not be measured and cannot participate in layout schemes.

layer
#

Type undefined | number

Inherited from ISpriteSettings

Numeric layer to put element in.

Elements with higher number will appear in front of the ones with lower numer.

If not set, will inherit layer from its ascendants.

layout
#

Type Layout | null

Inherited from IContainerSettings

A method to layout

Click here for more info

marginBottom
#

Type undefined | number

Inherited from ISpriteSettings

Bottom margin in pixels.

marginLeft
#

Type undefined | number

Inherited from ISpriteSettings

Left margin in pixels.

marginRight
#

Type undefined | number

Inherited from ISpriteSettings

Right margin in pixels.

marginTop
#

Type undefined | number

Inherited from ISpriteSettings

Top margin in pixels.

mask
#

Type Graphics | null

Inherited from IContainerSettings

An element to use as a container's mask (clipping region).

Click here for more info

maskContent
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true all content going outside the bounds of the container will be clipped.

maxHeight
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed height in pixels.

maxPanOut
#

Type undefined | number

Default 0.4

How much of a map can go outside the viewport.

Click here for more info

maxWidth
#

Type number | null

Inherited from ISpriteSettings

Maximum allowed width in pixels.

maxZoomLevel
#

Type undefined | number

Highest zoom level map is allowed to zoom in to.

@deault 32

minHeight
#

Type number | null

Inherited from ISpriteSettings

Minimum allowed height in pixels.

minWidth
#

Type number | null

Inherited from ISpriteSettings

Minimum allowed width in pixels.

minZoomLevel
#

Type undefined | number

Lowest zoom level map is allowed to zoom in to.

@deault 1

numberFormatter
#

Type NumberFormatter | undefined

Inherited from ISpriteSettings

An instance of NumberFormatter that should be used instead of global formatter object.

Click here for more info

opacity
#

Type undefined | number

Inherited from ISpriteSettings

Opacity. 0 - fully transparent; 1 - fully opaque.

paddingBottom
#

Type undefined | number

Inherited from IContainerSettings

Bottom padding in pixels.

paddingLeft
#

Type undefined | number

Inherited from IContainerSettings

Left padding in pixels.

paddingRight
#

Type undefined | number

Inherited from IContainerSettings

Right padding in pixels.

paddingTop
#

Type undefined | number

Inherited from IContainerSettings

Top padding in pixels.

panX
#

Type "none" | "rotateX" | "translateX"

Default "translateX"

Defines what happens when map is being dragged horizontally.

Click here for more info

panY
#

Type "none" | "rotateY" | "translateY"

Default "translateY"

Defines what happens when map is being dragged vertically.

Click here for more info

pinchZoom
#

Type undefined | false | true

Default true

Enables pinch-zooming of the map on multi-touch devices.

Click here for more info

position
#

Type "absolute" | "relative"

Inherited from ISpriteSettings

Positioning of the element.

"absolute" means element will not participate in parent layout scheme, and will be positioned solely accoridng its x and y settings.

projection
#

Type GeoProjection

A projection to use when plotting the map.

Click here for more info

reverseChildren
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true its children will be laid out in opposite order.

@since 5.1.1

rotation
#

Type undefined | number

Inherited from ISpriteSettings

Rotation in degrees.

rotationX
#

Type undefined | number

Horizontal centering of the map.

Click here for more info

rotationY
#

Type undefined | number

Vertical centering of the map.

Click here for more info

rotationZ
#

Type undefined | number

Depth centering of the map.

Click here for more info

scale
#

Type undefined | number

Inherited from ISpriteSettings

Scale.

Setting to a value less than 1 will shrink object.

setStateOnChildren
#

Type undefined | false | true

Inherited from IContainerSettings

If set to true, applying a state on a container will also apply the same state on its children.

Click here for more info

showTooltipOn
#

Type "hover" | "always" | "click"

Default "hover"

Inherited from ISpriteSettings

Defines when tooltip is shown over the element.

Available options:

  • "hover" (default) - tooltip is shown when element is hovered by a pointer or touched. It is hidden as soon as element is not hovered anymore, or touch occurs outside it.
  • "always" - a tooltip will always be shown over the element, without any interactions. Please note that if you need to show tooltips for multiple elements at the same time, you need to explicitly create a Tooltip instance and set element's tooltip setting with it.
  • '"click"' - a tooltip will only appear when target element is clicked/tapped. Tooltip will hide when clicking anywhere else on the page.

Click here for more info
@since 5.0.16

stateAnimationDuration
#

Type undefined | number

Inherited from IEntitySettings

Duration of transition from one state to another.

stateAnimationEasing
#

Type $ease.Easing

Inherited from IEntitySettings

Easing of transition from one state to another.

templateField
#

Type undefined | string

Inherited from ISpriteSettings

Allows binding element's settings to data.

Click here for more info

themeTags
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

Click here for more info

themeTagsSelf
#

Type Array

Inherited from IEntitySettings

Tags which can be used by the theme rules.

These tags only apply to this object, not any children.

Click here for more info

themes
#

Type Array

Inherited from IEntitySettings

A list of themes applied to the element.

toggleKey
#

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

Inherited from ISpriteSettings

If set, element will toggle specified boolean setting between true and false when clicked/touched.

tooltip
#

Type Tooltip

Inherited from ISpriteSettings

Tooltip instance.

tooltipHTML
#

Type undefined | string

Inherited from ISpriteSettings

HTML content to show in a tooltip when hovered.

@since 5.2.11

tooltipPosition
#

Type "fixed" | "pointer"

Inherited from ISpriteSettings

Tooltip position.

tooltipText
#

Type undefined | string

Inherited from ISpriteSettings

Text to show in a tooltip when hovered.

tooltipX
#

Type number | Percent

Inherited from ISpriteSettings

Tooltip pointer X coordinate relative to the element itself.

tooltipY
#

Type number | Percent

Inherited from ISpriteSettings

Tooltip pointer Y coordinate relative to the element itself.

userData
#

Type any

Inherited from IEntitySettings

A storage for any custom user data that needs to be associated with the element.

verticalScrollbar
#

Type Scrollbar

Inherited from IContainerSettings

Setting this to an instance of Scrollbar will enable vertical scrolling of content if it does not fit into the Container.

Click here for more info

visible
#

Type undefined | false | true

Inherited from ISpriteSettings

Is element visible?

wheelDuration
#

Type undefined | number

Duration of mouse-wheel action animation, in milliseconds.

wheelEasing
#

Type undefined | ( t: Time) => Time

Default am5.ease.out($ease.cubic)

An easing function to use for mouse wheel action animations.

Click here for more info

wheelSensitivity
#

Type undefined | number

Default 1

Sensitivity of a mouse wheel.

wheelX
#

Type "none" | "zoom" | "rotateX" | "rotateY"

Default "none"

Defines what happens when mouse wheel is turned horizontally.

Click here for more info

wheelY
#

Type "none" | "zoom" | "rotateX" | "rotateY"

Default "zoom"

Defines what happens when mouse wheel is turned vertically.

Click here for more info

wheelable
#

Type undefined | false | true

Inherited from ISpriteSettings

If set to true, mouse wheel events will be triggered over the element. It will also disable page scrolling using mouse wheel when pointer is over the element.

width
#

Type number | Percent | null

Inherited from ISpriteSettings

Element's absolute width in pixels (numeric value) or relative width to parent (Percent);

x
#

Type number | Percent | null

Inherited from ISpriteSettings

X position relative to parent.

y
#

Type number | Percent | null

Inherited from ISpriteSettings

Y position relative to parent.

zoomControl
#

Type ZoomControl

A ZoomControl instance.

Click here for more info

zoomLevel
#

Type undefined | number

Current zoom level.

zoomStep
#

Type undefined | number

Default 2

Increment zoom level by zoomStep when user zooms in via ZoomControl or API.

There are 65 inherited items currently hidden from this list.

Private settings

These are read-only settings accessible from a MapChart object using its getPrivate() method.

Read about private settings.

htmlElement
#

Read only

Type HTMLDivElement

Inherited from IContainerPrivate

A <div> element used for HTML content of the Container.

showingTooltip
#

Read only

Type undefined | false | true

Inherited from ISpritePrivate

Is element currently showing a tooltip?

tooltipTarget
#

Read only

Type Graphics

Inherited from ISpritePrivate

An element tooltip should inherit its colors from.

There are 3 inherited items currently hidden from this list.

Properties

adapters
#

Type Adapters

Default new Adapters(this)

Inherited from Entity

bulletsContainer
#

Type Container

Default Container.new()

Inherited from Chart

A Container chart places its bullets in.

chartContainer
#

Type Container

Default Container.new()

Inherited from Chart

A Container chart places its elements in.

children
#

Type Children

Default new Children(this)

Inherited from Container

List of Container's child elements.

className
#

Static

Type string

Default "MapChart"

classNames
#

Static

Type Array

Default "MapChart", "SerialChart", "Chart", "Container", "Sprite", "Entity"

dataItem
#

Type DataItem | undefined

Inherited from Sprite

A DataItem used for this element.

NOTE: data item is being assigned automatically in most cases where it matters. Use this accessor to set data item only if you know what you're doing.

events
#

Type SpriteEventDispatcher

Inherited from Sprite

parent
#

Type Container | undefined

Inherited from Sprite

Parent Container of this element.

root
#

Type Root

Inherited from Entity

An instance of Root object.

@readonly
@since 5.0.6

series
#

Type ListAutoDispose

Default new ListAutoDispose()

Inherited from SerialChart

A list of chart's series.

seriesContainer
#

Type Container

Default Container.new()

Inherited from SerialChart

A Container where chart will store all series.

states
#

Type States

Default new States(this)

Inherited from Entity

template
#

Type Template | undefined

Inherited from Entity

@todo needs description

uid
#

Type number

Default ++counter

Inherited from Settings

Unique ID.

There are 13 inherited items currently hidden from this list.

Methods

allChildren()

#

Returns Array

Inherited from Container

animate(

options: AnimationOptions

)

#

Returns Animation

Inherited from Settings

Animates setting values from current/start values to new ones.

Click here for more info

appear(

duration?: undefined | number,
delay?: undefined | number

)

#

Returns Promise

Inherited from Sprite

Plays initial reveal animation regardless if element is currently hidden or visible.

compositeOpacity()

#

Returns number

Inherited from Sprite

Returns an actual opacity of the element, taking into account all parents.

@since 5.2.11

convert(

point: IGeoPoint

)

#

Returns IPoint

Converts latitude/longitude to screen coordinates (X and Y).

depth()

#

Returns number

Inherited from Sprite

Returns depth (how deep in the hierachy of the content tree) of this element.

dispose()

#

Returns void

Inherited from Settings

Disposes this object.

eachChildren(

f: ( child: Sprite) => void

)

#

Returns void

Inherited from Container

geoBounds()

#

Returns void

Returns geographical bounds of the map.

geoCentroid()

#

Returns any

Returns coordinates to geographical center of the map.

geoPoint()

#

Returns any

Returns a geoPoint of the current zoom position.

You can later use it to restore zoom position, e.g.: chart.zoomToGeoPoint(geoPoint, zoomLevel, true).

@since 5.2.19

get(

key: Key,
fallback: F

)

#

Returns NonNullable | F

Inherited from Entity

Returns settings value for the specified key.

If there is no value, fallback is returned instead (if set).

Click here for more info

getArea(

dataItem: DataItem

)

#

Returns number

Returns area of a mapPolygon in square pixels.

getDateFormatter()

#

Returns DateFormatter

Inherited from Sprite

Returns an instance of DateFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getDurationFormatter()

#

Returns DurationFormatter

Inherited from Sprite

Returns an instance of DurationFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getNumberFormatter()

#

Returns NumberFormatter

Inherited from Sprite

Returns an instance of NumberFormatter used in this element.

If this element does not have it set, global one form Root is used.

Click here for more info

getTooltip()

#

Returns Tooltip | undefined

Inherited from Sprite

Returns Tooltip used for this element.

goHome(

duration?: undefined | number

)

#

Returns void

Repositions the map to the "home" zoom level and center coordinates.

Click here for more info

height()

#

Returns number

Inherited from Sprite

Returns height of this element in pixels.

hide(

duration?: undefined | number

)

#

Returns Promise

Inherited from Sprite

Hides the element and returns a Promise which completes when all hiding animations are finished.

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

hideTooltip()

#

Returns void

Inherited from Sprite

Hides element's Tooltip.

homeGeoPoint()

#

Returns IGeoPoint

Returns geographical coordinates for calculated or manual center of the map.

hover()

#

Returns void

Inherited from Sprite

Simulate hover over element.

innerHeight()

#

Returns number

Inherited from Container

Returns container's inner height (height without padding) in pixels.

innerWidth()

#

Returns number

Inherited from Container

Returns container's inner width (width without padding) in pixels.

invert(

point: IPoint

)

#

Returns IGeoPoint

Converts screen coordinates (X and Y) within chart to latitude and longitude.

isDisposed()

#

Returns boolean

Inherited from Settings

Returns true if this element is disposed.

isDragging()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently being dragged.

isFocus()

#

Returns boolean

Inherited from Sprite

Returns true if this element does currently have focus.

isHidden()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently hidden.

isHiding()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently animating to a hidden state.

isHover()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently hovered by a pointer.

isShowing()

#

Returns boolean

Inherited from Sprite

Returns true if this element is currently animating to a default state.

isType(

type: string

)

#

Returns this

Inherited from Entity

Checks if element is of certain class (or inherits one).

isVisible()

#

Returns boolean

Inherited from Sprite

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

isVisibleDeep()

#

Returns boolean

Inherited from Sprite

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

@since 5.2.7

maxHeight()

#

Returns number

Inherited from Sprite

Returns maximum allowed height of this element in pixels.

maxWidth()

#

Returns number

Inherited from Sprite

Returns maximum allowed width of this element in pixels.

new(

root: Root,
settings: ITSettings,
template?: Template

)

#

Static

Returns T

Inherited from Entity

Use this method to create an instance of this class.

Click here for more info

on(

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

)

#

Returns IDisposer

Inherited from Settings

Sets a callback function to invoke when specific key of settings changes or is set.

Click here for more info

remove(

key: Key

)

#

Returns void

Inherited from Entity

Removes a setting value for the specified key.

Click here for more info

removeAll()

#

Returns void

Inherited from Settings

Removes all keys;

Click here for more info

set(

key: Key,
value: Value

)

#

Returns Value

Inherited from Entity

Sets a setting value for the specified key, and returns the same value.

Click here for more info

setAll(

settings: Partial

)

#

Returns void

Inherited from Settings

Sets multiple settings at once.

settings must be an object with key: value pairs.

Click here for more info

setTimeout(

fn: () => void,
delay: number

)

#

Returns IDisposer

Inherited from Entity

Creates and returns a "disposable" timeout.

show(

duration?: undefined | number

)

#

Returns Promise

Inherited from Sprite

Shows currently hidden element and returns a Promise which completes when all showing animations are finished.

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 void

Inherited from Sprite

Shows element's Tooltip.

toBack()

#

Returns void

Inherited from Sprite

Moves sprite to the beginning of the parent's children array.

Depending on layout setting of the parten container, it may effect the positioning or overlapping order of the elements.

toFront()

#

Returns void

Inherited from Sprite

Moves sprite to the end of the parent's children array.

Depending on layout setting of the parten container, it may effect the positioning or overlapping order of the elements.

toGlobal(

point: IPoint

)

#

Returns IPoint

Inherited from Sprite

Converts X/Y coordinate within this element to a global coordinate.

toLocal(

point: IPoint

)

#

Returns IPoint

Inherited from Sprite

Converts global X/Y coordinate to a coordinate within this element.

unhover()

#

Returns void

Inherited from Sprite

Simulate unhover over element.

width()

#

Returns number

Inherited from Sprite

Returns width of this element in pixels.

x()

#

Returns number

Inherited from Sprite

Returns element's actual X position in pixels.

y()

#

Returns number

Inherited from Sprite

Returns element's actual Y position in pixels.

zoomIn()

#

Returns void

Zooms the map in.

zoomOut()

#

Returns void

Zooms the map out.

zoomToGeoBounds(

geoBounds: { bottom: number,
  left: number,
  right: number,
  top: number }
,
duration?: undefined | number

)

#

Returns void

Zoom the map to geographical bounds.

zoomToGeoPoint(

geoPoint: IGeoPoint,
level: number,
center?: undefined | false | true,
duration?: undefined | number

)

#

Returns void

Zooms the map to specific geographical point.

zoomToPoint(

point: IPoint,
level: number,
center?: undefined | false | true,
duration?: undefined | number

)

#

Returns void

Zooms the map to specific screen point.

There are 47 inherited items currently hidden from this list.

Events

Add event handlers to MapChart object using its events.on() method.

Read about adding event handlers.

#blur

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

Inherited from ISpriteEvents

Invoked when element loses focus.

#boundschanged

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

Inherited from ISpriteEvents

Invoked when element's bounds change due to any manipulation to it.

#click

Param { type: "click",
  target: this }

Inherited from ISpriteEvents

Invoked when element is clicked or tapped.

#dataitemchanged

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

Inherited from ISpriteEvents

Invoked when element's data item changes.

#dblclick

Param { type: "dblclick",
  target: this }

Inherited from ISpriteEvents

Invoked when element is doubleclicked or tapped twice quickly.

#dragged

Param { type: "dragged",
  target: this }

Inherited from ISpriteEvents

Invoked when element ois being dragged.

#dragstart

Param { type: "dragstart",
  target: this }

Inherited from ISpriteEvents

Invoked when element dragging starts.

#dragstop

Param { type: "dragstop",
  target: this }

Inherited from ISpriteEvents

Invoked when element dragging stops.

#focus

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

Inherited from ISpriteEvents

Invoked when element gains focus.

#geoboundschanged

Param { type: "geoboundschanged",
  target: this }

Invoked when geo bounds of the map change, usually after map is initialized.

#globalpointermove

Param { type: "globalpointermove",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer is moving anywhere in the window, even outside of the element or even chart area.

#globalpointerup

Param { type: "globalpointerup",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer button is released or touch stops in the window, even outside of the element or even chart area.

#middleclick

Param { type: "middleclick",
  target: this }

Inherited from ISpriteEvents

Invoked when element is clicked with the middle mouse button.

#pointerdown

Param { type: "pointerdown",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer button is pressed or touch starts over the element.

#pointerout

Param { type: "pointerout",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer moves outside the element.

#pointerover

Param { type: "pointerover",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer moves over the element.

#pointerup

Param { type: "pointerup",
  target: this }

Inherited from ISpriteEvents

Invoked when pointer button is released or touch stops over the element.

#positionchanged

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

Inherited from ISpriteEvents

Invoked when element's position (X/Y) changes.

#rightclick

Param { type: "rightclick",
  target: this }

Inherited from ISpriteEvents

Invoked when element is clicked width the right mouse button.

#wheel

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

Inherited from ISpriteEvents

Invoked when mouse wheel is spinned while pointer is over the element.

There are 19 inherited items currently hidden from this list.