SymbolLayerOptions interface
Opciones usadas al representar geometrías en un SymbolLayer.
- Extends
Propiedades
icon |
Opciones usadas para personalizar los iconos de los símbolos. Consulte IconOptions para conocer los valores predeterminados. |
line |
Distancia en píxeles entre dos delimitadores de símbolos a lo largo de una línea. Debe ser mayor o igual a 1.
El valor predeterminado es |
placement | Especifica la colocación de la etiqueta en relación con su geometría. '"point"': la etiqueta se coloca en el punto donde se encuentra la geometría. '"line"': la etiqueta se coloca a lo largo de la línea de la geometría. Solo se puede usar en geometrías LineString y Polygon. '"line-center"': la etiqueta se coloca en el centro de la línea de la geometría. Solo se puede usar en geometrías "LineString" y "Polygon". Valor predeterminado '"point"'. |
sort |
Ordena las características en orden ascendente en función de este valor. Las características con claves de ordenación inferiores se dibujan y colocan primero.
El valor predeterminado es |
source | Identificador o instancia de un origen de datos que representará la capa. |
source |
Necesario cuando el origen de la capa es VectorTileSource. Un origen vectorial puede tener varias capas dentro de ella, lo que identifica cuál se va a representar en esta capa. Prohibido para todos los demás tipos de orígenes. |
text |
Opciones usadas para personalizar el texto de los símbolos. Consulte TextOptions para conocer los valores predeterminados. |
z |
Determina si los símbolos superpuestos en la misma capa se representan en el orden en que aparecen en el origen de datos, o por su posición y en relación con la ventanilla.
Para controlar el orden y la priorización de símbolos de lo contrario, use '"auto"': ordena los símbolos por 'sortKey' si se establece. De lo contrario, se comporta como "viewport-y"". '"viewport-y"': ordena los símbolos por su posición y si 'allowOverlap' es 'true' o si 'ignorePlacement' es 'false'. '"source"': ordena símbolos por 'sortKey' si se establece. De lo contrario, los símbolos se representan en el mismo orden que los datos de origen. Predeterminado '"auto"' |
Propiedades heredadas
filter | Expresión que especifica condiciones en las características de origen. Solo se muestran las características que coinciden con el filtro. |
max |
Entero que especifica el nivel de zoom máximo en el que se va a representar la capa.
Este valor es exclusivo, es decir, la capa estará visible en |
min |
Entero que especifica el nivel de zoom mínimo en el que se va a representar la capa.
Este valor es inclusivo, es decir, la capa estará visible en |
visible | Especifica si la capa está visible o no.
El valor predeterminado es |
Detalles de las propiedades
iconOptions
Opciones usadas para personalizar los iconos de los símbolos.
Consulte IconOptions para conocer los valores predeterminados.
iconOptions?: IconOptions
Valor de propiedad
lineSpacing
Distancia en píxeles entre dos delimitadores de símbolos a lo largo de una línea. Debe ser mayor o igual a 1.
El valor predeterminado es 250
.
lineSpacing?: number | PropertyValueSpecification<number>
Valor de propiedad
number | PropertyValueSpecification<number>
placement
Especifica la colocación de la etiqueta en relación con su geometría.
'"point"': la etiqueta se coloca en el punto donde se encuentra la geometría.
'"line"': la etiqueta se coloca a lo largo de la línea de la geometría. Solo se puede usar en geometrías LineString y Polygon.
'"line-center"': la etiqueta se coloca en el centro de la línea de la geometría. Solo se puede usar en geometrías "LineString" y "Polygon".
Valor predeterminado '"point"'.placement?: "point" | "line" | "line-center"
Valor de propiedad
"point" | "line" | "line-center"
sortKey
Ordena las características en orden ascendente en función de este valor. Las características con claves de ordenación inferiores se dibujan y colocan primero.
El valor predeterminado es undefined
.
sortKey?: number | DataDrivenPropertyValueSpecification<number>
Valor de propiedad
number | DataDrivenPropertyValueSpecification<number>
source
Identificador o instancia de un origen de datos que representará la capa.
source?: string | Source
Valor de propiedad
string | Source
sourceLayer
Necesario cuando el origen de la capa es VectorTileSource. Un origen vectorial puede tener varias capas dentro de ella, lo que identifica cuál se va a representar en esta capa. Prohibido para todos los demás tipos de orígenes.
sourceLayer?: string
Valor de propiedad
string
textOptions
Opciones usadas para personalizar el texto de los símbolos.
Consulte TextOptions para conocer los valores predeterminados.
textOptions?: TextOptions
Valor de propiedad
zOrder
Determina si los símbolos superpuestos en la misma capa se representan en el orden en que aparecen en el origen de datos, o por su posición y en relación con la ventanilla.
Para controlar el orden y la priorización de símbolos de lo contrario, use sortKey
.
'"auto"': ordena los símbolos por 'sortKey' si se establece. De lo contrario, se comporta como "viewport-y"".
'"viewport-y"': ordena los símbolos por su posición y si 'allowOverlap' es 'true' o si 'ignorePlacement' es 'false'.
'"source"': ordena símbolos por 'sortKey' si se establece. De lo contrario, los símbolos se representan en el mismo orden que los datos de origen. Predeterminado '"auto"'
zOrder?: "auto" | "viewport-y" | "source"
Valor de propiedad
"auto" | "viewport-y" | "source"
Detalles de las propiedades heredadas
filter
Expresión que especifica condiciones en las características de origen. Solo se muestran las características que coinciden con el filtro.
filter?: Expression
Valor de propiedad
Heredado deLayerOptions.filter
maxZoom
Entero que especifica el nivel de zoom máximo en el que se va a representar la capa.
Este valor es exclusivo, es decir, la capa estará visible en maxZoom > zoom >= minZoom
.
El valor predeterminado es 24
.
maxZoom?: number
Valor de propiedad
number
Heredado deLayerOptions.maxZoom
minZoom
Entero que especifica el nivel de zoom mínimo en el que se va a representar la capa.
Este valor es inclusivo, es decir, la capa estará visible en maxZoom > zoom >= minZoom
.
El valor predeterminado es 0
.
minZoom?: number
Valor de propiedad
number
Heredado deLayerOptions.minZoom
visible
Especifica si la capa está visible o no.
El valor predeterminado es true
.
visible?: boolean
Valor de propiedad
boolean
Heredado deLayerOptions.visible