ofs-object 0.1.7 → 0.1.8

package/dist/index.d.ts

@@ -363,6 +363,11 @@ export declare abstract class BaseGLAdapter implements IMapAdapter {
      * is left without our handlers after destroy().
      */
     protected listen(event: string, handler: (e: any) => void): void;
+    /**
+     * Data features under a map event: rendered features within 6 px, falling back to a spatial point
+     * query when nothing rendered matched. Click and double-click both use it.
+     */
+    private featuresAtEvent;
     protected setupMapEventListeners(): void;
     /** undefined = not worked out yet for the current style */
     private styleFontCache;
@@ -1219,6 +1224,16 @@ export declare interface DrawEvents {
     'draw:otrack-change': {
         enabled: boolean;
     };
+    /** Grips started editing a feature - by any route, including switching from another feature */
+    'edit:start': {
+        layerId: string;
+        featureId: string | number;
+    };
+    /** Grips stopped editing a feature */
+    'edit:end': {
+        layerId: string;
+        featureId: string | number;
+    };
     'selection:draw-complete': {
         mode: 'select-box' | 'select-polygon';
         selectionPolygon: Feature<Polygon>;
@@ -1684,6 +1699,9 @@ export declare interface GripHandle {
     partIndex?: number;
 }
 
+/** Decides which features Grips may edit; see OFSDrawTools.setEditFilter */
+export declare type GripsEditFilter = (layerId: string, featureId: string | number) => boolean;
+
 export declare interface GripsEditorEvents {
     'grip:select': {
         handle: GripHandle;
@@ -1701,6 +1719,16 @@ export declare interface GripsEditorEvents {
         index: number;
     };
     'grip:clear': void;
+    /** Grips started editing a feature (also when switching from one feature to another) */
+    'edit:start': {
+        layerId: string;
+        featureId: string | number;
+    };
+    /** Grips stopped editing a feature */
+    'edit:end': {
+        layerId: string;
+        featureId: string | number;
+    };
 }
 
 /** A curve with no bend worth drawing is just a polyline and needs no metadata */
@@ -2354,6 +2382,11 @@ export declare interface MapClickEvent {
         geometry: any;
     }>;
     originalEvent: MouseEvent;
+    /**
+     * Stop the map's own handling of this event - for a double-click, the zoom. Present on events
+     * from the GL adapters (MapLibre / Mapbox `MapMouseEvent.preventDefault`).
+     */
+    preventDefault?: () => void;
 }
 
 /**
@@ -3194,6 +3227,8 @@ export declare class OFSDrawTools extends TypedEventEmitter<DrawEvents> {
     /** How far stored geometry may sag from the curves it samples */
     private sagToleranceMeters;
     private targetLayerId;
+    /** Which features Grips may edit (null = any) - see setEditFilter */
+    private editFilter;
     private tempSourceId;
     private unsubClick;
     private unsubDblClick;
@@ -3208,6 +3243,7 @@ export declare class OFSDrawTools extends TypedEventEmitter<DrawEvents> {
     private justFinishedDrag;
     private handleKeyDown;
     constructor(dataSource: OFSDataSource, mapAdapter: IMapAdapter);
+    private dataUnsubscribers;
     setOrtho(enabled: boolean): void;
     toggleOrtho(): boolean;
     /**
@@ -3437,6 +3473,28 @@ export declare class OFSDrawTools extends TypedEventEmitter<DrawEvents> {
      * Stop interactive Grips editing
      */
     stopEdit(): void;
+    /**
+     * Limit which features Grips may edit, e.g. only the selected features of the active layer:
+     *
+     * ```ts
+     * draw.setEditFilter((layerId, id) =>
+     *   layerId === ds.getActiveLayerId() && ds.getSelectedFeatureIds(layerId).includes(id));
+     * ```
+     * Applies to every way into Grips: startEdit, clicking in modify mode (a rejected feature counts as
+     * empty space), double-click to edit, the hover cursor, the `grips` command and a box selection
+     * that lands on one feature. It limits Grips only - move, rotate, offset and the other commands
+     * are not affected.
+     *
+     * An edit in progress is ended when the filter stops allowing it: when a new filter is set, and
+     * when the selection or the active layer changes. If the filter depends on other application state,
+     * call `stopEdit()` (or set the filter again) when that changes. `null` = any feature.
+     */
+    setEditFilter(filter: ((layerId: string, featureId: string | number) => boolean) | null): void;
+    /** End the current edit when the edit filter no longer allows it */
+    private enforceEditFilter;
+    private isSelected;
+    /** Whether Grips may edit this feature under the current edit filter */
+    canEdit(layerId: string, featureId: string | number): boolean;
     /**
      * Check if geometry editing is currently active
      */
@@ -3755,6 +3813,7 @@ export declare class OFSGripsEditor extends TypedEventEmitter<GripsEditorEvents>
     private currentSnapResult;
     private sourceId;
     private activeFeatureId;
+    private editFilter;
     private activeLayerId;
     private activeGrip;
     private isDragging;
@@ -3774,7 +3833,17 @@ export declare class OFSGripsEditor extends TypedEventEmitter<GripsEditorEvents>
     /**
      * Start editing a feature's geometry with grips
      */
-    editFeature(layerId: string, featureId: string | number): void;
+    /**
+     * Which features may be edited (null = any). Checked here, in the one method every way into
+     * editing goes through - clicking, double-clicking, startEdit, the `grips` command, a box selection
+     * that lands on one feature - so a new way in cannot forget it.
+     */
+    setEditFilter(filter: GripsEditFilter | null): void;
+    /**
+     * Start editing a feature. Returns false when it cannot be edited: it does not exist, its geometry
+     * type has no grips, or the edit filter rejects it.
+     */
+    editFeature(layerId: string, featureId: string | number): boolean;
     /**
      * Stop editing and clear grips
      */