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(context: Context): BabylonGuiTextBlock
Parameters
- context: Context
Returns BabylonGuiTextBlock
- Defined in bitbybit-docs.d.ts:35943

create

createTextBlock

createTextBlock(inputs: CreateTextBlockDto): TextBlock
Creates text block
Parameters
- inputs: CreateTextBlockDto
  text block properties
Returns TextBlock
Shortname
create text block

Disposable Output
true
- Defined in bitbybit-docs.d.ts:35951

createTextBlockObservableSelector

createTextBlockObservableSelector(
inputs: TextBlockObservableSelectorDto,
): onTextChangedObservable
Creates the selector of an observable for a text block
Parameters
- inputs: TextBlockObservableSelectorDto
  observable name
Returns onTextChangedObservable
Shortname
text block observable selector
- Defined in bitbybit-docs.d.ts:36062

get

getText

getText(inputs: TextBlockDto): string
Gets the text of the text block
Parameters
- inputs: TextBlockDto
  text block
Returns string
text of the text block

Shortname
get text block text
- Defined in bitbybit-docs.d.ts:36007

getTextWrapping

getTextWrapping(inputs: TextBlockDto): any
Gets the text wrapping of the text block
Parameters
- inputs: TextBlockDto
  text block
Returns any
text wrapping of the text block

Shortname
get text wrapping
- Defined in bitbybit-docs.d.ts:36015

getLineSpacing

getLineSpacing(inputs: TextBlockDto): string | number
Gets the line spacing of the text block
Parameters
- inputs: TextBlockDto
  text block
Returns string | number
line spacing of the text block

Shortname
get line spacing
- Defined in bitbybit-docs.d.ts:36023

getOutlineWidth

getOutlineWidth(inputs: TextBlockDto): number
Gets the outline width of the text block
Parameters
- inputs: TextBlockDto
  text block
Returns number
outline width of the text block

Shortname
get outline width
- Defined in bitbybit-docs.d.ts:36031

getResizeToFit

getResizeToFit(inputs: TextBlockDto): boolean
Gets the resize to fit of the text block
Parameters
- inputs: TextBlockDto
  text block
Returns boolean
resize to fit of the text block

Shortname
get resize to fit
- Defined in bitbybit-docs.d.ts:36039

getTextHorizontalAlignment

getTextHorizontalAlignment(inputs: TextBlockDto): number
Gets the text horizontal alignment of the text block
Parameters
- inputs: TextBlockDto
  text block
Returns number
text horizontal alignment of the text block

Shortname
get text horizontal alignment
- Defined in bitbybit-docs.d.ts:36047

getTextVerticalAlignment

getTextVerticalAlignment(inputs: TextBlockDto): number
Gets the text vertical alignment of the text block
Parameters
- inputs: TextBlockDto
  text block
Returns number
text vertical alignment of the text block

Shortname
get text vertical alignment
- Defined in bitbybit-docs.d.ts:36055

positioning

alignText

alignText(inputs: AlignmentDto<TextBlock>): TextBlock
Change the alignment for the text
Parameters
- inputs: AlignmentDto<TextBlock>
  the text block and the alignment values
Returns TextBlock
control that has changed text alignment

Shortname
align text block text
- Defined in bitbybit-docs.d.ts:35959

set

setTextOutline

setTextOutline(inputs: SetTextBlockTextOutlineDto): TextBlock
Change the text outline for the text
Parameters
- inputs: SetTextBlockTextOutlineDto
  the text block and the outline values
Returns TextBlock
control that has changed text outline

Shortname
text outline
- Defined in bitbybit-docs.d.ts:35967

setText

setText(inputs: SetTextBlockTextDto): TextBlock
Sets the new text to the text block
Parameters
- inputs: SetTextBlockTextDto
  text block and text
Returns TextBlock
control that has changed text

Shortname
set text block text
- Defined in bitbybit-docs.d.ts:35975

setRsizeToFit

setRsizeToFit(inputs: SetTextBlockResizeToFitDto): TextBlock
Enable or disable resize to fit
Parameters
- inputs: SetTextBlockResizeToFitDto
  text block and boolean value
Returns TextBlock
control that has enabled or disabled resize to fit

Shortname
set resize to fit
- Defined in bitbybit-docs.d.ts:35983

setTextWrapping

setTextWrapping(inputs: SetTextBlockTextWrappingDto): TextBlock
Sets the new text wrapping to the text block
Parameters
- inputs: SetTextBlockTextWrappingDto
  text block and text wrapping
Returns TextBlock
control that has changed text wrapping

Shortname
set text wrapping
- Defined in bitbybit-docs.d.ts:35991

setLineSpacing

setLineSpacing(inputs: SetTextBlockLineSpacingDto): TextBlock
Sets the line spacing of the text
Parameters
- inputs: SetTextBlockLineSpacingDto
  text block and line spacing
Returns TextBlock
control that has changed line spacing

Shortname
set line spacing
- Defined in bitbybit-docs.d.ts:35999