Preparing search index...

    Manages 2D canvas rendering and layout properties for a scene object.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    enabled: boolean

    Whether the component is active.

    id: Uuid

    The unique id of the entity.

    meta: Meta

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

    name: string

    Name of the component.

    pivot: vec2

    Anchor point for the canvas as a normalized 2D vector.

    sceneObject: SceneObject

    Scene object this component is attached to.

    sortingType: SortingType

    Determines how the canvas sorts its children during rendering.

    type: string

    The entity's type.

    unitType: UnitType

    Specifies the unit system used for canvas measurements.

    worldSpaceRect: Editor.Rect

    Bounding rectangle of the canvas in world space coordinates.

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean