TextOptions interface

Referência

Pacote:: azure-maps-control

Opções usadas para personalizar o texto num SymbolLayer

Extends: Options

Propriedades

allowOverlap	Especifica se o texto será visível se colidir com outros símbolos. Se for verdade, o texto será visível mesmo que colide com outros símbolos previamente desenhados. Predefinição `false`.
anchor	Especifica qual parte do ícone é colocada mais próxima da posição de âncora dos ícones no mapa. '"Centro": O centro do ícone é colocado mais próximo da âncora. ""À esquerda": O lado esquerdo do ícone é colocado mais próximo da âncora. "Direita": O lado direito do ícone é colocado mais próximo da âncora. 'Top': A parte superior do ícone é colocada mais próxima da âncora. ""Fundo": A parte inferior do ícone é colocada mais próxima da âncora. ""Parte superior à esquerda": O canto superior esquerdo do ícone é colocado mais próximo da âncora. ""top-right": O canto superior direito do ícone é colocado mais próximo da âncora. ""Inferior à esquerda": O canto inferior esquerdo do ícone é colocado mais próximo da âncora. ""Inferior-direito": O canto inferior direito do ícone é colocado mais próximo da âncora. "Centro" padrão.
color	A cor do texto. Predefinição `"#000000"`.
font	A pilha de fonte a utilizar para visualizar texto. Valores possíveis: `"SegoeFrutigerHelveticaMYingHei-Bold"`, `"SegoeFrutigerHelveticaMYingHei-Medium"`, , `"SegoeUi-Bold"`, `"SegoeUi-Light"`, `"SegoeUi-SemiLight""StandardCondensedSegoeUi-Light""SegoeUi-SemiBold""SegoeUi-SymbolRegular""StandardCondensedSegoeUi-Black""StandardFont-Black""StandardFont-Light""StandardCondensedSegoeUi-Bold""StandardCondensedSegoeUi-Regular""StandardFont-Bold""SegoeUi-Regular"`, , `"StandardFontCondensed-Regular""StandardFont-Regular""StandardFontCondensed-Black""StandardFontCondensed-Bold""StandardFontCondensed-Light""SegoeFrutigerHelveticaMYingHei-Regular"` Predefinição `["StandardFont-Regular"]`.
haloBlur	A distância desvanecimento da auréola para o exterior em pixels. Deve ser um número maior ou igual a 0. Predefinição `0`.
haloColor	A cor da auréola do texto, que o ajuda a destacar-se dos fundos. Predefinição `"rgba(0,0,0,0)"`.
haloWidth	A distância da auréola ao contorno da fonte em pixels. Deve ser um número maior ou igual a 0. A largura máxima de auréola de texto é de 1/4 do tamanho do tipo de letra. Predefinição `0`.
ignorePlacement	Especifica se os outros símbolos podem colidir com o texto. Se for verdade, outros símbolos podem ser visíveis mesmo que colidam com o texto. Predefinição `false`.
justify	Opções de justificação de texto. "Auto": O texto está alinhado em direção à posição de âncora. ""Esquerda": O texto está alinhado à esquerda. 'centro': O texto está centrado. ""direita": O texto está alinhado à direita. "Centro" padrão.
offset	Especifica uma distância compensada do ícone da sua âncora em ems. Os valores positivos indicam a direita e a descida, enquanto os valores negativos indicam para a esquerda e para cima. Predefinição `[0, 0]`.
opacity	Um número entre 0 e 1 que indica a opacidade na qual o texto será desenhado. Predefinição `1`.
optional	Especifica se o texto pode ser escondido se for sobreposto por outro símbolo. Se for verdade, os ícones serão exibidos sem o seu texto correspondente quando o texto colide com outros símbolos e o ícone não. Predefinição `false`.
padding	Tamanho da área adicional em torno da caixa de delimitação de texto utilizada para detetar colisões de símbolos. Predefinição `2`.
pitchAlignment	Especifica a orientação do texto quando o mapa é apresentado. 'auto': Corresponde automaticamente ao valor da 'rotaçãoAlignment'. "Mapa": O texto está alinhado com o plano do mapa. "Viewport": O texto está alinhado com o plano do viewport. Predefinição: "Auto".
radialOffset	Offset radial de texto, na direção da âncora do símbolo. Útil em combinação com `variableAnchor`, que falha em usar o bidimensional `offset` se presente. Predefinição: `0`
rotation	A quantidade para rodar o texto no sentido dos ponteiros do relógio em graus. Predefinição `0`
rotationAlignment	Em combinação com a `placement` propriedade do `SymbolLayerOptions`, especifica o comportamento de rotação dos glifos individuais que formam o texto. 'auto': Quando a 'colocação' é definida como 'ponto', isto equivale a "mapa". Quando a 'colocação' é definida como "linha", isto equivale a "mapa". "Mapa":" Quando a 'colocação' é definida como "ponto", alinha o texto leste-oeste. Quando a 'colocação' está definida como "linha", alinha os eixos de texto x com a linha. "Viewport": Produz glifos cujos eixos x estão alinhados com o eixo x do viewport, independentemente do valor da 'colocação'. Predefinição: "Auto".
size	O tamanho do tipo de letra em pixels. Deve ser um número maior ou igual a 0. Predefinição `16`.
textField	Especifica o nome de uma propriedade nas funcionalidades a utilizar para uma etiqueta de texto.
variableAnchor	Lista de potenciais locais de ancoragem, para aumentar a probabilidade de colocar etiquetas de alta prioridade no mapa. O renderizador tentará colocar a etiqueta em cada local, por ordem, antes de passar para a etiqueta seguinte. Utilize `justify: "auto"` para escolher a justificação de texto com base na posição de âncora. Para aplicar uma compensação use as `radialOffset` opções ou bidimensionais `offset` . '"Centro": O centro do ícone é colocado mais próximo da âncora. ""À esquerda": O lado esquerdo do ícone é colocado mais próximo da âncora. "Direita": O lado direito do ícone é colocado mais próximo da âncora. 'Top': A parte superior do ícone é colocada mais próxima da âncora. ""Fundo": A parte inferior do ícone é colocada mais próxima da âncora. ""Parte superior à esquerda": O canto superior esquerdo do ícone é colocado mais próximo da âncora. ""top-right": O canto superior direito do ícone é colocado mais próximo da âncora. ""Inferior à esquerda": O canto inferior esquerdo do ícone é colocado mais próximo da âncora. ""Inferior-direito": O canto inferior direito do ícone é colocado mais próximo da âncora. Padrão: "indefinido"

Detalhes de Propriedade

allowOverlap

Especifica se o texto será visível se colidir com outros símbolos. Se for verdade, o texto será visível mesmo que colide com outros símbolos previamente desenhados. Predefinição false.

allowOverlap?: boolean

Valor de Propriedade

boolean

anchor

Especifica qual parte do ícone é colocada mais próxima da posição de âncora dos ícones no mapa.

'"Centro": O centro do ícone é colocado mais próximo da âncora.

""À esquerda": O lado esquerdo do ícone é colocado mais próximo da âncora.

"Direita": O lado direito do ícone é colocado mais próximo da âncora.

'Top': A parte superior do ícone é colocada mais próxima da âncora.

""Fundo": A parte inferior do ícone é colocada mais próxima da âncora.

""Parte superior à esquerda": O canto superior esquerdo do ícone é colocado mais próximo da âncora.

""top-right": O canto superior direito do ícone é colocado mais próximo da âncora.

""Inferior à esquerda": O canto inferior esquerdo do ícone é colocado mais próximo da âncora.

""Inferior-direito": O canto inferior direito do ícone é colocado mais próximo da âncora.

"Centro" padrão.

anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

Valor de Propriedade

PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>

color

A cor do texto. Predefinição "#000000".

color?: string | DataDrivenPropertyValueSpecification<string>

Valor de Propriedade

string | DataDrivenPropertyValueSpecification<string>

font

A pilha de fonte a utilizar para visualizar texto. Valores possíveis: "SegoeFrutigerHelveticaMYingHei-Bold", "SegoeFrutigerHelveticaMYingHei-Medium", , "SegoeUi-Bold", "SegoeUi-Light", "SegoeUi-SemiLight""StandardCondensedSegoeUi-Light""SegoeUi-SemiBold""SegoeUi-SymbolRegular""StandardCondensedSegoeUi-Black""StandardFont-Black""StandardFont-Light""StandardCondensedSegoeUi-Bold""StandardCondensedSegoeUi-Regular""StandardFont-Bold""SegoeUi-Regular", , "StandardFontCondensed-Regular""StandardFont-Regular""StandardFontCondensed-Black""StandardFontCondensed-Bold""StandardFontCondensed-Light""SegoeFrutigerHelveticaMYingHei-Regular" Predefinição ["StandardFont-Regular"].

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

Valor de Propriedade

string[] | DataDrivenPropertyValueSpecification<string[]>

haloBlur

A distância desvanecimento da auréola para o exterior em pixels. Deve ser um número maior ou igual a 0. Predefinição 0.

haloBlur?: number | DataDrivenPropertyValueSpecification<number>

Valor de Propriedade

number | DataDrivenPropertyValueSpecification<number>

haloColor

A cor da auréola do texto, que o ajuda a destacar-se dos fundos. Predefinição "rgba(0,0,0,0)".

haloColor?: string | DataDrivenPropertyValueSpecification<string>

Valor de Propriedade

string | DataDrivenPropertyValueSpecification<string>

haloWidth

A distância da auréola ao contorno da fonte em pixels. Deve ser um número maior ou igual a 0. A largura máxima de auréola de texto é de 1/4 do tamanho do tipo de letra. Predefinição 0.

haloWidth?: number | DataDrivenPropertyValueSpecification<number>

Valor de Propriedade

number | DataDrivenPropertyValueSpecification<number>

ignorePlacement

Especifica se os outros símbolos podem colidir com o texto. Se for verdade, outros símbolos podem ser visíveis mesmo que colidam com o texto. Predefinição false.

ignorePlacement?: boolean

Valor de Propriedade

boolean

justify

Opções de justificação de texto.

"Auto": O texto está alinhado em direção à posição de âncora.

""Esquerda": O texto está alinhado à esquerda.

'centro': O texto está centrado.

""direita": O texto está alinhado à direita. "Centro" padrão.

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

Valor de Propriedade

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

offset

Especifica uma distância compensada do ícone da sua âncora em ems. Os valores positivos indicam a direita e a descida, enquanto os valores negativos indicam para a esquerda e para cima. Predefinição [0, 0].

offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>

Valor de Propriedade

Pixel | DataDrivenPropertyValueSpecification<Pixel>

opacity

Um número entre 0 e 1 que indica a opacidade na qual o texto será desenhado. Predefinição 1.

opacity?: number | DataDrivenPropertyValueSpecification<number>

Valor de Propriedade

number | DataDrivenPropertyValueSpecification<number>

optional

Especifica se o texto pode ser escondido se for sobreposto por outro símbolo. Se for verdade, os ícones serão exibidos sem o seu texto correspondente quando o texto colide com outros símbolos e o ícone não. Predefinição false.

optional?: boolean

Valor de Propriedade

boolean

padding

Tamanho da área adicional em torno da caixa de delimitação de texto utilizada para detetar colisões de símbolos. Predefinição 2.

padding?: number | PropertyValueSpecification<number>

Valor de Propriedade

number | PropertyValueSpecification<number>

pitchAlignment

Especifica a orientação do texto quando o mapa é apresentado.

'auto': Corresponde automaticamente ao valor da 'rotaçãoAlignment'.

"Mapa": O texto está alinhado com o plano do mapa.

"Viewport": O texto está alinhado com o plano do viewport.

Predefinição: "Auto".

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

Valor de Propriedade

"auto" | "map" | "viewport"

radialOffset

Offset radial de texto, na direção da âncora do símbolo. Útil em combinação com variableAnchor, que falha em usar o bidimensional offset se presente. Predefinição: 0

radialOffset?: number | DataDrivenPropertyValueSpecification<number>

Valor de Propriedade

number | DataDrivenPropertyValueSpecification<number>

rotation

A quantidade para rodar o texto no sentido dos ponteiros do relógio em graus. Predefinição 0

rotation?: number | DataDrivenPropertyValueSpecification<number>

Valor de Propriedade

number | DataDrivenPropertyValueSpecification<number>

rotationAlignment

Em combinação com a placement propriedade do SymbolLayerOptions, especifica o comportamento de rotação dos glifos individuais que formam o texto.

'auto': Quando a 'colocação' é definida como 'ponto', isto equivale a "mapa". Quando a 'colocação' é definida como "linha", isto equivale a "mapa".

"Mapa":" Quando a 'colocação' é definida como "ponto", alinha o texto leste-oeste. Quando a 'colocação' está definida como "linha", alinha os eixos de texto x com a linha.

"Viewport": Produz glifos cujos eixos x estão alinhados com o eixo x do viewport, independentemente do valor da 'colocação'.

Predefinição: "Auto".

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

Valor de Propriedade

"auto" | "map" | "viewport"

size

O tamanho do tipo de letra em pixels. Deve ser um número maior ou igual a 0. Predefinição 16.

size?: number | DataDrivenPropertyValueSpecification<number>

Valor de Propriedade

number | DataDrivenPropertyValueSpecification<number>

textField

Especifica o nome de uma propriedade nas funcionalidades a utilizar para uma etiqueta de texto.

textField?: string | DataDrivenPropertyValueSpecification<string>

Valor de Propriedade

string | DataDrivenPropertyValueSpecification<string>

variableAnchor

Lista de potenciais locais de ancoragem, para aumentar a probabilidade de colocar etiquetas de alta prioridade no mapa. O renderizador tentará colocar a etiqueta em cada local, por ordem, antes de passar para a etiqueta seguinte. Utilize justify: "auto" para escolher a justificação de texto com base na posição de âncora. Para aplicar uma compensação use as radialOffset opções ou bidimensionais offset .