Class TextRenderStyle

TextCanvas text rendering style.

Hierarchy

TextRenderStyle

Index

Constructors

constructor

Accessors

Methods

clone
copy

Constructors

constructor

new TextRenderStyle(params?: TextRenderParameters): TextRenderStyle

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:190
Creates a new TextRenderStyle.

Parameters
- Default value params: TextRenderParameters = {}
  
  Input TextRenderParameters.
Returns TextRenderStyle

New TextRenderStyle.

Accessors

backgroundColor

get backgroundColor(): Color
set backgroundColor(value: Color): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:320
Glyph background color.

Returns Color
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:324
Glyph background color.

Parameters
- value: Color
Returns void

backgroundOpacity

get backgroundOpacity(): number
set backgroundOpacity(value: number): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:342
Glyph background opacity.

Returns number
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:346
Glyph background opacity.

Parameters
- value: number
Returns void

color

get color(): Color
set color(value: Color): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:309
Glyph color.

Returns Color
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:313
Glyph color.

Parameters
- value: Color
Returns void

fontName

get fontName(): string
set fontName(value: string): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:254
Name of the preferred Font to be used when rendering.

Returns string
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:258
Name of the preferred Font to be used when rendering.

Parameters
- value: string
Returns void

fontSize

get fontSize(): FontSize
set fontSize(value: FontSize): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:265
Collection of unit and sizes to apply for the currently active Font.

Returns FontSize
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:269
Collection of unit and sizes to apply for the currently active Font.

Parameters
- value: FontSize
Returns void

fontStyle

get fontStyle(): FontStyle
set fontStyle(value: FontStyle): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:276
Glyph style to apply for the currently active Font.

Returns FontStyle
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:280
Glyph style to apply for the currently active Font.

Parameters
- value: FontStyle
Returns void

fontVariant

get fontVariant(): FontVariant
set fontVariant(value: FontVariant): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:287
Glyph variant to apply for the currently active Font.

Returns FontVariant
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:291
Glyph variant to apply for the currently active Font.

Parameters
- value: FontVariant
Returns void

opacity

get opacity(): number
set opacity(value: number): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:331
Glyph opacity.

Returns number
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:335
Glyph opacity.

Parameters
- value: number
Returns void

params

get params(): TextRenderParameters
set params(value: TextRenderParameters): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:243
Current TextRenderParameters for this style.

Returns TextRenderParameters
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:247
Current TextRenderParameters for this style.

Parameters
- value: TextRenderParameters
Returns void

rotation

get rotation(): number
set rotation(value: number): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:298
Glyph local rotation (radians).

Returns number
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:302
Glyph local rotation (radians).

Parameters
- value: number
Returns void

Methods

clone

clone(params?: TextRenderParameters): TextRenderStyle

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:357
Clone this TextRenderStyle.

Parameters
- Default value params: TextRenderParameters = {}
  
  Input TextRenderParameters.
Returns TextRenderStyle

Cloned TextRenderStyle.

copy

copy(source: TextRenderStyle): TextRenderStyle

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:368
Copy other TextRenderStyle properties into this object instance.

Parameters
- source: TextRenderStyle
  
  The source object to be copied.
Returns TextRenderStyle

reference to this object.

Generated using TypeDoc