Skip to main content

Editor.Components.BackgroundSettings

Class

Configures background styling for UI components.

Index

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

readonly id: Uuid

The unique id of the entity.

Inherited from

EntityStructure.id


margins

margins: Rect

Spacing around the background edges.


meta

readonly meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

Inherited from

EntityStructure.meta


type

readonly type: string

The entity's type.

Inherited from

EntityStructure.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

EntityStructure.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

EntityStructure.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

EntityStructure.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

EntityStructure.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

EntityStructure.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

EntityStructure.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

EntityStructure.isSame