@markerjs/markerjs3 3.0.1 → 3.2.0

package/markerjs3.d.ts

@@ -244,6 +244,13 @@ interface AnnotationState {
      * Height of the annotation.
      */
     height: number;
+    /**
+     * Default SVG filter to apply to markers in the annotation.
+     * (e.g. "drop-shadow(2px 2px 2px black)")
+     *
+     * @since 3.2.0
+     */
+    defaultFilter?: string;
     /**
      * Array of marker states for markers in the annotation.
      */
@@ -278,6 +285,16 @@ declare class MarkerBase {
      * Returns marker type name for the object instance.
      */
     get typeName(): string;
+    /**
+     * Marker type title (display name) used for accessibility and other attributes.
+     */
+    static title: string;
+    /**
+     * When true, the default filter is applied to the marker's visual.
+     *
+     * @since 3.2.0
+     */
+    static applyDefaultFilter: boolean;
     /**
      * SVG container object holding the marker's visual.
      *
@@ -302,10 +319,6 @@ declare class MarkerBase {
      * The default marker size when the marker is created with a click (without dragging).
      */
     defaultSize: ISize;
-    /**
-     * Marker type title (display name) used for accessibility and other attributes.
-     */
-    static title: string;
     /**
      * Marker lifecycle stage.
      *
@@ -854,6 +867,7 @@ declare class PolygonMarker extends MarkerBase {
     selectorVisualLines: SVGLineElement[];
     visibleVisual: SVGGraphicsElement | undefined;
     protected applyStrokeColor(): void;
+    protected applyFillColor(): void;
     protected applyStrokeWidth(): void;
     protected applyStrokeDasharray(): void;
     protected applyOpacity(): void;
@@ -909,6 +923,7 @@ interface FreehandMarkerState extends MarkerBaseState {
 declare class FreehandMarker extends MarkerBase {
     static typeName: string;
     static title: string;
+    static applyDefaultFilter: boolean;
     /**
      * Points of the freehand line.
      */
@@ -1250,6 +1265,7 @@ declare class TextMarker extends RectangularBoxMarkerBase {
 declare class CoverMarker extends ShapeMarkerBase {
     static typeName: string;
     static title: string;
+    static applyDefaultFilter: boolean;
     constructor(container: SVGGElement);
     protected getPath(width?: number, height?: number): string;
 }
@@ -1263,6 +1279,7 @@ declare class CoverMarker extends ShapeMarkerBase {
 declare class HighlightMarker extends ShapeMarkerBase {
     static typeName: string;
     static title: string;
+    static applyDefaultFilter: boolean;
     constructor(container: SVGGElement);
     protected getPath(width?: number, height?: number): string;
 }
@@ -1556,6 +1573,54 @@ declare class CaptionFrameMarker extends TextMarker {
     scale(scaleX: number, scaleY: number): void;
 }
 
+interface CurveMarkerState extends LinearMarkerBaseState {
+    /**
+     * x coordinate for the curve control point.
+     */
+    curveX: number;
+    /**
+     * y coordinate for the curve control point.
+     */
+    curveY: number;
+}
+
+/**
+ * Curve marker represents a curved line.
+ *
+ * @summary Curve marker.
+ * @group Markers
+ */
+declare class CurveMarker extends LineMarker {
+    static typeName: string;
+    static title: string;
+    /**
+     * x coordinate for the curve control point.
+     */
+    curveX: number;
+    /**
+     * y coordinate for the curve control point.
+     */
+    curveY: number;
+    constructor(container: SVGGElement);
+    protected getPath(): string;
+    getState(): CurveMarkerState;
+    restoreState(state: CurveMarkerState): void;
+}
+
+/**
+ * Highlighter marker imitates a freeform highlighter pen.
+ *
+ * @summary Semi-transparent freeform marker.
+ * @group Markers
+ * @since 3.2.0
+ */
+declare class HighlighterMarker extends FreehandMarker {
+    static typeName: string;
+    static title: string;
+    static applyDefaultFilter: boolean;
+    constructor(container: SVGGElement);
+}
+
 /**
  * Properties for marker editor.
  */
@@ -2021,6 +2086,20 @@ declare class MarkerArea extends HTMLElement {
     private prevPanPoint;
     private panTo;
     private undoRedoManager;
+    private _defaultFilter?;
+    /**
+     * Returns the default SVG filter for the created markers.
+     *
+     * @since 3.2.0
+     */
+    get defaultFilter(): string | undefined;
+    /**
+     * Sets the default SVG filter for the created markers
+     * (e.g. "drop-shadow(2px 2px 2px black)").
+     *
+     * @since 3.2.0
+     */
+    set defaultFilter(value: string | undefined);
     constructor();
     private connectedCallback;
     private disconnectedCallback;
@@ -2369,10 +2448,6 @@ declare class LinearMarkerEditor<TMarkerType extends LinearMarkerBase = LinearMa
     private manipulationStartY1;
     private manipulationStartX2;
     private manipulationStartY2;
-    /**
-     * Container for control elements.
-     */
-    protected controlBox: SVGGElement;
     /**
      * Container for manipulation grips.
      */
@@ -2770,6 +2845,25 @@ declare class CaptionFrameMarkerEditor<TMarkerType extends CaptionFrameMarker =
     protected setSize(): void;
 }
 
+declare class CurveMarkerEditor<TMarkerType extends CurveMarker = CurveMarker> extends LinearMarkerEditor<TMarkerType> {
+    /**
+     * Curve manipulation grip.
+     */
+    protected curveGrip?: ResizeGrip;
+    private manipulationStartCurveX;
+    private manipulationStartCurveY;
+    private curveControlLine1?;
+    private curveControlLine2?;
+    ownsTarget(el: EventTarget): boolean;
+    pointerDown(point: IPoint, target?: EventTarget): void;
+    protected resize(point: IPoint): void;
+    manipulate(point: IPoint): void;
+    protected setupControlBox(): void;
+    protected adjustControlBox(): void;
+    protected addControlGrips(): void;
+    protected positionGrips(): void;
+}
+
 /**
  * Event map for {@link MarkerView}.
  */
@@ -2907,6 +3001,20 @@ declare class MarkerView extends HTMLElement {
      * Sets the current zoom level.
      */
     set zoomLevel(value: number);
+    private _defaultFilter?;
+    /**
+     * Returns the default SVG filter for the created markers.
+     *
+     * @since 3.2.0
+     */
+    get defaultFilter(): string | undefined;
+    /**
+     * Sets the default SVG filter for the created markers
+     * (e.g. "drop-shadow(2px 2px 2px black)").
+     *
+     * @since 3.2.0
+     */
+    set defaultFilter(value: string | undefined);
     private _isInitialized;
     constructor();
     private connectedCallback;
@@ -3054,6 +3162,20 @@ declare class Renderer {
      * Both `width` and `height` have to be set for this to take effect.
      */
     height?: number;
+    private _defaultFilter?;
+    /**
+     * Returns the default SVG filter for the created markers.
+     *
+     * @since 3.2.0
+     */
+    get defaultFilter(): string | undefined;
+    /**
+     * Sets the default SVG filter for the created markers
+     * (e.g. "drop-shadow(2px 2px 2px black)").
+     *
+     * @since 3.2.0
+     */
+    set defaultFilter(value: string | undefined);
     constructor();
     private init;
     private addMainCanvas;
@@ -3082,4 +3204,4 @@ declare class Renderer {
     rasterize(state: AnnotationState, targetCanvas?: HTMLCanvasElement): Promise<string>;
 }
 
-export { Activator, type AnnotationState, ArrowMarker, ArrowMarkerEditor, type ArrowMarkerState, type ArrowType, type BlurHandler, CalloutMarker, CalloutMarkerEditor, type CalloutMarkerState, CaptionFrameMarker, CaptionFrameMarkerEditor, type CaptionFrameMarkerState, CheckImageMarker, CoverMarker, CustomImageMarker, EllipseFrameMarker, EllipseMarker, type FontSize, FrameMarker, FreehandMarker, FreehandMarkerEditor, type FreehandMarkerState, Grip, type GripLocation, HighlightMarker, type IPoint, type ISize, type ITransformMatrix, ImageMarkerBase, type ImageMarkerBaseState, ImageMarkerEditor, type ImageType, LineMarker, LinearMarkerBase, type LinearMarkerBaseState, LinearMarkerEditor, MarkerArea, type MarkerAreaEventData, type MarkerAreaEventMap, type MarkerAreaMode, MarkerBase, MarkerBaseEditor, type MarkerBaseState, type MarkerCreationStyle, type MarkerEditorEventData, type MarkerEditorProperties, type MarkerEditorState, type MarkerEventData, type MarkerStage, 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, TextBlock, TextBlockEditor, type TextChangedHandler, TextMarker, TextMarkerEditor, type TextMarkerState, XImageMarker };
+export { Activator, type AnnotationState, ArrowMarker, ArrowMarkerEditor, type ArrowMarkerState, type ArrowType, type BlurHandler, CalloutMarker, CalloutMarkerEditor, type CalloutMarkerState, CaptionFrameMarker, CaptionFrameMarkerEditor, type CaptionFrameMarkerState, CheckImageMarker, CoverMarker, CurveMarker, CurveMarkerEditor, type CurveMarkerState, CustomImageMarker, EllipseFrameMarker, EllipseMarker, type FontSize, FrameMarker, FreehandMarker, FreehandMarkerEditor, type FreehandMarkerState, Grip, type GripLocation, HighlightMarker, HighlighterMarker, type IPoint, type ISize, type ITransformMatrix, ImageMarkerBase, type ImageMarkerBaseState, ImageMarkerEditor, type ImageType, LineMarker, LinearMarkerBase, type LinearMarkerBaseState, LinearMarkerEditor, MarkerArea, type MarkerAreaEventData, type MarkerAreaEventMap, type MarkerAreaMode, MarkerBase, MarkerBaseEditor, type MarkerBaseState, type MarkerCreationStyle, type MarkerEditorEventData, type MarkerEditorProperties, type MarkerEditorState, type MarkerEventData, type MarkerStage, 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, TextBlock, TextBlockEditor, type TextChangedHandler, TextMarker, TextMarkerEditor, type TextMarkerState, XImageMarker };