vue3-maplibre-gl
Version:
Vue 3 components and composables for MapLibre GL JS - Build interactive maps with ease
39 lines (38 loc) • 1.82 kB
TypeScript
import { CreateLayerActions, Nullable, CircleLayerStyle } from '../../types';
import { MaybeRef } from 'vue';
import { Map, SourceSpecification, FilterSpecification, CircleLayerSpecification, StyleSetterOptions } from 'maplibre-gl';
type Layer = CircleLayerSpecification;
interface CreateCircleLayerProps {
map: MaybeRef<Nullable<Map>>;
source: MaybeRef<string | SourceSpecification | object | null>;
id?: string;
beforeId?: string;
filter?: FilterSpecification;
style?: CircleLayerStyle;
maxzoom?: number;
minzoom?: number;
metadata?: object;
sourceLayer?: string;
debug?: boolean;
register?: (actions: CreateLayerActions<Layer>, map: Map) => void;
}
interface CircleLayerActions extends CreateLayerActions<Layer> {
setStyle: (styleVal?: CircleLayerStyle) => void;
setRadius: (radius: number | string, options?: StyleSetterOptions) => void;
setColor: (color: string, options?: StyleSetterOptions) => void;
setOpacity: (opacity: number, options?: StyleSetterOptions) => void;
setStrokeWidth: (width: number, options?: StyleSetterOptions) => void;
setStrokeColor: (color: string, options?: StyleSetterOptions) => void;
setStrokeOpacity: (opacity: number, options?: StyleSetterOptions) => void;
setVisibility: (visibility: 'visible' | 'none', options?: StyleSetterOptions) => void;
}
/**
* Composable for creating and managing MapLibre GL Circle Layers
* Provides reactive circle layer with error handling, performance optimizations, and enhanced API
*
* @param props - Configuration options for the circle layer
* @returns Enhanced actions and state for the circle layer
*/
export declare function useCreateCircleLayer(props: CreateCircleLayerProps): CircleLayerActions;
export {};
//# sourceMappingURL=useCreateCircleLayer.d.ts.map