2.0 KiB
2.0 KiB
@worldwideview/wwv-plugin-sdk
Plugin SDK for building WorldWideView globe plugins. Provides TypeScript types, interfaces, and utilities that all plugins depend on.
Installation
npm install @worldwideview/wwv-plugin-sdk
Core Interfaces
| Interface | Purpose |
|---|---|
WorldPlugin |
Main plugin contract — lifecycle, data fetching, rendering |
GeoEntity |
A positioned object on the globe (lat/lon/alt + properties) |
PluginContext |
Host app context injected into every plugin at init |
LayerConfig |
Visual layer settings (color, clustering, limits) |
CesiumEntityOptions |
Per-entity Cesium rendering options (point, model, etc.) |
SelectionBehavior |
Optional trail / fly-to behavior on entity selection |
FilterDefinition |
Declarative filter UI (text, select, range, boolean) |
ServerPluginConfig |
Server-side API routing and polling config |
Quick Example
import type { WorldPlugin, GeoEntity, TimeRange, PluginContext, LayerConfig, CesiumEntityOptions } from "@worldwideview/wwv-plugin-sdk";
export class MyPlugin implements WorldPlugin {
id = "my-plugin";
name = "My Plugin";
description = "A custom WorldWideView plugin";
icon = "🌍";
category = "custom";
version = "1.0.0";
async initialize(ctx: PluginContext) { /* setup */ }
destroy() { /* cleanup */ }
async fetch(timeRange: TimeRange): Promise<GeoEntity[]> {
// Return geo-positioned entities
return [];
}
getPollingInterval() { return 30000; }
getLayerConfig(): LayerConfig {
return { color: "#3b82f6", clusterEnabled: true, clusterDistance: 40 };
}
renderEntity(entity: GeoEntity): CesiumEntityOptions {
return { type: "point", color: "#3b82f6", size: 6 };
}
}
Changelog
- v1.0.3 — Added README with core interfaces and usage docs.
- v1.0.2 — Package metadata updates.
- v1.0.1 — Package configuration fixes.
- v1.0.0 — Initial release with core types and interfaces.
License
ISC