Annotation Effects
Annotation Effects¶
Annotation Effects alter and modify Annotations, allowing for animation.
Note: Annotation Effects have Start and Duration properties, which control where the effect will occur.
Annotation Effects¶
Color¶
Color effects change the color of the annotation.
Properties¶
System¶
| Name | Explanation | Type |
|---|---|---|
| Color | The color to apply to the annotation. | Color |
| Duration | The duration of the effect in milliseconds. | Number |
| Start | The starting time of the effect in milliseconds. | Number |
Font¶
Font effects change the font of any text in the annotation.
Properties¶
System¶
| Name | Explanation | Type |
|---|---|---|
| Duration | The duration of the effect in milliseconds. | Number |
| Font | The font to apply to the annotation's text, replacing its current font settings. | Font |
| Start | The starting time of the effect in milliseconds. | Number |
Movement¶
Movement effects change the position of the annotation over time.
Properties¶
System¶
| Name | Explanation | Type |
|---|---|---|
| Duration | The duration of the effect in milliseconds. | Number |
| Start | The starting time of the effect in milliseconds. | Number |
Acceleration¶
| Name | Explanation | Type |
|---|---|---|
| Acceleration | The acceleration applied to the annotation's velocity each second, in world-space units. | Vector |
Velocity¶
| Name | Explanation | Type |
|---|---|---|
| Velocity | The initial velocity of the annotation in world-space units per second. | Vector |
Negative Value¶
Negative Value effects multiply any numeric values displayed in the annotation by -1.
Properties¶
System¶
| Name | Explanation | Type |
|---|---|---|
| Duration | The duration of the effect in milliseconds. | Number |
| Start | The starting time of the effect in milliseconds. | Number |
Number Formatter¶
Number Formatter effects apply different sub-effects depending on whether the annotation's text is a positive, negative, zero, or non-numeric value.
Properties¶
System¶
| Name | Explanation | Type |
|---|---|---|
| Duration | The duration of the effect in milliseconds. | Number |
| Negative Effects | The effects to apply if the number is negative. | Annotation Effect |
| Null Effects | The effects to apply if no number is provided. | Annotation Effect |
| Positive Effects | The effects to apply if the number is positive. | Annotation Effect |
| Start | The starting time of the effect in milliseconds. | Number |
| Zero Effects | The effects to apply if the number is zero. | Annotation Effect |
Text¶
Text effects replace the displayed string content of a text annotation when activated.
Properties¶
System¶
| Name | Explanation | Type |
|---|---|---|
| Duration | The duration of the effect in milliseconds. | Number |
| Start | The starting time of the effect in milliseconds. | Number |
| Text | The replacement text to display when this effect activates. Supports localization. | String |
Wait¶
Wait effects create a delay and extend the length of the annotation's effect sequence.
Properties¶
System¶
| Name | Explanation | Type |
|---|---|---|
| Duration | The duration of the effect in milliseconds. | Number |
| Start | The starting time of the effect in milliseconds. | Number |