OpenLayers v4.0.1 API - Class: Text

# Class: Text

This documentation is for OpenLayers v4.0.1. The latest is v.

## ol.style.Text

Set text style for vector features.

#### new ol.style.Text(opt_options)

src/ol/style/text.js, line 15

  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'
  `offsetX` | number | undefined | Horizontal text offset in pixels. A positive will shift the text right. Default is `0`.
  `offsetY` | number | undefined | Vertical text offset in pixels. A positive will shift the text down. Default is `0`.
  `scale` | number | undefined | Scale.
  `rotateWithView` | boolean | undefined | Whether to rotate the text with the view. Default is `false`.
  `rotation` | number | undefined | Rotation in radians (positive rotation clockwise). Default is `0`.
  `text` | string | undefined | Text content.
  `textAlign` | string | undefined | Text alignment. Possible values: 'left', 'right', 'center', 'end' or 'start'. Default is 'start'.
  `textBaseline` | string | undefined | Text base line. Possible values: 'bottom', 'top', 'middle', 'alphabetic', 'hanging', 'ideographic'. Default is 'alphabetic'.
  `fill` | ol.style.Fill | undefined | Fill style. If none is provided, we'll use a dark fill-style (#333).
  `stroke` | ol.style.Stroke | undefined | Stroke style.

### Methods

#### clone(){ol.style.Text}

src/ol/style/text.js, line 103

  Clones the style.

  ##### Returns:

  The cloned style.

#### getFill(){ol.style.Fill}

src/ol/style/text.js, line 155

  Get the fill style for the text.

  ##### Returns:

  Fill style.

#### getFont(){string|undefined}

src/ol/style/text.js, line 125

  Get the font name.

  ##### Returns:

  Font.

#### getOffsetX(){number}

src/ol/style/text.js, line 135

  Get the x-offset for the text.

  ##### Returns:

  Horizontal text offset.

#### getOffsetY(){number}

src/ol/style/text.js, line 145

  Get the y-offset for the text.

  ##### Returns:

  Vertical text offset.

#### getRotateWithView(){boolean|undefined}

src/ol/style/text.js, line 165

  Determine whether the text rotates with the map.

  ##### Returns:

  Rotate with map.

#### getRotation(){number|undefined}

src/ol/style/text.js, line 175

  Get the text rotation.

  ##### Returns:

  Rotation.

#### getScale(){number|undefined}

src/ol/style/text.js, line 185

  Get the text scale.

  ##### Returns:

  Scale.

#### getStroke(){ol.style.Stroke}

src/ol/style/text.js, line 195

  Get the stroke style for the text.

  ##### Returns:

  Stroke style.

#### getText(){string|undefined}

src/ol/style/text.js, line 205

  Get the text to be rendered.

  ##### Returns:

  Text.

#### getTextAlign(){string|undefined}

src/ol/style/text.js, line 215

  Get the text alignment.

  ##### Returns:

  Text align.

#### getTextBaseline(){string|undefined}

src/ol/style/text.js, line 225

  Get the text baseline.

  ##### Returns:

  Text baseline.

#### setFill(fill)

src/ol/style/text.js, line 269

  Set the fill.

  Name | Type | Description
  --- | --- | ---
  `fill` | ol.style.Fill | Fill style.

#### setFont(font)

src/ol/style/text.js, line 236

  Set the font.

  Name | Type | Description
  --- | --- | ---
  `font` | string | undefined | Font.

#### setOffsetX(offsetX)

src/ol/style/text.js, line 247

  Set the x offset.

  Name | Type | Description
  --- | --- | ---
  `offsetX` | number | Horizontal text offset.

#### setOffsetY(offsetY)

src/ol/style/text.js, line 258

  Set the y offset.

  Name | Type | Description
  --- | --- | ---
  `offsetY` | number | Vertical text offset.

#### setRotation(rotation)

src/ol/style/text.js, line 280

  Set the rotation.

  Name | Type | Description
  --- | --- | ---
  `rotation` | number | undefined | Rotation.

#### setScale(scale)

src/ol/style/text.js, line 291

  Set the scale.

  Name | Type | Description
  --- | --- | ---
  `scale` | number | undefined | Scale.

#### setStroke(stroke)

src/ol/style/text.js, line 302

  Set the stroke.

  Name | Type | Description
  --- | --- | ---
  `stroke` | ol.style.Stroke | Stroke style.

#### setText(text)

src/ol/style/text.js, line 313

  Set the text.

  Name | Type | Description
  --- | --- | ---
  `text` | string | undefined | Text.

#### setTextAlign(textAlign)

src/ol/style/text.js, line 324

  Set the text alignment.

  Name | Type | Description
  --- | --- | ---
  `textAlign` | string | undefined | Text align.

#### setTextBaseline(textBaseline)

src/ol/style/text.js, line 335

  Set the text baseline.

  Name | Type | Description
  --- | --- | ---
  `textBaseline` | string | undefined | Text baseline.