# 接口规格
本章节包括目前二维可视化，三维可视化，实景可视化的图层创建以及通用接口的说明。一些可视化方案的特有的接口，在各自的页面内单独描述。
有关地图的接口规格，请参考使用地图章节。
# LayerOptions
# Image
| 字段名 | 类型 | 说明 |
|---|---|---|
id必须 | string | 图片的 id，需要在map的实例内唯一。 |
url必须 | string | 图片的 url，需要能够通过 http 访问，如果是相对路径，页面需要通过 HTTPServer 发布后，才能浏览。 |
| type | string | 图片的类型，支持png，gif，svg等图片格式，默认为png。 |
| pixelRatio | number | 像素比率，默认为1 |
| sdf | boolean | 图标是否可以被 icon-color 着色，默认为false，设置为true后，图标的颜色将整个变为 icon-color 指定的颜色。 |
# DataOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| type | string | 只有在TileLayer中可以指定。当图层的 data链接中带有{x}，{y}，{z}等占位符时，无需填写。 当图层的 data链接来自超图时，可将此字段指定为supermap。 当图层的 data链接来自ArcGIS时，可将此字段指定为arcgis。更详细的使用说明参考栅格瓦片图层 |
| minZoom | number | 只有在图层数据为矢量瓦片或栅格瓦片服务时，可以指定，表示数据图层的最小层级。 |
| maxZoom | number | 只有在图层数据为矢量瓦片或栅格瓦片服务时，可以指定，表示数据图层的最大层级。 |
| coordinates | Array<[number, number]> | 只有在ImageLayer中需要指定，表示图像的左上角，右上角，右下角，左下角的经纬度坐标。 |
| bounds | [number, number, number, number] | 瓦片数据源的边界，SDK只请求边界范围内的瓦片，以[西经, 南纬, 东经, 北纬]的顺序输入。默认值：[-180,-85.051129,180,85.051129]。 |
| zoomOffset | number | 对于栅格瓦片数据源，某些服务的zoom值可能与本 SDK 存在固定差值，可以通过本参数消除此偏差。默认值：0。 |
| pipeline | PipelineOptions | 在图层数据为矢量数据时，可以指定特定的一个 PipelineOptions 或者多个 PipelineOptions 组成的数组。 |
# PipelineOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
type必须 | string | 可选'regeocoding'。 |
| priority | number | 当前 pipeline 的执行优先级。 |
# JoinOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
field必须 | string | 用户数据需要关联的字段名称，默认为id。 |
# Filter
过滤参数采用布尔值表达式（即返回结果是boolean值的表达式），具体可以参考：表达式参考。
但是为了方便场景场景的使用，同时提供如下的更简便的写法：
# 更简便的过滤参数
| 写法 | 用途 | 使用场景 | 等价表达式 |
|---|---|---|---|
'指定值' | 指定图层的数据中，id或者name字段的值与用户指定的值相等的元素，保留下来 | 在街镇图层中，只需要显示指定的街镇的数据，其他街镇需要隐藏的情况下 | ["or", ["==", "id", '指定值'], ["==", "name", "指定值"]] |
['指定值1','指定值2'] | 指定图层的数据中，id或者name字段的值在用户指定的值中的元素，保留下来 | 在街镇图层中，只需要显示指定的某几个街镇的数据，其他街镇需要隐藏的情况下 | ["or", ["in", "id", ['指定值1','指定值2']], ["in", "name", ["指定值1", "指定值2"]]] |
| [精度,维度] | 指定图层数据中，包含用户指定点所在的多边形的元素，保留下来 | 在街镇图层中，可以直接通过坐标点来过滤相关的街镇 | 内部实现，当前只支持图层的highlight()接口 |
# Focus
| 字段名 | 类型 | 说明 |
|---|---|---|
| changeCamera | boolean | 是否在图层加载时，进行地图视角的改变（即聚焦）,如果为否，则不作任何的视角改变，默认为true。 |
| animate | boolean | 在视图改变时，是否采用动画形式，默认为true。 |
| center | [number, number] | 属于视角配置参数，地图中心点。 |
| zoom | number | 属于视角配置参数，地图缩放等级。 |
| bearing | number | 属于视角配置参数，地图旋转角度。 |
| pitch | number | 属于视角配置参数，地图倾斜角度。 |
| spatialReference | string | 属于视角配置参数，地图中心点的坐标系统，默认和图层内一致。 |
| padding | Padding | 属于视角配置参数，图层距离容器四周距离(单位像素)。 |
| duration | number | 属于动画配置参数，动态转换的持续时间，按毫秒计算。 |
| easing | Function | 属于动画配置参数，该函数持续的时间在 0~1 之间， 返回一个表示状态的数字，初始状态为 0，最终状态为 1。 |
| speed | number | 属于动画配置参数，与 curve 相关的动态转换的平均速率，默认为 1.2。速率为 1.2 指，地图每秒以 1.2 倍于 curve 可见整屏（screenful）的速度随着飞行路径移动。 整屏（screenful） 指地图的可见屏幕跨度区域。它不对应固定的物理距离，而是随缩放级别变化。 |
| curve | number | 属于动画配置参数，随着飞行路径出现的缩放“曲线”。大幅度移动时会出现较高的缩放值，较小移动时有较低的缩放值 。值为 1 时会出现圆周运动。 |
| maxDuration | number | 属于动画配置参数，动效的最长持续时间，单位为毫秒。如果持续时间超过此最大值，会重置为0。 |
# Padding
| 字段名 | 类型 | 说明 |
|---|---|---|
| top | number | 地图页面上部分留空大小，默认为 0，单位： pixel。 |
| bottom | number | 地图页面底部分留空大小，默认为 0，单位： pixel。 |
| left | number | 地图页面左部分留空大小，默认为 0，单位： pixel。 |
| right | number | 地图页面右部分留空大小，默认为 0，单位： pixel。 |
# BlinkOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| minZoom | number | 该逻辑图层能显示的最小的zoom level，默认为 3。 |
| maxZoom | number | 该逻辑图层能显示的最大的zoom level（但不包括这个Level），默认为 20。 |
| dataId | string | 数据ID，如果其他业务图层也拥有同样的数据ID，则map只会使用第一个load到地图的数据，如此可以避免重复加载重复加载地图数据，提升地图的显示性能，使用更少的资源。不指定时，与所在的逻辑图层一致。 |
| dataLayer | string | 当在VectorLayer中，加载的数据源是从图致服务发布的矢量瓦片数据源时，需要设置指定的 Layer 名称。不指定时，与所在的逻辑图层一致。 |
style必须 | Style | 闪烁效果的显示样式，支持：circle-radius：闪烁的半径，默认为 100。circle-inner-radius：闪烁效果的内圈半径，默认为 30。circle-color闪烁效果的颜色，默认为#ff0000。circle-opacity闪烁效果的不透明度，默认为 1。circle-transition-duration：闪烁的间隔，单位毫秒，默认为 1000。以上样式只支持传入数值或字符串。 |
| filter | Filter | 图层数据过滤表达式。 |
# HighlightOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| minZoom | number | 该逻辑图层能显示的最小的zoom level，默认为 3。 |
| maxZoom | number | 该逻辑图层能显示的最大的zoom level（但不包括这个Level），默认为 20。 |
| dataId | string | 数据ID，如果其他业务图层也拥有同样的数据ID，则map只会使用第一个加载到地图的数据，如此可以避免重复加载重复加载地图数据，提升地图的显示性能，使用更少的资源。不指定时，与所在的逻辑图层一致。 |
| dataLayer | string | 当在VectorLayer中，加载的数据源是从图致服务发布的矢量瓦片数据源时，需要设置指定的 Layer 名称。不指定时，与所在的逻辑图层一致。 |
style必须 | Style | 图层的高亮显示样式，支持的样式内容与被高亮的图层一致。 |
| filter | Filter | 图层数据过滤表达式。 |
# LogicLayerOptions
LogicLayerOptions 和 LayerOptions 的区别
LayerOptions 是创建一整个图层的参数配置，LogicLayerOptions 是创建一整个图层时，子图层的参数。
因为一些较为复杂的图层，会由多个子图层组成，例如：
一个轨迹图层，会由4个图层组成：起点图层，终点图层；轨迹线段图层；从起点到终点不断移动的动态点图层。
为了能够方便的为这样的子图层配置属性，就有了 LogicLayerOptions 的概念。
| 字段名 | 类型 | 说明 |
|---|---|---|
| name | string | 图层的名称，在使用图层的各个接口时，可以通过这个名称来确定具体操作哪一个图层。 |
| zIndex | number ｜ string | 图层在地图中所属的垂直方向的位置索引，默认为 0。 |
| minZoom | number | 能显示的最小的zoom level，默认 3。 |
| maxZoom | number | 能显示的最大的zoom level（但不包括这个Level），默认20。 |
| interactive | boolean | 是否创建默认交互，如鼠标移入移出图层后鼠标样式变化。默认true。 |
data必须 | Data | 支持的数据类型参考各个图层说明文档内的定义。 |
| dataId | string | 如果希望复用本图层的数据，可以指定一个字符串，在创建别的图层时，可以直接使用这个 id作为数据源。 |
| dataLayer | string | 如果 data 属性传入的数据源为矢量瓦片，那么需要通过本属性来指定使用矢量瓦片中的哪个图层。 |
| dataOptions | DataOptions | 数据源的其他配置项，包括数据源的级别范围，额外的处理流程等。具体参见：DataOptions 配置。 |
| spatialReference | string | 图层数据的坐标系统，默认：gcj02。可选项分别为： - GPS坐标系— wgs84 - 火星/高德坐标系— gcj02 - 百度坐标系— bd09 - 城建坐标系— cgcs2000。 |
| joinData | Object | 用户关联的数据，使用数组形式。数组元素为有相同字段的对象。 |
| joinOptions | JoinOptions | 用户关联的数据时的额外配置项，比如需要关联的字段等，具体参见：JoinOptions 配置。 |
| style | Style | 支持的样式类型参考各个图层说明文档内的定义。 |
| filter | Filter | 图层数据的过滤条件，不满足过滤条件的数据将不显示。具体参见：Filter 配置。 |
| focus | Focus | 在执行flyTo或者fitView时的视角动画的默认参数，具体参见：Focus 配置。 |
| blink | BlinkOptions | 在图层中设置进行闪烁显示时的相关配置，可以包括过滤参数和显示风格参数。闪烁只适用于点的场景下。具体参见：BlinkOptions 配置。 |
| highlight | HighlightOptions | 在图层中设置高亮指定元素的相关配置，可以包括过滤参数和显示风格参数。具体参见：HighlightOptions 配置。 |
# SetzIndexOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| layer | string | 新的层级需要作用到的图层名称或者 id。 当一个图层包括多个子图层时，需要指定这个值，多个子图层的创建方式可以参考矢量瓦片图层。 |
# SetFocusOptions
包括 Focus 中所有的参数，以及以下的参数：
| 字段名 | 类型 | 说明 |
|---|---|---|
| filter | Filter | 图层数据过滤表达式，视角将会只聚焦到满足过滤条件的数据。 |
| layer | string | 视角聚焦的图层名称或者 id。 当一个图层包括多个子图层时，需要指定这个值，多个子图层的创建方式可以参考矢量瓦片图层。 |
# SetStyleOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| layer | string | 新的样式需要作用到的图层名称或者 id。 当一个图层包括多个子图层时，需要指定这个值，多个子图层的创建方式可以参考矢量瓦片图层。 |
# SetDataOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| layer | string | 新的数据需要作用到的图层名称或者 id。 当一个图层包括多个子图层时，需要指定这个值，多个子图层的创建方式可以参考矢量瓦片图层。 |
| dataLayer | string | 当在VectorLayer中，加载的数据源是从图致服务发布的矢量瓦片数据源时，需要设置指定的 Layer 名称。不指定时，与所在的逻辑图层一致。 |
| spatialReference | string | 图层数据的坐标系统，默认：gcj02。可选项分别为：- GPS坐标系— wgs84- 火星/高德坐标系— gcj02- 百度坐标系— bd09- 城建坐标系— cgcs2000。 |
| dataOptions | DataOptions | 数据源的其他配置项，包括数据源的级别范围，额外的处理流程等。详情参考DataOptions描述。 |
# SetJoinOptions
包括 JoinOptions 中所有的参数，以及以下的参数：
| 字段名 | 类型 | 说明 |
|---|---|---|
| layer | string | 需要执行数据关联操作的图层名称或者 id。 当一个图层包括多个子图层时，需要指定这个值，多个子图层的创建方式可以参考矢量瓦片图层。 |
# SetFilterOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| layer | string | 需要执行过滤操作的图层名称或者 id。 当一个图层包括多个子图层时，需要指定这个值，多个子图层的创建方式可以参考矢量瓦片图层。 |
# SetHighlightOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| filter | Filter | 图层数据过滤表达式，只有满足过滤条件的数据会有高亮效果。 |
| style | Style | 图层的高亮显示样式，支持的样式内容与被高亮的图层一致。 |
| changeCamera | boolean | 是否在高亮后，进行地图视角的改变（即聚焦），如果为否，则不作任何的视角改变，默认为true。 |
| focus | Focus | 如果changeCamera为true，本参数将作为视角转换的参数。 |
| layer | string | 需要执行高亮操作的图层名称或者 id。 当一个图层包括多个子图层时，需要指定这个值，多个子图层的创建方式可以参考矢量瓦片图层。 |
# ClearHighlightOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| layer | string | 需要清除高亮效果的图层名称或者 id。 当一个图层包括多个子图层时，需要指定这个值，多个子图层的创建方式可以参考矢量瓦片图层。 |
# SetBlinkOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| filter | Filter | 图层数据过滤表达式，只有满足过滤条件的数据会有闪烁效果。 |
| style | Style | 闪烁效果的显示样式，支持：circle-radius：闪烁的半径，默认为 100。circle-inner-radius：闪烁效果的内圈半径，默认为 30。circle-color闪烁效果的颜色，默认为#ff0000。circle-opacity闪烁效果的不透明度，默认为 1。circle-transition-duration：闪烁的间隔，单位毫秒，默认为 1000。以上样式只支持传入数值或字符串。 |
| layer | string | 需要执行闪烁操作的图层名称或者 id。 当一个图层包括多个子图层时，需要指定这个值，多个子图层的创建方式可以参考矢量瓦片图层。 |
# ClearBlinkOptions
| 字段名 | 类型 | 说明 |
|---|---|---|
| layer | string | 需要清除闪烁效果的图层名称或者 id。 当一个图层包括多个子图层时，需要指定这个值，多个子图层的创建方式可以参考矢量瓦片图层。 |