SymbolLayerOptions interface
Opções usadas ao renderizar geometrias em um SymbolLayer.
- Extends
Propriedades
icon |
Opções usadas para personalizar os ícones dos símbolos. Consulte IconOptions para obter padrões. |
line |
Distância em pixels entre duas âncoras de símbolo ao longo de uma linha. Deve ser maior ou igual a 1.
Padrão |
placement | Especifica o posicionamento do rótulo em relação à geometria. '"point"': o rótulo é colocado no ponto em que a geometria está localizada. '"line"': o rótulo é colocado ao longo da linha da geometria. Só pode ser usado em geometrias LineString e Polygon. '"line-center"': o rótulo é colocado no centro da linha da geometria. Só pode ser usado em geometrias 'LineString' e 'Polygon' Padrão '"point"'. |
sort |
Classifica os recursos em ordem crescente com base nesse valor. Os recursos com teclas de classificação inferiores são desenhados e colocados em primeiro lugar.
Padrão |
source | A ID ou a instância de uma fonte de dados que a camada renderizará. |
source |
Necessário quando a origem da camada é um VectorTileSource. Uma fonte de vetor pode ter várias camadas dentro dela, isso identifica qual delas renderizar nessa camada. Proibido para todos os outros tipos de fontes. |
text |
Opções usadas para personalizar o texto dos símbolos. Consulte TextOptions para ver os padrões. |
z |
Determina se os símbolos sobrepostos na mesma camada são renderizados na ordem em que aparecem na fonte de dados ou pela posição y em relação ao visor.
Para controlar a ordem e a priorização dos símbolos caso contrário, use '"auto"': classifica símbolos por 'sortKey' se definido. Caso contrário, se comporta como '"viewport-y"'. '"viewport-y"': classifica os símbolos por sua posição y se 'allowOverlap' for 'true' ou se 'ignorePlacement' for 'false'. '"source"': classifica símbolos por 'sortKey' se definido. Caso contrário, os símbolos serão renderizados na mesma ordem que os dados de origem. Padrão '"auto"' |
Propriedades herdadas
filter | Uma expressão que especifica condições nos recursos de origem. Somente os recursos que correspondem ao filtro são exibidos. |
max |
Um inteiro que especifica o nível máximo de zoom para renderizar a camada em.
Esse valor é exclusivo, ou seja, a camada ficará visível em |
min |
Um inteiro que especifica o nível mínimo de zoom para renderizar a camada em.
Esse valor é inclusivo, ou seja, a camada ficará visível em |
visible | Especifica se a camada está visível ou não.
Padrão |
Detalhes da propriedade
iconOptions
Opções usadas para personalizar os ícones dos símbolos.
Consulte IconOptions para obter padrões.
iconOptions?: IconOptions
Valor da propriedade
lineSpacing
Distância em pixels entre duas âncoras de símbolo ao longo de uma linha. Deve ser maior ou igual a 1.
Padrão 250
.
lineSpacing?: number | PropertyValueSpecification<number>
Valor da propriedade
number | PropertyValueSpecification<number>
placement
Especifica o posicionamento do rótulo em relação à geometria.
'"point"': o rótulo é colocado no ponto em que a geometria está localizada.
'"line"': o rótulo é colocado ao longo da linha da geometria. Só pode ser usado em geometrias LineString e Polygon.
'"line-center"': o rótulo é colocado no centro da linha da geometria. Só pode ser usado em geometrias 'LineString' e 'Polygon'
Padrão '"point"'.placement?: "point" | "line" | "line-center"
Valor da propriedade
"point" | "line" | "line-center"
sortKey
Classifica os recursos em ordem crescente com base nesse valor. Os recursos com teclas de classificação inferiores são desenhados e colocados em primeiro lugar.
Padrão undefined
.
sortKey?: number | DataDrivenPropertyValueSpecification<number>
Valor da propriedade
number | DataDrivenPropertyValueSpecification<number>
source
A ID ou a instância de uma fonte de dados que a camada renderizará.
source?: string | Source
Valor da propriedade
string | Source
sourceLayer
Necessário quando a origem da camada é um VectorTileSource. Uma fonte de vetor pode ter várias camadas dentro dela, isso identifica qual delas renderizar nessa camada. Proibido para todos os outros tipos de fontes.
sourceLayer?: string
Valor da propriedade
string
textOptions
Opções usadas para personalizar o texto dos símbolos.
Consulte TextOptions para ver os padrões.
textOptions?: TextOptions
Valor da propriedade
zOrder
Determina se os símbolos sobrepostos na mesma camada são renderizados na ordem em que aparecem na fonte de dados ou pela posição y em relação ao visor.
Para controlar a ordem e a priorização dos símbolos caso contrário, use sortKey
.
'"auto"': classifica símbolos por 'sortKey' se definido. Caso contrário, se comporta como '"viewport-y"'.
'"viewport-y"': classifica os símbolos por sua posição y se 'allowOverlap' for 'true' ou se 'ignorePlacement' for 'false'.
'"source"': classifica símbolos por 'sortKey' se definido. Caso contrário, os símbolos serão renderizados na mesma ordem que os dados de origem. Padrão '"auto"'
zOrder?: "auto" | "viewport-y" | "source"
Valor da propriedade
"auto" | "viewport-y" | "source"
Detalhes das propriedades herdadas
filter
Uma expressão que especifica condições nos recursos de origem. Somente os recursos que correspondem ao filtro são exibidos.
filter?: Expression
Valor da propriedade
Herdado deLayerOptions.filter
maxZoom
Um inteiro que especifica o nível máximo de zoom para renderizar a camada em.
Esse valor é exclusivo, ou seja, a camada ficará visível em maxZoom > zoom >= minZoom
.
Padrão 24
.
maxZoom?: number
Valor da propriedade
number
Herdado deLayerOptions.maxZoom
minZoom
Um inteiro que especifica o nível mínimo de zoom para renderizar a camada em.
Esse valor é inclusivo, ou seja, a camada ficará visível em maxZoom > zoom >= minZoom
.
Padrão 0
.
minZoom?: number
Valor da propriedade
number
Herdado deLayerOptions.minZoom
visible
Especifica se a camada está visível ou não.
Padrão true
.
visible?: boolean
Valor da propriedade
boolean
Herdado deLayerOptions.visible