aviation-chart 0.3.25 → 2.0.1

package/README.md

@@ -1,170 +1 @@
-# Kunyu Aviation Chart SDK
-
-A high-performance aviation chart SDK providing complete aeronautical data visualization: FIR/UIR, controlled and restricted airspace, airways, navaids (VOR/NDB), airports and runways, AMM, and terrain — plus business features such as NOTAM, ADS-B, and weather radar. Built with a modular architecture supporting plugins, performance optimization, and unified error handling.
-
-## ✨ Features
-
-- **Aviation data stack**: FIR, controlled/restricted airspace, airways, VOR/NDB, airport runways, AMM, terrain/contours — published per AIRAC period
-- **Theme switching**: in-place light/dark recoloring that never covers your overlay layers
-- **Business modules**: NOTAM, ADS-B, weather radar, raster layers
-- **Performance**: LOD (level-of-detail), lazy layer loading, massive-point clustering, low-zoom style simplification
-- **Plugin system**: unified plugin interface with a built-in measurement plugin
-- **Unified error handling**: centralized error management, fallback strategies, error statistics
-
-## 🚀 Getting Started
-
-### Option 1: CDN script (global `navMap`)
-
-```html
-<!-- latest -->
-<script src="https://aips.siniswift.com/sdk/nav-sdk.min.js"></script>
-<!-- or pin a version -->
-<!-- <script src="https://aips.siniswift.com/sdk/nav-sdk@0.2.0.min.js"></script> -->
-
-<div id="map" style="width:100%;height:600px;"></div>
-
-<script>
-  const sdk = new navMap.MapSDK({
-    container: 'map',
-    center: [116.3974, 39.9093],
-    zoom: 4,
-    theme: 'light',        // 'light' | 'dark'
-    period: '202606',      // AIRAC period; auto-computed if omitted
-  });
-</script>
-```
-
-> The underlying map engine is bundled into `nav-sdk.min.js` — no extra script needed.
-
-### Option 2: npm
-
-```bash
-npm install aviation-chart
-```
-
-```javascript
-import { MapSDK, MeasurePlugin } from 'aviation-chart';
-
-const sdk = new MapSDK({
-  container: 'map',
-  center: [116.3974, 39.9093],
-  zoom: 4,
-  performance: { lodEnabled: true, clusteringEnabled: true, lazyLoadingEnabled: true },
-});
-```
-
-## 📚 API Overview
-
-### Initialization options
-
-| Option | Description |
-|---|---|
-| `container` | Container id or element (required) |
-| `center` / `zoom` | Initial center and zoom |
-| `theme` | `'light'` / `'dark'` |
-| `period` | AIRAC period `YYYYMM` |
-| `apiUrl` | Chart data service URL, default `https://aips.siniswift.com` |
-| `layers` | Initial layer visibility, e.g. `{ airspace: true, controlled: false, terrain: false }` |
-| `performance` | `{ lodEnabled, clusteringEnabled, lazyLoadingEnabled }` |
-| `errorHandler` | Custom error handler function |
-
-### Layer control
-
-Layer groups: `airspace` (FIR), `airline` (airways), `controlled`, `restricted`, `vor`, `ndb`, `airport`, `runway`, `adiz`, `waypointOffAirway`, `amm`, `terrain`, `contour`, `background`, `landLayer`, `boundary`.
-
-```javascript
-// Two equivalent APIs
-sdk.setLayerVisible('airspace', true);
-sdk.addBuiltInLayer('controlled');
-sdk.toggleBuiltInLayer('airline');
-sdk.removeBuiltInLayer('restricted');
-
-// Theme and period
-sdk.setTheme('dark');
-sdk.setPeriod('202609');
-
-// LOD
-sdk.layerManager.setLODEnabled(true);
-```
-
-### Feature drawing (GeoJSON)
-
-```javascript
-sdk.addPoint([lng, lat], properties, style);
-sdk.addLine(coordinates, properties, style);
-sdk.addPolygon(coordinates, properties, style);
-
-// Cluster massive point sets
-sdk.geoJSONManager.setClusteringEnabled(true);
-```
-
-### Business features
-
-```javascript
-sdk.notam.open(true);          // NOTAM
-sdk.adsb.open();               // ADS-B
-sdk.api.getRadarData();        // weather radar data
-```
-
-### Popup
-
-```javascript
-const popup = new navMap.Popup()
-  .setLngLat([lng, lat])
-  .setHTML('<h3>Title</h3>')
-  .addTo(sdk.map);
-```
-
-### Plugins
-
-```javascript
-const measure = new navMap.MeasurePlugin();
-sdk.use(measure);
-measure.enable('distance');    // 'distance' | 'area'
-measure.disable();
-
-const plugin = sdk.getPlugin('measure');
-```
-
-### Underlying engine passthrough
-
-The SDK passes through the full underlying map-engine API — call methods directly on the instance, or access the raw instance via `sdk.map`:
-
-```javascript
-sdk.flyTo({ center: [lng, lat], zoom: 8 });
-sdk.setPaintProperty('airline', 'line-color', '#0057c8');
-sdk.queryRenderedFeatures([x, y]);
-
-const map = sdk.map;  // raw map instance
-```
-
-### Error & performance
-
-```javascript
-const sdk = new navMap.MapSDK({
-  container: 'map',
-  errorHandler: (error) => console.error(error.code, error.details),
-});
-
-sdk.getErrorStats();        // error statistics
-sdk.getPerformanceStats();  // performance statistics
-```
-
-## 🔧 Writing a Plugin
-
-```javascript
-export class MyPlugin {
-  name = 'my-plugin';
-  version = '1.0.0';
-  install(sdk) { /* install logic */ }
-  uninstall(sdk) { /* uninstall logic */ }
-}
-
-const plugin = new MyPlugin();
-sdk.use(plugin);
-sdk.pluginManager.hasPlugin('my-plugin');
-```
-
-## 📄 License
-
-MIT License
+ ## Kunyu