mirror of https://gitee.com/antv-l7/antv-l7
docs: 更新文档
This commit is contained in:
lzxue
parent
bac2e28da9
commit
7becddd82f
|
|
@ -0,0 +1,36 @@
|
|||
- 单通道 绘制结果由是单一的数值控制，如灰度图，数值对应的颜色可以通过表示配置 `rampColors` 色带控制。
|
||||
|
||||
```js
|
||||
layer.style({
|
||||
opacity: 0.5,
|
||||
});
|
||||
```
|
||||
|
||||
### options
|
||||
|
||||
| style | 类型 | 描述 | 默认值 |
|
||||
| ----------- | ------------------ | ------------------------------------------- | ------------- |
|
||||
| opacity | `number` | 图形的透明度 | `1` |
|
||||
| clampLow | `boolean` | 设置为 `true`，低于 `domain` 的数据将不显示 | `false` |
|
||||
| clampHigh | `boolean` | 设置为 `true`，高于 `domain` 的数据将不显示 | `false` |
|
||||
| domain | `[number, number]` | 数据映射区间 | `[ 0, 8000 ]` |
|
||||
| noDataValue | `number` | 不会显示的值 | `-9999999` |
|
||||
| rampColors | `IRampColors` | 值域映射颜色的色带 | `/` |
|
||||
|
||||
#### rampColors
|
||||
|
||||
- colors 颜色数组
|
||||
- positions 数据区间
|
||||
|
||||
配置值域映射颜色的色带，值域的范围为 `[0 - 1]`, 对应的我们需要为每一个 `position` 位置设置一个颜色值。
|
||||
|
||||
⚠️ colors, positions 的长度要相同
|
||||
|
||||
```javascript
|
||||
layer.style({
|
||||
rampColors: {
|
||||
colors: ['#FF4818', '#F7B74A', '#FFF598', '#91EABC', '#2EA9A1', '#206C7C'],
|
||||
positions: [0, 0.2, 0.4, 0.6, 0.8, 1.0],
|
||||
},
|
||||
});
|
||||
```
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: RasterLayer
|
||||
title: Raster 栅格瓦片
|
||||
order: 0
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -15,39 +15,4 @@ order: 0
|
|||
|
||||
## style
|
||||
|
||||
- 单通道 绘制结果由是单一的数值控制，如灰度图，数值对应的颜色可以通过表示配置 `rampColors` 色带控制。
|
||||
|
||||
```js
|
||||
layer.style({
|
||||
opacity: 0.5,
|
||||
});
|
||||
```
|
||||
|
||||
### options
|
||||
|
||||
| style | 类型 | 描述 | 默认值 |
|
||||
| ----------- | ------------------ | ------------------------------------------- | ------------- |
|
||||
| opacity | `number` | 图形的透明度 | `1` |
|
||||
| clampLow | `boolean` | 设置为 `true`，低于 `domain` 的数据将不显示 | `false` |
|
||||
| clampHigh | `boolean` | 设置为 `true`，高于 `domain` 的数据将不显示 | `false` |
|
||||
| domain | `[number, number]` | 数据映射区间 | `[ 0, 8000 ]` |
|
||||
| noDataValue | `number` | 不会显示的值 | `-9999999` |
|
||||
| rampColors | `IRampColors` | 值域映射颜色的色带 | `/` |
|
||||
|
||||
#### rampColors
|
||||
|
||||
- colors 颜色数组
|
||||
- positions 数据区间
|
||||
|
||||
配置值域映射颜色的色带，值域的范围为 `[0 - 1]`, 对应的我们需要为每一个 `position` 位置设置一个颜色值。
|
||||
|
||||
⚠️ colors, positions 的长度要相同
|
||||
|
||||
```javascript
|
||||
layer.style({
|
||||
rampColors: {
|
||||
colors: ['#FF4818', '#F7B74A', '#FFF598', '#91EABC', '#2EA9A1', '#206C7C'],
|
||||
positions: [0, 0.2, 0.4, 0.6, 0.8, 1.0],
|
||||
},
|
||||
});
|
||||
```
|
||||
<embed src="@/docs/api/raster_layer/common/style_single.md"></embed>
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
title: Options
|
||||
order: 1
|
||||
---
|
||||
|
||||
<embed src="@/docs/common/style.md"></embed>
|
||||
|
||||
### sourceLayer
|
||||
|
||||
<description> _string_ **required** </description>
|
||||
|
||||
只有矢量图层生效，用于设置矢量图层的数据源。
|
||||
|
||||
🌟 一般矢量服务返回的数据中存在多个图层的数据，我们需要从中进行选取。
|
||||
|
||||
```javascript
|
||||
const layer = new PointLayer({
|
||||
sourceLayer: 'city',
|
||||
});
|
||||
```
|
||||
|
||||
### featureId
|
||||
|
||||
<description> _string_ **optional** _default:_ 自动数字编号</description>
|
||||
|
||||
只有矢量图层生效，用于指定矢量图层的编码 `id`。
|
||||
|
||||
🌟 编码 `id` 用于在图层高亮时使用。
|
||||
|
||||
```javascript
|
||||
const layer = new PointLayer({
|
||||
featureId: 'id',
|
||||
});
|
||||
```
|
||||
|
||||
<embed src="@/docs/common/layer/options.md"></embed>
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: GeoJsonVT TileLayer
|
||||
title: GeoJsonVT 瓦片
|
||||
order: 0
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
---
|
||||
title: Options
|
||||
order: 1
|
||||
---
|
||||
|
||||
<embed src="@/docs/api/tile/options.zh.md"></embed>
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Raster TileLayer
|
||||
title: Raster 栅格瓦片
|
||||
order: 0
|
||||
---
|
||||
|
||||
|
|
@ -13,7 +13,7 @@ order: 0
|
|||
| 栅格瓦片 | `RasterLayer` | `rasterTile` | `arraybuffer` | 数据栅格 |
|
||||
| 栅格瓦片 | `RasterLayer` | `rasterTile` | `rgb` | 彩色遥感影像栅格 |
|
||||
|
||||
🌟 目前只支持 `GCJ-02` 火星坐标系。
|
||||
🌟 目前只支持 3857坐标系
|
||||
|
||||
### source(url: string, option: IOption)
|
||||
|
||||
|
|
@ -262,3 +262,7 @@ const parser = {
|
|||
* `['atan', value1, value2]` 返回 `n1===-1?Math.atan(n1): Math.atan2(n1, n2)`
|
||||
*/
|
||||
```
|
||||
|
||||
## style
|
||||
|
||||
<embed src="@/docs/api/raster_layer/common/style_single.md"></embed>
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Vector TileLayer
|
||||
title: Vector 矢量瓦片
|
||||
order: 0
|
||||
---
|
||||
|
||||
|
|
@ -15,7 +15,8 @@ order: 0
|
|||
| 矢量瓦片 | `MaskLayer` | parser of MaskLayer、`geojsonvt` | 矢量掩模图层 |
|
||||
| 矢量瓦片 | `TileDebugLayer` | `/` | `TileDebugLayer` 不需要执行 `source` 方法 |
|
||||
|
||||
🌟 目前只支持 `GCJ-02` 火星坐标系。
|
||||
### option
|
||||
<embed src="@/docs/api/tile/common/options.zh.md"></embed>
|
||||
|
||||
### source(url: string, option: IOption)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue