类:文本

文本(ol/style/Text~


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

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

new Text(options)

Name Type 描述
font string | undefined

字体样式使用CSSfont值,请参见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 TextPlacement (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', '']将生成示例 标签”。注意:不支持富文本placement: 'line'或即时渲染API。

textAlign CanvasTextAlign | undefined

文本对齐。可选值:'left', 'right', 'center', 'end''start'默认值为'center'为了placement: 'point'为了placement: 'line',默认是让渲染器选择一个放置位置,在该位置maxAngle未超出。

justify TextJustify | undefined

文本框内的文本对齐方式。如果未设置,文本将对齐到textAlign锚点。否则,使用选项。'left', 'center''right'两端对齐文本框中的文本。注意: justify对于即时渲染以及其他操作,被忽略。placement: 'line'.

textBaseline CanvasTextBaseline (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

方法

复制样式。

返回:
克隆的样式

getBackgroundFill(){Fill | null}

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

返回:
填充样式。

getBackgroundStroke(){Stroke | null}

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

返回:
描边样式

getDeclutterMode(){DeclutterMode}

获取形状的去重模式

返回:
Shape 的 declutter 模式

getFill(){Fill | null}

获取文本的填充样式。

返回:
填充样式。

getFont(){string | undefined}

获取字体名称。

返回:
字体。

getJustify(){TextJustify | undefined}

获取理由。

返回:
依据。

getKeepUpright(){boolean | undefined}

确定文本能否倒置渲染。

返回:
保持文本直立。

getMaxAngle(){number}

计算相邻字符间的最大角度。

返回:
以弧度为单位的角度。

getOffsetX(){number}

获取文本的x轴偏移量。

返回:
文本水平偏移。

getOffsetY(){number}

获取文本的 y 偏移量。

返回:
垂直文本偏移量。

getOverflow(){boolean}

获取 overflow 的配置。

返回:
使文本溢出其遵循路径的长度。

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

获取文本的内边距。

返回:
内边距。

获取标签放置。

返回:
文本标注。

getRepeat(){number | undefined}

获取文本的重复间隔。

返回:
重复间距(像素)

getRotateWithView(){boolean | undefined}

确定文本是否随地图旋转。

返回:
与地图同步旋转

getRotation(){number | undefined}

获取文本旋转角度。

返回:
旋转.

getScale(){number | Size | undefined}

获取文本缩放比例。

返回:
比例.

getStroke(){Stroke | null}

获取文本的描边样式。

返回:
描边样式

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

获取待渲染的文本。

返回:
文本。

getTextAlign(){CanvasTextAlign | undefined}

获取文本对齐方式。

返回:
文本对齐。

getTextBaseline(){CanvasTextBaseline | undefined}

获取文本基线。

返回:
文本基线。

setBackgroundFill(fill)

设置背景填充。

Name Type 描述
fill Fill | null

填充样式。

setBackgroundStroke(stroke)

设置背景描边。

Name Type 描述
stroke Stroke | null

描边样式。

setFill(fill)

设置填充。

Name Type 描述
fill Fill | null

填充样式。

setFont(font)

设置字体。

Name Type 描述
font string | undefined

字体。

setJustify(justify)

设置对齐方式。

Name Type 描述
justify TextJustify | undefined

设计依据。

setKeepUpright(keepUpright)

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

Name Type 描述
keepUpright boolean

保持文本直立。

setMaxAngle(maxAngle)

设定相邻字符间的最大夹角。

Name Type 描述
maxAngle number

以弧度为单位的角度。

setOffsetX(offsetX)

设置X轴偏移。

Name Type 描述
offsetX number

水平文本偏移

setOffsetY(offsetY)

设置Y轴偏移。

Name Type 描述
offsetY number

文本垂直偏移。

setOverflow(overflow)

设置 overflow 属性。

Name Type 描述
overflow boolean

文本可沿路径溢出。

setPadding(padding)

设置填充 ([top, right, bottom, left])。

Name Type 描述
padding Array.<number> | null

填充。

setPlacement(placement)

设置文本标注位置。

Name Type 描述
placement TextPlacement

放置。

setRepeat(repeat)

设置文本重复间隔。

Name Type 描述
repeat number | undefined

重复间隔(像素)。

setRotateWithView(rotateWithView)

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

Name Type 描述
rotateWithView boolean

随地图旋转。

setRotation(rotation)

设置旋转。

Name Type 描述
rotation number | undefined

旋转.

setScale(scale)

设置比例尺。

Name Type 描述
scale number | Size | undefined

比例.

setStroke(stroke)

设置描边。

Name Type 描述
stroke Stroke | null

描边样式。

setText(text)

设置文本。

Name Type 描述
text string | Array.<string> | undefined

文本。

setTextAlign(textAlign)

设置文本对齐。

Name Type 描述
textAlign CanvasTextAlign | undefined

文本对齐。

setTextBaseline(textBaseline)

设置文本基线。

Name Type 描述
textBaseline CanvasTextBaseline | undefined

文本基线。