Partager via


SymbolLayerOptions interface

Options utilisées lors du rendu des géométries dans un SymbolLayer.

Extends

Propriétés

iconOptions

Options utilisées pour personnaliser les icônes des symboles.

Pour connaître les valeurs par défaut, consultez IconOptions.

lineSpacing

Distance en pixels entre deux ancres de symboles le long d’une ligne. Doit être supérieur ou égal à 1. Par défaut, 250.

placement

Spécifie l’emplacement de l’étiquette par rapport à sa géométrie.

« point » : l’étiquette est placée au point où se trouve la géométrie.

'"line » : l’étiquette est placée le long de la ligne de la géométrie. Ne peut être utilisé que sur les géométries LineString et Polygon.

'"line-center »: l’étiquette est placée au centre de la ligne de la géométrie. Ne peut être utilisé que sur les géométries « LineString » et « Polygon »

Valeur par défaut '"point"'.
sortKey

Trie les fonctionnalités dans l’ordre croissant en fonction de cette valeur. Les fonctionnalités avec des touches de tri inférieures sont dessinées et placées en premier. Par défaut, undefined.

source

ID ou instance d’une source de données que la couche doit afficher.

sourceLayer

Obligatoire lorsque la source de la couche est un VectorTileSource. Une source vectorielle peut avoir plusieurs couches, ce qui identifie celle à restituer dans cette couche. Interdit pour tous les autres types de sources.

textOptions

Options utilisées pour personnaliser le texte des symboles.

Pour connaître les valeurs par défaut, consultez TextOptions.

zOrder

Détermine si les symboles qui se chevauchent dans la même couche sont rendus dans l’ordre dans lequel ils apparaissent dans la source de données ou par leur position y par rapport à la fenêtre d’affichage. Sinon, pour contrôler l’ordre et la hiérarchisation des symboles, utilisez sortKey.

'"auto"': trie les symboles par 'sortKey' si défini. Sinon, se comporte comme « "viewport-y"'.

'"viewport-y »: trie les symboles par leur position y si 'allowOverlap' est 'true' ou si 'ignorePlacement' a la valeur 'false'.

'"source"': trie les symboles par 'sortKey' si défini. Sinon, les symboles sont rendus dans le même ordre que les données sources. Par défaut « "auto"'

Propriétés héritées

filter

Expression spécifiant des conditions sur les fonctionnalités sources. Seules les fonctionnalités qui correspondent au filtre sont affichées.

maxZoom

Entier spécifiant le niveau de zoom maximal auquel effectuer le rendu de la couche. Cette valeur est exclusive, c’est-à-dire que la couche est visible dans maxZoom > zoom >= minZoom. Par défaut, 24.

minZoom

Entier spécifiant le niveau de zoom minimal auquel effectuer le rendu de la couche. Cette valeur est inclusive, c’est-à-dire que la couche est visible dans maxZoom > zoom >= minZoom. Par défaut, 0.

visible

Spécifie si la couche est visible ou non. Par défaut, true.

Détails de la propriété

iconOptions

Options utilisées pour personnaliser les icônes des symboles.

Pour connaître les valeurs par défaut, consultez IconOptions.

iconOptions?: IconOptions

Valeur de propriété

lineSpacing

Distance en pixels entre deux ancres de symboles le long d’une ligne. Doit être supérieur ou égal à 1. Par défaut, 250.

lineSpacing?: number | PropertyValueSpecification<number>

Valeur de propriété

number | PropertyValueSpecification<number>

placement

Spécifie l’emplacement de l’étiquette par rapport à sa géométrie.

« point » : l’étiquette est placée au point où se trouve la géométrie.

'"line » : l’étiquette est placée le long de la ligne de la géométrie. Ne peut être utilisé que sur les géométries LineString et Polygon.

'"line-center »: l’étiquette est placée au centre de la ligne de la géométrie. Ne peut être utilisé que sur les géométries « LineString » et « Polygon »

Valeur par défaut '"point"'.
placement?: "point" | "line" | "line-center"

Valeur de propriété

"point" | "line" | "line-center"

sortKey

Trie les fonctionnalités dans l’ordre croissant en fonction de cette valeur. Les fonctionnalités avec des touches de tri inférieures sont dessinées et placées en premier. Par défaut, undefined.

sortKey?: number | DataDrivenPropertyValueSpecification<number>

Valeur de propriété

number | DataDrivenPropertyValueSpecification<number>

source

ID ou instance d’une source de données que la couche doit afficher.

source?: string | Source

Valeur de propriété

string | Source

sourceLayer

Obligatoire lorsque la source de la couche est un VectorTileSource. Une source vectorielle peut avoir plusieurs couches, ce qui identifie celle à restituer dans cette couche. Interdit pour tous les autres types de sources.

sourceLayer?: string

Valeur de propriété

string

textOptions

Options utilisées pour personnaliser le texte des symboles.

Pour connaître les valeurs par défaut, consultez TextOptions.

textOptions?: TextOptions

Valeur de propriété

zOrder

Détermine si les symboles qui se chevauchent dans la même couche sont rendus dans l’ordre dans lequel ils apparaissent dans la source de données ou par leur position y par rapport à la fenêtre d’affichage. Sinon, pour contrôler l’ordre et la hiérarchisation des symboles, utilisez sortKey.

'"auto"': trie les symboles par 'sortKey' si défini. Sinon, se comporte comme « "viewport-y"'.

'"viewport-y »: trie les symboles par leur position y si 'allowOverlap' est 'true' ou si 'ignorePlacement' a la valeur 'false'.

'"source"': trie les symboles par 'sortKey' si défini. Sinon, les symboles sont rendus dans le même ordre que les données sources. Par défaut « "auto"'

zOrder?: "auto" | "viewport-y" | "source"

Valeur de propriété

"auto" | "viewport-y" | "source"

Détails de la propriété héritée

filter

Expression spécifiant des conditions sur les fonctionnalités sources. Seules les fonctionnalités qui correspondent au filtre sont affichées.

filter?: Expression

Valeur de propriété

Hérité deLayerOptions.filter

maxZoom

Entier spécifiant le niveau de zoom maximal auquel effectuer le rendu de la couche. Cette valeur est exclusive, c’est-à-dire que la couche est visible dans maxZoom > zoom >= minZoom. Par défaut, 24.

maxZoom?: number

Valeur de propriété

number

Hérité deLayerOptions.maxZoom

minZoom

Entier spécifiant le niveau de zoom minimal auquel effectuer le rendu de la couche. Cette valeur est inclusive, c’est-à-dire que la couche est visible dans maxZoom > zoom >= minZoom. Par défaut, 0.

minZoom?: number

Valeur de propriété

number

Hérité deLayerOptions.minZoom

visible

Spécifie si la couche est visible ou non. Par défaut, true.

visible?: boolean

Valeur de propriété

boolean

Hérité deLayerOptions.visible