Class: Text

ol/style/Text~Text 


import Text from 'ol/style/Text.js';

Set text style for vector features.

new Text(options)

style/Text.js, line 72
Name Type Description
font string | undefined

Font style as CSS font value, see: https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/font. Default is '10px sans-serif'
maxAngle number (defaults to Math.PI/4)

When placement is set to 'line', allow a maximum angle between adjacent characters. The expected value is in radians, and the default is 45° (Math.PI / 4).
offsetX number (defaults to 0)

Horizontal text offset in pixels. A positive will shift the text right.
offsetY number (defaults to 0)

Vertical text offset in pixels. A positive will shift the text down.
overflow boolean (defaults to false)

For polygon labels or when placement is set to 'line', allow text to exceed the width of the polygon at the label position or the length of the path that it follows.
placement TextPlacement (defaults to 'point')

Text placement.
repeat number | undefined

Repeat interval in pixels. When set, the text will be repeated at this interval. Only available when placement is set to 'line'. Overrides 'textAlign'.
scale number | Size | undefined

Scale.
rotateWithView boolean (defaults to false)

Whether to rotate the text with the view.
rotation number (defaults to 0)

Rotation in radians (positive rotation clockwise).
text string | Array.<string> | undefined

Text content or rich text content. For plain text provide a string, which can contain line breaks (\n). For rich text provide an array of text/font tuples. A tuple consists of the text to render and the font to use (or '' to use the text style's font). A line break has to be a separate tuple (i.e. '\n', ''). Example: ['foo', 'bold 10px sans-serif', ' bar', 'italic 10px sans-serif', ' baz', ''] will yield "foo bar baz". Note: Rich text is not supported for the immediate rendering API.
textAlign CanvasTextAlign | undefined

Text alignment. Possible values: 'left', 'right', 'center', 'end' or 'start'. Default is 'center' for placement: 'point'. For placement: 'line', the default is to let the renderer choose a placement where maxAngle is not exceeded.
justify TextJustify | undefined

Text justification within the text box. If not set, text is justified towards the textAlign anchor. Otherwise, use options 'left', 'center', or 'right' to justify the text within the text box. Note: justify is ignored for immediate rendering and also for placement: 'line'.
textBaseline CanvasTextBaseline (defaults to 'middle')

Text base line. Possible values: 'bottom', 'top', 'middle', 'alphabetic', 'hanging', 'ideographic'.
fill Fill | undefined

Fill style. If none is provided, we'll use a dark fill-style (#333).
stroke Stroke | undefined

Stroke style.
backgroundFill Fill | undefined

Fill style for the text background when placement is 'point'. Default is no fill.
backgroundStroke Stroke | undefined

Stroke style for the text background when placement is 'point'. Default is no stroke.
padding Array.<number> (defaults to [0, 0, 0, 0])

Padding in pixels around the text for decluttering and background. The order of values in the array is [top, right, bottom, left].

Methods

clone(){Text}

style/Text.js, line 214

Clones the style.

Returns:
The cloned style.

getBackgroundFill(){Fill}

style/Text.js, line 400

Get the background fill style for the text.

Returns:
Fill style.

getBackgroundStroke(){Stroke}

style/Text.js, line 409

Get the background stroke style for the text.

Returns:
Stroke style.

getFill(){Fill}

style/Text.js, line 311

Get the fill style for the text.

Returns:
Fill style.

getFont(){string | undefined}

style/Text.js, line 257

Get the font name.

Returns:
Font.

getJustify(){TextJustify | undefined}

style/Text.js, line 382

Get the justification.

Returns:
Justification.

getMaxAngle(){number}

style/Text.js, line 266

Get the maximum angle between adjacent characters.

Returns:
Angle in radians.

getOffsetX(){number}

style/Text.js, line 293

Get the x-offset for the text.

Returns:
Horizontal text offset.

getOffsetY(){number}

style/Text.js, line 302

Get the y-offset for the text.

Returns:
Vertical text offset.

getOverflow(){boolean}

style/Text.js, line 248

Get the overflow configuration.

Returns:
Let text overflow the length of the path they follow.

getPadding(){Array.<number> | null}

style/Text.js, line 418

Get the padding for the text.

Returns:
Padding.

getPlacement(){TextPlacement}

style/Text.js, line 275

Get the label placement.

Returns:
Text placement.

getRepeat(){number | undefined}

style/Text.js, line 284

Get the repeat interval of the text.

Returns:
Repeat interval in pixels.

getRotateWithView(){boolean | undefined}

style/Text.js, line 320

Determine whether the text rotates with the map.

Returns:
Rotate with map.

getRotation(){number | undefined}

style/Text.js, line 329

Get the text rotation.

Returns:
Rotation.

getScale(){number | Size | undefined}

style/Text.js, line 338

Get the text scale.

Returns:
Scale.

getStroke(){Stroke}

style/Text.js, line 355

Get the stroke style for the text.

Returns:
Stroke style.

getText(){string | Array.<string> | undefined}

style/Text.js, line 364

Get the text to be rendered.

Returns:
Text.

getTextAlign(){CanvasTextAlign | undefined}

style/Text.js, line 373

Get the text alignment.

Returns:
Text align.

getTextBaseline(){CanvasTextBaseline | undefined}

style/Text.js, line 391

Get the text baseline.

Returns:
Text baseline.

setBackgroundFill(fill)

style/Text.js, line 588

Set the background fill.

Name Type Description
fill Fill

Fill style.

setBackgroundStroke(stroke)

style/Text.js, line 598

Set the background stroke.

Name Type Description
stroke Stroke

Stroke style.

setFill(fill)

style/Text.js, line 507

Set the fill.

Name Type Description
fill Fill

Fill style.

setFont(font)

style/Text.js, line 438

Set the font.

Name Type Description
font string | undefined

Font.

setJustify(justify)

style/Text.js, line 568

Set the justification.

Name Type Description
justify TextJustify | undefined

Justification.

setMaxAngle(maxAngle)

style/Text.js, line 448

Set the maximum angle between adjacent characters.

Name Type Description
maxAngle number

Angle in radians.

setOffsetX(offsetX)

style/Text.js, line 458

Set the x offset.

Name Type Description
offsetX number

Horizontal text offset.

setOffsetY(offsetY)

style/Text.js, line 468

Set the y offset.

Name Type Description
offsetY number

Vertical text offset.

setOverflow(overflow)

style/Text.js, line 428

Set the overflow property.

Name Type Description
overflow boolean

Let text overflow the path that it follows.

setPadding(padding)

style/Text.js, line 608

Set the padding ([top, right, bottom, left]).

Name Type Description
padding Array.<number> | null

Padding.

setPlacement(placement)

style/Text.js, line 478

Set the text placement.

Name Type Description
placement TextPlacement

Placement.

setRepeat(repeat)

style/Text.js, line 487

Set the repeat interval of the text.

Name Type Description
repeat number | undefined

Repeat interval in pixels.

setRotateWithView(rotateWithView)

style/Text.js, line 497

Set whether to rotate the text with the view.

Name Type Description
rotateWithView boolean

Rotate with map.

setRotation(rotation)

style/Text.js, line 517

Set the rotation.

Name Type Description
rotation number | undefined

Rotation.

setScale(scale)

style/Text.js, line 527

Set the scale.

Name Type Description
scale number | Size | undefined

Scale.

setStroke(stroke)

style/Text.js, line 538

Set the stroke.

Name Type Description
stroke Stroke

Stroke style.

setText(text)

style/Text.js, line 548

Set the text.

Name Type Description
text string | Array.<string> | undefined

Text.

setTextAlign(textAlign)

style/Text.js, line 558

Set the text alignment.

Name Type Description
textAlign CanvasTextAlign | undefined

Text align.

setTextBaseline(textBaseline)

style/Text.js, line 578

Set the text baseline.

Name Type Description
textBaseline CanvasTextBaseline | undefined

Text baseline.