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 (по умолчанию Math.PI/4)	Если `placement` установлено в `'line'`, разрешить максимальный угол между смежными символами. Ожидаемое значение — в радианах, по умолчанию 45° (`Math.PI / 4`).
`offsetX`	number (по умолчанию 0)	Горизонтальное смещение текста в пикселях. Положительное значение сместит текст вправо.
`offsetY`	number (по умолчанию 0)	Вертикальное смещение текста в пикселях. Положительное значение сместит текст вниз.
`overflow`	boolean (по умолчанию false)	Для меток полигонов или когда `placement` установлено в `'line'`, разрешить текст за пределами ширины полигона в позиции метки или длины пути, по которому он следует.
`placement`	TextPlacement (по умолчанию 'point')	Позиционирование текста.
`repeat`	number \| undefined	Интервал повторения. При установке текст будет повторяться с этим интервалом, который определяет расстояние между двумя якорями текста в пикселях. Доступно только тогда, когда `placement` установлено в `'line'`. Переопределяет 'textAlign'.
`scale`	number \| Size \| undefined	Масштаб.
`rotateWithView`	boolean (по умолчанию false)	Вращать ли текст вместе с видом?
`keepUpright`	boolean (по умолчанию true)	Разрешить ли вращение текста на 180° для предотвращения отображения вверх ногами.
`rotation`	number (по умолчанию 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'`. По умолчанию `'center'` для `placement: 'point'`. Для `placement: 'line'` по умолчанию рендерер выбирает позиционирование, где `maxAngle` не превышен.
`justify`	TextJustify \| undefined	Выравнивание текста в пределах текстового поля. Если не задано, текст выравнивается к якорю `textAlign`. В противном случае используйте опции `'left'`, `'center'` или `'right'` для выравнивания текста в текстовом поле. Примечание: `justify` игнорируется для мгновенного рендеринга и также для `placement: 'line'`.
`textBaseline`	CanvasTextBaseline (по умолчанию '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> (по умолчанию [0, 0, 0, 0])	Отступ в пикселях вокруг текста для очистки и фона. Порядок значений в массиве — `[top, right, bottom, left]`.
`declutterMode`	DeclutterMode \| undefined	Режим очистки: `declutter`, `obstacle`, `none`

Методы

clone(){Текст} style/Text.js, строка 228: Клонирует стиль.

Возвращает:
Клонированный стиль.
getBackgroundFill(){Заливка | null} style/Text.js, строка 425: Получить стиль заливки фона для текста.

Возвращает:
Стиль заливки.
getBackgroundStroke(){Штрих | null} style/Text.js, строка 434: Получить стиль штриха фона для текста.

Возвращает:
Стиль штриха.
getDeclutterMode(){РежимДефрагментации} style/Text.js, строка 452: Получить режим дефрагментации формы.

Возвращает:
Режим дефрагментации формы
getFill(){Заливка | null} style/Text.js, строка 327: Получить стиль заливки для текста.

Возвращает:
Стиль заливки.
getFont(){string | undefined} style/Text.js, строка 273: Получить имя шрифта.

Возвращает:
Шрифт.
getJustify(){ВыравниваниеТекста | undefined} style/Text.js, строка 407: Получить выравнивание.

Возвращает:
Выравнивание.
getKeepUpright(){boolean | undefined} style/Text.js, строка 345: Определить, может ли текст отображаться в перевёрнутом виде.

Возвращает:
Поддерживать текст в вертикальном положении.
getMaxAngle(){number} style/Text.js, строка 282: Получить максимальный угол между смежными символами.

Возвращает:
Угол в радианах.
getOffsetX(){number} style/Text.js, строка 309: Получить смещение по оси x для текста.

Возвращает:
Горизонтальное смещение текста.
getOffsetY(){number} style/Text.js, строка 318: Получить смещение по оси y для текста.

Возвращает:
Вертикальное смещение текста.
getOverflow(){boolean} style/Text.js, строка 264: Получить конфигурацию overflow.

Возвращает:
Разрешить текстовому содержимому выходить за пределы длины пути, по которому они перемещаются.
getPadding(){Array.<number> | null} style/Text.js, строка 443: Получить отступ для текста.

Возвращает:
Отступ.
getPlacement(){ПоложениеТекста} style/Text.js, строка 291: Получить расположение метки.

Возвращает:
Расположение текста.
getRepeat(){number | undefined} style/Text.js, строка 300: Получить интервал повторения текста.

Возвращает:
Интервал повторения в пикселях.
getRotateWithView(){boolean | undefined} style/Text.js, строка 336: Определить, вращается ли текст вместе с картой.

Возвращает:
Вращать вместе с картой.
getRotation(){number | undefined} style/Text.js, строка 354: Получить поворот текста.

Возвращает:
Поворот.
getScale(){number | Размер | undefined} style/Text.js, строка 363: Получить масштаб текста.

Возвращает:
Масштаб.
getStroke(){Штрих | null} style/Text.js, строка 380: Получить стиль штриха для текста.

Возвращает:
Стиль штриха.
getText(){string | Array.<string> | undefined} style/Text.js, строка 389

Получить текст для отображения.

Возвращает:

Текст.

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

Получить выравнивание текста.

Возвращает:

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

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

Получить базовую линию текста.

Возвращает:

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

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

Установить заливку фона.

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

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

Установить обводку фона.

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

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

Установить заливку.

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

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

Установить шрифт.

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

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

Установить выравнивание.

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

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

Установить, может ли текст отображаться перевернутым.

Имя	Тип	Описание
`keepUpright`	логическое	Удерживать текст в вертикальном положении.

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

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

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

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

Установить смещение по оси X.

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

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

Установить смещение по оси Y.

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

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

Установить свойство overflow.

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

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

Установить отступы ([top, right, bottom, left]).

Имя	Тип	Описание
`padding`	Массив.<число> \| null	Отступы.

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

Установить размещение текста.

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

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

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

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

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

Установите, нужно ли вращать текст вместе с представлением.

Имя	Тип	Описание
`rotateWithView`	логическое	Вращать вместе с картой.

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

Установить поворот.

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

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

Установить масштаб.

Имя	Тип	Описание
`scale`	число \| Размер \| undefined	Масштаб.

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

Установить обводку.

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

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

Установить текст.

Имя	Тип	Описание
`text`	строка \| Массив.<строка> \| undefined	Текст.

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

Установить выравнивание текста.

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

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

Установить базовую линию текста.

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

new Text(options)

Методы

clone(){Текст}

Возвращает:

getBackgroundFill(){Заливка | null}

Возвращает:

getBackgroundStroke(){Штрих | null}

Возвращает:

getDeclutterMode(){РежимДефрагментации}

Возвращает:

getFill(){Заливка | null}

Возвращает:

getFont(){string | undefined}

Возвращает:

getJustify(){ВыравниваниеТекста | undefined}

Возвращает:

getKeepUpright(){boolean | undefined}

Возвращает:

getMaxAngle(){number}

Возвращает:

getOffsetX(){number}

Возвращает:

getOffsetY(){number}

Возвращает:

getOverflow(){boolean}

Возвращает:

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

Возвращает:

getPlacement(){ПоложениеТекста}

Возвращает:

getRepeat(){number | undefined}

Возвращает:

getRotateWithView(){boolean | undefined}

Возвращает:

getRotation(){number | undefined}

Возвращает:

getScale(){number | Размер | undefined}

Возвращает:

getStroke(){Штрих | null}

Возвращает:

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

Возвращает:

getTextAlign(){CanvasTextAlign | undefined}

Возвращает:

getTextBaseline(){CanvasTextBaseline | undefined}

Возвращает:

setBackgroundFill(fill)

setBackgroundStroke(stroke)

setFill(fill)

setFont(font)

setJustify(justify)

setKeepUpright(keepUpright)

setMaxAngle(maxAngle)

setOffsetX(offsetX)

setOffsetY(offsetY)

setOverflow(overflow)

setPadding(padding)

setPlacement(placement)

setRepeat(repeat)

setRotateWithView(rotateWithView)

setRotation(rotation)

setScale(scale)

setStroke(stroke)

setText(text)

setTextAlign(textAlign)

setTextBaseline(textBaseline)