Class BabylonGuiTextBlock

Hierarchy

BabylonGuiTextBlock

Index

Constructors

constructor

Methods

Constructors

constructor

new BabylonGuiTextBlock(context: Context): BabylonGuiTextBlock

- Defined in bitbybit-docs.d.ts:30080
Parameters
- context: Context
Returns BabylonGuiTextBlock

Methods

alignText

alignText(inputs: AlignmentDto<TextBlock>): TextBlock

- Defined in bitbybit-docs.d.ts:30096
Change the alignment for the text

group

positioning

shortname

align text block text

Parameters
- inputs: AlignmentDto<TextBlock>
  
  the text block and the alignment values
Returns TextBlock

control that has changed text alignment

createTextBlock

createTextBlock(inputs: CreateTextBlockDto): TextBlock

- Defined in bitbybit-docs.d.ts:30088
Creates text block

group

create

shortname

create text block

disposableoutput

true

Parameters
- inputs: CreateTextBlockDto
  
  text block properties
Returns TextBlock

createTextBlockObservableSelector

createTextBlockObservableSelector(inputs: TextBlockObservableSelectorDto): onTextChangedObservable

- Defined in bitbybit-docs.d.ts:30199
Creates the selector of an observable for a text block

group

create

shortname

text block observable selector

Parameters
- inputs: TextBlockObservableSelectorDto
  
  observable name
Returns onTextChangedObservable

getLineSpacing

getLineSpacing(inputs: TextBlockDto): string | number

- Defined in bitbybit-docs.d.ts:30160
Gets the line spacing of the text block

group

get

shortname

get line spacing

Parameters
- inputs: TextBlockDto
  
  text block
Returns string | number

line spacing of the text block

getOutlineWidth

getOutlineWidth(inputs: TextBlockDto): number

- Defined in bitbybit-docs.d.ts:30168
Gets the outline width of the text block

group

get

shortname

get outline width

Parameters
- inputs: TextBlockDto
  
  text block
Returns number

outline width of the text block

getResizeToFit

getResizeToFit(inputs: TextBlockDto): boolean

- Defined in bitbybit-docs.d.ts:30176
Gets the resize to fit of the text block

group

get

shortname

get resize to fit

Parameters
- inputs: TextBlockDto
  
  text block
Returns boolean

resize to fit of the text block

getText

getText(inputs: TextBlockDto): string

- Defined in bitbybit-docs.d.ts:30144
Gets the text of the text block

group

get

shortname

get text block text

Parameters
- inputs: TextBlockDto
  
  text block
Returns string

text of the text block

getTextHorizontalAlignment

getTextHorizontalAlignment(inputs: TextBlockDto): number

- Defined in bitbybit-docs.d.ts:30184
Gets the text horizontal alignment of the text block

group

get

shortname

get text horizontal alignment

Parameters
- inputs: TextBlockDto
  
  text block
Returns number

text horizontal alignment of the text block

getTextVerticalAlignment

getTextVerticalAlignment(inputs: TextBlockDto): number

- Defined in bitbybit-docs.d.ts:30192
Gets the text vertical alignment of the text block

group

get

shortname

get text vertical alignment

Parameters
- inputs: TextBlockDto
  
  text block
Returns number

text vertical alignment of the text block

getTextWrapping

getTextWrapping(inputs: TextBlockDto): boolean | TextWrapping

- Defined in bitbybit-docs.d.ts:30152
Gets the text wrapping of the text block

group

get

shortname

get text wrapping

Parameters
- inputs: TextBlockDto
  
  text block
Returns boolean | TextWrapping

text wrapping of the text block

setLineSpacing

setLineSpacing(inputs: SetTextBlockLineSpacingDto): TextBlock

- Defined in bitbybit-docs.d.ts:30136
Sets the line spacing of the text

group

set

shortname

set line spacing

Parameters
- inputs: SetTextBlockLineSpacingDto
  
  text block and line spacing
Returns TextBlock

control that has changed line spacing

setRsizeToFit

setRsizeToFit(inputs: SetTextBlockResizeToFitDto): TextBlock

- Defined in bitbybit-docs.d.ts:30120
Enable or disable resize to fit

group

set

shortname

set resize to fit

Parameters
- inputs: SetTextBlockResizeToFitDto
  
  text block and boolean value
Returns TextBlock

control that has enabled or disabled resize to fit

setText

setText(inputs: SetTextBlockTextDto): TextBlock

- Defined in bitbybit-docs.d.ts:30112
Sets the new text to the text block

group

set

shortname

set text block text

Parameters
- inputs: SetTextBlockTextDto
  
  text block and text
Returns TextBlock

control that has changed text

setTextOutline

setTextOutline(inputs: SetTextBlockTextOutlineDto): TextBlock

- Defined in bitbybit-docs.d.ts:30104
Change the text outline for the text

group

set

shortname

text outline

Parameters
- inputs: SetTextBlockTextOutlineDto
  
  the text block and the outline values
Returns TextBlock

control that has changed text outline

setTextWrapping

setTextWrapping(inputs: SetTextBlockTextWrappingDto): TextBlock

- Defined in bitbybit-docs.d.ts:30128
Sets the new text wrapping to the text block

group

set

shortname

set text wrapping

Parameters
- inputs: SetTextBlockTextWrappingDto
  
  text block and text wrapping
Returns TextBlock

control that has changed text wrapping

Generated using TypeDoc