@pilotdev/pilot-web-2d 25.8.4-alpha → 25.9.0

package/index.d.ts

@@ -80,6 +80,9 @@ export namespace Viewer3DIcons {
     const VIEWER_MEASUREMENT_PERPENDICULAR_ICON: string;
     const VIEWER_MEASUREMENT_POINT_COORDINATES_ICON: string;
     const VIEWER_MEASUREMENT_DIMENSION_ICON: string;
+    const VIEWER_POSITION_MOVE_ICON: string;
+    const VIEWER_POSITION_ROTATE_ICON: string;
+    const VIEWER_POSITION_ALIGN_ICON: string;
     const VIEWER_ZOOM_TO_FIT_ICON: string;
     const VIEWER_RENDER_OPTIONS_ICON: string;
     const VIEWER_CONTEXT_MENU_COPY_PROPS: string;
@@ -98,12 +101,6 @@ export namespace ViewerGeneralIcons {
     const ARROW_DR: string;
     const CHECK: string;
 }
-export namespace Viewer2DIcons {
-    const REMARK_CIRCLE_ICON: string;
-    const ZOOM_IN: string;
-    const ZOOM_OUT: string;
-    const FIT_WIDTH: string;
-}
 export interface ISettings {
     changeSetting<T>(name: string, value: T, notify?: boolean, providedData?: any): void;
     getSettingValue<T>(name: string): T;
@@ -160,6 +157,10 @@ export namespace ControlState {
         INACTIVE = 1,
         DISABLED = 2
     }
+    enum StateMode {
+        AUTO = 0,
+        MANUAL = 1
+    }
 }
 export interface IControl {
     container: HTMLElement;
@@ -208,17 +209,24 @@ export interface IMenu {
     addControl(control: IControl, index?: number): void;
     removeControl(index: number): void;
 }
+export class Separator extends Control {
+    
+    constructor(id: string);
+    setVertical(value: boolean): void;
+}
 interface IToolbarButton {
     button: IControl;
     index: number;
 }
 export class Toolbar extends Control implements IMenu {
+    /** @deprecated */
     readonly controls: IControl[];
     addControl(control: IControl, index?: number | undefined): void;
     removeControl(index: number): void;
     getControls(): IToolbarButton[];
     changeToolbarPosition(direction: ToolbarPosition): void;
     changeToolbarContentAlignment(content: ToolbarContentAlignment): void;
+    clear(): void;
 }
 export {};
 export class ExtensionBase {
@@ -299,10 +307,7 @@ export type ViewerSettings = Record<string, any>;
 export class ViewerConfiguration {
     settingsPrefix: string;
     appearance: ViewerSettings;
-    extensionsOptions: Array<{
-        name: string;
-        options: ViewerSettings;
-    }>;
+    extensionsOptions: Record<string, ViewerSettings>;
     createConfiguration(configuration: ViewerSettings, origin: ViewerSettings): void;
     mergeConfigurationAndSettings(configuration: ViewerSettings, settings: ISettings): void;
     changeTheme(newTheme: string): void;
@@ -345,6 +350,7 @@ export abstract class ViewerBase {
     onExtensionUnloading(extension: ExtensionBase): void;
     onPostExtensionUnload(extension: ExtensionBase): void;
     protected loadExtensions(): void;
+    protected loadEmbeddedExtension(extensionName: string, type: typeof ExtensionBase): void;
     protected setThemeFromSettings(): void;
 }
 export class EventsDispatcherCore implements IEventsDispatcher {
@@ -370,7 +376,9 @@ export class Button extends Control {
     getState(): ControlState.State;
     getIsChecked(): boolean;
     setIcon(iconClassName: string): void;
+    getIcon(): string;
     setFromSvgTemlate(template: string): void;
+    getSvgTemplate(): string;
     withoutIcon(): void;
     /**
      * Override this method to be notified when the user clicks on the button.
@@ -421,9 +429,11 @@ export class ComboButton extends Control {
     onClick(event: PointerEvent): void;
     onOpen(): void;
     onClose(): void;
+    setStateMode(mode: ControlState.StateMode): void;
     setState(state: ControlState.State): boolean;
     setText(text: string): void;
     setFromSvgTemlate(template: string): void;
+    getSvgTemplate(): string;
 }
 export class Checkbox {
     
@@ -458,6 +468,19 @@ export class Select {
     }): void;
     update(array: ISelectItem[], selectedIndex?: number): void;
 }
+export class Input extends Control {
+    
+    constructor(id: string);
+    get inputElement(): HTMLInputElement;
+    get error(): HTMLElement;
+    get valid(): boolean;
+    set valid(value: boolean);
+    setPlaceholder(placeholder: string): void;
+    setDisabled(value: boolean): void;
+    onChange(value: string): void;
+    setText(text: string): void;
+    destroy(): void;
+}
 export class ViewerToolbar extends Toolbar {
 }
 interface ElementClass {
@@ -477,9 +500,11 @@ export class Dialog extends Control implements ICloseable {
     get resizable(): boolean;
     setDialogContent(value: HTMLElement): Dialog;
     setHeader(value: HTMLElement): Dialog;
+    setHeaderShown(value: boolean): Dialog;
     setCaption(value: string): Dialog;
     setSvgIcon(template: string): Dialog;
     setFooter(value: HTMLElement): Dialog;
+    setFooterShown(value: boolean): Dialog;
     setDialogElementClassNames(value: ElementClass): Dialog;
     setSize(width: number, height: number): Dialog;
     setResizable(value: boolean): Dialog;
@@ -557,10 +582,17 @@ export interface IDocumentPage {
     get width(): number;
     get scale(): number;
     update(params?: IPageUpdateParams): void;
+    getViewport(scale: number): DOMRect;
+    convertToViewportPoint(x: number, y: number): number[];
+    convertToViewportRectangle(rect: number[]): number[];
+    convertToPagePoint(x: number, y: number): number[];
     dispose(): any;
 }
+export type DocumentKind = "PDF" | "XPS" | "OTHER";
 export interface IDocument {
     get pageCount(): number;
+    get scale(): number;
+    get kind(): DocumentKind;
     loadDocumentAsync(arrayBuffer: ArrayBuffer): Promise<void>;
     increaseScale(scaleFactor?: number): void;
     decreaseScale(scaleFactor?: number): void;
@@ -569,39 +601,136 @@ export interface IDocument {
     getPageByTarget(element: HTMLElement): IDocumentPage | undefined;
     getSourceData(): Promise<ArrayBuffer>;
     scrollPageIntoViewAsync(pageNumber: number): Promise<void>;
-    exitFromAnnotationMode(): void;
     dispose(): void;
 }
+export type Subtype = "Link" | "Text" | "Widget" | "Popup" | "FreeText" | "Line" | "Arrow" | "Square" | "Circle" | "PolyLine" | "Polygon" | "Cloud" | "Caret" | "Ink" | "Highlight" | "Underline" | "Squiggly" | "StrikeOut" | "Stamp" | "FileAttachment";
+export interface IAnnotation {
+    groupId: string;
+    borderStyle: IBorderStyle;
+    color?: IRGBColor | null;
+    backgroundColor?: IRGBColor | null;
+    borderColor?: IRGBColor | null;
+    rotation: number;
+    id: string;
+    name?: string | null;
+    subtype: Subtype;
+    pageNumber: number;
+    position?: IPosition;
+    size?: ISize;
+}
+export interface IPosition {
+    x: number;
+    y: number;
+}
+export interface ISize {
+    width: number;
+    height: number;
+}
+export interface IImageAnnotation extends IAnnotation {
+    canvas: HTMLCanvasElement;
+}
+export interface IEllipseAnnotation extends IAnnotation {
+    radiusX: number;
+    radiusY: number;
+    centerX: number;
+    centerY: number;
+}
+export interface IPolylineAnnotation extends IAnnotation {
+    points: number[];
+    type: PolylineType;
+}
+export interface ILineAnnotation extends IAnnotation {
+    points: [number, number, number, number];
+    lineEndings: [LineEndings, LineEndings];
+}
+export interface IInkAnnotation extends IAnnotation {
+    pointsList: number[][];
+}
+export interface ITextDecorationAnnotation extends IAnnotation {
+    quadPoints: number[];
+}
+export interface IBorderStyle {
+    width: number;
+    rawWidth: number;
+    style?: number;
+    dashArray?: number[];
+    horizontalCornerRadius?: number;
+    verticalCornerRadius?: number;
+}
+export interface IRGBColor {
+    0: number;
+    1: number;
+    2: number;
+}
+export type LineEndings = "None" | "Square" | "Circle" | "Diamond" | "OpenArrow" | "ClosedArrow" | "Butt" | "ROpenArrow" | "RClosedArrow" | "Slash";
+export type PolylineType = "PolygonCloud" | "Line";
+export class EventTypes extends CoreEventTypes {
+    static PAGE_RENDERED: string;
+    static DOCUMENT_ZOOM_IN: string;
+    static DOCUMENT_ZOOM_OUT: string;
+    static DOCUMENT_FIT_WIDTH: string;
+    static DOCUMENT_LOADED: string;
+    static DOCUMENT_UNLOADED: string;
+    static DOCUMENT_SCALE_CHANGED: string;
+    static ANNOTATION_MOVED: string;
+    static ANNOTATION_CHANGED: string;
+    static ANNOTATION_DELETED: string;
+    static ANNOTATIONS_LOADED: string;
+    static ANNOTATIONS_CREATED: string;
+    static ANNOTATION_SELECTED: string;
+    static ANNOTATION_DESELECTED: string;
+}
 export enum AnnotationTypes {
     STAMP = "stamp"
 }
+export class AnnotationsLoadedEventArgs extends Event {
+    page: IDocumentPage;
+    annotations: IAnnotation[];
+}
 export class AnnotationEventArgs {
     id: string;
     pageNumber: number;
-    positionX: number;
-    positionY: number;
     type: string;
 }
+export class AnnotationSizeChangedEventArgs extends AnnotationEventArgs {
+    size: ISize;
+}
+export class AnnotationPositionChangedEventArgs extends AnnotationEventArgs {
+    position: IPosition;
+}
 export class AnnotationPositionChangedEvent extends Event {
     page: IDocumentPage;
     args: AnnotationEventArgs;
 }
+export class AnnotationsCreatedEvent extends Event {
+    readonly annotations: IAnnotation[];
+}
+export class AnnotationDeletedEvent extends Event {
+    readonly annotation: IAnnotation;
+}
+export class AnnotationChangedEvent extends Event {
+    readonly annotation: IAnnotation;
+}
+export class AnnotationSelectedEvent extends Event {
+    readonly annotation: IAnnotation | null;
+}
+export class AnnotationDeselectedEvent extends Event {
+    readonly annotation: IAnnotation | null;
+}
 export const ZOOM_IN_SCALE_FACTOR = 1.15;
 export const ZOOM_OUT_SCALE_FACTOR = 0.85;
 export const ZOOM_MAX_SCALE = 10;
 export const ZOOM_MIN_SCALE = 4;
-export class EventTypes extends CoreEventTypes {
-    static PAGE_RENDERED: string;
-    static DOCUMENT_ZOOM_IN: string;
-    static DOCUMENT_ZOOM_OUT: string;
-    static DOCUMENT_FIT_WIDTH: string;
-    static ANNOTATION_MOVED: string;
-}
 export class PageRenderedEvent extends Event {
     page: IDocumentPage;
     
     constructor(type: string, page: IDocumentPage, eventInitDict?: EventInit);
 }
+export class ScaleChangingEvent extends Event {
+    scale: number;
+    
+    constructor(type: string, scale: number, eventInitDict?: EventInit);
+}
 export class DocumentLoadingOptions {
     documentId?: string;
     
@@ -623,6 +752,76 @@ export interface IPrintOptions {
     overlay?: IDocumentPrintOverlay;
     resolution?: number;
 }
+export class Extension extends ExtensionBase {
+    protected get viewer(): Viewer2D;
+}
+export type AddingAnnotationsProps = {
+    isReadonly?: boolean;
+};
+export class AnnotationManager {
+    /**
+     * @returns All annotations by document as flat array
+     *
+     */
+    getAllAnnotations(): IAnnotation[];
+    /**
+     * Adds one or more annotations to the document layer.
+     *
+     * @param annotations - The list of annotations to add.
+     */
+    addAnnotations(annotations: IAnnotation[], addProps?: AddingAnnotationsProps): void;
+    /**
+     * Removes annotations from the document layer.
+     *
+     * @param ids - The IDs of the annotations to remove.
+     * @returns The annotations that were removed.
+     */
+    removeAnnotations(ids: string[]): void;
+    /**
+     * Retrieves a specific annotation by its ID.
+     *
+     * @param annotationId - The ID of the annotation to retrieve.
+     * @returns The annotation if found, or `undefined` if no matching annotation exists.
+     */
+    getAnnotation(annotationId: string): IAnnotation | undefined;
+    getAnnotations(groupId: string): IAnnotation[];
+    /**
+     * Marks an annotation as selected.
+     *
+     * @param annotationId - The ID of the annotation to select.
+     */
+    select(annotationId: string): void;
+    /**
+     * Removes the selection state from a specific annotation.
+     *
+     * @param annotationId - The ID of the annotation to deselect.
+     */
+    deselect(annotationId: string): void;
+    /**
+     * Clears the selection state of all annotations.
+     */
+    clearSelection(): void;
+    /**
+     * Updates the visibility state of one or more annotations.
+     *
+     * @param ids - The IDs of the annotations whose visibility should be updated.
+     * @param visible - The desired visibility state (`true` to show, `false` to hide).
+     */
+    setVisibility(ids: string[], visible: boolean): void;
+    /**
+     * Clears all annotations from the document layer.
+     */
+    clearAnnotations(): void;
+    isRendered(annotation: IAnnotation): Promise<boolean>;
+}
+export class AnnotationsExtension extends Extension {
+    get annotationManager(): AnnotationManager;
+    load(): boolean | Promise<boolean>;
+    getName(): string;
+    onToolbarCreated(toolbar: Toolbar): void;
+    buildCustomToolbar(toolbar: Toolbar, props?: ToolbarProps): void;
+    clearTools(): void;
+}
 export let ViewerInstance: Viewer2D;
 export class Viewer2D extends ViewerBase {
     readonly settings: Readonly<ISettings>;
@@ -634,6 +833,7 @@ export class Viewer2D extends ViewerBase {
     start(): Promise<number>;
     finish(): Promise<void>;
     print(options: IPrintOptions | undefined): Promise<void>;
+    protected loadExtensions(): void;
 }
 export class GuiViewer2D extends Viewer2D {
     getToolbar(): ViewerToolbar;
@@ -648,14 +848,17 @@ export function CreateBasicViewer(container: HTMLElement, configuration?: Viewer
  */
 export function Initializer(options: InitializerOptions, callback: InitializeSuccessCallback): void;
 export function shutdown(): void;
-export class Extension extends ExtensionBase {
-    protected _viewer: Viewer2D;
-}
 export class Point2 {
     x: number;
     y: number;
     
     constructor(x: number, y: number);
 }
+export namespace Viewer2DIcons {
+    const REMARK_CIRCLE_ICON: string;
+    const ZOOM_IN: string;
+    const ZOOM_OUT: string;
+    const FIT_WIDTH: string;
+}
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pilotdev/pilot-web-2d",
-  "version": "25.8.4-alpha",
+  "version": "25.9.0",
   "description": "TypeScript definitions for ASCON PilotWeb2D component",
   "main": "",
   "types": "index.d.ts",