ofs-object 0.1.0-beta.2 → 0.1.0-beta.3

package/dist/index.d.ts

@@ -1071,6 +1071,8 @@ export declare const DEFAULT_MAX_NETWORK_POINTS = 5000;
 
 export declare const DEFAULT_POLAR_TRACKING: PolarTrackingSettings;
 
+export declare const DEFAULT_PREVIEW_STYLE: DrawPreviewStyle;
+
 /**
  * How far the stored polyline may sag away from the true arc, in meters. Five centimeters is below
  * the positional accuracy of the survey data these plans are drawn over, and is deliberately a
@@ -1253,6 +1255,21 @@ export declare type DrawMode = 'point' | 'line' | 'polygon' | 'circle' | 'rectan
  */
 export declare function drawNorthArrow(ctx: DrawingContext, x: number, y: number, size?: number, bearingDeg?: number): void;
 
+export declare interface DrawPreviewStyle {
+    pointColor: string;
+    pointRadius: number;
+    pointStrokeColor: string;
+    pointStrokeWidth: number;
+    lineColor: string;
+    lineWidth: number;
+    /** Dash pattern in multiples of the line width; an empty list draws a solid line */
+    lineDash: number[];
+    fillColor: string;
+    fillOpacity: number;
+    /** Applied to points and lines together, so the whole preview can be dimmed at once */
+    opacity: number;
+}
+
 /** Draw a scale bar with its left end at (x, y) (y is the bottom of the bar) */
 export declare function drawScaleBar(ctx: DrawingContext, plan: ScaleBarPlan, x: number, y: number, style?: ScaleBarStyle): void;
 
@@ -2847,12 +2864,64 @@ export declare interface OFSDataSourceEvents {
  */
 export declare type OFSDiagnosticHandler = (scope: string, error: unknown) => void;
 
+export declare class OFSDrawPreview {
+    private mapAdapter;
+    private sourceId;
+    private style;
+    private current;
+    /** Layer ids in draw order, bottom first */
+    get layerIds(): string[];
+    constructor(mapAdapter: IMapAdapter);
+    private raw;
+    /**
+     * Create the source and layers. Called for you the first time anything is drawn, so a caller that
+     * only ever uses `set` never has to think about it.
+     */
+    setupLayers(): void;
+    /**
+     * Replace what the preview shows. Safe to call on every mouse move: it writes one GeoJSON payload
+     * and touches nothing else.
+     *
+     * Points, lines and polygons can be mixed freely. A feature may carry `color`, `opacity`, `width`,
+     * `radius`, `fillOpacity`, `strokeColor` or `strokeWidth` in its properties to depart from the
+     * style for itself.
+     */
+    set(features: Feature<Geometry, any>[] | FeatureCollection | null): void;
+    /**
+     * Take the preview off the map.
+     *
+     * This is never called for you when a drawing finishes or is cancelled. The preview belongs to the
+     * caller and only the caller knows whether it has gone stale, so scaffolding tied to a drawing
+     * session is cleared from a `draw:complete` and `draw:cancel` handler.
+     */
+    clear(): void;
+    /** What the preview is currently showing */
+    getFeatures(): Feature<Geometry, any>[];
+    isEmpty(): boolean;
+    /** Change the look of the preview. Anything left out keeps its current value. */
+    setStyle(style: Partial<DrawPreviewStyle>): void;
+    getStyle(): DrawPreviewStyle;
+    /**
+     * Lift the preview above the data layers. The drawing guides are raised after this, so the rubber
+     * band and the measurements stay readable over whatever the preview is showing.
+     */
+    bringToFront(): void;
+    /** Remove the layers and the source, for when the draw tools are torn down */
+    destroy(): void;
+}
+
 export declare class OFSDrawTools extends TypedEventEmitter<DrawEvents> {
     private dataSource;
     private mapAdapter;
     readonly snapping: SnappingEngine;
     readonly grips: OFSGripsEditor;
     readonly selectionOverlay: OFSSelectionOverlay;
+    /**
+     * A scratch layer for the host application to draw on while a tool is in use - a planting grid
+     * following the line being drawn, the parcels a cutting line is about to divide. Nothing put here
+     * reaches the data source, the undo history or an export. See `preview/draw-preview.ts`.
+     */
+    readonly preview: OFSDrawPreview;
     orthoEnabled: boolean;
     polarTracking: PolarTrackingSettings;
     /** Angle convention and UCS used for typed angles, relative coordinates, ortho and polar tracking */