Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,484 changes: 1,484 additions & 0 deletions L7_API_Reference.md

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions site/.dumirc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -696,4 +696,8 @@ export default defineConfig({
'@antv/l7-source': path.resolve(__dirname, '../packages/source/src'),
'@antv/l7-utils': path.resolve(__dirname, '../packages/utils/src'),
},
redirects: {
'/api': '/api/scene',
'/en/api': '/en/api/scene',
},
});
28 changes: 23 additions & 5 deletions site/docs/api/common/layer/layer_ctr.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,34 @@ layer.setMinZoom(zoom);

设置图层最大缩放等级

参数

- zoom {number}

```javascript
layer.setMinZoom(zoom);
layer.setMaxZoom(zoom);
```

设置图层最大缩放等级
### getMinZoom(): number

参数
获取图层最小缩放等级

- zoom {number}
```javascript
const minZoom = layer.getMinZoom();
```

### getMaxZoom(): number

获取图层最大缩放等级

```javascript
layer.setMinZoom(zoom);
const maxZoom = layer.getMaxZoom();
```

### destroy()

销毁图层,释放相关资源。场景调用 `removeLayer` 时会自动销毁图层,一般不需要手动调用。

```javascript
layer.destroy();
```
22 changes: 22 additions & 0 deletions site/docs/api/common/layer/layer_encode.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,3 +415,25 @@ scene.addLayer(imageLayer);
}
}
```

### rotate

将数据值映射到图形的旋转角度上的方法,用于控制点图层图标/图形的旋转。

```javascript
layer.rotate(45); // 常量,所有元素旋转 45 度
layer.rotate('angle'); // 字段映射
layer.rotate('angle', [0, 360]); // 字段映射到角度范围
layer.rotate('angle', (angle) => {
return angle * (Math.PI / 180); // 回调函数
});
```

### label

为图层设置标注(文字标签),将数据字段映射为标注内容显示在图层元素旁边。主要在特定图层类型(如 PointLayer 的文字标注)中生效。

```javascript
layer.label('name'); // 以 name 字段的值作为标注文本
layer.label('name', (name) => `${name}市`); // 回调函数处理标注文本
```
2 changes: 1 addition & 1 deletion site/docs/api/common/layer/mask_method.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ scene.render();
### enableMask

```ts
layer.disableMask();
layer.enableMask();
scene.render();
```
8 changes: 8 additions & 0 deletions site/docs/api/common/layer/mouse_event.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,14 @@ layer.on('contextmenu', (e) => console.log(e));
layer.on('dblclick', (e) => console.log(e));
```

### mouseenter

鼠标进入图层要素时触发

```javascript
layer.on('mouseenter', (e) => console.log(e));
```

### unclick

点击未拾取到元素
Expand Down
82 changes: 79 additions & 3 deletions site/docs/api/common/map.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,96 @@

### pitch 地图倾角

地图初始俯仰角度 {number}  default 0
地图初始俯仰角度 {number} default 0

### bearing 地图偏转角

地图初始旋转角度(相对于正北方向顺时针偏转的度数) {number} default 0

### minZoom 最小缩放等级

地图最小缩放等级 {number}  default 0 Mapbox 0-24) 高德 (2-19)
地图最小缩放等级 {number} default 0 Mapbox 0-24) 高德 (2-19)

### maxZoom 最大缩放等级

地图最大缩放等级 {number}  default 22 Mapbox(0-24) 高德 (2-19)
地图最大缩放等级 {number} default 22 Mapbox(0-24) 高德 (2-19)

### minPitch 最小倾角

地图最小俯仰角 {number} default 0

### maxPitch 最大倾角

地图最大俯仰角 {number} default 60

### rotateEnable 是否允许旋转

地图是否可旋转 {Boolean} default true

### interactive 是否允许交互

<description> _boolean_ **optional** _default:_ true</description>

是否允许地图交互(包括鼠标、触摸、键盘等),设为 `false` 后地图变为静态展示状态

### scrollZoom 是否允许滚轮缩放

<description> _boolean_ **optional** _default:_ true</description>

是否启用滚轮缩放交互

### boxZoom 是否允许框选缩放

<description> _boolean_ **optional** _default:_ true</description>

是否启用框选缩放交互(按住 Shift 拖拽)

### dragRotate 是否允许拖拽旋转

<description> _boolean_ **optional** _default:_ true</description>

是否启用拖拽旋转交互

### dragPan 是否允许拖拽平移

<description> _boolean_ **optional** _default:_ true</description>

是否启用拖拽平移交互

### keyboard 是否允许键盘控制

<description> _boolean_ **optional** _default:_ true</description>

是否启用键盘快捷键控制地图

### doubleClickZoom 是否允许双击缩放

<description> _boolean_ **optional** _default:_ true</description>

是否启用双击缩放交互

### touchZoomRotate 是否允许触摸缩放旋转

<description> _boolean_ **optional** _default:_ true</description>

是否启用双指捏合缩放旋转交互

### renderWorldCopies 是否渲染世界副本

<description> _boolean_ **optional** _default:_ true</description>

超出 -180 和 180 经度范围时,是否在两侧重复渲染地图

### maxBounds 地图最大边界范围

限制地图可视范围在指定的地理范围内

### bearingSnap 北向吸附阈值

<description> _number_ **optional** _default:_ 7</description>

当用户旋转地图接近正北方向时,自动吸附到正北方向的角度阈值(度数)

## 地图事件

Scene 统一代理,见 [Scene 文档](/api/scene)
Expand Down
8 changes: 4 additions & 4 deletions site/docs/api/component/layer_popup.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ scene.on('loaded', () => {

## 配置

| 名称 | 说明 | 类型 | 默认值 |
| ------- | --------------------------------------------------------------------------------------------- | ----------------------------- | --------- |
| items | 需要展示 Popup 的图层配置数组,每个选项类型可见 [LayerPopupConfigItem](#layerpopupconfigitem) | `Array<LayerPopupConfigItem>` | `[]` |
| trigger | 鼠标触发 Popup 展示的方式 | `'hover' \| 'click'` | `'hover'` |
| 名称 | 说明 | 类型 | 默认值 |
| ------- | --------------------------------------------------------------------------------------------- | -------------------------------------------------- | --------- |
| items | 需要展示 Popup 的图层配置数组,每个选项类型可见 [LayerPopupConfigItem](#layerpopupconfigitem) | `Array<LayerPopupConfigItem>` | `[]` |
| trigger | 鼠标触发 Popup 展示的方式,`'click'` 在移动端会自动转换为 `'touchend'` | `'hover' \| 'click' \| 'touchend' \| 'touchstart'` | `'hover'` |

### LayerPopupConfigItem

Expand Down
81 changes: 67 additions & 14 deletions site/docs/api/component/marker.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,33 +28,86 @@ scene.addMarker(marker);

## 方法

#### setLnglat
#### setLnglat(lngLat: ILngLat | [number, number])

设置 marker 经纬度位置
Set marker longitude and latitude position

#### remove
```javascript
marker.setLnglat({ lng: 120, lat: 30 });
marker.setLnglat([120, 30]);
```

#### getLngLat(): ILngLat

Get marker longitude and latitude coordinates

#### remove()

Remove the marker from the map and clean up event bindings

#### hide()

Hide the marker visually without removing it from the map. Use `show()` to restore visibility.

```javascript
marker.hide();
```

#### show()

Show a hidden marker

```javascript
marker.show();
```

#### getElement(): HTMLElement

Get the marker DOM element

#### setElement(element: HTMLElement)

Set the marker DOM element to update Marker appearance

#### getOffset(): number[]

Get the marker offset `[x, y]`

#### setDraggable(draggable: boolean)

Set whether the marker supports dragging

#### getDraggable(): boolean

Get whether the marker currently supports dragging

#### togglePopup()

Toggle the marker popup open/closed

#### openPopup()

移除 marker
Open the associated Popup

#### getElement
#### closePopup()

获取 marker dom Element
Close the associated Popup

#### getLngLat
#### setPopup(popup: Popup)

获取 marker 经纬度坐标
Set a popup for the marker

#### togglePopup
#### getPopup(): Popup

开启或者关闭 marker 弹出框
Get the marker popup

#### setPopup
#### getExtData(): any

为 marker 设置 popup
Get user-defined custom data

#### getPopup
#### setExtData(data: any)

获取 marker 弹出框
Set user-defined custom data

## 示例代码

Expand Down
Loading
Loading