Class: Text

ol/style/Text~Text 


import Text from 'ol/style/Text';

Set text style for vector features.

new Text(opt_options)

style/Text.js, line 59
Name Type Description
options

Options.

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 module:ol/style/TextPlacement | string (defaults to 'point')

Text placement.
scale number | module:ol/size~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 string | 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 string | 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 string (defaults to 'middle')

Text base line. Possible values: 'bottom', 'top', 'middle', 'alphabetic', 'hanging', 'ideographic'.
fill module:ol/style/Fill~Fill | undefined

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

Stroke style.
backgroundFill module:ol/style/Fill~Fill | undefined

Fill style for the text background when placement is 'point'. Default is no fill.
backgroundStroke module:ol/style/Stroke~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(){module:ol/style/Text~Text}

style/Text.js, line 195

Clones the style.

Returns:
The cloned style.

getBackgroundFill(){module:ol/style/Fill~Fill}

style/Text.js, line 371

Get the background fill style for the text.

Returns:
Fill style.

getBackgroundStroke(){module:ol/style/Stroke~Stroke}

style/Text.js, line 380

Get the background stroke style for the text.

Returns:
Stroke style.

getFill(){module:ol/style/Fill~Fill}

style/Text.js, line 282

Get the fill style for the text.

Returns:
Fill style.

getFont(){string|undefined}

style/Text.js, line 237

Get the font name.

Returns:
Font.

getJustify(){string|undefined}

style/Text.js, line 353

Get the justification.

Returns:
Justification.

getMaxAngle(){number}

style/Text.js, line 246

Get the maximum angle between adjacent characters.

Returns:
Angle in radians.

getOffsetX(){number}

style/Text.js, line 264

Get the x-offset for the text.

Returns:
Horizontal text offset.

getOffsetY(){number}

style/Text.js, line 273

Get the y-offset for the text.

Returns:
Vertical text offset.

getOverflow(){boolean}

style/Text.js, line 228

Get the overflow configuration.

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

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

style/Text.js, line 389

Get the padding for the text.

Returns:
Padding.

getPlacement(){module:ol/style/TextPlacement|string}

style/Text.js, line 255

Get the label placement.

Returns:
Text placement.

getRotateWithView(){boolean|undefined}

style/Text.js, line 291

Determine whether the text rotates with the map.

Returns:
Rotate with map.

getRotation(){number|undefined}

style/Text.js, line 300

Get the text rotation.

Returns:
Rotation.

getScale(){number|module:ol/size~Size|undefined}

style/Text.js, line 309

Get the text scale.

Returns:
Scale.

getStroke(){module:ol/style/Stroke~Stroke}

style/Text.js, line 326

Get the stroke style for the text.

Returns:
Stroke style.

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

style/Text.js, line 335

Get the text to be rendered.

Returns:
Text.

getTextAlign(){string|undefined}

style/Text.js, line 344

Get the text alignment.

Returns:
Text align.

getTextBaseline(){string|undefined}

style/Text.js, line 362

Get the text baseline.

Returns:
Text baseline.

setBackgroundFill(fill)

style/Text.js, line 550

Set the background fill.

Name Type Description
fill module:ol/style/Fill~Fill

Fill style.

setBackgroundStroke(stroke)

style/Text.js, line 560

Set the background stroke.

Name Type Description
stroke module:ol/style/Stroke~Stroke

Stroke style.

setFill(fill)

style/Text.js, line 469

Set the fill.

Name Type Description
fill module:ol/style/Fill~Fill

Fill style.

setFont(font)

style/Text.js, line 409

Set the font.

Name Type Description
font string | undefined

Font.

setJustify(justify)

style/Text.js, line 530

Set the justification.

Name Type Description
justify string | undefined

Justification.

setMaxAngle(maxAngle)

style/Text.js, line 419

Set the maximum angle between adjacent characters.

Name Type Description
maxAngle number

Angle in radians.

setOffsetX(offsetX)

style/Text.js, line 429

Set the x offset.

Name Type Description
offsetX number

Horizontal text offset.

setOffsetY(offsetY)

style/Text.js, line 439

Set the y offset.

Name Type Description
offsetY number

Vertical text offset.

setOverflow(overflow)

style/Text.js, line 399

Set the overflow property.

Name Type Description
overflow boolean

Let text overflow the path that it follows.

setPadding(padding)

style/Text.js, line 570

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

Name Type Description
padding Array.<number> | null

Padding.

setPlacement(placement)

style/Text.js, line 449

Set the text placement.

Name Type Description
placement module:ol/style/TextPlacement | string

Placement.

setRotateWithView(rotateWithView)

style/Text.js, line 459

Set whether to rotate the text with the view.

Name Type Description
rotateWithView boolean

Rotate with map.

setRotation(rotation)

style/Text.js, line 479

Set the rotation.

Name Type Description
rotation number | undefined

Rotation.

setScale(scale)

style/Text.js, line 489

Set the scale.

Name Type Description
scale number | module:ol/size~Size | undefined

Scale.

setStroke(stroke)

style/Text.js, line 500

Set the stroke.

Name Type Description
stroke module:ol/style/Stroke~Stroke

Stroke style.

setText(text)

style/Text.js, line 510

Set the text.

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

Text.

setTextAlign(textAlign)

style/Text.js, line 520

Set the text alignment.

Name Type Description
textAlign string | undefined

Text align.

setTextBaseline(textBaseline)

style/Text.js, line 540

Set the text baseline.

Name Type Description
textBaseline string | undefined

Text baseline.