Class BabylonGuiTextBlock

文本标签：带有颜色、字体大小、对齐、可选轮廓、换行和行间距的文本块。用于其他控件旁的标题和读数。

Index

Constructors

create

createTextBlock createTextBlockObservableSelector

get

getText getTextWrapping getLineSpacing getOutlineWidth getResizeToFit getTextHorizontalAlignment getTextVerticalAlignment

positioning

set

setTextOutline setText setRsizeToFit setTextWrapping setLineSpacing

Constructors

constructor

new BabylonGuiTextBlock(): BabylonGuiTextBlock
Returns BabylonGuiTextBlock

create

createTextBlock

createTextBlock(inputs: CreateTextBlockDto): TextBlock
创建带有颜色和字体大小的文本块；尺寸为像素字符串或父级的分数，省略的尺寸由引擎决定。
Parameters
- inputs: CreateTextBlockDto
  名称、文本、颜色、可选的尺寸和字体大小
Returns TextBlock
文本块
Example
```
const title = bitbybit.babylon.gui.textBlock.createTextBlock({ name: "title", text: "Radius", color: "#f0cebb", width: "300px", height: "40px", fontSize: 24 });
panel.addControl(title);
```
- Defined in bitbybit-docs.d.ts:49706

createTextBlockObservableSelector

createTextBlockObservableSelector(
inputs: TextBlockObservableSelectorDto,
): onTextChangedObservable
将文本块事件的名称（其文本更改）作为类型化的选择器传递，供按名称订阅文本块事件的代码使用。
Parameters
- inputs: TextBlockObservableSelectorDto
  事件选择器
Returns onTextChangedObservable
同一个选择器
- Defined in bitbybit-docs.d.ts:49836

get

getText

getText(inputs: TextBlockDto): string
读取文本块当前显示的文本。
Parameters
- inputs: TextBlockDto
  文本块
Returns string
文本
- Defined in bitbybit-docs.d.ts:49777

getTextWrapping

getTextWrapping(inputs: TextBlockDto): any
读取文本块如何处理比自身宽的文本。
Parameters
- inputs: TextBlockDto
  文本块
Returns any
换行模式
- Defined in bitbybit-docs.d.ts:49785

getLineSpacing

getLineSpacing(inputs: TextBlockDto): string | number
读取文本块各行之间的额外空间。
Parameters
- inputs: TextBlockDto
  文本块
Returns string | number
行间距
- Defined in bitbybit-docs.d.ts:49793

getOutlineWidth

getOutlineWidth(inputs: TextBlockDto): number
读取文本块字母周围轮廓的宽度，0 表示没有。
Parameters
- inputs: TextBlockDto
  文本块
Returns number
轮廓宽度
- Defined in bitbybit-docs.d.ts:49801

getResizeToFit

getResizeToFit(inputs: TextBlockDto): boolean
读取文本块是否调整自身大小以适应其文本。
Parameters
- inputs: TextBlockDto
  文本块
Returns boolean
当自动调整大小以适应内容时为 true
- Defined in bitbybit-docs.d.ts:49809

getTextHorizontalAlignment

getTextHorizontalAlignment(inputs: TextBlockDto): number
读取文本在其块内的水平位置，以引擎表示左、中或右的数字表示。
Parameters
- inputs: TextBlockDto
  文本块
Returns number
水平对齐代码
- Defined in bitbybit-docs.d.ts:49818

getTextVerticalAlignment

getTextVerticalAlignment(inputs: TextBlockDto): number
读取文本在其块内的垂直位置，以引擎表示上、中或下的数字表示。
Parameters
- inputs: TextBlockDto
  文本块
Returns number
垂直对齐代码
- Defined in bitbybit-docs.d.ts:49827

positioning

alignText

alignText(inputs: AlignmentDto<TextBlock>): TextBlock
设置文本在其块内的位置：左、中或右，以及上、中或下。
Parameters
- inputs: AlignmentDto<TextBlock>
  文本块和两个对齐方式
Returns TextBlock
同一个文本块
Example
```
bitbybit.babylon.gui.textBlock.alignText({ control: title, horizontalAlignment: Bit.Inputs.BabylonGui.horizontalAlignmentEnum.left, verticalAlignment: Bit.Inputs.BabylonGui.verticalAlignmentEnum.center });
```
- Defined in bitbybit-docs.d.ts:49718

set

setTextOutline

setTextOutline(inputs: SetTextBlockTextOutlineDto): TextBlock
在文本块的字母周围绘制轮廓，宽 outlineWidth 像素，颜色为 outlineColor，使文本在繁杂的场景上保持可读；0 移除它。
Parameters
- inputs: SetTextBlockTextOutlineDto
  文本块、轮廓宽度和轮廓颜色
Returns TextBlock
同一个文本块
Example
```
bitbybit.babylon.gui.textBlock.setTextOutline({ textBlock: title, outlineWidth: 2, outlineColor: "black" });
```
- Defined in bitbybit-docs.d.ts:49731

setText

setText(inputs: SetTextBlockTextDto): TextBlock
将文本块显示的文本更改为给定文本。
Parameters
- inputs: SetTextBlockTextDto
  文本块和文本
Returns TextBlock
同一个文本块
Example
```
bitbybit.babylon.gui.textBlock.setText({ textBlock: readout, text: "Radius: 7.5" });
```
- Defined in bitbybit-docs.d.ts:49743

setRsizeToFit

setRsizeToFit(inputs: SetTextBlockResizeToFitDto): TextBlock
为 true 时让文本块放大或缩小以适应其文本，而不是保持其设定的尺寸。
Parameters
- inputs: SetTextBlockResizeToFitDto
  文本块和标志
Returns TextBlock
同一个文本块
- Defined in bitbybit-docs.d.ts:49751

setTextWrapping

setTextWrapping(inputs: SetTextBlockTextWrappingDto): TextBlock
设置文本块如何处理比自身宽的文本：为 true 时换到新行，为 false 时裁剪，或使用引擎的换行模式之一，例如省略号。
Parameters
- inputs: SetTextBlockTextWrappingDto
  文本块和换行模式
Returns TextBlock
同一个文本块
- Defined in bitbybit-docs.d.ts:49760

setLineSpacing

setLineSpacing(inputs: SetTextBlockLineSpacingDto): TextBlock
设置换行文本块各行之间的额外空间，以像素或字符串（例如 4px）表示。
Parameters
- inputs: SetTextBlockLineSpacingDto
  文本块和行间距
Returns TextBlock
同一个文本块
- Defined in bitbybit-docs.d.ts:49769