Editor APIUI / Canvas
Canvas Class
Container
The root node that can mount leaf nodes and provide various automatic layout functions
Hierarchy
↳
Canvas
Table of contents
Properties
click
Properties
onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other |
|---|
| Monitor custom attribute synchronization events |
Accessors
autoLayoutContainerRule(): UILayoutType other |
|---|
| Get automatic layout rules - container type |
autoLayoutEnable(): boolean other |
| Automatically layout when obtaining |
autoLayoutPacketRule(): UILayoutPacket other |
| Get automatic layout and typesetting rules - Arrangement rules |
autoLayoutPadding(): Margin other |
| Obtain edge spacing |
autoLayoutRule(): UILayout other |
| Get complete layout rules |
autoLayoutSpacing(): number other |
| Get Auto layout Interval |
clipEnable(): boolean other |
| Get whether to crop or not |
click
Accessors
alignPosition(): Readonly<Vector2> other |
|---|
| Get the align position of the widget. When the align method is right align, bottom align, and center align, the value of alignPosition is different from that of position; |
autoSizeHorizontalEnable(): boolean other |
| Get whether to automatically set the size horizontally |
autoSizeVerticalEnable(): boolean other |
| Get whether to set the size automatically vertical |
cachedGeometry(): Geometry other |
| Get the previous Get TickSpaceGeometry |
constraints(): Readonly<UIConstraintAnchors> other |
| Get the layout of the control |
desiredSize(): Vector2 other |
| Obtain expected size |
enable(): boolean other |
| Is it available |
guid(): string other |
| Get the widget GUID |
isHovered(): boolean other |
| Is it hovered |
mouseCursor(): MouseCursor other |
| Get the cursor type on the widget |
name(): string other |
| Get Name |
paintSpaceGeometry(): Geometry other |
| Get the last geometric information used to render the Widget |
parent(): Widget other |
| Get parent node |
pivot(): Vector2 other |
| Get the position of the widget anchor. This property determine the relative position of the widget graph and the anchor; At (0,0), the anchor point is located in the upper left corner of the control; (0.5,0.5), the anchor is at the center of the widget |
position(): Readonly<Vector2> other |
| Get the position of the control |
renderOpacity(): number other |
| Obtain rendering transparency |
renderScale(): Vector2 other |
| Get rendering scaling |
renderShear(): Vector2 other |
| Obtain rendering misalignment deformation |
renderTransformAngle(): number other |
| Obtain the rendering angle |
renderTransformPivot(): Vector2 other |
| Get Render anchor |
size(): Vector2 other |
| Get size |
tickSpaceGeometry(): Geometry other |
| Retrieve the last geometric information used to drive Widget Tick |
transform(): Readonly<UITransform> other |
| Obtain the size and position of the control |
visibility(): SlateVisibility other |
| Get visibility |
visible(): boolean other |
| Is it visible |
zOrder(): number other |
| Get Zorder |
Methods
newObject(parent?: Canvas, inName?: string): Canvas other |
|---|
| Create Canvas Control |
click
Methods
addChild(child: Widget): void other |
|---|
| Add child nodes |
clone(position: Vector2, Parent?: any): Widget other |
| Clone the UI widget and its child nodes to the specified parent widget position (default to its parent node) |
destroyObject(): void other |
| Remove and destroy immediately. Cannot be used again |
equal(that: Widget): boolean other |
| Determine if it is the same object |
findChildByPath(inPath: string): Widget other |
| Find nodes by relative path |
getChildAt(index: number): Widget other |
| What is the position node to obtain |
getChildByName<T: extends Widget<T>>(name: string): T: extends Widget<T> other |
| Search for nodes by name |
getChildrenCount(): number other |
| Obtain the number of child nodes |
getCustomProperties(): string[] other |
| Get all customize property |
getCustomProperty<T: extends CustomPropertyType>(propertyName: string): T: extends CustomPropertyType other |
| Get customize property |
getCustomPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other |
| Event proxy triggered when a given object property is modified |
invalidateLayoutAndVolatility(): void other |
| Immediately trigger re rendering and layout calculation |
removeAllChildren(): void other |
| Clearing all child nodes will destroy the UI and render it unusable |
removeChild(child: Widget): void other |
| Removing a node will destroy the UI and make it unusable |
removeChildAt(index: number): void other |
| Removing the third node will destroy the UI and render it unusable |
removeObject(): void other |
| Immediately remove and add to the root node for reuse |
serialize(): string other |
| Serialize UI widget |
setCustomProperty(propertyName: string, value: undefined CustomPropertyType): void other |
| Set custom attributes |
deserialize(Data: string, Parent?: Widget): Widget other |
| Deserialize UI |
Properties
Accessors
autoLayoutContainerRule
• | • | ||||
|---|---|---|---|---|---|
Get automatic layout rules - container type Returns
| Set automatic layout rules - container types Parameters
|
autoLayoutEnable
• | • | ||||
|---|---|---|---|---|---|
Automatically layout when obtaining Returns
| Set whether to auto layout Parameters
|
autoLayoutPacketRule
• | • | ||||
|---|---|---|---|---|---|
Get automatic layout and typesetting rules - Arrangement rules Returns
| Set Automatic layout Layout Rules - Arrangement Rules Parameters
|
autoLayoutPadding
• | • | ||||
|---|---|---|---|---|---|
Obtain edge spacing Returns
| Set edge spacing Parameters
|
autoLayoutRule
• | • | ||||
|---|---|---|---|---|---|
Get complete layout rules Returns
| Set up complete layout rules Parameters
|
autoLayoutSpacing
• | • | ||||
|---|---|---|---|---|---|
Get Auto layout Interval Returns
| Set automatic layout interval Parameters
|
clipEnable
• | • | ||||
|---|---|---|---|---|---|
Get whether to crop or not Returns
| Set whether to cull Parameters
|
Methods
newObject
• Static newObject(parent?, inName?): Canvas other
Create Canvas Control
Parameters
parent? Canvas | Usage: Create the external parent object of the control with default: null |
|---|---|
inName? string | Usage: name of the create widget default: null range: set a reasonable name |
Returns
Canvas | Return the created object |
|---|
When the parent and inName are the same as an existing object, the old object will be destroyed