MarkupText
Hierarchy
- MarkupEntity
- MarkupText
Implements
Index
Properties
publicreadonlyid
normal
position
publicreadonlyproperties
rotation
scale
style
Type declaration
backgroundColor: Color4
text
Accessors
isEnabled
Returns
trueif the entity and the sheet it belongs to are both enabled, otherwisefalse.Returns boolean
Sets if entity is enabled
Parameters
b: boolean
Returns void
sheet
Returns the markup sheet that the entity is attached to
Returns MarkupSheet2D
Methods
clone
Makes a deep copy of this entity
Returns MarkupText
copyFrom
Copies data of other markup text into current
Parameters
text: MarkupText
Returns void
copyTo
Copy the entity to another markup sheet.
Parameters
sheet: MarkupSheet2D
Markup sheet to copy the entity to.
Returns MarkupText
The new markup entity.
isEqual
Compares if this entity is equal to another entity
Parameters
o: MarkupText
Returns boolean
markAsDeleted
Marks the entity as deleted in the MarkupSheet2D.
Returns boolean
trueif object was deleted. Otherwisefalse.
markAsUpdated
Sets the entity as updated in the layer API.
Returns boolean
trueif object did exist, otherwisefalse
onAdded
Called when this entity is added
Parameters
Returns void
onDelete
Called when this entity is deleted
Parameters
Returns void
onUpdate
Called when this entity is updated
Parameters
Returns void
Class representing a markup text in the markup API. WARNING: MarkupText does not sanitize any text passed to it, if you are using MarkupText in conjunction with Html2CanvasText make sure to use a sanitizer (for example DOMPurify).