Type Alias ILayers

图层管理模块。

管理二维地图图层，包括查询、添加、移动、删除、显隐、可选、可编辑、样式和选择集。

type ILayers = {
    add: (
        param: AddLayerParam,
        beforeId?: string,
    ) => Promise<string | undefined>;
    addSelection: (layerId: string, elementId: number) => boolean;
    addToGroup: (
        param: AddLayerParam,
        groupId: string,
        beforeId?: string,
    ) => Promise<string | undefined>;
    changeLayerStyle: (id: string, style: Partial<IGeoStyle>) => boolean;
    changeTextStyle: (
        layerId: string,
        textIds: number[],
        style: Partial<ITextStyle>,
    ) => Promise<boolean>;
    clearSelection: (layerId: string) => boolean;
    getLayer: (id: string) => ILayer | undefined;
    getLayers: () => ILayer[];
    getRasterCapabilities: (id: string) => IRasterCapabilities | undefined;
    getRasterRenderInfo: (id: string) => IRasterRenderInfo | undefined;
    getRasterStyle: (id: string) => IRasterStyle | undefined;
    getSelection: (layerId: string, ids?: number[]) => number[];
    getStyle: (id: string) => undefined | IGeoStyle;
    getTheme: (
        id: string,
    ) =>
        | undefined
        | IThemeUnique
        | IThemeRange
        | IThemeLabel
        | IThemeLabelUnique
        | IThemeLabelRange;
    move: (id: string, beforeId: string) => void;
    moveToGroup: (id: string, groupId: string, beforeId?: string) => void;
    refresh: (id: string) => void;
    remove: (id: string) => boolean;
    rename: (id: string, name: string) => void;
    setEditable: (id: string, editable: boolean) => void;
    setMaxVisibleScale: (id: string, scale: number) => void;
    setMetaData: (id: string, metadata: unknown) => void;
    setMinVisibleScale: (id: string, scale: number) => void;
    setRasterStyle: (
        id: string,
        style: IRasterStyle | null,
    ) => Promise<IRasterStyle>;
    setSelectable: (id: string, selectable: boolean) => void;
    setSelectionStyle: (layerId: string, style: Partial<IGeoStyle>) => boolean;
    setVisible: (id: string, visible: boolean) => void;
    updateRasterStyle: (
        id: string,
        patch: Partial<IRasterStyle>,
    ) => Promise<IRasterStyle>;
}

Properties

add

add: (param: AddLayerParam, beforeId?: string) => Promise<string | undefined>

添加图层到根图层组中。

影像图层等待读取、统计和原生安装完成；准备或应用失败会 reject 并撤销此次新增。返回 id 不表示视口内全部瓦片已绘制。RN Controller 调用需 await。

Type declaration

- (param: AddLayerParam, beforeId?: string): Promise<string | undefined>
- Parameters
  - param: AddLayerParam
    图层参数。
  - OptionalbeforeId: string
    指定添加到某个图层前面；不传时添加到最后。
  Returns Promise<string | undefined>
  图层 id；添加失败时返回 undefined。

addSelection

addSelection: (layerId: string, elementId: number) => boolean

添加对象到选择集。

Type declaration

- (layerId: string, elementId: number): boolean
- Parameters
  - layerId: string
    图层 id。
  - elementId: number
    对象 id。
  Returns boolean
  添加成功返回 true；图层没有选择集时返回 false。

addToGroup

addToGroup: (
    param: AddLayerParam,
    groupId: string,
    beforeId?: string,
) => Promise<string | undefined>

添加图层到指定图层组中。

影像图层沿用 add 的准备、错误和回滚语义。

Type declaration

- (
      param: AddLayerParam,
      groupId: string,
      beforeId?: string,
  ): Promise<string | undefined>
- Parameters
  - param: AddLayerParam
    图层参数。
  - groupId: string
    目标图层组 id。
  - OptionalbeforeId: string
    添加到目标图层组的指定图层前；不传时添加到图层组最后。
  Returns Promise<string | undefined>
  图层 id；添加失败时返回 undefined。

changeLayerStyle

changeLayerStyle: (id: string, style: Partial<IGeoStyle>) => boolean

修改图层风格。

会刷新目标图层。当前方法只对已有图层风格可读取的图层生效。

Type declaration

- (id: string, style: Partial<IGeoStyle>): boolean
- Parameters
  - id: string
    矢量图层 id。
  - style: Partial<IGeoStyle>
    要合并到当前图层风格中的字段。
  Returns boolean
  修改成功返回 true，失败返回 false。

changeTextStyle

changeTextStyle: (
    layerId: string,
    textIds: number[],
    style: Partial<ITextStyle>,
) => Promise<boolean>

修改文本风格。

修改一个或多个文本对象样式，并刷新目标文本图层。

Type declaration

- (
      layerId: string,
      textIds: number[],
      style: Partial<ITextStyle>,
  ): Promise<boolean>
- Parameters
  - layerId: string
    文本图层 id。
  - textIds: number[]
    文本对象 id 数组。
  - style: Partial<ITextStyle>
    要合并到文本对象当前样式中的字段。
  Returns Promise<boolean>
  修改成功返回 true，失败返回 false。

clearSelection

clearSelection: (layerId: string) => boolean

清空图层选择集。

Type declaration

- (layerId: string): boolean
- Parameters
  - layerId: string
    图层 id。
  Returns boolean
  清空成功返回 true；图层没有选择集时返回 false。

getLayer

getLayer: (id: string) => ILayer | undefined

根据指定 id 获取图层信息。

Type declaration

- (id: string): ILayer | undefined
- Parameters
  - id: string
    图层 id。
  Returns ILayer | undefined
  图层信息；指定图层不存在时返回 undefined。

getLayers

getLayers: () => ILayer[]

获取根图层组中的所有图层。

Type declaration

- (): ILayer[]
- Returns ILayer[]
  根图层组中的图层数组。

getRasterCapabilities

getRasterCapabilities: (id: string) => IRasterCapabilities | undefined

查询图层数据与环境能力；unknown 表示尚未准备，不代表不支持。

Type declaration

- (id: string): IRasterCapabilities | undefined
- Parameters
  - id: string
    影像图层 id。
  Returns IRasterCapabilities | undefined
  renderer/采样支持范围及原因；不存在或非影像返回 undefined。

getRasterRenderInfo

getRasterRenderInfo: (id: string) => IRasterRenderInfo | undefined

查询准备/就绪/失败状态及实际 renderer、波段、物理范围和统计依据。 ready 表示实例准备完成；这些状态不会写入保存的地图。

Type declaration

- (id: string): IRasterRenderInfo | undefined
- Parameters
  - id: string
    影像图层 id。
  Returns IRasterRenderInfo | undefined
  实际结果；不存在或非影像返回 undefined。

getRasterStyle

getRasterStyle: (id: string) => IRasterStyle | undefined

获取最后成功提交的完整配置副本；准备期间仍返回旧值。

Type declaration

- (id: string): IRasterStyle | undefined
- Parameters
  - id: string
    影像图层 id，需已添加到地图。
  Returns IRasterStyle | undefined
  配置副本；不存在或非影像返回 undefined。RN client 需 await。

getSelection

getSelection: (layerId: string, ids?: number[]) => number[]

获取图层选择集。

Type declaration

- (layerId: string, ids?: number[]): number[]
- Parameters
  - layerId: string
    图层 id。
  - Optionalids: number[]
    指定获取的对象 id 数组；不传时返回所有已选对象 id。
  Returns number[]
  选择集中的对象 id 数组；图层没有选择集时返回空数组。

getStyle

getStyle: (id: string) => undefined | IGeoStyle

获取图层风格

Type declaration

- (id: string): undefined | IGeoStyle
- Parameters
  - id: string
    矢量图层id
  Returns undefined | IGeoStyle
  风格对象

getTheme

获取专题图层的专题对象

Type declaration

- (
      id: string,
  ):
      | undefined
      | IThemeUnique
      | IThemeRange
      | IThemeLabel
      | IThemeLabelUnique
      | IThemeLabelRange
- Parameters
  - id: string
    专题图层id
  Returns
      | undefined
      | IThemeUnique
      | IThemeRange
      | IThemeLabel
      | IThemeLabelUnique
      | IThemeLabelRange
  专题图对象

move

move: (id: string, beforeId: string) => void

调整图层顺序。

Type declaration

- (id: string, beforeId: string): void
- Parameters
  - id: string
    要移动的图层 id。
  - beforeId: string
    移动到此图层前。
  Returns void

moveToGroup

moveToGroup: (id: string, groupId: string, beforeId?: string) => void

移动图层到指定图层组内。

Type declaration

- (id: string, groupId: string, beforeId?: string): void
- Parameters
  - id: string
    要移动的图层 id。
  - groupId: string
    目标图层组 id。
  - OptionalbeforeId: string
    移动到目标图层组指定图层前；不传时移动到目标图层组最后。
  Returns void

refresh

refresh: (id: string) => void

刷新图层。

Type declaration

- (id: string): void
- Parameters
  - id: string
    要刷新的图层 id。
  Returns void

remove

remove: (id: string) => boolean

移除图层。

若目标是图层组，会将图层组内所有图层一起移除。

Type declaration

- (id: string): boolean
- Parameters
  - id: string
    要移除的图层 id。
  Returns boolean
  移除成功返回 true，失败返回 false。

rename

rename: (id: string, name: string) => void

重命名图层

Type declaration

- (id: string, name: string): void
- Parameters
  - id: string
    目标图层id
  - name: string
    名称
  Returns void

setEditable

setEditable: (id: string, editable: boolean) => void

设置图层可编辑

一副地图只能同时有一个可编辑图层

Type declaration

- (id: string, editable: boolean): void
- Parameters
  - id: string
    目标图层id
  - editable: boolean
    是否可编辑
  Returns void

setMaxVisibleScale

setMaxVisibleScale: (id: string, scale: number) => void

设置图层最大可见范围

Type declaration

- (id: string, scale: number): void
- Parameters
  - id: string
    目标图层id
  - scale: number
    图层比例尺
  Returns void

setMetaData

setMetaData: (id: string, metadata: unknown) => void

设置图层自定义信息

Type declaration

- (id: string, metadata: unknown): void
- Parameters
  - id: string
    图层id
  - metadata: unknown
    自定义信息
  Returns void

setMinVisibleScale

setMinVisibleScale: (id: string, scale: number) => void

设置图层最小可见范围

Type declaration

- (id: string, scale: number): void
- Parameters
  - id: string
    目标图层id
  - scale: number
    图层比例尺
  Returns void

setRasterStyle

setRasterStyle: (
id: string,
style: IRasterStyle | null,
) => Promise<IRasterStyle>

完整替换配置，省略字段恢复默认；null 重置全部参数。失败保留最后成功配置。

Type declaration

- (id: string, style: IRasterStyle | null): Promise<IRasterStyle>
- Parameters
  - id: string
    影像图层 id。
  - style: IRasterStyle | null
    新配置，或 null。
  Returns Promise<IRasterStyle>
  已提交的完整配置。成功表示实例已准备，不表示视口全部瓦片完成。

Throws

code/message：LAYER_NOT_FOUND、INVALID_LAYER_TYPE、INVALID_ARGUMENT、 UNSUPPORTED_RASTER_STYLE、TIFF_READ_FAILED、TIFF_STATISTICS_FAILED、RASTER_STYLE_APPLY_FAILED。

Example

await client.layers.setRasterStyle(id, { renderer: { type: 'grayscale', band: 1,
  stretch: { type: 'manual', range: [0, 6000] } } })

setSelectable

setSelectable: (id: string, selectable: boolean) => void

设置图层可选

Type declaration

- (id: string, selectable: boolean): void
- Parameters
  - id: string
    目标图层id
  - selectable: boolean
    是否可选
  Returns void

setSelectionStyle

setSelectionStyle: (layerId: string, style: Partial<IGeoStyle>) => boolean

修改选择集样式。

Type declaration

- (layerId: string, style: Partial<IGeoStyle>): boolean
- Parameters
  - layerId: string
    图层 id。
  - style: Partial<IGeoStyle>
    选择集样式。
  Returns boolean
  修改成功返回 true；图层没有选择集时返回 false。

setVisible

setVisible: (id: string, visible: boolean) => void

设置图层显隐

Type declaration

- (id: string, visible: boolean): void
- Parameters
  - id: string
    目标图层id
  - visible: boolean
    是否可见
  Returns void

updateRasterStyle

updateRasterStyle: (
id: string,
patch: Partial<IRasterStyle>,
) => Promise<IRasterStyle>

顶层原子更新；缺省字段保留，renderer/noData 整体替换，不深度合并。请求轮到提交时再与已提交配置合并，避免并发 patch 覆盖；失败保留旧配置。

Type declaration

- (id: string, patch: Partial<IRasterStyle>): Promise<IRasterStyle>
- Parameters
  - id: string
    影像图层 id。
  - patch: Partial<IRasterStyle>
    要更新的顶层字段，例如 { opacity: 0.5 }。
  Returns Promise<IRasterStyle>
  已提交完整配置；错误码与 setRasterStyle 相同。

Type Alias ILayers

Index

Properties

Properties

add

Type declaration

Parameters

Returns Promise<string | undefined>

addSelection

Type declaration

Parameters

Returns boolean

addToGroup

Type declaration

Parameters

Returns Promise<string | undefined>

changeLayerStyle

Type declaration

Parameters

Returns boolean

changeTextStyle

Type declaration

Parameters

Returns Promise<boolean>

clearSelection

Type declaration

Parameters

Returns boolean

getLayer

Type declaration

Parameters

Returns ILayer | undefined

getLayers

Type declaration

Returns ILayer[]

getRasterCapabilities

Type declaration

Parameters

Returns IRasterCapabilities | undefined

getRasterRenderInfo

Type declaration

Parameters

Returns IRasterRenderInfo | undefined

getRasterStyle

Type declaration

Parameters

Returns IRasterStyle | undefined

getSelection

Type declaration

Parameters

Returns number[]

getStyle

Type declaration

Parameters

Returns undefined | IGeoStyle

getTheme

Type declaration

Parameters

Returns | undefined | IThemeUnique | IThemeRange | IThemeLabel | IThemeLabelUnique | IThemeLabelRange

move

Type declaration

Parameters

Returns void

moveToGroup

Type declaration

Parameters

Returns void

refresh

Type declaration

Parameters

Returns void

remove

Type declaration

Parameters

Returns boolean

rename

Type declaration

Parameters

Returns void

setEditable

Returns
| undefined
| IThemeUnique
| IThemeRange
| IThemeLabel
| IThemeLabelUnique
| IThemeLabelRange