Editor.Components.BackgroundSettings
ClassConfigures background styling for UI components.
Index
Properties
Methods
Example
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;
// Create a Text component and configure its background
const obj = scene.createSceneObject('LabelWithBg');
const text = obj.addComponent('Text') as Editor.Components.Text;
text.text = 'Hello World';
// Enable background with rounded corners
const bg = text.backgroundSettings;
bg.enabled = true;
bg.cornerRadius = 8;
console.log(`Background: enabled=${bg.enabled}, cornerRadius=${bg.cornerRadius}`);
Extends
Properties
cornerRadius
cornerRadius:
number
Corner radius of the background shape.
enabled
enabled:
boolean
Whether the background is visible.
fill
fill:
TextFill
Fill color and style of the background.
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
margins
margins:
Rect
Spacing around the background edges.
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
type
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
EntityStructure.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
EntityStructure.getOwnedEntities
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean