IBulletSettings

Type interface

Inheritance

IBulletSettings extends IEntitySettings.

IBulletSettings is not extended by any other symbol.

Properties

autoRotate
#

Type undefined | false | true

Default false

If set to true, the bullet will be automatically rotated to face direction of line it is attached to.

NOTE: Works only in Flow and MapPointSeries (when MapPoint is attached to a MapLine).

autoRotateAngle
#

Type undefined | number

If autoRotate is set to true, value of autoRotateAngle will be added to the automatically-calculated angle.

dynamic
#

Type undefined | false | true

Default false

If set to true, the bullet will redraw its sprite element whenever anything in its parent series changes.

field
#

Type "open" | "high" | "low" | "value"

If a field will be set, the bullet will be located at exact value of that field, not paying atention to locationY/locationX. Works with XYSeries only.

If field is set, bullet will be placed at the specific data value, ignoring any locationX and locationY settings.

  • IMPORTANT: this setting works with XYSeries only.

Click here for more info
@since 5.6.0

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.

locationX
#

Type undefined | number

Horizontal location within target element.

0 - left, 1 - right, or anything inbetweeen.

locationY
#

Type undefined | number

Vertical location within target element.

0 - top, 1 - bottom, or anything inbetweeen.

sprite
#

Type Sprite

A visual element of the bullet.

stacked
#

Type "up" | "down" | "auto"

If set, will stack bullets instead of overlapping them.

  • "up - stacks bullets upwards.
  • "down - stacks bullets downwards.
  • "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

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.

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.

userData
#

Type any

Inherited from IEntitySettings

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

There are 7 inherited items currently hidden from this list.