README.en-US.md

English | 简体中文

L7Plot

🌍 Geospatial Visualization Chart Library Based on L7.

Website • Quick Start • API • Example

✨ Features

• 📦 Out of the box: configurable geographic charts with built-in multi granularity administrative data
• 🚀 Rich elements: rich chart types and map components, multi map basemap suppor
• 💯 Easy to customize: data driven, from number to shape, support multi-layer and multi map surface stacking
• 🌱 Dynamic interaction: strong chart interaction ability, support 2 / 3D perspective, and provide command dynamic interaction API

📦 Installation

$ npm install @antv/l7 @antv/l7plot

🔨 Usage

<div id="container"></div>

import { Dot } from '@antv/l7plot';

const data = [
  { lng: 103.715, lat: 31.211, depth: 10, mag: 5.8, title: 'M 5.8 - eastern Sichuan, China' },
  { lng: 104.682, lat: 31.342, depth: 10, mag: 5.7, title: 'M 5.7 - eastern Sichuan, China' },
  // ...
];

const dot = new Dot('container', {
  map: {
    type: 'mapbox',
    style: 'light',
    center: [103.447303, 31.753574],
    zoom: 7,
  },
  autoFit: true,
  source: {
    data: data,
    parser: { type: 'json', x: 'lng', y: 'lat' },
  },
  color: {
    field: 'mag',
    value: ['#82cf9c', '#10b3b0', '#2033ab'],
    scale: { type: 'quantize' },
  },
  size: {
    field: 'mag',
    value: ({ mag }) => (mag - 4.3) * 10,
  },
  state: { active: true },
  scale: { position: 'bottomright' },
  legend: { position: 'bottomleft' },
  tooltip: {
    items: ['title', 'mag', 'depth'],
  },
});

Local Development

# Global installation yarn
$ npm install yarn -g

# Install project dependencies
$ yarn bootstrap

# Compile each package in real time and start the storybook
$ yarn dev

# Run website
$ yarn dev-website

# Run unit tests
$ yarn test

# open electron for unit tests
$ yarn test-live

🤝 How to Contribute

Your contributions are always welcome! Please Do have a look at the issues first.

To become a contributor, please follow our contributing guide.

License

MIT