docs: update l7 package readme.md (#1096)

This commit is contained in:
YiQianYao 2022-05-05 18:53:26 +08:00 committed by GitHub
parent 5fe152723a
commit 936ac40d36
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 210 additions and 48 deletions

101
packages/l7/README.en-US.md Normal file
View File

@ -0,0 +1,101 @@
# L7
.
[![travis ci](https://travis-ci.com/antvis/L7.svg?branch=master)](https://travis-ci.com/antvis/L7) [![](https://flat.badgen.net/npm/v/@antv/l7?icon=npm)](https://www.npmjs.com/package/@antv/l7) ![最近提交](https://badgen.net/github/last-commit/antvis/L7)
Large-scale WebGL-powered Geospatial data visualization analysis framework.
[中文 README](./README.md)
[GitHub](https://github.com/antvis/L7)
Powered by WebGL, the rendering technology of L7 supports fast and efficient rendering of big data, 2D/3D rendering, possible through calculation and analysis of spatial data by GPU Parallel Compu-ting.
L7 focuses on geographic data expressivenessinteraction and design of geographic visualization layers. The basemaps on the platform are powered by third-party services
[website](https://l7.antv.vision/zh)
## 🌄 L7 visualization demos
![L7 demo](https://gw.alipayobjects.com/mdn/rms_855bab/afts/img/A*S-73QpO8d0YAAAAAAAAAAABkARQnAQ)
## 🌟 Highlight features of L7 2.0
- 🌏 Data-driven Visualization
Layer visualization API design base Semiology of Graphics.
It supports rich map visualization types for a better insight on data.
- 🌏 High performance rendering with 2D/3D effect
Real-time and dynamic rendering with millions of spatial data.
- 🌏 Simple and flexible data format
L7 supports a wide variety of data formats including CSV, JSON, geojson, among others, eliminating the need to run conversions ahead of time.
- 🌏 Multi-basemap
For global users, Mapbox is easy to be embedded by a simple line of code.
## Getting Started
### 📦 Installation
```bash
npm install @antv/l7
```
### Init Map by L7 scene
```javascript
import { Scene } from '@antv/l7';
import { Mapbox } from '@antv/l7-maps';
const scene = new Scene({
id: 'map',
map: new Mapbox({
style: 'light',
pitch: 0,
center: [107.054293, 35.246265],
zoom: 4.056,
}),
});
```
### Add Layer
```javascript
import { PointLayer } from '@antv/l7';
const pointLayer = new PointLayer()
.source(data)
.shape('circle')
.size('mag', [1, 25])
.color('mag', ['#5B8FF9', '#5CCEA1'])
.style({
opacity: 0.3,
strokeWidth: 1,
});
scene.addLayer(pointLayer);
```
## :memo: Documentation
- [Getting started with L7](https://l7.antv.vision/en/docs/api/l7)
- [Tutorials](https://l7.antv.vision/en/docs/tutorial/quickstart)
- [API documentation](https://l7.antv.vision/en/docs/api/l7)
- [Examples](https://l7.antv.vision/en/examples/gallery/basic)
- [Contributor documentation](./.github/CONTRIBUTING.md)
## 🔗 Links
- [L7Plot](https://github.com/antvis/L7Plot)
- [L7 React](https://github.com/antvis/L7-React)
- [L7 Boundary](https://github.com/antvis/L7-boundary)
- [L7 draw](https://github.com/antvis/L7-draw)
## ✅ License
[MIT license](./LICENSE).

View File

@ -1,72 +1,133 @@
# L7 ## L7 地理空间数据可视分析引擎
![最近提交](https://badgen.net/github/last-commit/antvis/L7) [![travis ci](https://travis-ci.com/antvis/L7.svg?branch=master)](https://travis-ci.com/antvis/L7) [![](https://flat.badgen.net/npm/v/@antv/l7?icon=npm)](https://www.npmjs.com/package/@antv/l7) ![最近提交](https://badgen.net/github/last-commit/antvis/L7)
L7 Large-scale WebGL-powered Geospatial data visualization analysis framework [README](./README.en-US.md)
## l7 visualization demos [GitHub](https://github.com/antvis/L7)
![l7 demo](https://gw.alipayobjects.com/mdn/antv_site/afts/img/A*zOFwTJ9wHXQAAAAAAAAAAABkARQnAQ)
### Installation
```bash ```bash
npm install @antv/l7 git clone https://github.com/antvis/L7 --depth=1
``` ```
### Features L7 是由蚂蚁金服 AntV 数据可视化团队推出的基于 WebGL 的开源大规模地理空间数据可视分析开发框架。L7 中的 L 代表 Location7 代表世界七大洲寓意能为全球位置数据提供可视分析的能力。L7 专注数据可视化化表达,通过颜色、大小、纹理,方向,体积等视觉变量设置实现从数据到信息清晰,有效的表达。
[官网地址](https://l7.antv.vision/zh)
### Links L7 能够满足常见的地图图表BI 系统的可视化分析、以及 GIS交通电力国土农业城市等领域的空间信息管理分析等应用系统开发需求。
![L7 demo](https://gw.alipayobjects.com/mdn/rms_855bab/afts/img/A*S-73QpO8d0YAAAAAAAAAAABkARQnAQ)
## Development ## 🌟 核心特性
使用 Yarn Workspace 完成依赖安装以及各包之间的 link 工作: 🌏 数据驱动可视化展示
```bash
yarn install
```
开发模式: 数据驱动,灵活数据映射,从数到形,支持丰富的地图可视化类型,更好洞察数据。
```bash
yarn watch
```
运行 Demo 🌏 2D3D 一体化的海量数据高性能渲染
```bash
yarn storybook
```
代替 `git commit` 提交: 海量空间数据实时,可交互,动态渲染,
```bash
yarn commit
```
## view doc example 🌏 简单灵活的数据接入
支持 CSVJSONGeoJSON 等数据格式接入,可以根据需求自定义数据格式,无需复杂的空间数据转换。
🌏 多地图底图支持,支持离线内网部署
屏蔽不同底图之间的差异用户只需要关注数据层表达交互。高德地图国内合法合规的地理底图Mapbox 满足国际化业务需求。
## 🌈 支持丰富的图表类型
#### 点图层
- 气泡图
- 散点图
- 符号地图
- 3D 柱状地图
- 聚合地图
- 复合图表地图
- 自定义 Marker
#### 线图层
- 路径地图
- 弧线,支持 2D 弧线、3D 弧线以及大圆航线
- 等值线
#### 面图层
- 填充图
- 3D 填充图
#### 热力图
- 经典热力图
- 蜂窝热力图
- 网格热力图
#### 栅格地图
- 图片
- Raster
## 📦 如何使用
### 安装
```bash ```bash
npm start npm install @antv/l7
```
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 ```javascript
import { Scene } from '@antv/l7';
import { Mapbox } from '@antv/l7-maps';
const scene = new Scene({
id: 'map',
map: new Mapbox({
style: 'light',
pitch: 0,
center: [107.054293, 35.246265],
zoom: 4.056,
}),
});
``` ```
将 lodash 添加为所有 package 的依赖(不包含root ### 添加图层
```bash
yarn workspaces run add lodash ```javascript
import { PointLayer } from '@antv/l7';
const pointLayer = new PointLayer()
.source(data)
.shape('circle')
.size('mag', [1, 25])
.color('mag', ['#5B8FF9', '#5CCEA1'])
.style({
opacity: 0.3,
strokeWidth: 1,
});
scene.addLayer(pointLayer);
``` ```
将 typescript 设置为 root 的开发依赖 ## :memo: 文档
```bash
yarn add -W -D typescript jest - [开始使用](https://l7.antv.vision/en/docs/api/l7)
``` - [教程](https://l7.antv.vision/en/docs/tutorial/quickstart)
- [文档](https://l7.antv.vision/en/docs/api/l7)
- [示例](https://l7.antv.vision/en/examples/gallery/basic)
- [贡献](./.github/CONTRIBUTING.md)
## 🔗 Links
- [L7Plot](https://github.com/antvis/L7Plot)
- [L7 React](https://github.com/antvis/L7-React)
- [L7 Boundary](https://github.com/antvis/L7-boundary)
- [L7 draw](https://github.com/antvis/L7-draw)
## ✅ License
[MIT license](./LICENSE).