IconOptions interface
Opciones usadas para personalizar los iconos de una clase SymbolLayer
- Extends
Propiedades
allow |
Especifica si el icono de símbolo puede superponer otros símbolos en el mapa.
Si |
anchor | Especifica qué parte del icono se coloca más cerca de la posición del delimitador de iconos en el mapa. '"center"': el centro del icono se coloca más cerca del delimitador. '"left"': el lado izquierdo del icono se coloca más cerca del delimitador. '"right"': el lado derecho del icono se coloca más cerca del delimitador. '"top"': la parte superior del icono se coloca más cerca del delimitador. '"bottom"': la parte inferior del icono se coloca más cerca del delimitador. '"top-left"': la esquina superior izquierda del icono se coloca más cerca del delimitador. '"top-right"': la esquina superior derecha del icono se coloca más cerca del delimitador. '"bottom-left"': la esquina inferior izquierda del icono se coloca más cerca del delimitador. '"bottom-right"': la esquina inferior derecha del icono se coloca más cerca del delimitador. Valor predeterminado '"bottom"'. |
ignore |
Especifica si otros símbolos pueden superponerse a este símbolo.
Si es true, otros símbolos pueden ser visibles aunque entren en conflicto con el icono.
El valor predeterminado es |
image | Nombre de la imagen en el sprite de imagen del mapa que se va a usar para dibujar el icono.
Las imágenes integradas disponibles son: |
offset | Especifica una distancia de desplazamiento del icono desde su delimitador en píxeles.
Los valores positivos indican derecha y abajo, mientras que los valores negativos indican hacia la izquierda y hacia arriba.
Cada componente se multiplica por el valor de tamaño para obtener el desplazamiento final en píxeles.
Cuando se combina con la rotación, el desplazamiento será como si la dirección girada fuera hacia arriba.
El valor predeterminado es |
opacity | Número comprendido entre 0 y 1 que indica la opacidad en la que se dibujará el icono.
El valor predeterminado es |
optional | Especifica si se puede ocultar un icono de símbolos, pero su texto se muestra si se superpone con otro símbolo.
Si es true, el texto se mostrará sin sus iconos correspondientes cuando el icono entre en conflicto con otros símbolos y el texto no lo hace.
El valor predeterminado es |
padding | Tamaño del área adicional alrededor del rectángulo de selección de iconos que se usa para detectar colisiones de símbolos.
El valor predeterminado es |
pitch |
Especifica la orientación del icono cuando se inclina el mapa. '"auto"': coincide automáticamente con el valor de 'rotationAlignment'. '"mapa"': el icono está alineado con el plano del mapa. '"viewport"': el icono está alineado con el plano de la ventanilla. Valor predeterminado ''auto'' |
rotation | Cantidad que se va a girar el icono en sentido de las agujas del reloj en grados Predeterminado |
rotation |
En combinación con la propiedad placement de symbolLayerOptions, esto determina el comportamiento de rotación de los iconos. '"auto"': cuando la colocación es "point", esto equivale a "viewport". Cuando la colocación es "line", esto equivale a "map". '"map"': cuando la colocación es "point" alinea los iconos east-west. Cuando la colocación es "línea" alinea los ejes x de los iconos con la línea. '"viewport"': los iconos' x-axes se alinearán con el eje x de la ventanilla. Valor predeterminado '"auto"'. |
size | Escala el tamaño original del icono según el factor proporcionado.
Debe ser mayor o igual que 0.
El valor predeterminado es |
Detalles de las propiedades
allowOverlap
Especifica si el icono de símbolo puede superponer otros símbolos en el mapa.
Si true
el icono será visible incluso si entra en conflicto con otros símbolos dibujados anteriormente.
Sugerencia: establézcalo en true si anima un símbolo para garantizar una representación fluida.
El valor predeterminado es false
.
allowOverlap?: boolean
Valor de propiedad
boolean
anchor
Especifica qué parte del icono se coloca más cerca de la posición del delimitador de iconos en el mapa.
'"center"': el centro del icono se coloca más cerca del delimitador.
'"left"': el lado izquierdo del icono se coloca más cerca del delimitador.
'"right"': el lado derecho del icono se coloca más cerca del delimitador.
'"top"': la parte superior del icono se coloca más cerca del delimitador.
'"bottom"': la parte inferior del icono se coloca más cerca del delimitador.
'"top-left"': la esquina superior izquierda del icono se coloca más cerca del delimitador.
'"top-right"': la esquina superior derecha del icono se coloca más cerca del delimitador.
'"bottom-left"': la esquina inferior izquierda del icono se coloca más cerca del delimitador.
'"bottom-right"': la esquina inferior derecha del icono se coloca más cerca del delimitador.
Valor predeterminado '"bottom"'.anchor?: PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
Valor de propiedad
PositionAnchor | DataDrivenPropertyValueSpecification<PositionAnchor>
ignorePlacement
Especifica si otros símbolos pueden superponerse a este símbolo.
Si es true, otros símbolos pueden ser visibles aunque entren en conflicto con el icono.
El valor predeterminado es false
.
ignorePlacement?: boolean
Valor de propiedad
boolean
image
Nombre de la imagen en el sprite de imagen del mapa que se va a usar para dibujar el icono.
Las imágenes integradas disponibles son: marker-black
, marker-blue
, pin-blue
pin-darkblue
marker-darkblue
marker-red
marker-yellow
, pin-red
, pin-round-blue
, , . pin-round-red
pin-round-darkblue
El valor predeterminado es "marker-blue"
.
image?: string | DataDrivenPropertyValueSpecification<string>
Valor de propiedad
string | DataDrivenPropertyValueSpecification<string>
offset
Especifica una distancia de desplazamiento del icono desde su delimitador en píxeles.
Los valores positivos indican derecha y abajo, mientras que los valores negativos indican hacia la izquierda y hacia arriba.
Cada componente se multiplica por el valor de tamaño para obtener el desplazamiento final en píxeles.
Cuando se combina con la rotación, el desplazamiento será como si la dirección girada fuera hacia arriba.
El valor predeterminado es [0, 0]
.
offset?: Pixel | DataDrivenPropertyValueSpecification<Pixel>
Valor de propiedad
opacity
Número comprendido entre 0 y 1 que indica la opacidad en la que se dibujará el icono.
El valor predeterminado es 1
.
opacity?: number | DataDrivenPropertyValueSpecification<number>
Valor de propiedad
number | DataDrivenPropertyValueSpecification<number>
optional
Especifica si se puede ocultar un icono de símbolos, pero su texto se muestra si se superpone con otro símbolo.
Si es true, el texto se mostrará sin sus iconos correspondientes cuando el icono entre en conflicto con otros símbolos y el texto no lo hace.
El valor predeterminado es false
.
optional?: boolean
Valor de propiedad
boolean
padding
Tamaño del área adicional alrededor del rectángulo de selección de iconos que se usa para detectar colisiones de símbolos.
El valor predeterminado es 2
.
padding?: number | DataDrivenPropertyValueSpecification<number>
Valor de propiedad
number | DataDrivenPropertyValueSpecification<number>
pitchAlignment
Especifica la orientación del icono cuando se inclina el mapa.
'"auto"': coincide automáticamente con el valor de 'rotationAlignment'.
'"mapa"': el icono está alineado con el plano del mapa.
'"viewport"': el icono está alineado con el plano de la ventanilla.
Valor predeterminado ''auto''pitchAlignment?: "auto" | "map" | "viewport"
Valor de propiedad
"auto" | "map" | "viewport"
rotation
Cantidad que se va a girar el icono en sentido de las agujas del reloj en grados Predeterminado 0
.
rotation?: number | DataDrivenPropertyValueSpecification<number>
Valor de propiedad
number | DataDrivenPropertyValueSpecification<number>
rotationAlignment
En combinación con la propiedad placement de symbolLayerOptions, esto determina el comportamiento de rotación de los iconos.
'"auto"': cuando la colocación es "point", esto equivale a "viewport". Cuando la colocación es "line", esto equivale a "map".
'"map"': cuando la colocación es "point" alinea los iconos east-west. Cuando la colocación es "línea" alinea los ejes x de los iconos con la línea.
'"viewport"': los iconos' x-axes se alinearán con el eje x de la ventanilla.
Valor predeterminado '"auto"'.rotationAlignment?: "auto" | "map" | "viewport"
Valor de propiedad
"auto" | "map" | "viewport"
size
Escala el tamaño original del icono según el factor proporcionado.
Debe ser mayor o igual que 0.
El valor predeterminado es 1
.
size?: number | DataDrivenPropertyValueSpecification<number>
Valor de propiedad
number | DataDrivenPropertyValueSpecification<number>