UIElementBase
Defined in: ui/src/UIElementBase.ts:12
The base class of every @yagejs/ui element. It holds the element’s
transformOrigin, scale, rotation and zIndex, and its parent’s layout
pass places it about its transformOrigin. A custom element extends it and
calls applyTransformProps from its constructor and its update().
Extended by
Section titled “Extended by”UIPanelUITextUISplitTextUIButtonUIImageUINineSliceUIProgressBarUICheckboxUIScrollViewPixiUIBase
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UIElementBase():
UIElementBase
Returns
Section titled “Returns”UIElementBase
Properties
Section titled “Properties”_transform
Section titled “_transform”
readonly_transform:ElementTransform
Defined in: ui/src/UIElementBase.ts:20
Internal
Implementation of
Section titled “Implementation of”displayObject
Section titled “displayObject”
abstractreadonlydisplayObject:DisplayContainer
Defined in: ui/src/UIElementBase.ts:13
Implementation of
Section titled “Implementation of”visible
Section titled “visible”
abstractvisible:boolean
Defined in: ui/src/UIElementBase.ts:15
Implementation of
Section titled “Implementation of”yogaNode
Section titled “yogaNode”
abstractreadonlyyogaNode:Node
Defined in: ui/src/UIElementBase.ts:14
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”rotation
Section titled “rotation”Get Signature
Section titled “Get Signature”get rotation():
number
Defined in: ui/src/UIElementBase.ts:50
See LayoutProps.rotation.
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set rotation(
value):void
Defined in: ui/src/UIElementBase.ts:54
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Get Signature
Section titled “Get Signature”get scale():
Readonly<{x:number;y:number; }>
Defined in: ui/src/UIElementBase.ts:41
See LayoutProps.scale.
Returns
Section titled “Returns”Readonly<{ x: number; y: number; }>
Set Signature
Section titled “Set Signature”set scale(
value):void
Defined in: ui/src/UIElementBase.ts:45
Parameters
Section titled “Parameters”number | { x: number; y: number; }
Returns
Section titled “Returns”void
transformOrigin
Section titled “transformOrigin”Get Signature
Section titled “Get Signature”get transformOrigin():
Readonly<{x:number;y:number; }>
Defined in: ui/src/UIElementBase.ts:32
See LayoutProps.transformOrigin.
Returns
Section titled “Returns”Readonly<{ x: number; y: number; }>
Set Signature
Section titled “Set Signature”set transformOrigin(
value):void
Defined in: ui/src/UIElementBase.ts:36
Parameters
Section titled “Parameters”number | { x: number; y: number; }
Returns
Section titled “Returns”void
zIndex
Section titled “zIndex”Get Signature
Section titled “Get Signature”get zIndex():
number
Defined in: ui/src/UIElementBase.ts:59
See LayoutProps.zIndex.
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set zIndex(
value):void
Defined in: ui/src/UIElementBase.ts:63
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Methods
Section titled “Methods”applyTransformProps()
Section titled “applyTransformProps()”
protectedapplyTransformProps(props):void
Defined in: ui/src/UIElementBase.ts:27
Apply the four transform props present in props. A present key holding
undefined resets that prop to its default. Throws before writing
anything if a value is not finite.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”
abstractdestroy():void
Defined in: ui/src/UIElementBase.ts:17
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”update()
Section titled “update()”
abstractupdate(props):void
Defined in: ui/src/UIElementBase.ts:16
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/ui.md.