@markerjs/markerjs3 3.0.0-alpha.2 → 3.0.0-alpha.3

package/markerjs3.d.ts

@@ -393,6 +393,32 @@ declare class ShapeOutlineMarkerBase extends RectangularBoxMarkerBase {
 interface ShapeOutlineMarkerBaseState extends RectangularBoxMarkerBaseState {
 }
 
+/**
+ * Represents shape's state.
+ */
+interface ShapeMarkerBaseState extends ShapeOutlineMarkerBaseState {
+    fillColor: string;
+}
+
+declare abstract class ShapeMarkerBase extends ShapeOutlineMarkerBase {
+    static title: string;
+    protected _fillColor: string;
+    get fillColor(): string;
+    set fillColor(value: string);
+    constructor(container: SVGGElement);
+    createVisual(): void;
+    /**
+     * Returns current marker state that can be restored in the future.
+     */
+    getState(): ShapeMarkerBaseState;
+    /**
+     * Restores previously saved marker state.
+     *
+     * @param state - previously saved state.
+     */
+    restoreState(state: MarkerBaseState): void;
+}
+
 declare class FrameMarker extends ShapeOutlineMarkerBase {
     /**
      * String type name of the marker type.
@@ -487,6 +513,54 @@ declare class LinearMarkerBase extends MarkerBase {
     scale(scaleX: number, scaleY: number): void;
 }
 
+declare class LineMarker extends LinearMarkerBase {
+    static typeName: string;
+    static title: string;
+    constructor(container: SVGGElement);
+    protected getPath(): string;
+    /**
+     * Returns current marker state that can be restored in the future.
+     */
+    getState(): LinearMarkerBaseState;
+}
+
+type ArrowType = 'both' | 'start' | 'end' | 'none';
+interface ArrowMarkerState extends LinearMarkerBaseState {
+    arrowType: ArrowType;
+}
+
+declare class ArrowMarker extends LineMarker {
+    static typeName: string;
+    static title: string;
+    private _arrowType;
+    get arrowType(): ArrowType;
+    set arrowType(value: ArrowType);
+    constructor(container: SVGGElement);
+    protected getPath(): string;
+    protected applyStrokeWidth(): void;
+    /**
+     * Returns marker's state.
+     */
+    getState(): ArrowMarkerState;
+    /**
+     * Restores marker's state to the previously saved one.
+     * @param state - previously saved state.
+     */
+    restoreState(state: MarkerBaseState): void;
+}
+
+declare class MeasurementMarker extends LineMarker {
+    static typeName: string;
+    static title: string;
+    constructor(container: SVGGElement);
+    protected getPath(): string;
+    protected applyStrokeWidth(): void;
+    /**
+     * Returns marker's state.
+     */
+    getState(): LinearMarkerBaseState;
+}
+
 interface PolygonMarkerState extends MarkerBaseState {
     /**
      * Polygon points.
@@ -798,6 +872,7 @@ declare class TextMarker extends RectangularBoxMarkerBase {
     textBlock: TextBlock;
     constructor(container: SVGGElement);
     createVisual(): void;
+    adjustVisual(): void;
     ownsTarget(el: EventTarget): boolean;
     protected setTextBoundingBox(): void;
     /**
@@ -832,6 +907,58 @@ declare class TextMarker extends RectangularBoxMarkerBase {
     scale(scaleX: number, scaleY: number): void;
 }
 
+declare class CoverMarker extends ShapeMarkerBase {
+    /**
+     * String type name of the marker type.
+     */
+    static typeName: string;
+    /**
+     * Marker type title (display name) used for accessibility and other attributes.
+     */
+    static title: string;
+    constructor(container: SVGGElement);
+    protected getPath(width?: number, height?: number): string;
+    getState(): ShapeMarkerBaseState;
+}
+
+declare class HighlightMarker extends ShapeMarkerBase {
+    /**
+     * String type name of the marker type.
+     */
+    static typeName: string;
+    /**
+     * Marker type title (display name) used for accessibility and other attributes.
+     */
+    static title: string;
+    constructor(container: SVGGElement);
+    protected getPath(width?: number, height?: number): string;
+    getState(): ShapeMarkerBaseState;
+}
+
+interface CalloutMarkerState extends TextMarkerState {
+    tipPosition: IPoint;
+}
+
+declare class CalloutMarker extends TextMarker {
+    static typeName: string;
+    static title: string;
+    private _tipPosition;
+    get tipPosition(): IPoint;
+    set tipPosition(value: IPoint);
+    private tipBase1Position;
+    private tipBase2Position;
+    private _calloutVisual;
+    constructor(container: SVGGElement);
+    protected getPath(): string;
+    private setTipPoints;
+    createVisual(): void;
+    adjustVisual(): void;
+    ownsTarget(el: EventTarget): boolean;
+    getState(): CalloutMarkerState;
+    restoreState(state: MarkerBaseState): void;
+    scale(scaleX: number, scaleY: number): void;
+}
+
 interface MarkerEditorProperties<TMarkerType extends MarkerBase = MarkerBase> {
     /**
      * SVG container for the marker and editor elements.
@@ -943,10 +1070,11 @@ declare class MarkerBaseEditor<TMarkerType extends MarkerBase = MarkerBase> {
     get opacity(): number;
     constructor(properties: MarkerEditorProperties<TMarkerType>);
     ownsTarget(el: EventTarget | null): boolean;
+    protected isMultiSelected: boolean;
     /**
      * Selects this marker and displays appropriate selected marker UI.
      */
-    select(): void;
+    select(multi?: boolean): void;
     /**
      * Deselects this marker and hides selected marker UI.
      */
@@ -1045,6 +1173,7 @@ declare class MarkerArea extends HTMLElement {
     private _isInitialized;
     private _currentMarkerEditor?;
     get currentMarkerEditor(): MarkerBaseEditor | undefined;
+    private _selectedMarkerEditors;
     private _newMarkerOutline;
     private _targetImage;
     get targetImage(): HTMLImageElement | undefined;
@@ -1076,15 +1205,25 @@ declare class MarkerArea extends HTMLElement {
     private addNewMarker;
     private markerCreated;
     private markerStateChanged;
+    deleteMarker(markerEditor: MarkerBaseEditor): void;
+    deleteSelectedMarkers(): void;
     setCurrentEditor(editor?: MarkerBaseEditor): void;
+    selectEditor(editor: MarkerBaseEditor): void;
+    deselectEditor(editor?: MarkerBaseEditor): void;
     private touchPoints;
     private isDragging;
+    private isSelecting;
+    private _marqueeSelectOutline;
+    private _marqueeSelectRect;
+    private _manipulationStartX;
+    private _manipulationStartY;
     private onCanvasPointerDown;
     private onCanvasDblClick;
     private onPointerMove;
     private showOutline;
     private hideOutline;
     private onPointerUp;
+    private finishMarqueeSelection;
     private onPointerOut;
     private onKeyUp;
     private attachEvents;
@@ -1211,13 +1350,14 @@ declare class RectangularBoxMarkerBaseEditor<TMarkerType extends RectangularBoxM
      * Container for the marker's editing controls.
      */
     protected controlBox: SVGGElement;
+    protected manipulationBox: SVGGElement;
     private readonly CB_DISTANCE;
     private controlRect?;
     private rotatorGripLine?;
     private controlGrips;
     protected disabledResizeGrips: GripLocation[];
     private rotatorGrip?;
-    private activeGrip?;
+    protected activeGrip?: Grip;
     private disableRotation;
     constructor(properties: MarkerEditorProperties<TMarkerType>);
     /**
@@ -1259,17 +1399,17 @@ declare class RectangularBoxMarkerBaseEditor<TMarkerType extends RectangularBoxM
     /**
      * Displays marker's controls.
      */
-    select(): void;
+    select(multi?: boolean): void;
     /**
      * Hides marker's controls.
      */
     deselect(): void;
     private setupControlBox;
     protected adjustControlBox(): void;
-    private addControlGrips;
+    protected addControlGrips(): void;
     private createRotateGrip;
-    private positionGrips;
-    private positionGrip;
+    protected positionGrips(): void;
+    protected positionGrip(grip: SVGGraphicsElement | undefined, x: number, y: number): void;
     /**
      * Hides marker's editing controls.
      */
@@ -1311,6 +1451,9 @@ declare class ShapeOutlineMarkerEditor<TMarkerType extends ShapeOutlineMarkerBas
     pointerUp(point: IPoint): void;
 }
 
+declare class ShapeMarkerEditor<TMarkerType extends ShapeMarkerBase = ShapeMarkerBase> extends ShapeOutlineMarkerEditor<TMarkerType> {
+}
+
 declare class LinearMarkerEditor<TMarkerType extends LinearMarkerBase = LinearMarkerBase> extends MarkerBaseEditor<TMarkerType> {
     /**
      * Default line length when marker is created with a simple click (without dragging).
@@ -1329,6 +1472,7 @@ declare class LinearMarkerEditor<TMarkerType extends LinearMarkerBase = LinearMa
      * Container for control elements.
      */
     protected controlBox: SVGGElement;
+    protected manipulationBox: SVGGElement;
     /**
      * First manipulation grip
      */
@@ -1401,7 +1545,7 @@ declare class LinearMarkerEditor<TMarkerType extends LinearMarkerBase = LinearMa
     /**
      * Displays marker's controls.
      */
-    select(): void;
+    select(multi?: boolean): void;
     /**
      * Hides marker's controls.
      */
@@ -1422,6 +1566,7 @@ declare class PolygonMarkerEditor<TMarkerType extends PolygonMarker = PolygonMar
      * Container for control elements.
      */
     protected controlBox: SVGGElement;
+    protected manipulationBox: SVGGElement;
     protected grips: ResizeGrip[];
     /**
      * Active manipulation grip.
@@ -1491,7 +1636,7 @@ declare class PolygonMarkerEditor<TMarkerType extends PolygonMarker = PolygonMar
     /**
      * Displays marker's controls.
      */
-    select(): void;
+    select(multi?: boolean): void;
     /**
      * Hides marker's controls.
      */
@@ -1586,6 +1731,24 @@ declare class TextMarkerEditor<TMarkerType extends TextMarker = TextMarker> exte
     private markerSizeChanged;
 }
 
+declare class ArrowMarkerEditor<TMarkerType extends ArrowMarker = ArrowMarker> extends LinearMarkerEditor<TMarkerType> {
+    set arrowType(value: ArrowType);
+    get arrowType(): ArrowType;
+}
+
+declare class CalloutMarkerEditor<TMarkerType extends CalloutMarker = CalloutMarker> extends TextMarkerEditor<TMarkerType> {
+    private tipGrip?;
+    private manipulationStartTipPositionX;
+    private manipulationStartTipPositionY;
+    constructor(properties: MarkerEditorProperties<TMarkerType>);
+    protected addControlGrips(): void;
+    private createTipGrip;
+    protected positionGrips(): void;
+    ownsTarget(el: EventTarget): boolean;
+    pointerDown(point: IPoint, target?: EventTarget): void;
+    protected resize(point: IPoint): void;
+}
+
 interface MarkerViewEventMap {
     /**
      * Viewer initialized.
@@ -1725,4 +1888,4 @@ declare class Renderer {
     rasterize(state: AnnotationState, targetCanvas?: HTMLCanvasElement): Promise<string>;
 }
 
-export { type AnnotationState, type ColorType, FrameMarker, FreehandMarker, FreehandMarkerEditor, type FreehandMarkerState, Grip, type IPoint, LinearMarkerBase, type LinearMarkerBaseState, LinearMarkerEditor, MarkerArea, type MarkerAreaEventData, type MarkerAreaEventMap, MarkerBase, MarkerBaseEditor, type MarkerBaseState, type MarkerEditorProperties, type MarkerEditorState, MarkerView, type MarkerViewEventData, type MarkerViewEventMap, PolygonMarker, PolygonMarkerEditor, type PolygonMarkerState, RectangularBoxMarkerBase, type RectangularBoxMarkerBaseState, Renderer, ResizeGrip, RotateGrip, ShapeOutlineMarkerBase, type ShapeOutlineMarkerBaseState, ShapeOutlineMarkerEditor, SvgHelper, TextMarker, TextMarkerEditor, type TextMarkerState };
+export { type AnnotationState, ArrowMarker, ArrowMarkerEditor, type ArrowMarkerState, type ArrowType, CalloutMarker, CalloutMarkerEditor, type CalloutMarkerState, type ColorType, CoverMarker, FrameMarker, FreehandMarker, FreehandMarkerEditor, type FreehandMarkerState, Grip, HighlightMarker, type IPoint, LineMarker, LinearMarkerBase, type LinearMarkerBaseState, LinearMarkerEditor, MarkerArea, type MarkerAreaEventData, type MarkerAreaEventMap, MarkerBase, MarkerBaseEditor, type MarkerBaseState, type MarkerEditorProperties, type MarkerEditorState, MarkerView, type MarkerViewEventData, type MarkerViewEventMap, MeasurementMarker, PolygonMarker, PolygonMarkerEditor, type PolygonMarkerState, RectangularBoxMarkerBase, type RectangularBoxMarkerBaseState, Renderer, ResizeGrip, RotateGrip, ShapeMarkerBase, type ShapeMarkerBaseState, ShapeMarkerEditor, ShapeOutlineMarkerBase, type ShapeOutlineMarkerBaseState, ShapeOutlineMarkerEditor, SvgHelper, TextMarker, TextMarkerEditor, type TextMarkerState };