TextOptions interface

Пакет:

azure-maps-control

Параметры, используемые для настройки текста в SymbolLayer

Extends

Options

Свойства

allowOverlap	Указывает, будет ли текст виден, если он столкнется с другими символами. Если значение равно true, текст будет виден, даже если он столкнется с другими ранее нарисованными символами. Значение по умолчанию: false.
anchor	Указывает, какая часть значка расположена ближе всего к позиции привязки значков на карте. "центр": центр значка расположен ближе всего к привязке. ""left": левая сторона значка расположена ближе всего к привязке. ""right": правая сторона значка расположена ближе всего к привязке. ""top": верхняя часть значка расположена ближе всего к привязке. "внизу": нижняя часть значка расположена ближе всего к привязке. ""сверху слева": верхний левый угол значка расположен ближе всего к привязке. ""в правом верхнем углу": верхний правый угол значка расположен ближе всего к привязке. ""внизу слева": нижний левый угол значка расположен ближе всего к привязке. ""внизу справа": нижний правый угол значка расположен ближе всего к привязке. По умолчанию ""center".
color	Цвет текста. Значение по умолчанию: "#000000".
font	Стек шрифтов, используемый для отображения текста. Возможные значения: "SegoeFrutigerHelveticaMYingHei-Bold", "SegoeFrutigerHelveticaMYingHei-Regular""StandardCondensedSegoeUi-Regular""StandardCondensedSegoeUi-Bold""StandardFont-Regular""SegoeUi-Bold""SegoeFrutigerHelveticaMYingHei-Medium""SegoeUi-Light""SegoeUi-SemiBold""SegoeUi-SemiLight""SegoeUi-SymbolRegular""StandardCondensedSegoeUi-Black""StandardCondensedSegoeUi-Light""StandardFont-Light""SegoeUi-Regular""StandardFont-Black""StandardFont-Bold", "StandardFontCondensed-Black", "StandardFontCondensed-Bold", . "StandardFontCondensed-Light""StandardFontCondensed-Regular" Значение по умолчанию: ["StandardFont-Regular"].
haloBlur	Расстояние исчезания гало к внешней стороне в пикселях. Должно быть число больше или равно 0. Значение по умолчанию: 0.
haloColor	Цвет ореола текста, который помогает выделиться из фона. Значение по умолчанию: "rgba(0,0,0,0)".
haloWidth	Расстояние от ореола до контура шрифта в пикселях. Должно быть число больше или равно 0. Максимальная ширина ореолов текста составляет 1/4 размера шрифта. Значение по умолчанию: 0.
ignorePlacement	Указывает, могут ли другие символы сталкиваться с текстом. Если значение равно true, другие символы могут быть видны, даже если они сталкиваются с текстом. Значение по умолчанию: false.
justify	Параметры обоснования текста. ""auto": текст выравнивается по отношению к позиции привязки. ""left": текст выравнивается по левому краю. "центр": текст находится в центре. ""right": текст выравнивается по правому краю. По умолчанию "центр"
offset	Указывает расстояние смещения значка от привязки в ems. Положительные значения указывают справа и вниз, а отрицательные значения — слева и вверх. Значение по умолчанию: [0, 0].
opacity	Число от 0 до 1, указывающее непрозрачность, с которой будет вырисовываться текст. Значение по умолчанию: 1.
optional	Указывает, может ли текст быть скрыт, если он перекрывается другим символом. Если значение равно true, значки будут отображаться без соответствующего текста, когда текст сталкивается с другими символами, и значок не отображается. Значение по умолчанию: false.
padding	Размер дополнительной области вокруг ограничивающего текста поля, используемого для обнаружения конфликтов символов. Значение по умолчанию: 2.
pitchAlignment	Указывает ориентацию текста при размечении карты. ""auto": автоматически соответствует значению "rotationAlignment". "карта": текст выравнивается по плоскости карты. ""viewport": текст выравнивается по плоскости окна просмотра. По умолчанию: ""auto""
radialOffset	Радиальное смещение текста в направлении привязки символа. Полезен в сочетании с variableAnchor, с которым по умолчанию используется двумерный offset , если он присутствует. По умолчанию: 0
rotation	Величина поворота текста по часовой стрелке в градусах. По умолчанию 0
rotationAlignment	В сочетании со свойством placement объекта SymbolLayerOptionsуказывает поведение поворота отдельных глифов, формируя текст. ""auto": если для параметра "placement" задано значение "точка", это эквивалентно "map". Если для параметра "placement" задано значение "line", это эквивалентно "map". "карта": если для параметра "размещение" задано значение "точка", выравнивается текст на востоке и западе. Если для параметра "placement" задано значение "строка", выравнивает текстовые оси x и линию. ""viewport": создает глифы, x-оси которых выравниваются по оси X окна просмотра, независимо от значения "размещение". По умолчанию: ""auto""
size	Размер шрифта в пикселях. Должно быть число больше или равно 0. Значение по умолчанию: 16.
textField	Указывает имя свойства для компонентов, используемых для текстовой метки.
variableAnchor	Список потенциальных расположений привязки для повышения вероятности размещения меток высокого приоритета на карте. Отрисовщик попытается разместить метку в каждом расположении, прежде чем перейти к следующей метке. Используется justify: "auto" для выбора текстового обоснования на основе позиции привязки. Чтобы применить смещение, используйте radialOffset параметры или двумерные offset параметры. "центр": центр значка расположен ближе всего к привязке. "слева": левая сторона значка находится ближе всего к привязке. "right": правая сторона значка находится ближе всего к привязке. "сверху": верхняя часть значка находится ближе всего к привязке. "внизу": нижняя часть значка находится ближе всего к привязке. ""вверху слева": верхний левый угол значка расположен ближе к привязке. ""в правом верхнем углу": верхний правый угол значка расположен ближе всего к привязке. "внизу слева": нижний левый угол значка расположен ближе всего к привязке. ""внизу справа": нижний правый угол значка расположен ближе всего к привязке. Значение по умолчанию: "undefined"

Сведения о свойстве

allowOverlap

Указывает, будет ли текст виден, если он столкнется с другими символами. Если значение равно true, текст будет виден, даже если он столкнется с другими ранее нарисованными символами. Значение по умолчанию: false.

allowOverlap?: boolean

Значение свойства

boolean

anchor

Указывает, какая часть значка расположена ближе всего к позиции привязки значков на карте.

"центр": центр значка расположен ближе всего к привязке.

""left": левая сторона значка расположена ближе всего к привязке.

""right": правая сторона значка расположена ближе всего к привязке.

""top": верхняя часть значка расположена ближе всего к привязке.

"внизу": нижняя часть значка расположена ближе всего к привязке.

""сверху слева": верхний левый угол значка расположен ближе всего к привязке.

""в правом верхнем углу": верхний правый угол значка расположен ближе всего к привязке.

""внизу слева": нижний левый угол значка расположен ближе всего к привязке.

""внизу справа": нижний правый угол значка расположен ближе всего к привязке.

По умолчанию ""center".

anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

Значение свойства

PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

color

Цвет текста. Значение по умолчанию: "#000000".

color?: string | DataDrivenPropertyValueSpecification<string>

Значение свойства

string | DataDrivenPropertyValueSpecification<string>

font

Стек шрифтов, используемый для отображения текста. Возможные значения: "SegoeFrutigerHelveticaMYingHei-Bold", "SegoeFrutigerHelveticaMYingHei-Regular""StandardCondensedSegoeUi-Regular""StandardCondensedSegoeUi-Bold""StandardFont-Regular""SegoeUi-Bold""SegoeFrutigerHelveticaMYingHei-Medium""SegoeUi-Light""SegoeUi-SemiBold""SegoeUi-SemiLight""SegoeUi-SymbolRegular""StandardCondensedSegoeUi-Black""StandardCondensedSegoeUi-Light""StandardFont-Light""SegoeUi-Regular""StandardFont-Black""StandardFont-Bold", "StandardFontCondensed-Black", "StandardFontCondensed-Bold", . "StandardFontCondensed-Light""StandardFontCondensed-Regular" Значение по умолчанию: ["StandardFont-Regular"].

font?: string[] | DataDrivenPropertyValueSpecification<string[]>

Значение свойства

string[] | DataDrivenPropertyValueSpecification<string[]>

haloBlur

Расстояние исчезания гало к внешней стороне в пикселях. Должно быть число больше или равно 0. Значение по умолчанию: 0.

haloBlur?: number | DataDrivenPropertyValueSpecification<number>

Значение свойства

number | DataDrivenPropertyValueSpecification<number>

haloColor

Цвет ореола текста, который помогает выделиться из фона. Значение по умолчанию: "rgba(0,0,0,0)".

haloColor?: string | DataDrivenPropertyValueSpecification<string>

Значение свойства

string | DataDrivenPropertyValueSpecification<string>

haloWidth

Расстояние от ореола до контура шрифта в пикселях. Должно быть число больше или равно 0. Максимальная ширина ореолов текста составляет 1/4 размера шрифта. Значение по умолчанию: 0.

haloWidth?: number | DataDrivenPropertyValueSpecification<number>

Значение свойства

number | DataDrivenPropertyValueSpecification<number>

ignorePlacement

Указывает, могут ли другие символы сталкиваться с текстом. Если значение равно true, другие символы могут быть видны, даже если они сталкиваются с текстом. Значение по умолчанию: false.

ignorePlacement?: boolean

Значение свойства

boolean

justify

Параметры обоснования текста.

""auto": текст выравнивается по отношению к позиции привязки.

""left": текст выравнивается по левому краю.

"центр": текст находится в центре.

""right": текст выравнивается по правому краю. По умолчанию "центр"

justify?: "auto" | "left" | "center" | "right"

Значение свойства

"auto" | "left" | "center" | "right"

offset

Указывает расстояние смещения значка от привязки в ems. Положительные значения указывают справа и вниз, а отрицательные значения — слева и вверх. Значение по умолчанию: [0, 0].

offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>

Значение свойства

Pixel | DataDrivenPropertyValueSpecification<Pixel>

opacity

Число от 0 до 1, указывающее непрозрачность, с которой будет вырисовываться текст. Значение по умолчанию: 1.

opacity?: number | DataDrivenPropertyValueSpecification<number>

Значение свойства

number | DataDrivenPropertyValueSpecification<number>

optional

Указывает, может ли текст быть скрыт, если он перекрывается другим символом. Если значение равно true, значки будут отображаться без соответствующего текста, когда текст сталкивается с другими символами, и значок не отображается. Значение по умолчанию: false.

optional?: boolean

Значение свойства

boolean

padding

Размер дополнительной области вокруг ограничивающего текста поля, используемого для обнаружения конфликтов символов. Значение по умолчанию: 2.

padding?: number | PropertyValueSpecification<number>

Значение свойства

number | PropertyValueSpecification<number>

pitchAlignment

Указывает ориентацию текста при размечении карты.

""auto": автоматически соответствует значению "rotationAlignment".

"карта": текст выравнивается по плоскости карты.

""viewport": текст выравнивается по плоскости окна просмотра.

По умолчанию: ""auto""

pitchAlignment?: "auto" | "map" | "viewport"

Значение свойства

"auto" | "map" | "viewport"

radialOffset

Радиальное смещение текста в направлении привязки символа. Полезен в сочетании с variableAnchor, с которым по умолчанию используется двумерный offset , если он присутствует. По умолчанию: 0

radialOffset?: number | DataDrivenPropertyValueSpecification<number>

Значение свойства

number | DataDrivenPropertyValueSpecification<number>

rotation

Величина поворота текста по часовой стрелке в градусах. По умолчанию 0

rotation?: number | DataDrivenPropertyValueSpecification<number>

Значение свойства

number | DataDrivenPropertyValueSpecification<number>

rotationAlignment

В сочетании со свойством placement объекта SymbolLayerOptionsуказывает поведение поворота отдельных глифов, формируя текст.

""auto": если для параметра "placement" задано значение "точка", это эквивалентно "map". Если для параметра "placement" задано значение "line", это эквивалентно "map".

"карта": если для параметра "размещение" задано значение "точка", выравнивается текст на востоке и западе. Если для параметра "placement" задано значение "строка", выравнивает текстовые оси x и линию.

""viewport": создает глифы, x-оси которых выравниваются по оси X окна просмотра, независимо от значения "размещение".

По умолчанию: ""auto""

rotationAlignment?: "auto" | "map" | "viewport"

Значение свойства

"auto" | "map" | "viewport"

size

Размер шрифта в пикселях. Должно быть число больше или равно 0. Значение по умолчанию: 16.

size?: number | DataDrivenPropertyValueSpecification<number>

Значение свойства

number | DataDrivenPropertyValueSpecification<number>

textField

Указывает имя свойства для компонентов, используемых для текстовой метки.

textField?: string | DataDrivenPropertyValueSpecification<string>

Значение свойства

string | DataDrivenPropertyValueSpecification<string>

variableAnchor

Список потенциальных расположений привязки для повышения вероятности размещения меток высокого приоритета на карте. Отрисовщик попытается разместить метку в каждом расположении, прежде чем перейти к следующей метке. Используется justify: "auto" для выбора текстового обоснования на основе позиции привязки. Чтобы применить смещение, используйте radialOffset параметры или двумерные offset параметры.

"центр": центр значка расположен ближе всего к привязке.

"слева": левая сторона значка находится ближе всего к привязке.

"right": правая сторона значка находится ближе всего к привязке.

"сверху": верхняя часть значка находится ближе всего к привязке.

"внизу": нижняя часть значка находится ближе всего к привязке.

""вверху слева": верхний левый угол значка расположен ближе к привязке.

""в правом верхнем углу": верхний правый угол значка расположен ближе всего к привязке.

"внизу слева": нижний левый угол значка расположен ближе всего к привязке.

""внизу справа": нижний правый угол значка расположен ближе всего к привязке.

Значение по умолчанию: "undefined"

variableAnchor?: PositionAnchor[]

Значение свойства

PositionAnchor[]