跳到主要内容

Component_text

Ploy3D • Docs

Ploy3D / Component_text

Class: Component_text

UI文本控件。

Extends​

Constructors​

new Component_text()​

new Component_text(system, canvas, id, options): Component_text

构造函数。

Parameters​

• system: CalynUI

UI系统实例。

• canvas: Canvas

UI画布实例。

• id: number

实例ID。

• options: object & object & object

可选的初始化数据。

Returns​

Component_text

Overrides​

Component.constructor

Accessors​

active​

get active(): boolean

元素是否激活。

set active(b): void

Parameters​

• b: boolean

Returns​

boolean

Inherited from​

Component.active

aspect_mode​

get aspect_mode(): "none" | "width_ctrl" | "height_ctrl"

元素宽高比约束模式。

Returns​

"none" | "width_ctrl" | "height_ctrl"

Inherited from​

Component.aspect_mode

aspect_ratio​

get aspect_ratio(): number

元素当前宽高比。

Returns​

number

Inherited from​

Component.aspect_ratio

children​

get children(): Element[]

子级元素列表。

Returns​

Element[]

Inherited from​

Component.children

children_occ_height​

get children_occ_height(): number

文本占用高度。

Returns​

number

Overrides​

Component.children_occ_height

children_occ_width​

get children_occ_width(): number

文本占用宽度。

Returns​

number

Overrides​

Component.children_occ_width

guid​

get guid(): string

元素GUID。

Returns​

string

Inherited from​

Component.guid

height​

get height(): object

元素当前设计高度。

Returns​

object

height​

height: number

内容区域设计高度。

occ_height​

occ_height: number

总占用设计高度（包含边距）。

timestrap​

timestrap: number

数据时间戳。

Inherited from​

Component.height

id​

get id(): number

元素ID。

Returns​

number

Inherited from​

Component.id

multi_line_settings​

get multi_line_settings(): object

多行文本设置。

Returns​

object

default_lines​

default_lines: string[]

当前文本默认分行。

dynamic_lines​

dynamic_lines: string[]

当前文本动态分行。

font​

font: string

当前字体。

font_size​

font_size: number

当前字体大小。

line_actualBoundingBoxAscent​

line_actualBoundingBoxAscent: number

表示从textBaseline属性指示的水平线到用于渲染文本的边界矩形顶部的距离。

line_actualBoundingBoxDescent​

line_actualBoundingBoxDescent: number

表示从textBaseline属性指示的水平线到用于渲染文本的边界矩形底部的距离。

line_height​

line_height: number

当前文本行高。

line_width​

line_width: number

当前文本最大行宽。

text​

text: string

当前设置对应的文本。

style​

get style(): object

样式设置。

Returns​

object

bg_fill?​

optional bg_fill: boolean

是否填充背景。

bg_fill_color?​

optional bg_fill_color: string

背景填充颜色。

bg_radii?​

optional bg_radii: number

圆角矩形圆弧半径。

bg_stroke?​

optional bg_stroke: boolean

是否描绘背景边框。

bg_stroke_color?​

optional bg_stroke_color: string

背景边框颜色。

bg_stroke_dash?​

optional bg_stroke_dash: number

背景边框虚线间隔（实线长度为间隔的2倍）。

bg_stroke_width?​

optional bg_stroke_width: number

背景边框线宽。

font?​

optional font: string

字体。

font_color?​

optional font_color: string

字体颜色。

font_size?​

optional font_size: number

字体大小（单位PX）。

Inherited from​

Component.style

text​

set text(value): void

设置文本。

Parameters​

• value: string

type​

get type(): "canvas" | "layout" | "panel" | "component"

元素类型（"layout"，"canvas"都派生自"panel"，所以可以认为只有两大类"component"，"panel"）。

Returns​

"canvas" | "layout" | "panel" | "component"

Inherited from​

Component.type

width​

get width(): object

元素当前设计宽度。

Returns​

object

occ_width​

occ_width: number

总占用设计宽度（包含边距）。

timestrap​

timestrap: number

数据时间戳。

width​

width: number

内容区域设计宽度。

Inherited from​

Component.width

Methods​

AddChild()​

AddChild<T>(option): T

添加子级元素。

Type Parameters​

• T extends Element

Parameters​

• option: Options

子级元素配置。

Returns​

T

Inherited from​

Component.AddChild

Draw()​

Draw(pass, style): Promise<void>

绘制元素。

Parameters​

• pass: number

绘制阶段。

• style

• style.bg_fill?: boolean

是否填充背景。

• style.bg_fill_color?: string

背景填充颜色。

• style.bg_radii?: number

圆角矩形圆弧半径。

• style.bg_stroke?: boolean

是否描绘背景边框。

• style.bg_stroke_color?: string

背景边框颜色。

• style.bg_stroke_dash?: number

背景边框虚线间隔（实线长度为间隔的2倍）。

• style.bg_stroke_width?: number

背景边框线宽。

• style.font?: string

字体。

• style.font_color?: string

字体颜色。

• style.font_size?: number

字体大小（单位PX）。

Returns​

Promise<void>

Overrides​

Component.Draw

OnDrag()​

OnDrag(width, height, event): void

拖拽元素。

Parameters​

• width: number

拖拽实际所在平面宽度。

• height: number

拖拽实际所在平面高度。

• event: MouseEvent & object

鼠标事件对象。

Returns​

void

Inherited from​

Component.OnDrag

Update()​

Update(style): Promise<boolean>

更新元素绘制范围参数（先根遍历更新）。

Parameters​

• style

• style.bg_fill?: boolean

是否填充背景。

• style.bg_fill_color?: string

背景填充颜色。

• style.bg_radii?: number

圆角矩形圆弧半径。

• style.bg_stroke?: boolean

是否描绘背景边框。

• style.bg_stroke_color?: string

背景边框颜色。

• style.bg_stroke_dash?: number

背景边框虚线间隔（实线长度为间隔的2倍）。

• style.bg_stroke_width?: number

背景边框线宽。

• style.font?: string

字体。

• style.font_color?: string

字体颜色。

• style.font_size?: number

字体大小（单位PX）。

Returns​

Promise<boolean>

返回是否绘制当前元素。

Inherited from​

Component.Update