Class TextLayoutStyle

TextCanvas text rendering style.

Hierarchy

TextLayoutStyle

Index

Constructors

constructor

Accessors

Methods

clone
copy

Constructors

constructor

new TextLayoutStyle(params?: TextLayoutParameters): TextLayoutStyle

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

Parameters
- Default value params: TextLayoutParameters = {}
  
  Input TextLayoutParameters.
Returns TextLayoutStyle

New TextLayoutStyle.

Accessors

canvasRotation

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

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:508
TextCanvas rotation (radians).

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

Parameters
- value: number
Returns void

horizontalAlignment

get horizontalAlignment(): HorizontalAlignment
set horizontalAlignment(value: HorizontalAlignment): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:552
Text position inside a line.

Returns HorizontalAlignment
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:556
Text position inside a line.

Parameters
- value: HorizontalAlignment
Returns void

leading

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

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:475
Inter-line spacing (pixels). Scaled by FontSize.

Returns number
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:479
Inter-line spacing (pixels). Scaled by FontSize.

Parameters
- value: number
Returns void

lineRotation

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

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:519
Line typesetting rotation (radians).

Returns number
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:523
Line typesetting rotation (radians).

Parameters
- value: number
Returns void

lineWidth

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

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:497
Maximum line width (pixels).

Returns number
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:501
Maximum line width (pixels).

Parameters
- value: number
Returns void

maxLines

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

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:486
Maximum number of lines to be considered when using TextCanvas.

Returns number
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:490
Maximum number of lines to be considered when using TextCanvas.

Parameters
- value: number
Returns void

params

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

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

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

Parameters
- value: TextLayoutParameters
Returns void

placements

get placements(): TextPlacements
set placements(value: TextPlacements): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:565
Text placement options relative to label anchor (origin).

note

TextPlacements options may override alignment settings.

Returns TextPlacements
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:569
Text placement options relative to label anchor (origin).

note

TextPlacements options may override alignment settings.

Parameters
- value: TextPlacements
Returns void

tracking

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

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:464
Inter-glyph spacing (pixels). Scaled by FontSize.

Returns number
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:468
Inter-glyph spacing (pixels). Scaled by FontSize.

Parameters
- value: number
Returns void

verticalAlignment

get verticalAlignment(): VerticalAlignment
set verticalAlignment(value: VerticalAlignment): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:541
Text position regarding the baseline.

Returns VerticalAlignment
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:545
Text position regarding the baseline.

Parameters
- value: VerticalAlignment
Returns void

wrappingMode

get wrappingMode(): WrappingMode
set wrappingMode(value: WrappingMode): void

- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:530
Wrapping (line-breaking) mode.

Returns WrappingMode
- Defined in @here/harp-text-canvas/lib/rendering/TextStyle.ts:534
Wrapping (line-breaking) mode.

Parameters
- value: WrappingMode
Returns void

Methods

clone

clone(params?: TextLayoutParameters): TextLayoutStyle

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

Parameters
- Default value params: TextLayoutParameters = {}
  
  Input TextLayoutParameters.
Returns TextLayoutStyle

Cloned TextLayoutStyle.

copy

copy(other: TextLayoutStyle): TextLayoutStyle

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

Parameters
- other: TextLayoutStyle
  
  The object to be copied.
Returns TextLayoutStyle

reference to this object.

Generated using TypeDoc