aviation-chart 0.2.6 → 0.3.1

package/dist/nav-sdk.d.ts

@@ -53,6 +53,320 @@ declare class GlobalConfigManager {
 }
 declare const globalConfig: GlobalConfigManager;
 
+type StrokeLineType = "solid" | "dashed" | "dotted" | "dash-dot" | "long-dash" | "double-dash";
+
+interface CircleOptions {
+    center: [number, number];
+    radius: number;
+    steps?: number;
+    color?: string;
+    opacity?: number;
+    fillTranslate?: [number, number];
+    fillPattern?: string;
+    antialias?: boolean;
+    strokeColor?: string;
+    strokeWidth?: number;
+    strokeOpacity?: number;
+    strokeLineType?: StrokeLineType;
+    strokeDasharray?: number[];
+    strokeLineCap?: "butt" | "round" | "square";
+    strokeLineJoin?: "bevel" | "round" | "miter";
+    strokeBlur?: number;
+    strokeTranslate?: [number, number];
+    label?: string;
+    labelSize?: number;
+    labelColor?: string;
+    labelHaloColor?: string;
+    labelHaloWidth?: number;
+    cursor?: string;
+    beforeId?: string;
+    minZoom?: number;
+    maxZoom?: number;
+    properties?: Record<string, any>;
+}
+type CircleStyleKey = "color" | "opacity" | "fillTranslate" | "fillPattern" | "antialias" | "strokeColor" | "strokeWidth" | "strokeOpacity" | "strokeLineType" | "strokeDasharray" | "strokeBlur" | "strokeTranslate" | "strokeLineCap" | "strokeLineJoin";
+declare class Circle {
+    readonly id: string;
+    private _center;
+    private _radius;
+    private _options;
+    private _map;
+    private _visible;
+    private _sourceId;
+    private _fillLayerId;
+    private _strokeLayerId;
+    private _labelLayerId;
+    constructor(options: CircleOptions);
+    bindTo(mapOrSdk: any): this;
+    private _ring;
+    private _geojson;
+    private _resolveStrokeDash;
+    private _addToMap;
+    private _updateSource;
+    getCenter(): [number, number];
+    setCenter(center: [number, number]): this;
+    getRadius(): number;
+    setRadius(radius: number): this;
+    getBounds(): [[number, number], [number, number]];
+    contains(lnglat: [number, number]): boolean;
+    setStyle(style: Partial<Pick<CircleOptions, CircleStyleKey>>): this;
+    setLabel(label: string): this;
+    show(): this;
+    hide(): this;
+    isVisible(): boolean;
+    remove(): void;
+}
+
+interface TextOptions {
+    position: [number, number];
+    text: string;
+    fontSize?: number;
+    fontFamily?: string[];
+    fontWeight?: "normal" | "bold";
+    fontStyle?: "normal" | "italic";
+    color?: string;
+    opacity?: number;
+    haloColor?: string;
+    haloWidth?: number;
+    haloBlur?: number;
+    translate?: [number, number];
+    rotation?: number;
+    anchor?: "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right";
+    offset?: [number, number];
+    justify?: "auto" | "left" | "center" | "right";
+    allowOverlap?: boolean;
+    ignorePlacement?: boolean;
+    maxWidth?: number;
+    lineHeight?: number;
+    letterSpacing?: number;
+    backgroundColor?: string;
+    backgroundOpacity?: number;
+    cursor?: string;
+    beforeId?: string;
+    minZoom?: number;
+    maxZoom?: number;
+    properties?: Record<string, any>;
+}
+type TextStyleKey = "fontSize" | "fontWeight" | "color" | "opacity" | "haloColor" | "haloWidth" | "haloBlur" | "translate" | "rotation" | "anchor" | "offset" | "justify" | "maxWidth" | "lineHeight" | "letterSpacing";
+declare class Text {
+    readonly id: string;
+    private _position;
+    private _text;
+    private _options;
+    private _map;
+    private _visible;
+    private _sourceId;
+    private _layerId;
+    constructor(options: TextOptions);
+    bindTo(mapOrSdk: any): this;
+    private _geojson;
+    private _buildFont;
+    private _addToMap;
+    private _updateSource;
+    getText(): string;
+    setText(text: string): this;
+    getPosition(): [number, number];
+    setPosition(position: [number, number]): this;
+    setStyle(style: Partial<Pick<TextOptions, TextStyleKey>>): this;
+    show(): this;
+    hide(): this;
+    isVisible(): boolean;
+    remove(): void;
+}
+
+interface MarkerOptions {
+    position: [number, number];
+    label?: string;
+    labelClassName?: string;
+    labelFontSize?: number;
+    labelColor?: string;
+    labelBackground?: string;
+    labelOffset?: [number, number];
+    labelPosition?: "top" | "bottom" | "left" | "right";
+    icon?: string | HTMLElement;
+    iconWidth?: number;
+    iconHeight?: number;
+    color?: string;
+    opacity?: number;
+    scale?: number;
+    draggable?: boolean;
+    angle?: number;
+    anchor?: "center" | "top" | "bottom" | "left" | "right" | "top-left" | "top-right" | "bottom-left" | "bottom-right";
+    offset?: [number, number];
+    cursor?: string;
+    popupContent?: string | HTMLElement;
+    popupOffset?: number;
+    popupMaxWidth?: string;
+    popupOpen?: boolean;
+    className?: string;
+}
+type MarkerEventType = "click" | "dblclick" | "mouseenter" | "mouseleave" | "dragstart" | "drag" | "dragend";
+declare class EnhancedMarker {
+    readonly id: string;
+    private _options;
+    private _marker;
+    private _map;
+    private _wrapperEl;
+    private _labelEl;
+    private _iconEl;
+    private _listeners;
+    private _visible;
+    constructor(options: MarkerOptions);
+    private _labelPositionCSS;
+    private _buildElement;
+    private _buildLabelEl;
+    private _applyPopup;
+    private _setupEvents;
+    bindTo(mapOrSdk: any): this;
+    getPosition(): [number, number];
+    setPosition(position: [number, number]): this;
+    getLabel(): string | undefined;
+    setLabel(label: string): this;
+    setLabelStyle(style: Partial<Pick<MarkerOptions, "labelFontSize" | "labelColor" | "labelBackground">>): this;
+    setIcon(icon: string | HTMLElement): this;
+    setIconSize(width: number, height: number): this;
+    getDraggable(): boolean;
+    setDraggable(draggable: boolean): this;
+    getAngle(): number;
+    setAngle(angle: number): this;
+    setOpacity(opacity: number): this;
+    setPopup(content: string | HTMLElement): this;
+    openPopup(): this;
+    closePopup(): this;
+    show(): this;
+    hide(): this;
+    isVisible(): boolean;
+    on(event: MarkerEventType, fn: Function): this;
+    off(event: MarkerEventType, fn: Function): this;
+    private _emit;
+    remove(): void;
+}
+
+type LineType = "solid" | "dashed" | "dotted" | "dash-dot" | "long-dash" | "double-dash";
+interface PolylineOptions {
+    path: [number, number][];
+    color?: string;
+    width?: number;
+    opacity?: number;
+    lineType?: LineType;
+    dasharray?: number[];
+    lineCap?: "butt" | "round" | "square";
+    lineJoin?: "bevel" | "round" | "miter";
+    miterLimit?: number;
+    roundLimit?: number;
+    blur?: number;
+    offset?: number;
+    translate?: [number, number];
+    gradient?: any[];
+    borderWidth?: number;
+    borderColor?: string;
+    showArrow?: boolean;
+    arrowSpacing?: number;
+    label?: string;
+    labelSize?: number;
+    labelColor?: string;
+    labelHaloColor?: string;
+    labelHaloWidth?: number;
+    labelOffset?: [number, number];
+    labelSpacing?: number;
+    cursor?: string;
+    beforeId?: string;
+    minZoom?: number;
+    maxZoom?: number;
+    properties?: Record<string, any>;
+}
+type PolylineStyleKey = "color" | "width" | "opacity" | "lineType" | "dasharray" | "blur" | "offset" | "translate" | "borderWidth" | "borderColor" | "lineCap" | "lineJoin";
+declare class Polyline {
+    readonly id: string;
+    private _path;
+    private _options;
+    private _map;
+    private _visible;
+    private _sourceId;
+    private _borderLayerId;
+    private _layerId;
+    private _arrowLayerId;
+    private _labelLayerId;
+    constructor(options: PolylineOptions);
+    bindTo(mapOrSdk: any): this;
+    private _geojson;
+    private _resolveDasharray;
+    private _addToMap;
+    private _ensureArrowImage;
+    private _updateSource;
+    getPath(): [number, number][];
+    setPath(path: [number, number][]): this;
+    getLength(): number;
+    getBounds(): [[number, number], [number, number]];
+    setStyle(style: Partial<Pick<PolylineOptions, PolylineStyleKey>>): this;
+    setLabel(label: string): this;
+    show(): this;
+    hide(): this;
+    isVisible(): boolean;
+    remove(): void;
+}
+
+interface PolygonOptions {
+    path: [number, number][][];
+    color?: string;
+    opacity?: number;
+    fillTranslate?: [number, number];
+    fillPattern?: string;
+    antialias?: boolean;
+    strokeColor?: string;
+    strokeWidth?: number;
+    strokeOpacity?: number;
+    strokeLineType?: StrokeLineType;
+    strokeDasharray?: number[];
+    strokeLineCap?: "butt" | "round" | "square";
+    strokeLineJoin?: "bevel" | "round" | "miter";
+    strokeBlur?: number;
+    strokeOffset?: number;
+    strokeTranslate?: [number, number];
+    label?: string;
+    labelSize?: number;
+    labelColor?: string;
+    labelHaloColor?: string;
+    labelHaloWidth?: number;
+    labelAnchor?: "center" | "left" | "right" | "top" | "bottom";
+    labelOffset?: [number, number];
+    cursor?: string;
+    beforeId?: string;
+    minZoom?: number;
+    maxZoom?: number;
+    properties?: Record<string, any>;
+}
+type PolygonStyleKey = "color" | "opacity" | "fillTranslate" | "fillPattern" | "antialias" | "strokeColor" | "strokeWidth" | "strokeOpacity" | "strokeLineType" | "strokeDasharray" | "strokeBlur" | "strokeOffset" | "strokeTranslate" | "strokeLineCap" | "strokeLineJoin";
+declare class EnhancedPolygon {
+    readonly id: string;
+    private _path;
+    private _options;
+    private _map;
+    private _visible;
+    private _sourceId;
+    private _fillLayerId;
+    private _strokeLayerId;
+    private _labelLayerId;
+    constructor(options: PolygonOptions);
+    bindTo(mapOrSdk: any): this;
+    private _geojson;
+    private _centroid;
+    private _resolveStrokeDash;
+    private _addToMap;
+    private _updateSource;
+    getPath(): [number, number][][];
+    setPath(path: [number, number][][]): this;
+    getArea(): number;
+    getBounds(): [[number, number], [number, number]];
+    contains(lnglat: [number, number]): boolean;
+    setStyle(style: Partial<Pick<PolygonOptions, PolygonStyleKey>>): this;
+    setLabel(label: string): this;
+    show(): this;
+    hide(): this;
+    isVisible(): boolean;
+    remove(): void;
+}
+
 interface GraticuleConfig {
     enabled?: boolean;
     interval?: number;
@@ -660,6 +974,11 @@ declare class MapSDK implements IMapSDK {
     addLine(coordinates: [], properties?: Record<string, any>, style?: StyleConfig, id?: string): string;
     addPolygon(coordinates: [], properties?: Record<string, any>, style?: StyleConfig, id?: string): string;
     addGeoJSON(sourceId: string, geojson?: any, props?: GeoJSONSourceSpecification | null | undefined): any;
+    createCircle(options: CircleOptions): Circle;
+    createText(options: TextOptions): Text;
+    createMarker(options: MarkerOptions): EnhancedMarker;
+    createPolyline(options: PolylineOptions): Polyline;
+    createPolygon(options: PolygonOptions): EnhancedPolygon;
     addLayer(layerConfig: LayerConfig): void;
     hoverLayer(layers: LayerRef, cb: (e: any) => void): void;
     hoverPopup(layerId: LayerRef, f: HtmlFunction): () => void;
@@ -1629,7 +1948,7 @@ declare function buildLayersLight(): ({
         "text-anchor": string;
         "text-justify": string;
         "text-size": (string | number | string[])[];
-        "text-offset": (string | number | (string | number[])[])[];
+        "text-offset": number[];
         "icon-allow-overlap": boolean;
         "icon-ignore-placement": boolean;
         "text-allow-overlap": boolean;
@@ -3225,4 +3544,4 @@ declare function buildLayersDark(): ({
     maxzoom?: never;
 })[];
 
-export { API, MapSDK as AviationChart, BuiltInLayer, CHART_THEMES, ClusteringConfig, DEFAULT_LAYER_VISIBILITY, DrawPlugin, ErrorHandler, ErrorManager, EventListener, GROUP_ALIASES, GeoJSONCollection, GeoJSONFeature, GeoJSONManager, GlobalConfigManager, HookCallback, HookContext, HookRegistry, IGeoJSONManager, ILayerManager, IMapSDK, IPlugin, LAYER_GROUPS, LAYER_LABELS, LODConfig, LayerConfig, LayerManager, MapEvent, MapSDK, MapSDKOptions, MeasurePlugin, NOTAM, PerformanceManager, PluginManager, SDKError, StyleConfig, TYPEMAP, WindFrame, WindManager, WindOptions, MapSDK as default, globalConfig };
+export { API, MapSDK as AviationChart, BuiltInLayer, CHART_THEMES, Circle, CircleOptions, ClusteringConfig, DEFAULT_LAYER_VISIBILITY, DrawPlugin, EnhancedMarker, EnhancedPolygon, ErrorHandler, ErrorManager, EventListener, GROUP_ALIASES, GeoJSONCollection, GeoJSONFeature, GeoJSONManager, GlobalConfigManager, HookCallback, HookContext, HookRegistry, IGeoJSONManager, ILayerManager, IMapSDK, IPlugin, LAYER_GROUPS, LAYER_LABELS, LODConfig, LayerConfig, LayerManager, LineType, MapEvent, MapSDK, MapSDKOptions, MarkerOptions, MeasurePlugin, NOTAM, PerformanceManager, PluginManager, PolygonOptions, Polyline, PolylineOptions, SDKError, StrokeLineType, StyleConfig, TYPEMAP, Text, TextOptions, WindFrame, WindManager, WindOptions, MapSDK as default, globalConfig };