Class MTextContext

MText context class for managing text formatting state

Index

Constructors

constructor

new MTextContext(): MTextContext
Returns MTextContext
- Defined in parser/Parser.ts:358

Properties

continueStroke

continueStroke: boolean

Whether to continue stroke formatting

color

color: MTextColor

Color (ACI or RGB)

align

align: MTextLineAlignmentValue

Line alignment

fontFace

fontFace: { family: string; style: string; weight: number }

Font face properties

oblique

oblique: number

Oblique angle

paragraph

paragraph: {
    indent: number;
    left: number;
    right: number;
    align: MTextParagraphAlignmentValue;
    tabs: (string | number)[];
}

Paragraph properties

Accessors

capHeight

get capHeight(): { value: number; isRelative: boolean }
Get the capital letter height

Returns { value: number; isRelative: boolean }
- Defined in parser/Parser.ts:380
set capHeight(value: { value: number; isRelative: boolean }): void
Set the capital letter height
Parameters
- value: { value: number; isRelative: boolean }
  Height value
Returns void
- Defined in parser/Parser.ts:388

widthFactor

get widthFactor(): { value: number; isRelative: boolean }
Get the character width factor

Returns { value: number; isRelative: boolean }
- Defined in parser/Parser.ts:398
set widthFactor(value: { value: number; isRelative: boolean }): void
Set the character width factor
Parameters
- value: { value: number; isRelative: boolean }
  Width factor value
Returns void
- Defined in parser/Parser.ts:406

charTrackingFactor

get charTrackingFactor(): { value: number; isRelative: boolean }
Get the character tracking factor

Returns { value: number; isRelative: boolean }
- Defined in parser/Parser.ts:416
set charTrackingFactor(value: { value: number; isRelative: boolean }): void
Set the character tracking factor
Parameters
- value: { value: number; isRelative: boolean }
  Tracking factor value
Returns void
- Defined in parser/Parser.ts:424

aci

get aci(): number
Get the ACI color value

Returns number
- Defined in parser/Parser.ts:434
set aci(value: number): void
Set the ACI color value
Parameters
- value: number
  ACI color value (0-256)
Returns void
Throws
Error if value is out of range
- Defined in parser/Parser.ts:443

rgb

get rgb(): [number, number, number]
Get the RGB color value

Returns [number, number, number]
- Defined in parser/Parser.ts:450
set rgb(value: [number, number, number]): void
Set the RGB color value
Parameters
- value: [number, number, number]
Returns void
- Defined in parser/Parser.ts:457

italic

get italic(): boolean
Gets whether the current text should be rendered in italic style.

Returns boolean
True if the font style is 'Italic', otherwise false.
- Defined in parser/Parser.ts:465
set italic(value: boolean): void
Sets whether the current text should be rendered in italic style.
Parameters
- value: boolean
  If true, sets the font style to 'Italic'; if false, sets it to 'Regular'.
Returns void
- Defined in parser/Parser.ts:472

bold

get bold(): boolean
Gets whether the current text should be rendered in bold style. This is primarily used for mesh fonts and affects font selection.

Returns boolean
True if the font weight is 700 or higher, otherwise false.
- Defined in parser/Parser.ts:481
set bold(value: boolean): void
Sets whether the current text should be rendered in bold style. This is primarily used for mesh fonts and affects font selection.
Parameters
- value: boolean
  If true, sets the font weight to 700; if false, sets it to 400.
Returns void
- Defined in parser/Parser.ts:489

underline

get underline(): boolean
Get whether text is underlined

Returns boolean
- Defined in parser/Parser.ts:496
set underline(value: boolean): void
Set whether text is underlined
Parameters
- value: boolean
  Whether to underline
Returns void
- Defined in parser/Parser.ts:504

strikeThrough

get strikeThrough(): boolean
Get whether text has strike-through

Returns boolean
- Defined in parser/Parser.ts:511
set strikeThrough(value: boolean): void
Set whether text has strike-through
Parameters
- value: boolean
  Whether to strike through
Returns void
- Defined in parser/Parser.ts:519

overline

get overline(): boolean
Get whether text has overline

Returns boolean
- Defined in parser/Parser.ts:526
set overline(value: boolean): void
Set whether text has overline
Parameters
- value: boolean
  Whether to overline
Returns void
- Defined in parser/Parser.ts:534

hasAnyStroke

get hasAnyStroke(): boolean
Get whether text has any stroke formatting

Returns boolean
- Defined in parser/Parser.ts:541

Methods

copy

copy(): MTextContext
Create a deep copy of this context

Returns MTextContext
A new MTextContext with the same properties
- Defined in parser/Parser.ts:562

toObject

toObject(): Record<string, any>
Convert context to a plain object for serialization

Returns Record<string, any>
Plain object representation
- Defined in parser/Parser.ts:587

Class MTextContext

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MTextContext

Properties

continueStroke

color

align

fontFace

oblique

paragraph

Accessors

capHeight

Returns { value: number; isRelative: boolean }

Parameters

Returns void

widthFactor

Returns { value: number; isRelative: boolean }

Parameters

Returns void

charTrackingFactor

Returns { value: number; isRelative: boolean }

Parameters

Returns void

aci

Returns number

Parameters

Returns void

Throws

rgb

Returns [number, number, number]

Parameters

Returns void

italic

Returns boolean

Parameters

Returns void

bold

Returns boolean

Parameters

Returns void

underline

Returns boolean

Parameters

Returns void

strikeThrough

Returns boolean

Parameters

Returns void

overline

Returns boolean

Parameters

Returns void

hasAnyStroke

Returns boolean

Methods

copy

Returns MTextContext

toObject

Returns Record<string, any>

Settings

On This Page