@pilotdev/pilot-web-2d 25.5.0 → 25.8.0

package/index.d.ts

@@ -16,9 +16,10 @@ export type StringMap = {
 };
 export class Localization {
     static initialize(options: any): Promise<void>;
-    static translate<T extends (string | StringMap) = string>(stringToTrans: string): T;
+    static translate<T extends (string | StringMap) = string>(stringToTrans: string, options?: {}): T;
     static setLanguage(language: string): Promise<void>;
     static extendLocalization(locales: any): boolean;
+    static numberToStr(value: number, digitsAfterPoint?: number): string;
 }
 export type InitializeSuccessCallback = () => void;
 export function coreInitializer(options: InitializerOptions, callback: InitializeSuccessCallback): void;
@@ -50,11 +51,15 @@ export class Resizer {
     
     constructor(resizableContainer: HTMLElement, containerToRestriction: HTMLElement, elementAnchor?: HTMLElement, windowStater?: WindowStater);
     get windowState(): IWindowStyle | null;
+    set resizeStart(value: () => void);
+    set resizeEnd(value: () => void);
+    dispose(): void;
 }
 export class Dragger {
     
     constructor(allowedDraggableElement: HTMLElement, draggableContainer: HTMLElement, containerToRestriction: HTMLElement, windowStater?: WindowStater);
     get windowState(): IWindowStyle | null;
+    dispose(): void;
 }
 export namespace Viewer3DIcons {
     const VIEWER_SETTINGS_ICON: string;
@@ -77,6 +82,7 @@ export namespace Viewer3DIcons {
     const VIEWER_MEASUREMENT_DIMENSION_ICON: string;
     const VIEWER_ZOOM_TO_FIT_ICON: string;
     const VIEWER_RENDER_OPTIONS_ICON: string;
+    const VIEWER_CONTEXT_MENU_COPY_PROPS: string;
 }
 export namespace ViewerGeneralIcons {
     const CLOSE: string;
@@ -115,6 +121,7 @@ export class SettingChangedEvent extends Event {
     providedData: any;
 }
 export class LoadingSpinner {
+    protected readonly _progress: ProgressBar;
     set loadingTextKey(value: string);
     get loadingTextKey(): string;
     addToDOM(container: HTMLElement): void;
@@ -225,6 +232,7 @@ export class ExtensionBase {
     onMouseUp(event: MouseEvent): void;
     onMouseLongTouch(event: MouseEvent): void;
     onToolbarCreated(toolbar: Toolbar): void;
+    onContextMenu(menu: IMenu): void;
     onTouchStart(event: TouchEvent): void;
     onTouchEnd(event: TouchEvent): void;
 }
@@ -337,6 +345,11 @@ export class EventsDispatcherCore implements IEventsDispatcher {
     removeEvent(type: string): void;
     clearListeners(): void;
 }
+export interface IMenuBuilder {
+    build(): IControl[];
+    removeAllButtons(): IMenuBuilder;
+    withButton(controlId: string, icon: string, translationKey: string, command: () => void): IMenuBuilder;
+}
 export class Button extends Control {
     
     constructor(id: string);
@@ -347,6 +360,7 @@ export class Button extends Control {
     getIsChecked(): boolean;
     setIcon(iconClassName: string): void;
     setFromSvgTemlate(template: string): void;
+    withoutIcon(): void;
     /**
      * Override this method to be notified when the user clicks on the button.
      * @param {MouseEvent} event
@@ -369,10 +383,15 @@ export namespace Button {
         CLICK = "click"
     }
 }
-export class SubMenu implements IMenu {
+export class ContextMenu implements IMenu {
     readonly controls: IControl[];
     set selectedIndex(value: number | number[]);
     get selectedIndex(): number | number[];
+    set opened(value: boolean);
+    get opened(): boolean;
+    set textStubKey(value: string);
+    get textStubKey(): string;
+    get menuWrapper(): HTMLElement;
     setEnabled(index: number, value: boolean): void;
     addControl(control: IControl, index?: number): void;
     removeControl(index?: number): void;
@@ -383,7 +402,7 @@ export class SubMenu implements IMenu {
 export class ComboButton extends Control {
     
     constructor(id: string, selectedIndex?: number);
-    get subMenu(): SubMenu;
+    get subMenu(): ContextMenu;
     /**
      * Override this method to be notified when the user clicks on the button.
      * @param {MouseEvent} event
@@ -451,6 +470,7 @@ export class Dialog extends Control implements ICloseable {
     setSvgIcon(template: string): Dialog;
     setFooter(value: HTMLElement): Dialog;
     setDialogElementClassNames(value: ElementClass): Dialog;
+    setSize(width: number, height: number): Dialog;
     setResizable(value: boolean): Dialog;
     setWindowOptions(value: IWindowStateOptions): Dialog;
     setDraggable(value: boolean): Dialog;
@@ -459,6 +479,8 @@ export class Dialog extends Control implements ICloseable {
     destroyDialog(): void;
     isDialogShown(): boolean;
     subscribe(fn: (state: boolean) => void): void;
+    subscribeToResizeStart(fn: () => void): void;
+    subscribeToResizeEnd(fn: () => void): void;
 }
 export {};
 export interface ISettingsStorage {
@@ -496,6 +518,9 @@ export function createSvgElement(svgString: string): HTMLElement;
 export function isString(element: any): boolean;
 export function isSvg(element: string): boolean;
 export function isSvgString(element: any): boolean;
+export class GlobalEvents {
+    static events: EventsDispatcherCore;
+}
 export class Viewer2DConfiguration extends ViewerConfiguration {
     
     constructor(appearance?: ViewerSettings);
@@ -524,6 +549,7 @@ export interface IDocumentPage {
     dispose(): any;
 }
 export interface IDocument {
+    get pageCount(): number;
     loadDocumentAsync(arrayBuffer: ArrayBuffer): Promise<void>;
     increaseScale(scaleFactor?: number): void;
     decreaseScale(scaleFactor?: number): void;
@@ -532,8 +558,23 @@ export interface IDocument {
     getPageByTarget(element: HTMLElement): IDocumentPage | undefined;
     getSourceData(): Promise<ArrayBuffer>;
     scrollPageIntoViewAsync(pageNumber: number): Promise<void>;
+    exitFromAnnotationMode(): void;
     dispose(): void;
 }
+export enum AnnotationTypes {
+    STAMP = "stamp"
+}
+export class AnnotationEventArgs {
+    id: string;
+    pageNumber: number;
+    positionX: number;
+    positionY: number;
+    type: string;
+}
+export class AnnotationPositionChangedEvent extends Event {
+    page: IDocumentPage;
+    args: AnnotationEventArgs;
+}
 export const ZOOM_IN_SCALE_FACTOR = 1.15;
 export const ZOOM_OUT_SCALE_FACTOR = 0.85;
 export const ZOOM_MAX_SCALE = 10;
@@ -543,6 +584,7 @@ export class EventTypes extends CoreEventTypes {
     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;
@@ -554,6 +596,20 @@ export class DocumentLoadingOptions {
     
     constructor(documentId?: string);
 }
+export interface IDocumentPrintOverlay {
+    open(indeterminate: boolean): void;
+    close(): void;
+    updateProgress(progress: number, total: number): void;
+}
+export class DocumentPrintOverlay extends LoadingSpinner implements IDocumentPrintOverlay {
+    open(determinate: boolean): void;
+    close(): void;
+    updateProgress(progress: number, total: number): void;
+}
+export interface IPrintOptions {
+    overlay?: IDocumentPrintOverlay;
+    resolution?: number;
+}
 export let ViewerInstance: Viewer2D;
 export class Viewer2D extends ViewerBase {
     readonly settings: Readonly<ISettings>;
@@ -564,6 +620,7 @@ export class Viewer2D extends ViewerBase {
     unloadDocument(): void;
     start(): Promise<number>;
     finish(): Promise<void>;
+    print(options: IPrintOptions | undefined): Promise<void>;
 }
 export class GuiViewer2D extends Viewer2D {
     getToolbar(): ViewerToolbar;

package/package.json

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