Class: 文本

ol/style/文本~文本 


import 文本 from 'ol/style/文本.js';

为矢量要素设置文本样式。

new 文本(options)

style/文本。js, line 74
Name Type Description
font string | undefined

字体样式，作为 CSS font 值，参见：https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/font。默认为 '10px sans-serif'
maxAngle number (defaults to Math.PI/4)

当 placement 设置为 'line' 时，允许相邻字符之间的最大角度。预期值以弧度为单位，默认为 45°（Math.PI / 4）。
offsetX number (defaults to 0)

水平文本偏移量（像素）。正值将使文本向右偏移。
offsetY number (defaults to 0)

垂直文本偏移量（像素）。正值将使文本向下偏移。
overflow boolean (defaults to false)

对于多边形标签或当 placement 设置为 'line' 时，允许文本超出标签位置处多边形的宽度或其跟随路径的长度。
placement 文本Placement (defaults to 'point')

文本放置。
repeat number | undefined

重复间隔。设置后，文本将按此间隔重复，间隔指定两个文本锚点之间的距离（像素）。仅在 placement 设置为 'line' 时可用。覆盖 'textAlign'。
scale number | Size | undefined

比例。
rotateWithView boolean (defaults to false)

文本是否随视图旋转。
keepUpright boolean (defaults to true)

是否可以将文本旋转 180° 以防止倒置渲染。
rotation number (defaults to 0)

旋转角度（弧度，正值为顺时针）。
text string | Array.<string> | undefined

文本内容或富文本内容。对于纯文本，提供一个字符串，可以包含换行符（\n）。对于富文本，提供文本/字体元组的数组。元组由要渲染的文本和要使用的字体组成（或 '' 使用文本样式的字体）。换行必须是单独的元组（即 '\n', ''）。示例：['foo', 'bold 10px sans-serif', ' bar', 'italic 10px sans-serif', ' baz', ''] 将生成 "foo bar baz"。注意：富文本不支持 placement: 'line' 或即时渲染 API。
textAlign Canvas文本Align | undefined

文本对齐方式。可能的值：'left'、'right'、'center'、'end' 或 'start'。placement: 'point' 时默认为 'center'。placement: 'line' 时，默认让渲染器选择不超过 maxAngle 的放置位置。
justify 文本Justify | undefined

文本框内的文本对齐。如果未设置，文本向 textAlign 锚点对齐。否则，使用 'left'、'center' 或 'right' 选项在文本框内对齐文本。注意：justify 在即时渲染和 placement: 'line' 时被忽略。
textBaseline Canvas文本Baseline (defaults to 'middle')

文本基线。可能的值：'bottom'、'top'、'middle'、'alphabetic'、'hanging'、'ideographic'。
fill Fill | null | undefined

填充样式。如果未提供，将使用深色填充样式 (#333)。指定 null 表示不填充。
stroke Stroke | undefined

描边样式。
backgroundFill Fill | undefined

当 placement 为 'point' 时文本背景的填充样式。默认无填充。
backgroundStroke Stroke | undefined

当 placement 为 'point' 时文本背景的描边样式。默认无描边。
padding Array.<number> (defaults to [0, 0, 0, 0])

文本周围用于去重叠和背景的内边距（像素）。数组中值的顺序为 [top, right, bottom, left]。
declutterMode DeclutterMode | undefined

去重叠模式：declutter、obstacle、none

Methods

clone(){文本}

style/文本。js, line 228

克隆样式。

返回值：
The cloned style.

getBackgroundFill(){Fill | null}

style/文本。js, line 428

获取文本的背景填充样式。

返回值：
填充样式。

getBackgroundStroke(){Stroke | null}

style/文本。js, line 437

获取文本的背景描边样式。

返回值：
描边样式。

getDeclutterMode(){DeclutterMode}

style/文本。js, line 455

获取形状的去重叠模式

返回值：
Shape's declutter mode

getFill(){Fill | null}

style/文本。js, line 330

获取文本的填充样式。

返回值：
填充样式。

getFont(){string | undefined}

style/文本。js, line 276

获取font name.

返回值：
字体。

getJustify(){文本Justify | undefined}

style/文本。js, line 410

获取justification.

返回值：
对齐方式。

getKeepUpright(){boolean | undefined}

style/文本。js, line 348

判断文本是否可以倒置渲染。

返回值：
保持文本直立。

getMaxAngle(){number}

style/文本。js, line 285

获取相邻字符之间的最大角度。

返回值：
角度（弧度）。

getOffsetX(){number}

style/文本。js, line 312

获取x-offset for the text.

返回值：
水平文本偏移量。

getOffsetY(){number}

style/文本。js, line 321

获取y-offset for the text.

返回值：
垂直文本偏移量。

getOverflow(){boolean}

style/文本。js, line 267

获取overflow configuration.

返回值：
Let text overflow the length of the path they follow.

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

style/文本。js, line 446

获取padding for the text.

返回值：
内边距。

getPlacement(){文本Placement}

style/文本。js, line 294

获取label placement.

返回值：
文本放置。

getRepeat(){number | undefined}

style/文本。js, line 303

获取文本的重复间隔。

返回值：
重复间隔（像素）。

getRotateWithView(){boolean | undefined}

style/文本。js, line 339

判断文本是否随地图旋转。

返回值：
随地图旋转。

getRotation(){number | undefined}

style/文本。js, line 357

获取text rotation.

返回值：
旋转角度。

getScale(){number | Size | undefined}

style/文本。js, line 366

获取text scale.

返回值：
比例。

getStroke(){Stroke | null}

style/文本。js, line 383

获取文本的描边样式。

返回值：
描边样式。

get文本(){string | Array.<string> | undefined}

style/文本。js, line 392

获取text to be rendered.

返回值：
文本。

get文本Align(){Canvas文本Align | undefined}

style/文本。js, line 401

获取text alignment.

返回值：
文本 align.

get文本Baseline(){Canvas文本Baseline | undefined}

style/文本。js, line 419

获取text baseline.

返回值：
文本 baseline.

setBackgroundFill(fill)

style/文本。js, line 635

设置background fill.

Name Type Description
fill Fill | null

填充样式。

setBackgroundStroke(stroke)

style/文本。js, line 645

设置background stroke.

Name Type Description
stroke Stroke | null

描边样式。

setFill(fill)

style/文本。js, line 554

设置fill.

Name Type Description
fill Fill | null

填充样式。

setFont(font)

style/文本。js, line 475

设置font.

Name Type Description
font string | undefined

字体。

setJustify(justify)

style/文本。js, line 615

设置justification.

Name Type Description
justify 文本Justify | undefined

对齐方式。

setKeepUpright(keepUpright)

style/文本。js, line 544

设置文本是否可以倒置渲染。

Name Type Description
keepUpright boolean

保持文本直立。

setMaxAngle(maxAngle)

style/文本。js, line 485

设置相邻字符之间的最大角度。

Name Type Description
maxAngle number

角度（弧度）。

setOffsetX(offsetX)

style/文本。js, line 495

设置x offset.

Name Type Description
offsetX number

水平文本偏移量。

setOffsetY(offsetY)

style/文本。js, line 505

设置y offset.

Name Type Description
offsetY number

垂直文本偏移量。

setOverflow(overflow)

style/文本。js, line 465

设置overflow property.

Name Type Description
overflow boolean

允许文本溢出其跟随的路径。

setPadding(padding)

style/文本。js, line 655

设置padding ([top, right, bottom, left]).

Name Type Description
padding Array.<number> | null

内边距。

setPlacement(placement)

style/文本。js, line 515

设置text placement.

Name Type Description
placement 文本Placement

放置方式。

setRepeat(repeat)

style/文本。js, line 524

设置文本的重复间隔。

Name Type Description
repeat number | undefined

重复间隔（像素）。

setRotateWithView(rotateWithView)

style/文本。js, line 534

设置文本是否随视图旋转。

Name Type Description
rotateWithView boolean

随地图旋转。

setRotation(rotation)

style/文本。js, line 564

设置旋转角度。

Name Type Description
rotation number | undefined

旋转角度。

setScale(scale)

style/文本。js, line 574

设置比例。

Name Type Description
scale number | Size | undefined

比例。

setStroke(stroke)

style/文本。js, line 585

设置stroke.

Name Type Description
stroke Stroke | null

描边样式。

set文本(text)

style/文本。js, line 595

设置text.

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

文本。

set文本Align(textAlign)

style/文本。js, line 605

设置text alignment.

Name Type Description
textAlign Canvas文本Align | undefined

文本 align.

set文本Baseline(textBaseline)

style/文本。js, line 625

设置text baseline.

Name Type Description
textBaseline Canvas文本Baseline | undefined

文本 baseline.