Tick

Type class

A basic Tick class.

A tick is a short dash, mainly connecting an object like axis or slice to it's textual label.

More info: ITickEvents for a list of available events

More info: ITickAdapters for a list of available Adapters

Sources

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

TypeScript

/**
 * Import from: "charts.ts"
 * Use like: am4charts.Tick
 */
import * as am4charts from "@amcharts/amcharts4/charts";

JavaScript

/**
 * Include via: <script src="charts.js"></script>
 * Access items like: am4charts.Tick
 */

Inheritance

Tick extends Sprite.

Tick is extended by AxisTick, FunnelTick, PieTick.

Properties

#length

Type number

Length of the tick in pixels.

171 inherited items

#adapter

Type Adapter <this, ISpriteAdapters>Inherited from Sprite

Holds Adapter.

More info: Adapters about Adapters

#align

Type AlignInherited from Sprite

Controls horizontal alignment of the element.

This is used by parent Container when layouting its children.

#alwaysShowTooltip

Type booleanDefault falseInherited from SpriteSince 4.5.4

Deprecated Use showTooltipOn = "always" instead

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.

#animations

Type Array <Animation>Inherited from Sprite

Returns a list elements's animations currently being played.

If the list has not been initialized it is created.

#appeared

Type booleanDefault falseInherited from Sprite

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.

#applyOnClones

Type booleanDefault falseInherited from Sprite

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>Inherited from 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);
      }
    }
  }
}

#clickable

Type booleanInherited from Sprite

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.

#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.

#cloneTooltip

Type booleanDefault trueInherited from Sprite

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.

#config

Type objectInherited 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>Inherited from Sprite

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 booleanDefault falseInherited from Sprite

Should element prevent context menu to be displayed, e.g. when right-clicked?

#cursorDownStyle

Type Array <IStyleProperty>Inherited from Sprite

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 ICursorOptionsInherited from Sprite

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.

More info: ICursorOptions for a list of available options

#cursorOverStyle

Type Array <IStyleProperty>Inherited from Sprite

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.OptionalInherited from Sprite

A DataItem to use as element's data source.

#dateFormatter

Type DateFormatterInherited from Sprite

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.

More info: DateFormatter on dates formatting

#defaultState

Type SpriteState <ISpriteProperties, ISpriteAdapters>Inherited from Sprite

Returns a SpriteState object for "default" state.

This is a shortcut to this.states.getKey("default").

#disabled

Type booleanInherited from Sprite

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 SVGSVGElementInherited from Sprite

Returns DOM element reference associated with this element.

#draggable

Type booleanInherited from Sprite

Controls if the element is draggable.

#dummyData

Type anyInherited from Sprite

A property which you can use to store any data you want.

#durationFormatter

Type DurationFormatterInherited from Sprite

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.

More info: DurationFormatter on durations

#dx

Type numberInherited from Sprite

A horizontal offset for the element in pixels.

Can be negative value for offset to the left.

#dy

Type numberInherited from Sprite

A vertical offset for the element in pixels.

Can be negative value for offset upwards.

#element

Type Optional <AMElement>Inherited from Sprite

The main element for this Sprite, usually an SVG <g>.

All other sub-elements are created in it.

#events

Type SpriteEventDispatcher <AMEvent <this, ISpriteEvents>>Inherited from Sprite

Event dispatcher.

More info: Event Listeners about Events

#exportable

Type booleanDefault trueInherited from Sprite

If set to false this element will be omitted when exporting the chart to an image.

#exporting

Type ExportInherited from Sprite

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.

More info: Exporting Charts about exporting

#fill

Type $type.Optional <Color | Pattern | LinearGradient | RadialGradient>Inherited from Sprite

Element's fill color or pattern.

#fillModifier

Type ColorModifierInherited from Sprite

ColorModifier that can be used to modify color and pattern of the element's fill, e.g. create gradients.

#fillOpacity

Type numberInherited from Sprite

Element's fill opacity.

Opacity ranges from 0 (fully transparent) to 1 (fully opaque).

#filters

Type List <Filter>Inherited from Sprite

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)Inherited from Sprite

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 numberInherited from Sprite

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)

#group

Type GroupInherited from Sprite

Holds Sprite's main SVG group (<g>) element. Other Sprite's elements are all placed in this group.

#height

Type number | PercentInherited from Sprite

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 booleanInherited from Sprite

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>Inherited from Sprite

Returns a SpriteState object for "hidden" state.

This is a shortcut to this.states.getKey("hidden").

#hitOptions

Type IHitOptionsInherited from Sprite

Returns Sprite's click (hit) options.

Click (hit) options control things like double-click, timeouts, etc.

More info: IHitOptions for available options.

#horizontalCenter

Type HorizontalCenterInherited from Sprite

Controls which part of the element to treat as a horizontal center.

The setting will be used when positioning, resizing and rotating the element.

#hoverable

Type booleanDefault falseInherited from Sprite

Controls if the element is hoverable (hover events are registered).

Use over and out events, to watch for those respective actions.

#hoverOnFocus

Type booleanDefault falseInherited from Sprite

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 IHoverOptionsInherited from Sprite

Returns Sprite's hover options.

More info: IHoverOptions for available options.

#htmlContainer

Type $type.Optional <HTMLElement>Inherited from Sprite

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 stringInherited from Sprite

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 booleanDefault falseInherited from Sprite

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>Inherited from Sprite

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 booleanInherited from Sprite

Returns true if Sprite has already finished initializing.

#innerHeight

Type numberInherited from Sprite

Returns element's measured inner height in pixels.

Inner height is actual available space for content, e.g. element's height minus vertical padding.

#innerWidth

Type numberInherited from Sprite

Returns element's measured inner width in pixels.

Inner width is actual available space for content, e.g. element's width minus horizontal padding.

#interactions

Type InteractionObjectInherited from Sprite

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 booleanInherited from Sprite

Setting this to false will effectively disable all interactivity on the element.

#isActive

Type booleanInherited from Sprite

Indicates if this element is currently active (toggled on) or not (toggled off).

#isDown

Type booleanInherited from Sprite

Indicates if this element has any pointers (mouse or touch) pressing down on it.

#isDragged

Type booleanInherited from Sprite

Returns indicator if this element is being dragged at the moment.

#isFocused

Type booleanInherited from Sprite

Indicates if this element is focused (possibly by tab navigation).

#isHidden

Type booleanInherited from Sprite

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 booleanDefault falseInherited from Sprite

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 booleanInherited from Sprite

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 booleanInherited from Sprite

Returns indicator if this element is being resized at the moment.

#isShowing

Type booleanDefault falseInherited from Sprite

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 IKeyboardOptionsInherited from Sprite

Returns elements keyboard options.

#language

Type LanguageInherited from Sprite

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>Inherited from Sprite

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 | PercentInherited from Sprite

Bottom margin - absolute (px) or relative (Percent).

#marginLeft

Type number | PercentInherited from Sprite

Left margin - absolute (px) or relative (Percent).

#marginRight

Type number | PercentInherited from Sprite

Right margin - absolute (px) or relative (Percent).

#marginTop

Type number | PercentInherited from Sprite

Top margin - absolute (px) or relative (Percent).

#maxHeight

Type numberInherited from Sprite

Maximum allowed height for the element in pixels.

#maxWidth

Type numberInherited from Sprite

Maximum allowed width for the element in pixels.

#measuredHeight

Type numberInherited from Sprite

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.

#measuredWidth

Type numberInherited from Sprite

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.

#minHeight

Type Optional <number>Inherited from Sprite

Minimum height for the element in pixels.

Set to undefined to remove the limit.

#minWidth

Type Optional <number>Inherited from Sprite

Minimum width of the element in pixels.

Set to undefined to remove the limit.

#modal

Type Optional <Modal>Inherited from Sprite

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.

More info: Modalrmation about using Modal windows

#mouseOptions

Type IMouseOptionsInherited from Sprite

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 booleanInherited from Sprite

Controls if element should keep constant size and not scale even if there is space available, or it does not fit.

#nonScalingStroke

Type booleanInherited from Sprite

Controls if the element's stroke (outline) should remain keep constant thicnkess and do not scale when the whole element is resized.

#numberFormatter

Type NumberFormatterInherited from Sprite

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.

More info: NumberFormatter on formatting numbers

#opacity

Type numberInherited from Sprite

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 numberInherited from Sprite

Returns element's measured height plus its top and bottom margins in pixels.

#outerWidth

Type numberInherited from Sprite

Returns element's measured width plus its left and right margins in pixels.

#paddingBottom

Type number | PercentInherited from Sprite

Bottom padding - absolute (px) or relative (Percent).

#paddingLeft

Type number | PercentInherited from Sprite

Left padding - absolute (px) or relative (Percent).

#paddingRight

Type number | PercentInherited from Sprite

Right padding - absolute (px) or relative (Percent).

#paddingTop

Type number | PercentInherited from Sprite

Top padding - absolute (px) or relative (Percent).

#parent

Type Optional <Container>Inherited from Sprite

Elements' parent Container.

#path

Type stringInherited from Sprite

Path of Sprite element

#pixelHeight

Type numberInherited from Sprite

Returns element's height in pixels. For actual height use measuredHeight property.

#pixelMarginBottom

Type numberInherited from Sprite

Returns current bottom margin in pixels.

#pixelMarginLeft

Type numberInherited from Sprite

Returns current left margin in pixels.

#pixelMarginRight

Type numberInherited from Sprite

Returns current right margin in pixels.

#pixelMarginTop

Type numberInherited from Sprite

Returns current top margin in pixels.

#pixelPaddingBottom

Type numberInherited from Sprite

Returns current bottom padding in pixels.

#pixelPaddingLeft

Type numberInherited from Sprite

Returns current left padding in pixels.

#pixelPaddingRight

Type numberInherited from Sprite

Returns current right padding in pixels.

#pixelPaddingTop

Type numberInherited from Sprite

Returns current top padding in pixels.

#pixelPerfect

Type booleanInherited from Sprite

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 numberInherited from Sprite

Returns element's width in pixels, if width was set. For actual width use measuredWidth property.

#pixelX

Type numberInherited from Sprite

Returns element's current absolute X coordinate in pixels.

#pixelY

Type numberInherited from Sprite

Returns element's current absolute Y coordinate in pixels.

#plugins

Type List <IPlugin>Inherited from SpriteSince 4.2.2

A list of plugins (objects that implement IPlugin interface) attached to this object.

#popups

Type Optional <ListTemplate <Popup>>Inherited from Sprite

A list of popups for this chart.

#properties

Type ISpritePropertiesInherited from Sprite

Holds values for Sprite's properties.

#propertyFields

Type objectInherited from Sprite

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.

More info: SpriteState

#readerDescription

Type stringInherited from Sprite

Screen reader description of the element.

#readerHidden

Type booleanInherited from Sprite

Controls if element should be hidden from screen readers.

More info: https://www.w3.org/TR/wai-aria-1.1/#aria-hiddenrmation

#readerOrientation

Type stringInherited from SpriteSince 4.7.16

Orientation of the element.

#readerTitle

Type stringInherited from Sprite

Screen reader title of the element.

#readerValueNow

Type stringInherited from SpriteSince 4.7.16

Current value of the element.

#readerValueText

Type stringInherited from SpriteSince 4.7.16

Text representation of the current value of the element.

#realFill

Type Color | Pattern | LinearGradient | RadialGradientInherited from Sprite

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 | RadialGradientInherited from Sprite

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 numberInherited from Sprite

Returns current relative bottom margin.

#relativeMarginLeft

Type numberInherited from Sprite

Returns current relative left margin.

#relativeMarginRight

Type numberInherited from Sprite

Returns current relative right margin.

#relativeMarginTop

Type numberInherited from Sprite

Returns current relative top margin.

#relativePaddingBottom

Type numberInherited from Sprite

Returns current relative bottom padding.

#relativePaddingLeft

Type numberInherited from Sprite

Returns current relative left padding.

#relativePaddingRight

Type numberInherited from Sprite

Returns current relative right padding.

#relativePaddingTop

Type numberInherited from Sprite

Returns current relative top padding.

#relativeX

Type numberInherited from Sprite

Returns element's current relative X coordinate in Percent.

#relativeY

Type numberInherited from Sprite

Returns element's current relative Y coordinate in Percent.

#resizable

Type booleanInherited from Sprite

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 RolesInherited from Sprite

A WAI-ARIA role for the element.

More info: https://www.w3.org/TR/wai-aria-1.1/#role_definitionsrmation on WAI-ARIA roles

#rollOutDelay

Type numberDefault 0Inherited from Sprite

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 numberInherited from Sprite

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 booleanInherited from Sprite

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 numberInherited from Sprite

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 ShapeRenderingDefault "auto"Inherited from Sprite

An SVG-specific shape-rendering value.

shape-rendering controls how vector graphics are drawn and rendered.

More info: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/shape-renderingrmation about shape-rendering

#shouldClone

Type booleanDefault trueInherited from Sprite

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 booleanInherited from Sprite

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 booleanInherited from Sprite

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"Inherited from SpriteSince 4.7.9

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"
      }
    }
  }]
}

#states

Type DictionaryTemplate <string, SpriteState <ISpriteProperties, ISpriteAdapters>>Inherited from Sprite

Returns a collection of element's available SpriteState entries.

More info: SpriteState

#stroke

Type Color | Pattern | LinearGradient | RadialGradientInherited from Sprite

Element's stroke (outline) color or pattern.

#strokeDasharray

Type stringInherited from Sprite

A stroke-dasharray for the stroke (outline).

"Dasharray" allows setting rules to make lines dashed, dotted, etc.

More info: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray on stroke-dasharray

#strokeDashoffset

Type numberInherited from Sprite

A stroke-dashoffset for the stroke (outline).

"Dashoffset" allows setting the start position of the dashes if strokeDasharray is used.

More info: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dashoffset on stroke-dashoffset

#strokeLinecap

Type "butt" | "square" | "round"Inherited from Sprite

A stroke-linecap to indicate how line ends are drawn.

More info: https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Fills_and_Strokes#Stroke on stroke-linecap

#strokeLinejoin

Type "miter" | "round" | "bevel"Inherited from Sprite

A stroke-linejoin to indicate how line ends are drawn.

More info: https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Fills_and_Strokes#Stroke on stroke-linejoin

#strokeModifier

Type ColorModifierInherited from Sprite

ColorModifier that can be used to modify color and pattern of the element's stroke (outline), e.g. create gradients.

#strokeOpacity

Type numberInherited from Sprite

Stroke (outline) opacity.

The values may range from 0 (fully transparent) to 1 (fully opaque).

#strokeWidth

Type numberInherited from Sprite

Stroke (outline) thickness in pixels.

#svgContainer

Type $type.Optional <SVGContainer>Inherited from Sprite

HTML container (<div>) which is used to place chart's <svg> element in.

Sets HTML container to add SVG and other chart elements to.

#swipeable

Type booleanInherited from Sprite

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.

#swipeOptions

Type ISwipeOptionsInherited from Sprite

Returns element's swipe gesture options.

#tabindex

Type numberInherited from Sprite

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 booleanInherited from Sprite

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>Inherited from Sprite

A Tooltip object to be used when displayed rollover information for the element.

#tooltipColorSource

Type $type.Optional <Sprite>Inherited from 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.

More info: Tooltip

More info: Sprite

#tooltipDataItem

Type DataItemInherited from Sprite

A DataItem to use when populating content for the element's Tooltip.

More info: Tooltip

More info: DataItem

#tooltipHTML

Type stringInherited from Sprite

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"Inherited from Sprite

Specifies if Tooltip should follow the mouse or touch pointer or stay at the fixed position.

Position

#tooltipText

Type stringInherited from Sprite

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.

More info: TextFormatter

#tooltipX

Type number | PercentInherited from Sprite

X coordinate the Tooltip should be shown at.

#tooltipY

Type number | PercentInherited from Sprite

Y coordinate the Tooltip should be shown at.

#trackable

Type booleanInherited from Sprite

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 stringInherited from BaseObject

Returns object's internal unique ID.

#url

Type $type.Optional <string>Inherited from Sprite

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 stringInherited from Sprite

Target to use for URL clicks:

• _blank

• _self (default)

• _parent

• _top

• Name of the window/frame Ignored if url is not set.

#userClassName

Type stringInherited from SpriteSince 4.9.11

A custom class name to set on the element.

If set, the value will be added to element's class attribute.

#valign

Type VerticalAlignInherited from Sprite

Controls vertical alignment of the element.

This is used by parent Container when layouting its children.

#verticalCenter

Type VerticalCenterInherited from Sprite

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 booleanInherited from Sprite

Indicates if element is current visible (true) or hidden (false).

#wheelable

Type booleanInherited from Sprite

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 | PercentInherited from Sprite

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 | PercentInherited from Sprite

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 | PercentInherited from Sprite

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 numberInherited from Sprite

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".

Methods

#constructor()

Returns Tick

Constructor

40 inherited items

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

Returns AnimationInherited from Sprite

Creates and starts an Animation with given animationOptions.

More info: Animation for additional information about available options

#appear()

Returns voidInherited from Sprite

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>Inherited from Sprite

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 voidInherited from Sprite

#clone(cloneId?: string)

Returns thisInherited 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 voidInherited from Sprite

Closes all currently open popup windows

#closeModal()

Returns voidInherited from Sprite

Hides modal window if there is one currently open.

#copyFrom(source: this)

Returns voidInherited from Sprite

Copies all parameters from another Sprite.

#dispatch(eventType: Key,
data?: any)

Returns voidInherited 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 voidInherited from BaseObjectEvents

Works like dispatch, except event is triggered immediately, without waiting for the next frame cycle.

#dispose()

Returns voidInherited from Sprite

Destroys this object and all related data.

#getCurrentThemes()

Returns ITheme[]Inherited from Sprite

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 numberInherited from Sprite

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 numberInherited from Sprite

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 [""]Inherited from Sprite

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 numberInherited from Sprite

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 numberInherited from Sprite

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 IPointInherited from Sprite

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

#hide(duration?: number)

Returns $type.Optional <Animation>Inherited from Sprite

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 voidInherited from Sprite

Hides element's Tooltip.

More info: Tooltip

#hitTest(sprite: Sprite)

Returns booleanInherited from Sprite

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

#insertAfter(sprite: Sprite)

Returns SpriteInherited from Sprite

Insert this element after sibling element.

#insertBefore(sprite: Sprite)

Returns SpriteInherited from Sprite

Insert this element before sibling element.

#invalidate()

Returns voidInherited from Sprite

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 booleanInherited from BaseObject

Returns if this object has been already been disposed.

#isInteractive()

Returns booleanInherited from Sprite

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

#isInTransition()

Returns booleanInherited from Sprite

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

#isReady()

Returns booleanInherited from Sprite

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 SpriteInherited from 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 voidInherited from Sprite

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>Inherited from Sprite

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

The text parameter can contain HTML content.

More info: Modalrmation about using Modal windows

#openPopup(text: string,
title?: string)

Returns Optional <Popup>Inherited from Sprite

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 SpriteInherited from Sprite

Sets padding for the element in pixels.

#setPropertyValue(property: Key,
value: any,
invalidate?: boolean,
transform?: boolean)

Returns booleanInherited from Sprite

Sets elements's property value. Will also propagate the same property value on all element's clones.

#setState(value: string | SpriteState <ISpriteProperties, ISpriteAdapters>,
transitionDuration?: number,
easing?: (value: number) => number)

Returns $type.Optional <Animation>Inherited from Sprite

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.

More info: SpriteState

#setVisibility(value: boolean)

Returns voidInherited from Sprite

Sets visibility property:

• true - visible

• false - hidden

#show(duration?: number)

Returns $type.Optional <Animation>Inherited from Sprite

Reveals hidden element.

Has no effect if element is already visible.

If duration is not specified, it will use default.

#showTooltip(point?: IPoint)

Returns booleanInherited from Sprite

Shows the element's Tooltip.

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

More info: Tooltip

#toBack()

Returns voidInherited from Sprite

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

#toFront()

Returns voidInherited from Sprite

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

Events

49 inherited items

#appeared

Param { type: "appeared", target: Tick }Inherited from ISpriteEvents

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

#beforedisposed

Param { type: "beforedisposed", target: Tick }Inherited from ISpriteEvents

Invoked just before Sprite is disposed.

#beforevalidated

Param { type: "beforevalidated", target: Tick }Inherited from ISpriteEvents

Invoked before Sprite is validated.

#blur

Param { type: "blur", target: Tick, 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.

#disabled

Param { type: "disabled", target: Tick }Inherited from ISpriteEvents

Invoked when sprite is disabled

#doublehit

Param { type: "doublehit", target: Tick } & SpritePointerTypeEvent & SpritePointEvent & SpriteMouseTouchEventInherited from ISpriteEvents

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

#down

Param { type: "down", target: Tick } & PointerTypeEvent & PointerEvent & MouseTouchEventInherited from IInteractionObjectEvents

Invoked when the mouse button is pressed or touch starts.

#drag

Param { type: "drag", target: Tick, event: MouseEvent | TouchEvent | KeyboardEvent, startPoint: IPoint } & PointerTypeEvent & ShiftEvent & PointEventInherited from IInteractionObjectEvents

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

#dragged

Param { type: "dragged", target: Tick, event: MouseEvent | TouchEvent | KeyboardEvent, startPoint: IPoint } & SpritePointerTypeEvent & SpriteShiftEvent & SpritePointEventInherited 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

Param { type: "dragstart", target: Tick, event: MouseEvent | TouchEvent | KeyboardEvent } & PointerTypeEventInherited 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 { type: "dragstop", target: Tick, event: MouseTouchEvent | KeyboardEvent } & PointerTypeEventInherited 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: Tick }Inherited from ISpriteEvents

Invoked when sprite is enabled

#focus

Param { type: "focus", target: Tick, event: FocusEvent }Inherited from IInteractionObjectEvents

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

#globalscalechanged

Param { type: "globalscalechanged", target: Tick }Inherited from ISpriteEvents

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

#hidden

Param { type: "hidden", target: Tick }Inherited from ISpriteEvents

Invoked when visible Sprite is hidden.

#hit

Param { type: "hit", target: Tick } & SpritePointerTypeEvent & SpritePointEvent & SpriteMouseTouchEventInherited from ISpriteEvents

Invoked when Sprite is clicked or touched.

#inited

Param { type: "inited", target: Tick }Inherited from ISpriteEvents

Invoked when Sprite is initialized.

#input

Param { type: "input", target: Tick, event: KeyboardEvent }Inherited from IInteractionObjectEvents

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

#keydown

Param { type: "keydown", target: Tick, event: KeyboardEvent }Inherited from IInteractionObjectEvents

Invoked when the key is pressed on the keyboard.

#keypress

Param { type: "keypress", target: Tick, 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

Param { type: "keyup", target: Tick, event: KeyboardEvent }Inherited from IInteractionObjectEvents

Invoked when the key is released on the keyboard.

#maxsizechanged

Param { type: "maxsizechanged", target: Tick, 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

Param { type: "out", target: Tick } & 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

Param { type: "over", target: Tick } & 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

Param { type: "parentset", target: Tick }Inherited from ISpriteEvents

Invoked when a sprite is added to a parent

#positionchanged

Param { type: "positionchanged", target: Tick }Inherited from ISpriteEvents

Invoked when position of the Sprite changes.

#propertychanged

Param { type: "propertychanged", target: Tick, property: string }Inherited from ISpriteEvents

Invoked when property of the Sprite changes.

#ready

Param { type: "ready", target: Tick }Inherited 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

Param { type: "removedfromqueue", target: Tick }Inherited from ISpriteEvents

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

#resize

Param { type: "resize", target: Tick, point1: IPoint, point2: IPoint, startPoint1: IPoint, startPoint2: IPoint } & PointerTypeEvent & ScaleEvent & MouseTouchEventInherited from IInteractionObjectEvents

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

#rightclick

Param { type: "rightclick", target: Tick } & MouseTouchEventInherited from IInteractionObjectEvents

Invoked when right mouse button is clicked on the object.

#shown

Param { type: "shown", target: Tick }Inherited from ISpriteEvents

Invoked when hidden Sprite is shown.

#sizechanged

Param { type: "sizechanged", target: Tick }Inherited from ISpriteEvents

Invoked when size of the Sprite changes.

#swipe

Param { type: "swipe", target: Tick } & PointerTypeEvent & MouseTouchEventInherited from IInteractionObjectEvents

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

#swipeleft

Param { type: "swipeleft", target: Tick } & PointerTypeEvent & MouseTouchEventInherited from IInteractionObjectEvents

Invoked when user performs "swiping" gesture towards left.

#swiperight

Param { type: "swiperight", target: Tick } & PointerTypeEvent & MouseTouchEventInherited from IInteractionObjectEvents

Invoked when user performs "swiping" gesture towards right.

#toggled

Param { type: "toggled", target: Tick }Inherited from ISpriteEvents

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

#track

Param { type: "track", target: Tick } & SpritePointerTypeEvent & SpritePointEvent & SpritePointerEvent & SpriteMouseTouchEventInherited from ISpriteEvents

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

#transformed

Param { type: "transformed", target: Tick, dummyData: string }Inherited from ISpriteEvents

#transitionended

Param { type: "transitionended", target: Tick }Inherited from ISpriteEvents

Invoked when Sprite completes transition to a SpriteState.

#up

Param { type: "up", target: Tick } & PointerTypeEvent & PointerEvent & MouseTouchEventInherited from IInteractionObjectEvents

Invoked when the mouse button is released or touch ends.

#validated

Param { type: "validated", target: Tick }Inherited from ISpriteEvents

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

#visibilitychanged

Param { type: "visibilitychanged", target: Tick, visible: boolean }Inherited from ISpriteEvents

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

#wheel

Param { type: "wheel", target: Tick, event: WheelEvent } & SpritePointEvent & SpriteShiftEventInherited from ISpriteEvents

Invoked when user turns mouse wheel while over the Sprite.

#wheeldown

Param { type: "wheeldown", target: Tick, event: WheelEvent } & SpritePointEvent & SpriteShiftEventInherited from ISpriteEvents

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

#wheelleft

Param { type: "wheelleft", target: Tick, event: WheelEvent } & SpritePointEvent & SpriteShiftEventInherited from ISpriteEvents

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

#wheelright

Param { type: "wheelright", target: Tick, event: WheelEvent } & SpritePointEvent & SpriteShiftEventInherited from ISpriteEvents

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

#wheelup

Param { type: "wheelup", target: Tick, event: WheelEvent } & SpritePointEvent & SpriteShiftEventInherited from ISpriteEvents

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

#zIndexChanged

Param { type: "zIndexChanged", target: Tick }Inherited from ISpriteEvents

Invoked when zIndex of a sprite is changed

Adapters

123 inherited items

#align

Param AlignInherited from ISpriteProperties

#alwaysShowTooltip

Param booleanInherited from ISpriteProperties

#clickable

Param booleanInherited from ISpriteProperties

#contextMenuDisabled

Param booleanInherited from ISpriteProperties

#criticalError

Param ErrorInherited from ISpriteAdapters

#cursorOptions

Param ICursorOptionsInherited from ISpriteAdapters

#disabled

Param booleanInherited from ISpriteProperties

#draggable

Param booleanInherited from ISpriteProperties

#dx

Param numberInherited from ISpriteProperties

#dy

Param numberInherited from ISpriteProperties

#fill

Param Color | LinearGradient | RadialGradient | PatternInherited from ISpriteProperties

#fillModifier

Param ColorModifierInherited from ISpriteProperties

#fillOpacity

Param numberInherited from ISpriteProperties

#focusable

Param booleanInherited from ISpriteProperties

#globalScale

Param numberInherited from ISpriteAdapters

#height

Param number | PercentInherited from ISpriteProperties

#hidden

Param booleanInherited from ISpriteProperties

#hitOptions

Param IHitOptionsInherited from ISpriteAdapters

#horizontalCenter

Param HorizontalCenterInherited from ISpriteProperties

#hoverable

Param booleanInherited from ISpriteProperties

#hoverOnFocus

Param booleanInherited from ISpriteProperties

#hoverOptions

Param IHoverOptionsInherited from ISpriteAdapters

#id

Param stringInherited from ISpriteProperties

#inert

Param booleanInherited from ISpriteProperties

#inertiaOptions

Param Dictionary <InertiaTypes, IInertiaOptions>Inherited from ISpriteAdapters

#innerHeight

Param numberInherited from ISpriteAdapters

#innerWidth

Param numberInherited from ISpriteAdapters

#interactionsEnabled

Param booleanInherited from ISpriteProperties

#isActive

Param booleanInherited from ISpriteProperties

#isHover

Param booleanInherited from ISpriteProperties

#keyboardOptions

Param IKeyboardOptionsInherited from ISpriteAdapters

#length

Param numberInherited from ITickProperties

Length of the tick (px).

#marginBottom

Param numberInherited from ISpriteProperties

#marginLeft

Param numberInherited from ISpriteProperties

#marginRight

Param numberInherited from ISpriteProperties

#marginTop

Param numberInherited from ISpriteProperties

#mask

Param SpriteInherited from ISpriteAdapters

#maxHeight

Param numberInherited from ISpriteProperties

#maxWidth

Param numberInherited from ISpriteProperties

#maxX

Param numberInherited from ISpriteProperties

#maxY

Param numberInherited from ISpriteProperties

#measuredHeight

Param numberInherited from ISpriteAdapters

#measuredWidth

Param numberInherited from ISpriteAdapters

#minHeight

Param numberInherited from ISpriteProperties

#minWidth

Param numberInherited from ISpriteProperties

#minX

Param numberInherited from ISpriteProperties

#minY

Param numberInherited from ISpriteProperties

#mouseOptions

Param IMouseOptionsInherited from ISpriteAdapters

#nonScaling

Param booleanInherited from ISpriteProperties

#nonScalingStroke

Param booleanInherited from ISpriteProperties

#opacity

Param numberInherited from ISpriteProperties

#outerHeight

Param numberInherited from ISpriteAdapters

#outerWidth

Param numberInherited from ISpriteAdapters

#paddingBottom

Param numberInherited from ISpriteProperties

#paddingLeft

Param numberInherited from ISpriteProperties

#paddingRight

Param numberInherited from ISpriteProperties

#paddingTop

Param numberInherited from ISpriteProperties

#path

Param stringInherited from ISpriteProperties

#pixelHeight

Param numberInherited from ISpriteAdapters

#pixelMarginBottom

Param numberInherited from ISpriteAdapters

#pixelMarginLeft

Param numberInherited from ISpriteAdapters

#pixelMarginRight

Param numberInherited from ISpriteAdapters

#pixelMarginTop

Param numberInherited from ISpriteAdapters

#pixelPerfect

Param booleanInherited from ISpriteProperties

#pixelWidth

Param numberInherited from ISpriteAdapters

#pixelX

Param numberInherited from ISpriteAdapters

#pixelY

Param numberInherited from ISpriteAdapters

#populateString

Param stringInherited from ISpriteAdapters

#readerChecked

Param booleanInherited from ISpriteProperties

#readerControls

Param stringInherited from ISpriteProperties

#readerDescribedBy

Param stringInherited from ISpriteProperties

#readerDescription

Param stringInherited from ISpriteProperties

#readerHidden

Param booleanInherited from ISpriteProperties

#readerLabelledBy

Param stringInherited from ISpriteProperties

#readerLive

Param AriaLiveInherited from ISpriteProperties

#readerOrientation

Param stringInherited from ISpriteProperties

#readerTitle

Param stringInherited from ISpriteProperties

#readerValueNow

Param stringInherited from ISpriteProperties

#readerValueText

Param stringInherited from ISpriteProperties

#relativeHeight

Param numberInherited from ISpriteAdapters

#relativeMarginBottom

Param numberInherited from ISpriteAdapters

#relativeMarginLeft

Param numberInherited from ISpriteAdapters

#relativeMarginRight

Param numberInherited from ISpriteAdapters

#relativeMarginTop

Param numberInherited from ISpriteAdapters

#relativeWidth

Param numberInherited from ISpriteAdapters

#relativeX

Param numberInherited from ISpriteAdapters

#relativeY

Param numberInherited from ISpriteAdapters

#resizable

Param booleanInherited from ISpriteProperties

#role

Param RolesInherited from ISpriteProperties

#rotation

Param numberInherited from ISpriteProperties

#scale

Param numberInherited from ISpriteProperties

#shapeRendering

Param ShapeRenderingInherited from ISpriteProperties

#showOnInit

Param booleanInherited from ISpriteProperties

#showTooltipOn

Param "hover" | "hit" | "always"Inherited from ISpriteProperties

#stroke

Param Color | LinearGradient | RadialGradient | PatternInherited from ISpriteProperties

#strokeDasharray

Param stringInherited from ISpriteProperties

#strokeDashoffset

Param numberInherited from ISpriteProperties

#strokeLinecap

Param "butt" | "square" | "round"Inherited from ISpriteProperties

#strokeLinejoin

Param "miter" | "round" | "bevel"Inherited from ISpriteProperties

#strokeModifier

Param ColorModifierInherited from ISpriteProperties

#strokeOpacity

Param numberInherited from ISpriteProperties

#strokeWidth

Param numberInherited from ISpriteProperties

#swipeable

Param booleanInherited from ISpriteProperties

#swipeOptions

Param ISwipeOptionsInherited from ISpriteAdapters

#tabindex

Param numberInherited from ISpriteProperties

#togglable

Param booleanInherited from ISpriteProperties

#tooltipHTML

Param stringInherited from ISpriteProperties

#tooltipPosition

Param "fixed" | "pointer"Inherited from ISpriteProperties

#tooltipText

Param stringInherited from ISpriteProperties

#tooltipX

Param number | PercentInherited from ISpriteProperties

#tooltipY

Param number | PercentInherited from ISpriteProperties

#trackable

Param booleanInherited from ISpriteProperties

#url

Param stringInherited from ISpriteProperties

#urlTarget

Param stringInherited from ISpriteProperties

#userClassName

Param stringInherited from ISpriteProperties

#valign

Param VerticalAlignInherited from ISpriteProperties

#verticalCenter

Param VerticalCenterInherited from ISpriteProperties

#visible

Param booleanInherited from ISpriteProperties

#wheelable

Param booleanInherited from ISpriteProperties

#width

Param number | PercentInherited from ISpriteProperties

#x

Param number | PercentInherited from ISpriteProperties

#y

Param number | PercentInherited from ISpriteProperties

#zIndex

Param numberInherited from ISpriteProperties