ol mapbox style
v12.3.5
Cree mapas de OpenLapeS a partir de objetos de especificación de estilo MAPBOX.
Obtenga una impresión de lo que hace esta biblioteca explorando los ejemplos en vivo.
Para usar la biblioteca en una aplicación con un entorno de desarrollo basado en NPM, instálela con
npm install ol-mapbox-style
Cuando se instale de esta manera, solo importe el módulo de estilo OL-Mapbox, como en el ejemplo de uso a continuación. Para usar una construcción independiente de estilo OL-Mapbox, solo incluya 'Dist/Olms.js' en su página HTML y acceda a las funciones exportadas del objeto olms global (por ejemplo, olms.apply() , olms.applyBackground() ) . Tenga en cuenta que la construcción independiente depende de la compilación completa de OpenLayers.
OL-Mapbox-Style> = V9 requiere OpenLayers Version> = 7 .
V8 de estilo OL-Mapbox requiere OpenLayers Version> = 6.13.0 <7 .
Consulte la sección API para la documentación completa.
El siguiente código crea un mapa de OpenLayers del estilo V9 brillante de Mapbox, usando un https:// url:
import { apply } from 'ol-mapbox-style' ;
apply ( 'map' , 'https://api.mapbox.com/styles/v1/mapbox/bright-v9?access_token=YOUR_MAPBOX_TOKEN' ) ; Para asignar estilo y fuente solo a una capa, use applyStyle() . mapbox:// Las URL también son compatibles:
import { applyStyle } from 'ol-mapbox-style' ;
import VectorTileLayer from 'ol/layer/VectorTile.js'
const layer = new VectorTileLayer ( { declutter : true } ) ;
applyStyle ( layer , 'mapbox://styles/mapbox/bright-v9' , { accessToken : 'YOUR_MAPBOX_TOKEN' } ) ; Para aplicar las propiedades de la capa background del estilo de mapbox al mapa o una capa VectorTile , use la función applyBackground() .
También hay una API de bajo nivel disponible. Para crear una función de estilo para capas de baldosas vectoriales o vectoriales individuales para OpenLayers, use el módulo de stylefunction :
import { stylefunction } from 'ol-mapbox-style' ;
import VectorLayer from 'ol/layer/Vector.js' ;
import VectorSource from 'ol/source/Vector.js' ;
import GeoJSON from 'ol/format/GeoJSON.js' ;
const layer = new VectorLayer ( {
source : new VectorSource ( {
format : new GeoJSON ( ) ,
url : 'data/states.geojson'
} )
} ) ;
fetch ( 'data/states.json' ) . then ( function ( response ) {
response . json ( ) . then ( function ( glStyle ) {
stylefunction ( layer , glStyle , 'states' ) ;
} ) ;
} ) ;Tenga en cuenta que esta API de bajo nivel no crea una fuente para la capa, y se requiere trabajo adicional para configurar el manejo de sprite para estilos que usan iconos.
ol-mapbox-style no puede usar glifos PBF/SDF para la propiedad de diseño text-font , como se define en la especificación de estilo MAPBOX. En cambio, se basa en fuentes web. Una propiedad ol:webfonts Metadatos se puede configurar en la raíz del objeto de estilo para especificar una ubicación para WebFonts, por ejemplo
{
"version" : 8 ,
"metadata" : {
"ol:webfonts" : "https://my.server/fonts/{font-family}/{fontweight}{-fontstyle}.css"
}
// ...
} Como alternativa, se pueden usar la opción de webfonts de las funciones apply() o applyStyle() .
Los siguientes marcadores de posición se pueden usar en la URL de la plantilla:
{font-family} : Familia de fuentes CSS convertida en minúsculas, en blanco reemplazados con-, por ejemplo, Noto-Sans{Font+Family} : Familia de fuentes CSS en el caso original, en blanco reemplazados con+, por ejemplo, Noto+Sans{fontweight} : CSS Font Weight (numérico), por ejemplo, 400, 700{fontstyle} : estilo de fuente CSS, por ejemplo, normal, cursiva{-fontstyle} : estilo de fuente CSS que no sea lo normal, por ejemplo, una cadena italica o vacía para lo normal Si no hay propiedad metadata['ol:webfonts'] disponible en el objeto de estilo, se utilizarán fuentes de fuentes. También es posible que la aplicación cargue otras fuentes, utilizando CSS. Si una fuente ya está disponible en el navegador, ol-mapbox-style no la cargará.
Debido a esta diferencia, la pila de fuentes se trata un poco diferente a la definida en la especificación: el estilo y el peso se toman de la fuente primaria (es decir, la primera en la pila de fuentes). Las fuentes posteriores en la pila de fuentes solo se usan si la fuente primaria no está disponible/cargada, y se utilizarán con el estilo y el peso de la fuente primaria.
npm run build
Los archivos de distribución resultantes estarán en la carpeta dist/ . Para ver la biblioteca en acción, navegue a dist/index.html .
Para ejecutar la prueba localmente, ejecutar
npm test
Para las pruebas de depuración en el navegador, ejecute
npm run karma
y abra un navegador en el host y el puerto indicado en la salida de la consola (generalmente http: // localhost: 9876/) y haga clic en el botón 'Depurar' para ir al entorno de depuración.
estilo Ol-Mapbox • Docios
estilo Ol-Mapbox • Docios
capas :
string[]
Capas. Si no se proporciona ninguna fuente, las capas con las ID proporcionadas se utilizarán desde la matriz layers del estilo. Todas las capas deben usar la misma fuente.
Fuente :
string
Fuente. El valor predeterminado es '' , que hace que la primera fuente en el estilo se use.
actualateSource :
boolean
Actualizar o crear fuente de capa de vector (mosaico) con parámetros especificados para la fuente en la definición de estilo Mapbox.
estilo Ol-Mapbox • Docios
ID :
string|number
La identificación de la característica.
Fuente :
string
La ID de origen.
estilo Ol-Mapbox • Docios
Accesstoken :
string
El token de acceso para su estilo de mapbox. Esto debe ser proporcionado para mapbox:// URL de estilo. Para https:// y otras URL, cualquier clave de acceso debe ser el último parámetro de consulta de la URL de estilo.
Antecedentes :
false|BackgroundColor
Color de fondo para la capa. Si no se especifica, se utilizará el fondo del objeto de estilo MAPBOX. Establezca en false para evitar que se use el fondo del estilo de mapbox.
ClassName :
string
Un nombre de clase CSS para configurar en el elemento de capa.
Declutter :
boolean
Imágenes y texto de Declutter. El desorden se aplica a todos los estilos de imagen y texto de todas las capas vectoriales y vectortiles que lo han establecido en true . La prioridad se define por el índice Z de la capa, el zIndex del estilo y el orden de las características. Un mayor índice Z significa mayor prioridad. Dentro del mismo índice Z, una característica representada antes de otra tiene mayor prioridad.
Como una optimización, las características desaprobadas de las capas con el mismo className se representan por encima de los estilos de relleno y trazo de todas esas capas, independientemente del índice Z. Para optar por no tener este comportamiento y colocar las características de Deltutterd con su propia capa, configure la capa con un className que no sea ol-layer .
extensión :
Extent
La extensión limitada para la representación de la capa. La capa no se representará fuera de este grado.
capas :
string[]
Limite la representación a la lista de capas incluidas. Todas las capas deben compartir la misma fuente vectorial. Si su estilo usa más de una fuente, debe usar la propiedad source o la propiedad layers para limitar la representación a una sola fuente de vectores.
Mapa :
Map
Establece la capa como superposición en un mapa. El mapa no administrará esta capa en su colección de capas, y la capa se representará en la parte superior. Esto es útil para capas temporales. La forma estándar de agregar una capa a un mapa y hacer que el mapa lo administre es usar map.addLayer() .
MaxResolution :
number
La resolución máxima (exclusiva) debajo de la cual esta capa será visible. Si no se definen maxResolution ni minZoom , el maxResolution de la capa coincidirá con el minzoom de la fuente de estilo.
Maxzoom :
number
El nivel máximo de zoom de vista (inclusive) en el que esta capa será visible.
MinResolution :
number
La resolución mínima (inclusive) en la que esta capa será visible.
Minzoom :
number
El nivel mínimo de zoom de vista (exclusivo) por encima del cual esta capa será visible. Si no se definen maxResolution ni minZoom , el minZoom de la capa coincidirá con el minzoom de la fuente de estilo.
Opacidad :
number
Opacidad (0, 1).
precarga :
number
Precarga. Cargue los mosaicos de baja resolución hasta los niveles preload . 0 significa que no hay precarga.
Propiedades :
object
Propiedades observables arbitrarias. Se puede acceder con #get() y #set() .
renderbuffer :
number
El búfer en píxeles alrededor de la extensión del mosaico utilizada por el renderizador al obtener características del mosaico de vectores para la representación o la detección de golpes. Valor recomendado: los mosaicos vectoriales generalmente se generan con un búfer, por lo que este valor debe coincidir con el mayor búfer de los mosaicos usados. Debe ser al menos el tamaño del símbolo de punto más grande o el ancho de línea.
Rendermode :
VectorTileRenderType
Modo de renderizado para los mosaicos vectoriales:
'hybrid' : los elementos de polígono y línea se representan como imágenes, por lo que los píxeles se escalan durante las animaciones de zoom. Los símbolos y textos de puntos se representan con precisión como vectores y pueden permanecer en posición vertical en vistas rotadas.'vector' : todo se representa como vectores. Use este modo para mejorar el rendimiento en las capas de baldosas vectoriales con solo unas pocas características renderizadas (por ejemplo, para resaltar un subconjunto de características de otra capa con la misma fuente). Renderorder :
OrderFunction
Renderizar orden. Función que se utilizará al clasificar las características antes de renderizar. Por defecto, las características se dibujan en el orden en que se crean. Use null para evitar el tipo, pero obtenga un orden de dibujo indefinido.
Fuente :
string
Si su estilo usa más de una fuente, debe usar la propiedad source o la propiedad layers para limitar la representación a una sola fuente de vectores. La propiedad source corresponde a la ID de una fuente vectorial en su estilo MAPBOX.
styleUrl :
string
La URL del objeto de estilo Mapbox para usar para esta capa. Para un estilo creado con Mapbox Studio y alojado en Mapbox, esto se verá como 'Mapbox: // Styles/You/Your-Style'.
Update whileanimating :
boolean
Cuando se establece en true , los lotes de características se recrearán durante las animaciones. Esto significa que no se mostrarán vectores recortados, pero la configuración tendrá un impacto de rendimiento para grandes cantidades de datos vectoriales. Cuando se establece en false , los lotes se recrearán cuando no hay animación activa.
Actualización WhileMinteracting :
boolean
Cuando se establece en true , los lotes de características se recrearán durante las interacciones. Ver también updateWhileAnimating .
Use InteriMtileSonError :
boolean
Use mosaicos provisionales en error.
Visible :
boolean
Visibilidad.
Zindex :
number
El índice Z para la representación de la capa. En el momento de la representación, las capas se ordenarán primero por índice z y luego por posición. Cuando undefined , se supone un zIndex de 0 para las capas que se agregan a la colección layers del mapa, o Infinity cuando se usó el método setMap() de la capa.
estilo Ol-Mapbox • Docios
Accesstoken :
string
Token de acceso para 'mapbox: //' URLS.
AccessTokenParam :
string
Access Token Param. Para uso interno.
getImage : (
arg0,arg1) =>string|HTMLCanvasElement|HTMLImageElement
Función que devuelve una imagen para un nombre de icono. Si el resultado es un HTMLImageElement, ya debe cargarse. La capa se puede usar para llamar a la capa. Esta función se utilizará para iconos que no están en el sprite o para anular los iconos de sprite.
• Arg0 : VectorLayer < VectorSource any , any > | VectorTileLayer < VectorTile any , any >
• Arg1 : string
string | HTMLCanvasElement | HTMLImageElement
Proyección :
string
Solo útil cuando se trabaja con proyecciones no estándar. Código de una proyección registrada con OpenLayers. Todas las fuentes del estilo deben proporcionarse en esta proyección. La proyección también debe tener una extensión válida definida, que se utilizará para determinar el origen y las resoluciones de la cuadrícula de mosaico para todas las fuentes de mosaico del estilo. Cuando se proporciona, el marcador de posición BBox en URL de mosaico y Geojson cambia: el valor predeterminado es {bbox-epsg-3857} , cuando la proyección está establecida en EPSG:4326 , el marcador de posición BBox será {bbox-epsg-4326} .
Resoluciones :
number[]
Solo útil cuando se trabaja con proyecciones no estándar. Resoluciones para la resolución de mapeo al zoom utilizado en el estilo MAPBOX.
styleUrl :
string
URL del estilo MAPBOX GL. Requerido para los estilos que se proporcionaron como objeto, cuando contienen una URL de sprite relativo o fuentes que hacen referencia a datos por URL relativa.
TransformRequest : (
arg0,arg1) =>string|void|Request|Promise<string|Request>
Funciona para controlar cómo ol-mapbox-style obtiene recursos. Se puede usar para modificar la URL, agregar encabezados o configurar opciones de credenciales. Llamado con la URL y el tipo de recurso como argumentos, se supone que esta función devuelve una Request o una string de URL, o una promesa tehereOf. Sin un valor de devolución, la solicitud original no se modificará.
• Arg0 : string
• Arg1 : ResourceType
string | void | Request | Promise < string | Request >
WebFonts :
string
Plantilla para resolver los pasos web. Se puede usar para especificar dónde obtener fuentes web cuando no se establecen metadatos ol:webfonts en el objeto de estilo. Consulte getFonts() y la sección "Manejo de fuentes" en README.md para más detalles.
estilo Ol-Mapbox • Docios
ResourceType <>:
"Style"|"Source"|"Sprite"|"SpriteImage"|"Tiles"|"GeoJSON"
estilo Ol-Mapbox • Docios
Renombres y reexports aplicar
estilo Ol-Mapbox • Docios
import { MapboxVectorLayer } from 'ol-mapbox-style' ; Una capa de mosaico vectorial basada en un estilo de Mapbox que utiliza una sola fuente vectorial. Configure la capa con styleUrl y accessToken que se muestra en el panel Share de Mapbox Studio. Si el estilo usa más de una fuente, use la propiedad source para elegir una sola fuente de vectores. Si desea representar un subconjunto de las capas en el estilo, use la propiedad layers (todas las capas deben compartir la misma fuente vectorial). Vea las opciones de constructor para obtener más detalles.
const map = new Map({
view: new View({
center: [0, 0],
zoom: 1,
}),
layers: [
new MapboxVectorLayer({
styleUrl: 'mapbox://styles/mapbox/bright-v9',
accessToken: 'your-mapbox-access-token-here',
}),
],
target: 'map',
});
En el error de configuración o carga, la capa activará un evento 'error' . Los oyentes recibirán un objeto con una propiedad error que se puede usar para diagnosticar el problema.
Nota para los usuarios de la compilación completa : el MapboxVectorLayer requiere que la biblioteca OL-Mapbox también se cargue.
Opciones.
Módulo: OL/Eventos/Evento ~ BaseEvent#Evento: Error
VectorTileLayerNuevo MapboxVectorLayer (
options):MapboxVectorLayer
• Opciones : Options
Opciones de capa. Como mínimo, se deben proporcionar styleUrl y accessToken .
MapboxVectorLayer
VectorTileLayer.constructor
Accesstoken :
string
estilo Ol-Mapbox • Docios
AddMapboxlayer (
mapOrGroup,mapboxLayer,beforeLayerId?):Promisevoid
Agregue un nuevo objeto Mapbox Capeta al estilo. El mapa se volverá a renderizar.
• Maporgroup : Map | LayerGroup
Se apply el mapa o el grupo de capa.
• Mapboxlayer : any
Objeto de capa MAPBOX.
• ¿BorforLayerid? : string
ID opcional de la capa MAPBOX antes de la nueva capa que se agregará.
Promise void
Se resuelve cuando la capa agregada está disponible.
estilo Ol-Mapbox • Docios
Aplicar (
mapOrGroupOrElement,style,options):Promise<Map|LayerGroup>
Carga y aplica un objeto de estilo MAPBOX en un mapa OpenLayers o LayerGroup. Esto incluye el fondo del mapa, las capas y para instancias de mapa que no tenían una vista definida aún también el centro y el zoom.
Ejemplo:
import apply from 'ol-mapbox-style' ;
apply ( 'map' , 'mapbox://styles/mapbox/bright-v9' , { accessToken : 'YOUR_MAPBOX_TOKEN' } ) ;El centro y el zoom solo se establecerán si están presentes en el documento de estilo Mapbox, y si aún no se establecen en el mapa de OpenLayers.
Las capas se agregarán al mapa de OpenLayers, sin afectar las capas que ya puedan estar configuradas en el mapa.
Las capas agregadas por apply() tendrán dos propiedades adicionales:
mapbox-source : la id de la fuente del documento de estilo mapbox de la que se creó la capa OpenLayers. Por lo general, apply() crea una capa de estilo OpenLayers por fuente de estilo Mapbox, a menos que la pila de capa tenga capas de diferentes fuentes intermedias.mapbox-layers : las id de las capas del documento de estilo Mapbox que se incluyen en la capa OpenLayers. Esta función establece una propiedad adicional mapbox-style en el mapa OpenLapeS o la instancia de LayerGroup, que contiene el objeto de estilo MAPBOX.
• MaporGrouporElement : string | Map | LayerGroup | HTMLElement
Ya sea una instancia de mapa de OpenLayers existente, o un elemento HTML, o la ID de un elemento HTML que será el objetivo de un nuevo mapa de OpenLayers o un grupo de capa. Si el grupo de capas, los estilos relatados en el mapa y la vista serán ignorados.
• Estilo : any
Objeto de estilo JSON o URL de estilo que apunta a un objeto de estilo MAPBOX. Cuando se usa API MAPBOX, la URL es el styleUrl que se muestra en el panel "Share" de Mapbox Studio. Además, se debe establecer la opción accessToken (ver más abajo). Cuando se pase como objeto de estilo JSON, todas las capas OpenLayers creadas por apply() estarán disponibles de inmediato, pero es posible que aún no tengan una fuente (es decir, cuando están definidas por una URL de Tilejson en el documento de estilo Mapbox). Cuando se pasa como URL de estilo, las capas se agregarán al mapa cuando el documento de estilo MAPBOX se cargue y analice.
• Opciones : Options = {}
Opciones.
Promise < Map | LayerGroup >
Una promesa que se resuelve después de todas las capas se han agregado a la instancia del mapa de OpenLayers o el grupo de capa, sus fuentes establecidas y sus estilos aplicados. La devolución de llamada resolve se llamará con la instancia del mapa de OpenLayers o el grupo de capa como argumento.
estilo Ol-Mapbox • Docios
ApplyBackground (
mapOrLayer,glStyle,options):Promiseany
Aplica las propiedades de la primera capa background del estilo de mapbox al mapa o capa proporcionada (grupo).
Ejemplo:
import { applyBackground } from 'ol-mapbox-style' ;
import { Map } from 'ol' ;
const map = new Map ( { target : 'map' } ) ;
applyBackground ( map , 'https://api.maptiler.com/maps/basic/style.json?key=YOUR_OPENMAPTILES_TOKEN' ) ; • Maporlayer : Map | BaseLayer
Mapa o capa (grupo) de OpenLayers.
• Glstyle : any
Objeto de estilo MAPBOX o URL.
• Opciones : Options = {}
Opciones.
Promise any
Prometen que se resuelve cuando se aplica el fondo.
estilo Ol-Mapbox • Docios
ApplyStyle (
layer,glStyle,sourceOrLayersOrOptions?,optionsOrPath?,resolutions?):Promiseany
Aplica una función de estilo a una ol/layer/VectorTile u ol/layer/Vector con un ol/source/VectorTile o un ol/source/Vector . Si la capa aún no tiene una fuente, se creará y poblará a partir de la información en el glStyle (a menos que updateSource esté configurado en false ).
Ejemplo:
import { applyStyle } from 'ol-mapbox-style' ;
import { VectorTile } from 'ol/layer.js' ;
const layer = new VectorTile ( { declutter : true } ) ;
applyStyle ( layer , 'https://api.maptiler.com/maps/basic/style.json?key=YOUR_OPENMAPTILES_TOKEN' ) ; La función de estilo representará todas las capas del objeto glStyle que usan la fuente de la primera capa, la source especificada o un subconjunto de capas de la misma fuente. La fuente debe ser un "type": "vector" o "type": "geojson" .
Se establecerán dos propiedades adicionales en la capa proporcionada:
mapbox-source : la id de la fuente del documento de estilo mapbox de la que se creó la capa OpenLayers. Por lo general, apply() crea una capa de estilo OpenLayers por fuente de estilo Mapbox, a menos que la pila de capa tenga capas de diferentes fuentes intermedias.mapbox-layers : las id de las capas del documento de estilo Mapbox que se incluyen en la capa OpenLayers. • Capa : VectorLayer < VectorSource any , any > | VectorTileLayer < VectorTile any , any >
Capa de Layers Open. Cuando la capa tiene una fuente configurada, se modificará para usar la configuración de la source del GLSTYLE. Las opciones especificadas en la fuente de la capa anularán las de la source del Glstyle, a excepción de url y tileUrlFunction . Cuando la proyección de origen es el valor predeterminado ( EPSG:3857 ), el tileGrid también se anulará. Si prefiere no hacer que OL-Mapbox Style modifique la fuente, configure applyStyle() con la opción updateSource: false .
• Glstyle : any
Objeto de estilo Mapbox.
• ¿SourceRlayersorOptions? : string | string [] | Options y ApplyStyleOptions = ''
Opciones o clave source o una matriz de id de capa del objeto Mapbox Style. Cuando se proporciona una clave source , todas las capas para la fuente especificada se incluirán en la función de estilo. Cuando se proporcionan id de capa, deben ser de capas que usan la misma fuente. Cuando no se proporcione o un valor de falsificación, se presentarán todas las capas que usan la primera fuente especificada en el estilo GLStyle.
• ¿ OptionsorPath? : string | Options y ApplyStyleOptions = {}
Desapercibido . Opciones. Alternativamente, la ruta del archivo de estilo (solo se requiere cuando se usa una ruta relativa para la propiedad "sprite" del estilo).
• ¿ Resoluciones? : number [] = undefined
Desapercibido . Resoluciones para la resolución de mapeo al nivel de zoom. Solo se necesita cuando se trabaja con cuadrículas o proyecciones no estándar, también se puede suministrar opciones.
Promise any
Promesa que se resolverá cuando el estilo se pueda usar para renderizar.
estilo Ol-Mapbox • Docios
getFeatureState (
mapOrLayer,feature):any
Establece o elimina un estado de característica. El estado de la característica se tiene en cuenta para el estilo, al igual que las propiedades de la función, y se puede usar, por ejemplo, para representar condicionalmente las características seleccionadas de manera diferente.
• Maporlayer : Map | VectorLayer < VectorSource any , any > | VectorTileLayer < VectorTile any , any >
Mapa o capa para establecer el estado de la función.
• Característica : FeatureIdentifier
Identificador de características.
any
Estado de la función o null Cuando no se establece ningún estado de característica para el identificador de características dado.
estilo Ol-Mapbox • Docios
GetLape (
map,layerId):Layer<Source,LayerRenderer<any>>
Obtenga la instancia de la capa OpenLayers que contiene la layer de estilo MAPBOX proporcionada. Tenga en cuenta que múltiples capas de estilo MAPBOX se combinan en una sola instancia de capa OpenLapeers cuando usan la misma source de estilo MAPBOX.
• Mapa : Map | LayerGroup
OpenLayers Map o LayerGroup.
• Layerid : string
ID de capa de estilo MAPBOX.
Layer < Source , LayerRenderer < any >>
Instancia de capa de OpenLayers.
estilo Ol-Mapbox • Docios
GetLapeers (
map,sourceId):Layer<Source,LayerRenderer<any>> []
Obtenga las instancias de la capa OpenLayers para la source de estilo mapbox proporcionada.
• Mapa : Map | LayerGroup
OpenLayers Map o LayerGroup.
• SourceId : string
ID de origen de estilo MAPBOX.
Layer < Source , LayerRenderer < any >> []
Instancias de capa de Layers Open.
estilo Ol-Mapbox • Docios
getMapboxlayer (
mapOrGroup,layerId):any
Obtenga el objeto de capa MAPBOX para la layerId proporcionada.
• Maporgroup : Map | LayerGroup
Mapa o grupo de capa.
• Layerid : string
ID de capa MAPBOX.
any
Objeto de capa MAPBOX.
estilo Ol-Mapbox • Docios
getSource (
map,sourceId):Source
Obtenga la instancia de fuente OpenLayers para la source de estilo Mapbox proporcionada.
• Mapa : Map | LayerGroup
OpenLayers Map o LayerGroup.
• SourceId : string
ID de origen de estilo MAPBOX.
Source
Instancia de origen de OpenLayers.
estilo Ol-Mapbox • Docios
getStyleForLayer (
feature,resolution,olLayer,layerId):Style[]
Obtenga el estilo solo para una capa de mapa específica. Esto puede ser útil para crear una leyenda.
• Característica : RenderFeature | Feature Geometry
Característica OpenLayers.
• Resolución : number
Ver resolución.
• Ollayer : VectorLayer < VectorSource any , any > | VectorTileLayer < VectorTile any , any >
Capa de Layers Open.
• Layerid : string
ID de la capa de Mapbox para obtener el estilo para
Style []
Estilos para la capa de mapa proporcionada.
estilo Ol-Mapbox • Docios
RecordStyLElayer (
record):void
Enciende la grabación de la layer y desactivada del estilo Mapbox. Cuando se enciende, la capa a la que pertenece una característica renderizada se establecerá como la propiedad mapbox-layer de la función.
• Registro : boolean = false
La grabación de la capa de estilo está activada.
void
estilo Ol-Mapbox • Docios
RemoVEMAPBOXLAYER (
mapOrGroup,mapboxLayerIdOrLayer):void
Elimine un objeto de capa de mapa del estilo. El mapa se volverá a renderizar.
• Maporgroup : Map | LayerGroup
Se apply el mapa o el grupo de capa.
• MAPBOXLAYERORLAYER : any
ID de capa MAPBOX o objeto de capa MAPBOX.
void
estilo Ol-Mapbox • Docios
renderTransparent (
enabled):void
Configure si las características con un estilo transparente deben representarse. Cuando se establece en true , será posible presionar el contenido de detección que no sea visible, como los rellenos transparentes de los polígonos, usando ol/layer/Layer#getFeatures() u ol/Map#getFeaturesAtPixel()
• Habilitado : boolean
La representación de elementos transparentes está habilitada. El valor predeterminado es false .
void
estilo Ol-Mapbox • Docios
setFeatureState (
mapOrLayer,feature,state):void
Establece o elimina un estado de característica. El estado de la característica se tiene en cuenta para el estilo, al igual que las propiedades de la función, y se puede usar, por ejemplo, para representar condicionalmente las características seleccionadas de manera diferente.
El estado de la función se almacenará en la capa OpenLayers que coincide con el identificador de características, en la propiedad mapbox-featurestate .
• Maporlayer : Map | VectorLayer < VectorSource any , any > | VectorTileLayer < VectorTile any , any >
Abra el mapa o la capa de llayers para configurar el estado de la función.
• Característica : FeatureIdentifier
Identificador de características.
• Estado : any
Estado de características. Establecer en null para eliminar el estado de la función.
void
estilo Ol-Mapbox • Docios
Style -Function (
olLayer,glStyle,sourceOrLayers,resolutions,spriteData,spriteImageUrl,getFonts,getImage?, ...args?):StyleFunction
Crea una función de estilo desde el objeto glStyle para todas las capas que usan la source especificada, que debe ser un "type": "vector" o "type": "geojson" Fuente y la aplica a la capa de layas abiertas especificadas.
Se establecerán dos propiedades adicionales en la capa proporcionada:
mapbox-source : la id de la fuente del documento de estilo mapbox de la que se creó la capa OpenLayers. Por lo general, apply() crea una capa de estilo OpenLayers por fuente de estilo Mapbox, a menos que la pila de capa tenga capas de diferentes fuentes intermedias.mapbox-layers : las id de las capas del documento de estilo Mapbox que se incluyen en la capa OpenLayers.Esta función también funciona en un trabajador web. En el modo trabajador, el hilo principal debe escuchar mensajes del trabajador y responder con otro mensaje para asegurarse de que funcione la carga de imagen de Sprite:
worker . addEventListener ( 'message' , event => {
if ( event . data . action === 'loadImage' ) {
const image = new Image ( ) ;
image . crossOrigin = 'anonymous' ;
image . addEventListener ( 'load' , function ( ) {
createImageBitmap ( image , 0 , 0 , image . width , image . height ) . then ( imageBitmap => {
worker . postMessage ( {
action : 'imageLoaded' ,
image : imageBitmap ,
src : event . data . src
} , [ imageBitmap ] ) ;
} ) ;
} ) ;
image . src = event . data . src ;
}
} ) ; • Ollayer : VectorLayer < VectorSource any , any > | VectorTileLayer < VectorTile any , any >
OpenLayers Capa para aplicar el estilo. Además del estilo, la capa obtendrá dos propiedades: mapbox-source será la id de la fuente del glStyle utilizada para la capa, y mapbox-layers serán una serie de las id de las capas del glStyle .
• Glstyle : any
Objeto de estilo Mapbox.
• SourceorLayers : string | string []
Clave source o una matriz de id de capa del objeto Mapbox Style. Cuando se proporciona una clave source , todas las capas para la fuente especificada se incluirán en la función de estilo. Cuando se proporcionan id de capa, deben ser de capas que usan la misma fuente.
• Resoluciones : number [] = defaultResolutions
Resoluciones para la resolución de mapeo al nivel de zoom.
• Spritedata : any = undefined
Datos de sprite de la URL especificada en la propiedad sprite del objeto de estilo Mapbox. Solo se requiere si se especifica una propiedad sprite en el objeto Mapbox Style.
• SpriteImageUrl : string | Request | Promise < string | Request > = undefined
URL de imagen Sprite para el sprite especificado en la propiedad sprite del objeto Mapbox Style. Solo se requiere si se especifica una propiedad sprite en el objeto Mapbox Style.
• getFonts = undefined
Función que recibe una pila de fuentes y la plantilla de URL de la propiedad de metadata['ol:webfonts'] (si se establece) como argumentos, y devuelve una pila de fuentes (modificada) que está disponible. Los nombres de fuentes son los nombres utilizados en el objeto de estilo Mapbox. Si no se proporciona, la pila de fuentes se usará como es. Esta función también se puede usar para cargar fuentes web.
• ¿ GetImage? = undefined
Función que devuelve una imagen o una URL para un nombre de imagen. Si el resultado es un HTMLImageElement, ya debe cargarse. La capa se puede usar para llamar a la capa. Esta función se puede usar para iconos que no están en el sprite o para anular los iconos de sprite.
• ... args? : any
StyleFunction
Función de estilo para usar en ol.layer.Vector o ol.layer.VectorTile .
estilo Ol-Mapbox • Docios
UpdateMapboxlayer (
mapOrGroup,mapboxLayer):void
Actualice un objeto de capa MAPBOX en el estilo. El mapa se volverá a renderizar con el nuevo estilo.
• Maporgroup : Map | LayerGroup
Se apply el mapa o el grupo de capa.
• Mapboxlayer : any
Objeto de capa de Mapbox actualizado.
void
estilo Ol-Mapbox • Docios
UpdateMapboxSource (
mapOrGroup,id,mapboxSource):PromiseSource
Actualiza un objeto de origen de mapbox en el estilo. Se reemplazará la fuente de Según OpenLayers y el mapa se volverá a renderizar.
• Maporgroup : Map | LayerGroup
Se apply el mapa o el grupo de capa.
• ID : string
Clave de la fuente en el objeto sources literal.
• MAPBOXSource : any
Objeto de origen MAPBOX.
Promise Source
Prometen que se resuelve cuando la fuente ha sido actualizada.
