Files
site/node_modules/terra-draw/dist/modes/base.mode.d.ts
T
site-admin 3ac81d5a52
deploy / build-and-publish (push) Successful in 1m37s
the editable site (validation-lab)
2026-11-21 08:03:55 +01:00

105 lines
5.7 KiB
TypeScript

import { BehaviorConfig, TerraDrawModeBehavior } from "./base.behavior";
import { TerraDrawOnChangeContext, HexColor, OnFinishContext, Projection, TerraDrawAdapterStyling, TerraDrawGeoJSONStore, TerraDrawKeyboardEvent, TerraDrawModeRegisterConfig, TerraDrawModeState, TerraDrawMouseEvent, Validation, HexColorStyling, NumericStyling, UrlStyling, DashArrayStyling, MarkerAnchorStyling } from "../common";
import { FeatureId, GeoJSONStoreFeatures, StoreChangeHandler } from "../store/store";
export type CustomStyling = Record<string, string | number | HexColorStyling | NumericStyling | UrlStyling | DashArrayStyling | MarkerAnchorStyling>;
export declare enum ModeTypes {
Drawing = "drawing",
Select = "select",
Static = "static",
Render = "render"
}
export declare const DefaultPointerEvents: {
readonly rightClick: true;
readonly contextMenu: false;
readonly leftClick: true;
readonly onDragStart: true;
readonly onDrag: true;
readonly onDragEnd: true;
};
type AllowPointerEvent = boolean | ((event: TerraDrawMouseEvent) => boolean);
export type ModeUpdateOptions<Mode> = Omit<Mode, "modeName">;
export interface PointerEvents {
leftClick: AllowPointerEvent;
rightClick: AllowPointerEvent;
contextMenu: AllowPointerEvent;
onDragStart: AllowPointerEvent;
onDrag: AllowPointerEvent;
onDragEnd: AllowPointerEvent;
}
export type BaseModeOptions<Styling extends CustomStyling> = {
modeName?: string;
styles?: Partial<Styling>;
pointerDistance?: number;
validation?: Validation;
projection?: Projection;
pointerEvents?: PointerEvents;
};
export declare abstract class TerraDrawBaseDrawMode<Styling extends CustomStyling> {
protected _state: TerraDrawModeState;
get state(): TerraDrawModeState;
set state(_: TerraDrawModeState);
protected _styles: Partial<Styling>;
get styles(): Partial<Styling>;
set styles(styling: Partial<Styling>);
protected pointerEvents: PointerEvents;
protected behaviors: TerraDrawModeBehavior[];
protected validate: Validation | undefined;
protected pointerDistance: number;
protected coordinatePrecision: number;
protected undoRedoMaxStackSize?: number;
protected onStyleChange: StoreChangeHandler<TerraDrawOnChangeContext | undefined>;
protected store: TerraDrawGeoJSONStore;
protected projection: Projection;
protected setDoubleClickToZoom: TerraDrawModeRegisterConfig["setDoubleClickToZoom"];
protected unproject: TerraDrawModeRegisterConfig["unproject"];
protected project: TerraDrawModeRegisterConfig["project"];
protected setCursor: TerraDrawModeRegisterConfig["setCursor"];
protected registerBehaviors(_behaviorConfig: BehaviorConfig): void;
private isInitialUpdate;
constructor(options?: BaseModeOptions<Styling>, willCallUpdateOptionsInParentClass?: boolean);
updateOptions(options?: BaseModeOptions<Styling>): void;
protected allowPointerEvent(pointerEvent: AllowPointerEvent, event: TerraDrawMouseEvent): boolean;
type: ModeTypes;
mode: string;
protected setDrawing(): void;
protected setStarted(): void;
protected setStopped(): void;
register(config: TerraDrawModeRegisterConfig): void;
validateFeature(feature: unknown): ReturnType<Validation>;
afterFeatureAdded(_feature: GeoJSONStoreFeatures): void;
afterFeatureUpdated(_feature: GeoJSONStoreFeatures): void;
private performFeatureValidation;
protected validateModeFeature(feature: unknown, modeValidationFn: (feature: GeoJSONStoreFeatures) => ReturnType<Validation>): ReturnType<Validation>;
abstract start(): void;
abstract stop(): void;
abstract cleanUp(): void;
abstract styleFeature(feature: GeoJSONStoreFeatures): TerraDrawAdapterStyling;
onFinish(_finishedId: FeatureId, _context: OnFinishContext): void;
onDeselect(_deselectedId: FeatureId): void;
onSelect(_selectedId: FeatureId): void;
onKeyDown(_event: TerraDrawKeyboardEvent): void;
onKeyUp(_event: TerraDrawKeyboardEvent): void;
undo(): void;
clearHistory(): void;
undoSize(): number;
redoSize(): number;
redo(): void;
onMouseMove(_event: TerraDrawMouseEvent): void;
onClick(_event: TerraDrawMouseEvent): void;
onDragStart(_event: TerraDrawMouseEvent, _setMapDraggability: (enabled: boolean) => void): void;
onDrag(_event: TerraDrawMouseEvent, _setMapDraggability: (enabled: boolean) => void): void;
onDragEnd(_event: TerraDrawMouseEvent, _setMapDraggability: (enabled: boolean) => void): void;
protected getHexColorStylingValue(value: HexColor | ((feature: GeoJSONStoreFeatures) => HexColor | undefined) | undefined, defaultValue: HexColor, feature: GeoJSONStoreFeatures): HexColor;
protected getNumericStylingValue(value: number | ((feature: GeoJSONStoreFeatures) => number | undefined) | undefined, defaultValue: number, feature: GeoJSONStoreFeatures): number;
protected getUrlStylingValue(value: UrlStyling | undefined, defaultValue: string, feature: GeoJSONStoreFeatures): string;
protected getMarkerAnchorStylingValue(value: MarkerAnchorStyling | undefined, defaultValue: NonNullable<TerraDrawAdapterStyling["markerAnchor"]>, feature: GeoJSONStoreFeatures): NonNullable<TerraDrawAdapterStyling["markerAnchor"]>;
protected getDashArrayStylingValue(value: [number, number] | ((feature: GeoJSONStoreFeatures) => [number, number] | undefined) | undefined, defaultValue: [number, number] | undefined, feature: GeoJSONStoreFeatures): [number, number] | undefined;
private getStylingValue;
}
export declare abstract class TerraDrawBaseSelectMode<Styling extends CustomStyling> extends TerraDrawBaseDrawMode<Styling> {
type: ModeTypes;
abstract selectFeature(featureId: FeatureId): void;
abstract deselectFeature(featureId: FeatureId): void;
}
export {};