Source
定义于: src/source/source.ts:25
Source
接口是所有源类型必须实现的接口;
实现
- CanvasSource
- GeoJSONSource
- ImageSource
- RasterDEMTileSource
- RasterTileSource
- VectorTileSource
- VideoSource
方法
hasTransition()
hasTransition(): boolean
定义于: src/source/source.ts:42
返回一个布尔值,表示此源是否具有当前渲染需要考虑的渐变;
返回
boolean
true或false;
loadTile()
loadTile(
tile
: Tile): Promise<void>
定义于: src/source/source.ts:35
实现此方法以加载tile;请注意,此函数可能会被重复调用,例如当showCollisionBoxes
或检查过期图块被启用时;
参数
参数 | 类型 | 描述 |
---|---|---|
tile | Tile | 要加载的图块 |
返回
Promise<void>
loaded()
loaded(): boolean
定义于: src/source/source.ts:26
如果源已完全加载,则返回true
;
返回
boolean
onAdd()
onAdd(
map
: Map): void
定义于: src/source/source.ts:28
当源添加到地图时调用;
参数
参数 | 类型 | 描述 |
---|---|---|
map | Map | 地图实例 |
返回
void
onRemove()
onRemove(
map
: Map): void
定义于: src/source/source.ts:30
当源从地图移除时调用;
参数
参数 | 类型 | 描述 |
---|---|---|
map | Map | 地图实例 |
返回
void
prepare()
prepare(
context
: Context): void
定义于: src/source/source.ts:43
在任何图块渲染之前调用;准备源的任何状态;如果实现此方法,则根据需要将状态保存在源上并返回void
;
参数
参数 | 类型 | 描述 |
---|---|---|
context | Context | 上下文 |
返回
void
reload()
reload(): void
定义于: src/source/source.ts:32
使源的所有图块失效并重新加载它们;
返回
void
serialize()
serialize(): any
定义于: src/source/source.ts:33
返回描述源且可用于重新创建源的对象;该对象应与构造函数接受的对象格式相同;
返回
any
setPaintProperty()
setPaintProperty(
name
: string,value
: any): void
定义于: src/source/source.ts:37
设置源的绘制属性;
参数
参数 | 类型 | 描述 |
---|---|---|
name | string | 属性名称 |
value | any | 属性值 |
返回
void
update()
update(
transform
: Transform,terrain
: Terrain | null,validationOnly
: boolean): boolean
定义于: src/source/source.ts:39
更新源及其图块以匹配地图视图;返回true
表示图块已添加至地图视图中,触发重绘;
参数
参数 | 类型 | 描述 |
---|---|---|
transform | Transform | 转换 |
terrain | Terrain | null | 地形;如果为null,表示地图上没有地形 |
validationOnly | boolean | 验证模式 |
返回
boolean
属性
hasRTLText?
hasRTLText?: boolean
定义于: src/source/source.ts:41
表示源是否含有从右到左的文本;只适用于矢量图块源;
id
id: string
定义于: src/source/source.ts:44
源的唯一标识符;
roundZoom?
roundZoom?: boolean
定义于: src/source/source.ts:40
如果源需要为图块坐标四舍五入缩放级别值,则为true
;
sourceCache
sourceCache: SourceCache
定义于: src/source/source.ts:31
该源的SourceCache;
type
type: string
定义于: src/source/source.ts:34
源的类型,例如"vector"、"raster"等;