Style

定义于: src/style/style.ts:200

样式基类;

继承

• Evented

方法

addLayer()

addLayer(layerObject: AddLayerObject, before?: string, options?: StyleSetterOptions): this

定义于: src/style/style.ts:952

向地图样式添加图层; 该图层将被插入到ID为before的图层之前，如果省略before则会被追加到末尾;

参数

返回

this

addSprite()

addSprite(id: string, url: string, options: StyleSetterOptions, completion?: (err: Error) => void): void

定义于: src/style/style.ts:1798

添加精灵图;

参数

返回

void

getFilter()

getFilter(layer: string): void | FilterSpecification

定义于: src/style/style.ts:1171

获取图层的过滤器对象;

参数

返回

void | FilterSpecification

图层的过滤器(如果有)

getLayer()

getLayer(id: string): StyleLayer

定义于: src/style/style.ts:1096

返回具有给定id的样式图层对象;

参数

返回

StyleLayer

如果存在具有给定id的图层，则返回该图层

getLayersOrder()

getLayersOrder(): string[]

定义于: src/style/style.ts:1105

按顺序返回当前样式中所有图层的ID，包括自定义图层;

返回

string[]

按顺序排列的图层ID

getLayoutProperty()

getLayoutProperty(layerId: string, name: string): any

定义于: src/style/style.ts:1196

从给定图层获取布局属性的值;

参数

返回

any

属性值

getSource()

getSource(id: string): Source

定义于: src/style/style.ts:941

通过ID获取数据源;

参数

返回

Source

数据源

getSprite()

getSprite(): object[]

定义于: src/style/style.ts:1851

获取当前精灵图值;

返回

object[]

未设置精灵图时为空数组; 否则为ID-URL对

hasLayer()

hasLayer(id: string): boolean

定义于: src/style/style.ts:1115

检查样式中是否存在特定图层;

参数

返回

boolean

指定给定图层是否存在的布尔值

listens()

listens(type: string): boolean

定义于: src/util/evented.ts:165

如果Evented实例或任何转发的Evented实例对指定类型有侦听器，则返回true;

参数

返回

boolean

如果指定事件类型至少有一个已注册的侦听器，则为true，否则为false

继承自

Evented.listens

moveLayer()

moveLayer(id: string, before?: string): void

定义于: src/style/style.ts:1027

将图层移动到不同的z位置; 该图层将被插入到ID为before的图层之前，如果省略before则会被追加到末尾;

参数

返回

void

off()

off(type: string, listener: Listener): Style

定义于: src/util/evented.ts:90

移除先前注册的事件侦听器;

参数

返回

Style

继承自

Evented.off

on()

on(type: string, listener: Listener): Subscription

定义于: src/util/evented.ts:73

为指定的事件类型添加侦听器;

参数

返回

Subscription

继承自

Evented.on

once()

once(type: string, listener?: Listener): Promise<any> | Style

定义于: src/util/evented.ts:106

添加一个仅调用一次的侦听器到指定的事件类型;

侦听器将在注册后事件首次触发时被调用;

参数

返回

Promise<any> | Style

如果未提供侦听器，则为this或promise

继承自

Evented.once

removeLayer()

removeLayer(id: string): void

定义于: src/style/style.ts:1060

从样式中移除具有给定ID的图层; 如果不存在这样的图层，将触发ErrorEvent事件;

参数

返回

void

removeSource()

removeSource(id: string): this

定义于: src/style/style.ts:899

从此样式表中移除一个数据源，根据其ID;

参数

返回

this

异常

如果找不到具有给定ID的数据源

removeSprite()

removeSprite(id: string): void

定义于: src/style/style.ts:1819

通过其ID移除精灵图; 当最后一个精灵图被移除时，整个this.stylesheet.sprite对象变为undefined; 这个falsy的undefined值稍后会阻止尝试加载不存在的精灵图;

参数

返回

void

setEventedParent()

setEventedParent(parent?: Evented, data?: any): Style

定义于: src/util/evented.ts:176

将此Evented实例触发的所有事件冒泡到父Evented实例;

参数

返回

Style

继承自

Evented.setEventedParent

setGeoJSONSourceData()

setGeoJSONSourceData(id: string, data: string | GeoJSON<Geometry, {[name: string]: any; }>): void

定义于: src/style/style.ts:925

设置GeoJSON数据源的数据，根据其ID;

参数

返回

void

setSprite()

setSprite(sprite: SpriteSpecification, options: StyleSetterOptions, completion?: (err: Error) => void): void

定义于: src/style/style.ts:1862

为样式的精灵图设置新值;

参数

返回

void

setState()

setState(nextState: StyleSpecification, options: StyleSwapOptions & StyleSetterOptions): boolean

定义于: src/style/style.ts:725

更新此样式的状态以匹配给定的样式JSON，仅执行必要的突变;

如果mapbox-gl-style-spec差异算法产生不支持的操作，可能会抛出错误('Unimplemented: METHOD');

参数

返回

boolean

如果进行了任何更改，则为true；否则为false