Text~Text

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

Задать стиль текста для векторных объектов.

new Text(options) style/Text.js, строка 74

Имя	Тип	Описание
`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`	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', '']` даст результат "foo bar baz". Примечание: Форматированный текст не поддерживается для `placement: 'line'` и API непосредственной отрисовки.
`textAlign`	CanvasTextAlign \| undefined	Выравнивание текста. Возможные значения: `'left'`, `'right'`, `'center'`, `'end'` или `'start'`. Для `placement: 'point'` по умолчанию используется `'center'`. Для `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`

Методы

clone(){Text} style/Text.js, строка 228

Создаёт копию стиля.

Возвращает:

Копию стиля.

getBackgroundFill(){Fill | null} style/Text.js, строка 428

Возвращает стиль заливки фона текста.

Возвращает:

Стиль заливки.

getBackgroundStroke(){Stroke | null} style/Text.js, строка 437

Возвращает стиль обводки фона текста.

Возвращает:

Стиль обводки.

getDeclutterMode(){DeclutterMode} style/Text.js, строка 455

Возвращает режим устранения наложений для фигуры

Возвращает:

Режим устранения наложений фигуры

getFill(){Fill | null} style/Text.js, строка 330

Возвращает стиль заливки текста.

Возвращает:

Стиль заливки.

getFont(){string | undefined} style/Text.js, строка 276

Возвращает название шрифта.

Возвращает:

Шрифт.

getJustify(){TextJustify | undefined} style/Text.js, строка 410

Возвращает выравнивание по ширине.

Возвращает:

Выравнивание по ширине.

getKeepUpright(){boolean | undefined} style/Text.js, строка 348

Определяет, можно ли отображать текст вверх ногами.

Возвращает:

Сохранять текст в правильном положении.

getMaxAngle(){number} style/Text.js, строка 285

Возвращает максимальный угол между соседними символами.

Возвращает:

Угол в радианах.

getOffsetX(){number} style/Text.js, строка 312

Возвращает смещение текста по оси x.

Возвращает:

Горизонтальное смещение текста.

getOffsetY(){number} style/Text.js, строка 321

Возвращает смещение текста по оси y.

Возвращает:

Вертикальное смещение текста.

getOverflow(){boolean} style/Text.js, строка 267

Возвращает настройку overflow.

Возвращает:

Разрешает тексту выходить за пределы длины пути, вдоль которого он расположен.

getPadding(){Array.<number> | null} style/Text.js, строка 446

Возвращает внутренний отступ текста.

Возвращает:

Внутренний отступ.

getPlacement(){TextPlacement} style/Text.js, строка 294

Возвращает способ размещения подписи.

Возвращает:

Размещение текста.

getRepeat(){number | undefined} style/Text.js, строка 303

Возвращает интервал повторения текста.

Возвращает:

Интервал повторения в пикселях.

getRotateWithView(){boolean | undefined} style/Text.js, строка 339

Определяет, поворачивается ли текст вместе с картой.

Возвращает:

Поворачивать вместе с картой.

getRotation(){number | undefined} style/Text.js, строка 357

Возвращает угол поворота текста.

Возвращает:

Угол поворота.

getScale(){number | Size | undefined} style/Text.js, строка 366

Возвращает масштаб текста.

Возвращает:

Масштаб.

getStroke(){Stroke | null} style/Text.js, строка 383

Возвращает стиль обводки текста.

Возвращает:

Стиль обводки.

getText(){string | Array.<string> | undefined} style/Text.js, строка 392

Возвращает текст для отображения.

Возвращает:

Текст.

getTextAlign(){CanvasTextAlign | undefined} style/Text.js, строка 401

Возвращает выравнивание текста.

Возвращает:

Выравнивание текста.

getTextBaseline(){CanvasTextBaseline | undefined} style/Text.js, строка 419

Возвращает базовую линию текста.

Возвращает:

Базовая линия текста.

setBackgroundFill(fill) style/Text.js, строка 635

Задаёт заливку фона.

Имя	Тип	Описание
`fill`	Fill \| null	Стиль заливки.

setBackgroundStroke(stroke) style/Text.js, строка 645

Задаёт обводку фона.

Имя	Тип	Описание
`stroke`	Stroke \| null	Стиль обводки.

setFill(fill) style/Text.js, строка 554

Задаёт заливку.

Имя	Тип	Описание
`fill`	Fill \| null	Стиль заливки.

setFont(font) style/Text.js, строка 475

Задаёт шрифт.

Имя	Тип	Описание
`font`	string \| undefined	Шрифт.

setJustify(justify) style/Text.js, строка 615

Задаёт выравнивание по ширине.

Имя	Тип	Описание
`justify`	TextJustify \| undefined	Выравнивание по ширине.

setKeepUpright(keepUpright) style/Text.js, строка 544

Задаёт, можно ли отображать текст вверх ногами.

Имя	Тип	Описание
`keepUpright`	boolean	Сохранять текст в правильном положении.

setMaxAngle(maxAngle) style/Text.js, строка 485

Задаёт максимальный угол между соседними символами.

Имя	Тип	Описание
`maxAngle`	number	Угол в радианах.

setOffsetX(offsetX) style/Text.js, строка 495

Задаёт смещение по оси x.

Имя	Тип	Описание
`offsetX`	number	Горизонтальное смещение текста.

setOffsetY(offsetY) style/Text.js, строка 505

Задаёт смещение по оси y.

Имя	Тип	Описание
`offsetY`	number	Вертикальное смещение текста.

setOverflow(overflow) style/Text.js, строка 465

Задаёт свойство overflow.

Имя	Тип	Описание
`overflow`	boolean	Разрешает тексту выходить за пределы пути, вдоль которого он расположен.

setPadding(padding) style/Text.js, строка 655

Задаёт внутренний отступ ([top, right, bottom, left]).

Имя	Тип	Описание
`padding`	Array.<number> \| null	Внутренний отступ.

setPlacement(placement) style/Text.js, строка 515

Задаёт способ размещения текста.

Имя	Тип	Описание
`placement`	TextPlacement	Размещение.

setRepeat(repeat) style/Text.js, строка 524

Задаёт интервал повторения текста.

Имя	Тип	Описание
`repeat`	number \| undefined	Интервал повторения в пикселях.

setRotateWithView(rotateWithView) style/Text.js, строка 534

Задаёт, нужно ли поворачивать текст вместе с видом карты.

Имя	Тип	Описание
`rotateWithView`	boolean	Поворачивать вместе с картой.

setRotation(rotation) style/Text.js, строка 564

Задаёт угол поворота.

Имя	Тип	Описание
`rotation`	number \| undefined	Угол поворота.

setScale(scale) style/Text.js, строка 574

Задаёт масштаб.

Имя	Тип	Описание
`scale`	number \| Size \| undefined	Масштаб.

setStroke(stroke) style/Text.js, строка 585

Задаёт обводку.

Имя	Тип	Описание
`stroke`	Stroke \| null	Стиль обводки.

setText(text) style/Text.js, строка 595

Задаёт текст.

Имя	Тип	Описание
`text`	string \| Array.<string> \| undefined	Текст.

setTextAlign(textAlign) style/Text.js, строка 605

Задаёт выравнивание текста.

Имя	Тип	Описание
`textAlign`	CanvasTextAlign \| undefined	Выравнивание текста.

setTextBaseline(textBaseline) style/Text.js, строка 625

Задаёт базовую линию текста.

Имя	Тип	Описание
`textBaseline`	CanvasTextBaseline \| undefined	Базовая линия текста.