Documentation

IBulletSettings

Type interface

Inheritance

IBulletSettings extends IEntitySettings.

IBulletSettings is not extended by any other symbol.

Properties

animations #	Type `Array` Inherited from `IEntitySettings` Animations the element plays on its own, described as data - so they can be set from a JSON config and saved with it. Each one animates a setting of the element (or, with `target: "dataItem"`, a value of its data item - a map point's `positionOnLine`, say). They start when the setting is applied, restart when it changes, and stop when the element is disposed. A saved config keeps what was configured, never a value caught half way through an animation. sprite.set("animations", [ { key: "rotation", to: 360, duration: 4000, loops: 0 }, { key: "scale", from: 1, to: 1.3, duration: 800, loops: 0, yoyo: true, easing: "sine" } ]); @since 5.20.8
autoRotate #	Type `undefined` \| `false` \| `true` Default `false` Rotates the bullet to follow the direction of the line it sits on. Works on links of `Flow` charts, `HierarchyLink` and `MapSankeySeries`, and in `MapPointSeries` for points placed on a `MapLine`.
autoRotateAngle #	Type `undefined` \| `number` Degrees added to the angle that `autoRotate` sets.
dynamic #	Type `undefined` \| `false` \| `true` Default `false` Refreshes the `sprite` (its fill, size and label text, and those of its children) each time the series positions its bullets.
field #	Type `"open"` \| `"high"` \| `"low"` \| `"value"` Places the bullet at this value of the data item along the value axis, in place of the location on that axis. The location across it still applies. IMPORTANT: this setting works with `XYSeries` only. Click here for more info @since 5.6.0
id #	Type `undefined` \| `string` Inherited from `IEntitySettings` A unique ID for looking the element up in `root.entitiesById`. Setting an ID that another element already has throws an error.
ignoreThemes #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IEntitySettings` Ignores themes: no theme rule applies to the element, not even one of the default theme. @since 5.15.6
locationX #	Type `undefined` \| `number` Default `0.5` Horizontal location within the target element, from `0` (left) to `1` (right). In a pie slice it runs along the arc.
locationY #	Type `undefined` \| `number` Default `0.5` Vertical location within the target element, from `0` (top) to `1` (bottom). On XY columns `0` is the column's base and `1` its value end; in a pie slice it runs from the inner to the outer radius.
sprite #	Type `Sprite` The element the bullet shows.
stacked #	Type `"up"` \| `"down"` \| `"auto"` Stacks bullets at the same spot instead of overlapping them. `"up"` - stacks bullets upwards (rightwards on a horizontal series). `"down"` - stacks bullets downwards (leftwards on a horizontal series). `"auto"` - stacks bullets in the direction that offers more space. IMPORTANT: this setting works with `XYSeries` only. Click here for more info @since 5.6.0
stateAnimationDuration #	Type `undefined` \| `number` Default `0` Inherited from `IEntitySettings` How long, in milliseconds, a switch from one state to another animates. `0` switches at once.
stateAnimationEasing #	Type `$ease.Easing` Default `out(cubic)` Inherited from `IEntitySettings` Easing of the animated switch from one state to another.
themeTags #	Type `Array` Inherited from `IEntitySettings` Tags that theme rules can target. They also count for the element's children, so a rule can match a child by a tag of its parent. Click here for more info
themeTagsSelf #	Type `Array` Inherited from `IEntitySettings` Tags that theme rules can target, like `themeTags`, but only for this element, not its children. Click here for more info
themes #	Type `Array` Inherited from `IEntitySettings` Themes applied to the element and everything inside it.
userData #	Type `any` Inherited from `IEntitySettings` Any data of your own to keep with the element.
There are 9 inherited items currently hidden from this list.