Skip to content

Commit

Permalink
docs(layer): add layer docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lzxue committed Nov 20, 2019
1 parent 573a6ae commit d44583f
Show file tree
Hide file tree
Showing 26 changed files with 817 additions and 341 deletions.
6 changes: 0 additions & 6 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,8 @@
"eslint-config-egg"
],
"globals": {
"$": true,
"AMap": true,
"L7": true,
"AMapUI": true,
"DataSet": true,
"G2": true,
"_": true,
"mapboxgl":true,
},
"env": {
"browser": true,
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ L7 Large-scale WebGL-powered Geospatial data visualization analysis framework
### Installation

```
npm install @l7/l7
npm install @antv/l7
```

Expand Down
125 changes: 125 additions & 0 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
## L7 地理空间数据可视分析引擎

L7 是由蚂蚁金服 AntV 数据可视化团队推出的基于 WebGL 的开源大规模地理空间数据可视分析开发框架。L7 中的 L 代表 Location,7 代表世界七大洲,寓意能为全球位置数据提供可视分析的能力。L7 以图形符号学为理论基础,将抽象复杂的空间数据转化成 2D、3D 符号,通过颜色、大小、体积、纹理等视觉变量实现丰富的可视化表达。

<video id="video" controls="" preload="none" poster="https://gw.alipayobjects.com/mdn/antv_site/afts/img/A*rjkiQLCoZxUAAAAAAAAAAABkARQnAQ">
<source id="mp4" src="https://gw.alipayobjects.com/mdn/antv_site/afts/file/A*viKwSJl2OGIAAAAAAAAAAABkARQnAQ"; type="video/map4">
<source id="webm" src="https://gw.alipayobjects.com/os/basement_prod/65d5dbe8-d78d-4c6b-9318-fa06b1456784.webm" type="video/webm">
<source id="ogv" src="http://media.w3.org/2010/05/sintel/trailer.ogv" type="video/ogg">
<p>Your user agent does not support the HTML5 Video element.</p>
</video>


### Installation

```
npm install @antv/l7
```


## 核心特性

### 🌏 数据驱动可视化展示

数据驱动,从数到形,支持丰富的地图可视化类型,更好洞察数据。

### 🌏 2D,3D 一体化的海量数据高性能渲染

百万级空间数据实时,动态渲染。

### 🌏简单灵活的数据接入

支持CSV,JSON,geojson等数据格式接入,可以根据需求自定义数据格式,无需复杂的空间数据转换。

### 🌏 多地图底图支持,支持离线内网部署

高德地图国内合法合规的地理底图,Mapbox 满足国际化业务需求。

## 支持丰富的图表类型

### 点图层

- 气泡图
- 散点图
- 符号地图
- 3D柱状地图
- 聚合地图
- 复合图表地图
- 自定义Marker

### 线图层

- 路径地图
- 弧线,支持2D弧线、3D弧线以及大圆航线
- 等值线

### 面图层

- 填充图
- 3D填充图

### 热力图

- 经典热力图
- 蜂窝热力图
- 网格热力图

### 栅格地图
- 图片
- Raster

## L7 2.0 Roadmap

![L7 Road Map](https://gw.alipayobjects.com/mdn/antv_site/afts/img/A*3j9HTLTQT2MAAAAAAAAAAABkARQnAQ)

## Development

使用 Yarn Workspace 完成依赖安装以及各包之间的 link 工作:
```bash
yarn install
```

开发模式:
```bash
yarn watch
```

运行 Demo
```bash
yarn storybook
```

代替 `git commit` 提交:
```bash
yarn commit
```

## view doc example

```bash
npm start
```
visit http://localhost:8000/

## Add Package

add new package:
```bash
lerna create my-pack -y
```

将 ui-lib 作为 my-pack 的依赖:
```bash
yarn workspace my-pack add ui-lib/1.0.0
```

将 lodash 添加为所有 package 的依赖(不包含root)
```bash
yarn workspaces run add lodash
```

将 typescript 设置为 root 的开发依赖
```bash
yarn add -W -D typescript jest
```
48 changes: 24 additions & 24 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// @see https://babeljs.io/docs/en/next/config-files#project-wide-configuration
module.exports = (api) => {
module.exports = api => {
api.cache(() => process.env.NODE_ENV);

const isSite = api.env('site');
Expand All @@ -10,16 +10,16 @@ module.exports = (api) => {

if (isSite) { //
return {
"presets": [
"babel-preset-gatsby"
presets: [
'babel-preset-gatsby'
],
"plugins": [
'@babel/plugin-proposal-optional-chaining',
'@babel/plugin-proposal-nullish-coalescing-operator',
plugins: [
'@babel/plugin-proposal-optional-chaining',
'@babel/plugin-proposal-nullish-coalescing-operator',
[
'@babel/plugin-proposal-decorators',
{
legacy: true,
legacy: true
}
],
[
Expand All @@ -29,10 +29,10 @@ module.exports = (api) => {
extensions: [
// 由于使用了 TS 的 resolveJsonModule 选项,JSON 可以直接引入,不需要当作纯文本
// '.json',
'.glsl',
'.glsl'
]
}
],
]
]
};
}
Expand All @@ -43,35 +43,35 @@ module.exports = (api) => {
{
targets: {
browsers: 'Last 2 Chrome versions, Firefox ESR',
node: 'current',
node: 'current'
},
// set `modules: false` when building CDN bundle, let rollup do commonjs works
// @see https://github.com/rollup/rollup-plugin-babel#modules
modules: (isCDNBundle || isESModule) ? false : 'auto',
},
modules: (isCDNBundle || isESModule) ? false : 'auto'
}
],
[
'@babel/preset-react',
{
development: isCommonJS,
},
development: isCommonJS
}
],
'@babel/preset-typescript',
'@babel/preset-typescript'
],
plugins: [
'@babel/plugin-proposal-optional-chaining',
'@babel/plugin-proposal-nullish-coalescing-operator',
[
'@babel/plugin-proposal-decorators',
{
legacy: true,
legacy: true
}
],
[
'@babel/plugin-proposal-class-properties',
{
// @see https://github.com/storybookjs/storybook/issues/6069#issuecomment-472544973
loose: true,
loose: true
}
],
'@babel/plugin-syntax-dynamic-import',
Expand All @@ -87,21 +87,21 @@ module.exports = (api) => {
extensions: [
// 由于使用了 TS 的 resolveJsonModule 选项,JSON 可以直接引入,不需要当作纯文本
// '.json',
'.glsl',
'.glsl'
]
}
],
[
// @see https://github.com/babel/babel/issues/8741#issuecomment-509041135
'const-enum',
{
transform: 'constObject',
transform: 'constObject'
}
],
// 按需引用 @see https://github.com/lodash/babel-plugin-lodash
'lodash',
// 内联 WebGL 常量 @see https://www.npmjs.com/package/babel-plugin-inline-webgl-constants
isCDNBundle ? 'inline-webgl-constants' : {},
isCDNBundle ? 'inline-webgl-constants' : {}
],
ignore: [
'node_modules',
Expand All @@ -113,8 +113,8 @@ module.exports = (api) => {
'__tests__',
'__stories__',
'**/*/__snapshots__',
'**/*/__tests__',
]: [],
],
'**/*/__tests__'
] : []
]
};
}
};
4 changes: 2 additions & 2 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
module.exports = {
extends: [
"@commitlint/config-conventional"
'@commitlint/config-conventional'
]
};
};
9 changes: 5 additions & 4 deletions docs/API/L7.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,20 @@ L7 是由蚂蚁金服 AntV 数据可视化团队推出的基于 WebGL 的开源

## 核心特性

### 数据驱动可视化展示

### 🌏 数据驱动可视化展示

数据驱动,从数到形,支持丰富的地图可视化类型,更好洞察数据。

### 2D,3D 一体化的海量数据高性能渲染
### 🌏 2D,3D 一体化的海量数据高性能渲染

百万级空间数据实时,动态渲染。

### 简单灵活的数据接入
### 🌏 简单灵活的数据接入

支持CSV,JSON,geojson等数据格式接入,可以根据需求自定义数据格式,无需复杂的空间数据转换。

### 多地图底图支持,支持离线内网部署
### 🌏 多地图底图支持,支持离线内网部署

高德地图国内合法合规的地理底图,Mapbox 满足国际化业务需求。

Expand Down
Loading

0 comments on commit d44583f

Please sign in to comment.