TextOptions interface
Opções usadas para personalizar o texto em um SymbolLayer
- Extends
Propriedades
| allow |
Especifica se o texto ficará visível se ele colidir com outros símbolos.
Se for verdadeiro, o texto ficará visível mesmo se ele colidir com outros símbolos desenhados anteriormente.
Padrão |
| anchor | Especifica qual parte do ícone é colocada mais próxima da posição de âncora de ícones no mapa. '"center"': o centro do ícone é colocado mais próximo da âncora. '"left"': o lado esquerdo do ícone é colocado mais próximo da âncora. '"right"': o lado direito do ícone é colocado mais próximo da âncora. '"top": a parte superior do ícone é colocada mais próxima da âncora. '"bottom"': a parte inferior do ícone é colocada mais próxima da âncora. '"canto superior esquerdo": o canto superior esquerdo do ícone é colocado mais próximo da âncora. '"canto superior direito": o canto superior direito do ícone é colocado mais próximo da âncora. '"inferior esquerdo"': 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 '"central"'. |
| color | A cor do texto.
Padrão |
| font | A pilha de fontes a ser usada para exibir texto.
Valores possíveis: |
| halo |
A distância de fadeout do halo em direção ao exterior em pixels.
Deve ser um número maior ou igual a 0.
Padrão |
| halo |
A cor do halo do texto, que o ajuda a se destacar em segundo plano.
Padrão |
| halo |
A distância do halo até o contorno da fonte em pixels.
Deve ser um número maior ou igual a 0.
A largura máxima do halo de texto é 1/4 do tamanho da fonte.
Padrão |
| ignore |
Especifica se os outros símbolos têm permissão para colidir com o texto.
Se for verdadeiro, outros símbolos poderão ser visíveis mesmo que colidam com o texto.
Padrão |
| justify | Opções de justificativa de texto. '"auto": o texto está alinhado em direção à posição de âncora. '"left"': o texto está alinhado à esquerda. '"center": o texto é centralizado. '"right": o texto está alinhado à direita. Padrão '"center". |
| offset | Especifica uma distância de deslocamento do ícone de sua âncora ems.
Valores positivos indicam direita e para baixo, enquanto valores negativos indicam esquerda e para cima.
Padrão |
| opacity | Um número entre 0 e 1 que indica a opacidade na qual o texto será desenhado.
Padrão |
| optional | Especifica se o texto pode ser oculto se ele for sobreposto por outro símbolo.
Se verdadeiro, os ícones serão exibidos sem o texto correspondente quando o texto colidir com outros símbolos e o ícone não.
Padrão |
| padding | Tamanho da área adicional ao redor da caixa delimitadora de texto usada para detectar colisões de símbolo.
Padrão |
| pitch |
Especifica a orientação do texto quando o mapa é lançado. '"auto": corresponde automaticamente ao valor de 'rotationAlignment'. '"map": o texto está alinhado ao plano do mapa. '"viewport"': o texto está alinhado ao plano do visor. Padrão: '"auto"' |
| radial |
Deslocamento radial do texto, na direção da âncora do símbolo. Útil em combinação com |
| rotation | A quantidade para girar o texto no sentido horário em graus.
Padrão |
| rotation |
Em combinação com a '"auto": quando o 'posicionamento' é definido como '"point"', isso é equivalente a '"map". Quando o 'posicionamento' é definido como '"line"' isso é equivalente a '"map"'. '"map": quando o 'posicionamento' é definido como '"point"', alinha o texto leste-oeste. Quando o 'posicionamento' é definido como '"line"', alinha os eixos x de texto com a linha. '"viewport": produz glifos cujos eixos x estão alinhados com o eixo x do visor, independentemente do valor de 'posicionamento'. Padrão: '"auto"' |
| size | O tamanho da fonte em pixels.
Deve ser um número maior ou igual a 0.
Padrão |
| text |
Especifica o nome de uma propriedade nos recursos a serem usados para um rótulo de texto. |
| variable |
Lista de possíveis locais de âncora, para aumentar a chance de colocar rótulos de alta prioridade no mapa. O renderizador tentará colocar o rótulo em cada local, em ordem, antes de passar para o próximo rótulo. Use '"center": o centro do ícone é colocado mais próximo da âncora. '"left"': o lado esquerdo do ícone é colocado mais próximo da âncora. '"right": o lado direito do ícone é colocado mais próximo da âncora. '"top": a parte superior do ícone é colocada mais próxima da âncora. '"bottom"': a parte inferior do ícone é colocada mais próxima da âncora. '"superior esquerdo"': o canto superior esquerdo do ícone é colocado mais próximo da âncora. '"canto superior direito": o canto superior direito do ícone é colocado mais próximo da âncora. '"inferior esquerdo"': 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 da propriedade
allowOverlap
Especifica se o texto ficará visível se ele colidir com outros símbolos.
Se for verdadeiro, o texto ficará visível mesmo se ele colidir com outros símbolos desenhados anteriormente.
Padrão false.
allowOverlap?: booleanValor da propriedade
boolean
anchor
Especifica qual parte do ícone é colocada mais próxima da posição de âncora de ícones no mapa.
'"center"': o centro do ícone é colocado mais próximo da âncora.
'"left"': o lado esquerdo do ícone é colocado mais próximo da âncora.
'"right"': o lado direito do ícone é colocado mais próximo da âncora.
'"top": a parte superior do ícone é colocada mais próxima da âncora.
'"bottom"': a parte inferior do ícone é colocada mais próxima da âncora.
'"canto superior esquerdo": o canto superior esquerdo do ícone é colocado mais próximo da âncora.
'"canto superior direito": o canto superior direito do ícone é colocado mais próximo da âncora.
'"inferior esquerdo"': 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 '"central"'.anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>Valor da propriedade
PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
color
A cor do texto.
Padrão "#000000".
color?: string | DataDrivenPropertyValueSpecification<string>Valor da propriedade
string | DataDrivenPropertyValueSpecification<string>
font
A pilha de fontes a ser usada para exibir texto.
Valores possíveis: "SegoeFrutigerHelveticaMYingHei-Bold", , "SegoeFrutigerHelveticaMYingHei-Medium", "SegoeFrutigerHelveticaMYingHei-Regular", "SegoeUi-Bold", "SegoeUi-Light", "SegoeUi-Regular", "SegoeUi-SemiBold", "SegoeUi-SemiLight", "SegoeUi-SymbolRegular", "StandardCondensedSegoeUi-Black", "StandardCondensedSegoeUi-Bold", , "StandardCondensedSegoeUi-Light""StandardCondensedSegoeUi-Regular", , "StandardFont-Black", , , "StandardFont-Bold", , "StandardFont-Light", "StandardFont-Regular", "StandardFontCondensed-Black", , "StandardFontCondensed-Bold", "StandardFontCondensed-Light""StandardFontCondensed-Regular"
Padrão ["StandardFont-Regular"].
font?: string[] | DataDrivenPropertyValueSpecification<string[]>Valor da propriedade
string[] | DataDrivenPropertyValueSpecification<string[]>
haloBlur
A distância de fadeout do halo em direção ao exterior em pixels.
Deve ser um número maior ou igual a 0.
Padrão 0.
haloBlur?: number | DataDrivenPropertyValueSpecification<number>Valor da propriedade
number | DataDrivenPropertyValueSpecification<number>
haloColor
A cor do halo do texto, que o ajuda a se destacar em segundo plano.
Padrão "rgba(0,0,0,0)".
haloColor?: string | DataDrivenPropertyValueSpecification<string>Valor da propriedade
string | DataDrivenPropertyValueSpecification<string>
haloWidth
A distância do halo até o contorno da fonte em pixels.
Deve ser um número maior ou igual a 0.
A largura máxima do halo de texto é 1/4 do tamanho da fonte.
Padrão 0.
haloWidth?: number | DataDrivenPropertyValueSpecification<number>Valor da propriedade
number | DataDrivenPropertyValueSpecification<number>
ignorePlacement
Especifica se os outros símbolos têm permissão para colidir com o texto.
Se for verdadeiro, outros símbolos poderão ser visíveis mesmo que colidam com o texto.
Padrão false.
ignorePlacement?: booleanValor da propriedade
boolean
justify
Opções de justificativa de texto.
'"auto": o texto está alinhado em direção à posição de âncora.
'"left"': o texto está alinhado à esquerda.
'"center": o texto é centralizado.
'"right": o texto está alinhado à direita. Padrão '"center".
justify?: "auto" | "left" | "center" | "right"Valor da propriedade
"auto" | "left" | "center" | "right"
offset
Especifica uma distância de deslocamento do ícone de sua âncora ems.
Valores positivos indicam direita e para baixo, enquanto valores negativos indicam esquerda e para cima.
Padrão [0, 0].
offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>Valor da propriedade
opacity
Um número entre 0 e 1 que indica a opacidade na qual o texto será desenhado.
Padrão 1.
opacity?: number | DataDrivenPropertyValueSpecification<number>Valor da propriedade
number | DataDrivenPropertyValueSpecification<number>
optional
Especifica se o texto pode ser oculto se ele for sobreposto por outro símbolo.
Se verdadeiro, os ícones serão exibidos sem o texto correspondente quando o texto colidir com outros símbolos e o ícone não.
Padrão false.
optional?: booleanValor da propriedade
boolean
padding
Tamanho da área adicional ao redor da caixa delimitadora de texto usada para detectar colisões de símbolo.
Padrão 2.
padding?: number | PropertyValueSpecification<number>Valor da propriedade
number | PropertyValueSpecification<number>
pitchAlignment
Especifica a orientação do texto quando o mapa é lançado.
'"auto": corresponde automaticamente ao valor de 'rotationAlignment'.
'"map": o texto está alinhado ao plano do mapa.
'"viewport"': o texto está alinhado ao plano do visor.
Padrão: '"auto"'pitchAlignment?: "auto" | "map" | "viewport"Valor da propriedade
"auto" | "map" | "viewport"
radialOffset
Deslocamento radial do texto, na direção da âncora do símbolo. Útil em combinação com variableAnchoro qual o padrão é usar o bidimensional offset se presente.
Padrão: 0
radialOffset?: number | DataDrivenPropertyValueSpecification<number>Valor da propriedade
number | DataDrivenPropertyValueSpecification<number>
rotation
A quantidade para girar o texto no sentido horário em graus.
Padrão 0
rotation?: number | DataDrivenPropertyValueSpecification<number>Valor da 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 o 'posicionamento' é definido como '"point"', isso é equivalente a '"map". Quando o 'posicionamento' é definido como '"line"' isso é equivalente a '"map"'.
'"map": quando o 'posicionamento' é definido como '"point"', alinha o texto leste-oeste. Quando o 'posicionamento' é definido como '"line"', alinha os eixos x de texto com a linha.
'"viewport": produz glifos cujos eixos x estão alinhados com o eixo x do visor, independentemente do valor de 'posicionamento'.
Padrão: '"auto"'rotationAlignment?: "auto" | "map" | "viewport"Valor da propriedade
"auto" | "map" | "viewport"
size
O tamanho da fonte em pixels.
Deve ser um número maior ou igual a 0.
Padrão 16.
size?: number | DataDrivenPropertyValueSpecification<number>Valor da propriedade
number | DataDrivenPropertyValueSpecification<number>
textField
Especifica o nome de uma propriedade nos recursos a serem usados para um rótulo de texto.
textField?: string | DataDrivenPropertyValueSpecification<string>Valor da propriedade
string | DataDrivenPropertyValueSpecification<string>
variableAnchor
Lista de possíveis locais de âncora, para aumentar a chance de colocar rótulos de alta prioridade no mapa. O renderizador tentará colocar o rótulo em cada local, em ordem, antes de passar para o próximo rótulo. Use justify: "auto" para escolher a justificativa de texto com base na posição de âncora. Para aplicar um deslocamento, use as radialOffset opções bidimensionais ou bidimensionais offset .
'"center": o centro do ícone é colocado mais próximo da âncora.
'"left"': o lado esquerdo do ícone é colocado mais próximo da âncora.
'"right": o lado direito do ícone é colocado mais próximo da âncora.
'"top": a parte superior do ícone é colocada mais próxima da âncora.
'"bottom"': a parte inferior do ícone é colocada mais próxima da âncora.
'"superior esquerdo"': o canto superior esquerdo do ícone é colocado mais próximo da âncora.
'"canto superior direito": o canto superior direito do ícone é colocado mais próximo da âncora.
'"inferior esquerdo"': 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'variableAnchor?: PositionAnchor[]