IconOptions interface
Opções usadas para personalizar os ícones em um SymbolLayer
- Extends
Propriedades
allow |
Especifica se o ícone de símbolo pode sobrepor outros símbolos no mapa.
Se |
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. '"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 '"inferior". |
ignore |
Especifica se outros símbolos podem sobrepor esse símbolo.
Se for verdadeiro, outros símbolos poderão ser visíveis mesmo se colidirem com o ícone.
Padrão |
image | O nome da imagem no sprite de imagem do mapa a ser usado para desenhar o ícone.
As imagens internas disponíveis são: |
offset | Especifica uma distância de deslocamento do ícone de sua âncora em pixels.
Valores positivos indicam direita e para baixo, enquanto valores negativos indicam esquerda e para cima.
Cada componente é multiplicado pelo valor de tamanho para obter o deslocamento final em pixels.
Quando combinado com a rotação, o deslocamento será como se a direção girada estivesse para cima.
Padrão |
opacity | Um número entre 0 e 1 que indica a opacidade na qual o ícone será desenhado.
Padrão |
optional | Especifica se um ícone de símbolos pode ser oculto, mas seu texto será exibido se ele estiver sobreposto a outro símbolo.
Se verdadeiro, o texto será exibido sem seus ícones correspondentes quando o ícone colidir com outros símbolos e o texto não.
Padrão |
padding | Tamanho da área adicional ao redor da caixa delimitadora de ícone usada para detectar colisões de símbolo.
Padrão |
pitch |
Especifica a orientação do ícone quando o mapa é lançado. '"auto": corresponde automaticamente ao valor de 'rotationAlignment'. '"map": o ícone está alinhado ao plano do mapa. '"viewport"': o ícone está alinhado ao plano do visor Padrão '"auto"' |
rotation | A quantidade para girar o ícone no sentido horário em graus Padrão |
rotation |
Em combinação com a propriedade de posicionamento de um SymbolLayerOptions, isso determina o comportamento de rotação dos ícones. '"auto": quando o posicionamento é "point" isso é equivalente a "viewport". Quando o posicionamento é "linha", isso é equivalente a "mapa". '"map": quando o posicionamento é "point" alinha ícones leste-oeste. Quando o posicionamento é "line" alinha os eixos x dos ícones com a linha. '"viewport"': os eixos x dos ícones serão alinhados com o eixo x do visor. Padrão '"auto". |
size | Dimensiona o tamanho original do ícone pelo fator fornecido.
Deve ser maior ou igual a 0.
Padrão |
Detalhes da propriedade
allowOverlap
Especifica se o ícone de símbolo pode sobrepor outros símbolos no mapa.
Se true
o ícone ficar visível mesmo se ele colidir com outros símbolos desenhados anteriormente.
Dica: defina isso como true se animar um símbolo para garantir a renderização suave.
Padrão false
.
allowOverlap?: boolean
Valor 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.
'"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 '"inferior".anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
Valor da propriedade
PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
ignorePlacement
Especifica se outros símbolos podem sobrepor esse símbolo.
Se for verdadeiro, outros símbolos poderão ser visíveis mesmo se colidirem com o ícone.
Padrão false
.
ignorePlacement?: boolean
Valor da propriedade
boolean
image
O nome da imagem no sprite de imagem do mapa a ser usado para desenhar o ícone.
As imagens internas disponíveis são: marker-black
, , marker-blue
, marker-darkblue
, marker-red
, marker-yellow
, pin-blue
, , pin-darkblue
, pin-red
, , pin-round-blue
, , pin-round-darkblue
, pin-round-red
.
Padrão "marker-blue"
.
image?: string | DataDrivenPropertyValueSpecification<string>
Valor da propriedade
string | DataDrivenPropertyValueSpecification<string>
offset
Especifica uma distância de deslocamento do ícone de sua âncora em pixels.
Valores positivos indicam direita e para baixo, enquanto valores negativos indicam esquerda e para cima.
Cada componente é multiplicado pelo valor de tamanho para obter o deslocamento final em pixels.
Quando combinado com a rotação, o deslocamento será como se a direção girada estivesse 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 ícone será desenhado.
Padrão 1
.
opacity?: number | DataDrivenPropertyValueSpecification<number>
Valor da propriedade
number | DataDrivenPropertyValueSpecification<number>
optional
Especifica se um ícone de símbolos pode ser oculto, mas seu texto será exibido se ele estiver sobreposto a outro símbolo.
Se verdadeiro, o texto será exibido sem seus ícones correspondentes quando o ícone colidir com outros símbolos e o texto não.
Padrão false
.
optional?: boolean
Valor da propriedade
boolean
padding
Tamanho da área adicional ao redor da caixa delimitadora de ícone usada para detectar colisões de símbolo.
Padrão 2
.
padding?: number | DataDrivenPropertyValueSpecification<number>
Valor da propriedade
number | DataDrivenPropertyValueSpecification<number>
pitchAlignment
Especifica a orientação do ícone quando o mapa é lançado.
'"auto": corresponde automaticamente ao valor de 'rotationAlignment'.
'"map": o ícone está alinhado ao plano do mapa.
'"viewport"': o ícone está alinhado ao plano do visor
Padrão '"auto"'pitchAlignment?: "auto" | "map" | "viewport"
Valor da propriedade
"auto" | "map" | "viewport"
rotation
A quantidade para girar o ícone 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 propriedade de posicionamento de um SymbolLayerOptions, isso determina o comportamento de rotação dos ícones.
'"auto": quando o posicionamento é "point" isso é equivalente a "viewport". Quando o posicionamento é "linha", isso é equivalente a "mapa".
'"map": quando o posicionamento é "point" alinha ícones leste-oeste. Quando o posicionamento é "line" alinha os eixos x dos ícones com a linha.
'"viewport"': os eixos x dos ícones serão alinhados com o eixo x do visor.
Padrão '"auto".rotationAlignment?: "auto" | "map" | "viewport"
Valor da propriedade
"auto" | "map" | "viewport"
size
Dimensiona o tamanho original do ícone pelo fator fornecido.
Deve ser maior ou igual a 0.
Padrão 1
.
size?: number | DataDrivenPropertyValueSpecification<number>
Valor da propriedade
number | DataDrivenPropertyValueSpecification<number>