@pilotdev/pilot-web-2d 23.0.7-alpha.1 → 23.0.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +89 -20
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -23,16 +23,22 @@ export class Localization {
23
23
  export type InitializeSuccessCallback = () => void;
24
24
  export function coreInitializer(options: InitializerOptions, callback: InitializeSuccessCallback): void;
25
25
  export function coreShutdown(): void;
26
+ export class DeviceEventHandler {
27
+ static isMobile: boolean;
28
+ static eventStartType: string;
29
+ static eventProcessType: string;
30
+ static eventEndType: string;
31
+ }
26
32
  export interface IWindowStyle {
27
33
  width: string;
28
34
  height: string;
29
35
  left: string;
30
- right: string;
31
36
  top: string;
32
37
  }
33
38
  export interface IWindowStateOptions {
34
39
  saveKey: string;
35
- restoreWindowSize: boolean;
40
+ restoreWindowSize?: boolean;
41
+ restoreWindowPosition?: boolean;
36
42
  }
37
43
  export class WindowStater {
38
44
  get windowStylesState(): IWindowStyle;
@@ -82,6 +88,7 @@ export namespace Viewer2DIcons {
82
88
  const REMARK_CIRCLE_ICON: string;
83
89
  const ZOOM_IN: string;
84
90
  const ZOOM_OUT: string;
91
+ const FIT_WIDTH: string;
85
92
  }
86
93
  export interface ISettings {
87
94
  changeSetting<T>(name: string, value: T, notify?: boolean, providedData?: any): void;
@@ -109,16 +116,27 @@ export class CoreEventTypes {
109
116
  static VIEWER_MOUSE_MOVE_EVENT: string;
110
117
  static VIEWER_MOUSE_UP_EVENT: string;
111
118
  static VIEWER_MOUSE_LONG_TOUCH_EVENT: string;
119
+ static VIEWER_MOUSE_WHEEL: string;
120
+ static VIEWER_TOUCHSTART_EVENT: string;
121
+ static VIEWER_TOUCHEND_EVENT: string;
112
122
  static SETTING_CHANGED_EVENT: string;
113
123
  static SETTING_RESET_EVENT: string;
114
124
  static SETTING_LANGUAGE_CHANGED_EVENT: string;
115
125
  static SETTING_THEME_CHANGED_EVENT: string;
116
126
  }
127
+ export namespace ControlState {
128
+ enum State {
129
+ ACTIVE = 0,
130
+ INACTIVE = 1,
131
+ DISABLED = 2
132
+ }
133
+ }
117
134
  export interface IControl {
118
135
  container: HTMLElement;
119
136
  getId(): string;
120
137
  setToolTip(tooltipText: string): void;
121
138
  setText(text: string): void;
139
+ setState(state: ControlState.State): void;
122
140
  }
123
141
  export class Control implements IControl {
124
142
  container: HTMLElement;
@@ -129,6 +147,7 @@ export class Control implements IControl {
129
147
  getId(): string;
130
148
  setToolTip(tooltipText: string): void;
131
149
  setText(text: string): void;
150
+ setState(state: ControlState.State): void;
132
151
  }
133
152
  export enum ToolbarPosition {
134
153
  TOP_FIXED = "ascn-toolbar-position-fixed-top",
@@ -178,12 +197,15 @@ export class ExtensionBase {
178
197
  * @returns {string} Returns the name of the extension.
179
198
  */
180
199
  getName(): string;
200
+ addCursorPhantomFromSvg(template: string): void;
201
+ removeCursorPhantom(): void;
181
202
  onMouseDown(event: MouseEvent): void;
182
203
  onMouseMove(event: MouseEvent): void;
183
204
  onMouseUp(event: MouseEvent): void;
184
205
  onMouseLongTouch(event: MouseEvent): void;
185
206
  onToolbarCreated(toolbar: Toolbar): void;
186
- protected bindDomEvents(): void;
207
+ onTouchStart(event: TouchEvent): void;
208
+ onTouchEnd(event: TouchEvent): void;
187
209
  }
188
210
  export class ExtensionManager {
189
211
  registerExtensionType(extensionId: string, extension: typeof ExtensionBase): boolean;
@@ -282,13 +304,6 @@ export class EventsDispatcherCore implements IEventsDispatcher {
282
304
  removeEvent(type: string): void;
283
305
  clearListeners(): void;
284
306
  }
285
- export namespace ControlState {
286
- enum State {
287
- ACTIVE = 0,
288
- INACTIVE = 1,
289
- DISABLED = 2
290
- }
291
- }
292
307
  export class Button extends Control {
293
308
 
294
309
  constructor(id: string);
@@ -324,6 +339,7 @@ export class SubMenu implements IMenu {
324
339
  readonly controls: IControl[];
325
340
  set selectedIndex(value: number);
326
341
  get selectedIndex(): number;
342
+ setEnabled(index: number, value: boolean): void;
327
343
  addControl(control: IControl, index?: number): void;
328
344
  removeControl(index?: number): void;
329
345
  clearList(): void;
@@ -345,6 +361,40 @@ export class ComboButton extends Control {
345
361
  setText(text: string): void;
346
362
  setFromSvgTemlate(template: string): void;
347
363
  }
364
+ export class Checkbox {
365
+
366
+ constructor(id: string, checked: boolean, disabled: boolean, placeholder: string);
367
+ get checked(): boolean;
368
+ set checked(value: boolean);
369
+ get disabled(): boolean;
370
+ set disabled(value: boolean);
371
+ get label(): HTMLLabelElement;
372
+ onChange(value: boolean): void;
373
+ createElement(): Element;
374
+ }
375
+ interface ISelectItem {
376
+ text: string;
377
+ value: string;
378
+ }
379
+ export class Select {
380
+
381
+ constructor(id: string, items: ISelectItem[], placeholder: string);
382
+ get select(): HTMLElement;
383
+ get disabled(): boolean;
384
+ set disabled(value: boolean);
385
+ get selectedIndex(): number;
386
+ set selectedIndex(value: number);
387
+ get placeholder(): string;
388
+ set placeholder(value: string);
389
+ get label(): HTMLElement;
390
+ get previousSelectedIndex(): number;
391
+ onChange({ index, value }: {
392
+ index: any;
393
+ value: any;
394
+ }): void;
395
+ update(array: ISelectItem[], selectedIndex?: number): void;
396
+ }
397
+ export {};
348
398
  export class ViewerToolbar extends Toolbar {
349
399
  }
350
400
  interface ElementClass {
@@ -362,13 +412,14 @@ export class Dialog extends Control {
362
412
  setDialogContent(value: HTMLElement): Dialog;
363
413
  setHeader(value: HTMLElement): Dialog;
364
414
  setCaption(value: string): Dialog;
365
- setIcon(iconClassName: string): Dialog;
415
+ setSvgIcon(template: string): Dialog;
366
416
  setFooter(value: HTMLElement): Dialog;
367
417
  setDialogElementClassNames(value: ElementClass): Dialog;
368
418
  setResizable(value: boolean): Dialog;
369
419
  setWindowOptions(value: IWindowStateOptions): Dialog;
370
420
  setDraggable(value: boolean): Dialog;
371
- openDialog(): HTMLElement;
421
+ setCloseble(value: boolean): Dialog;
422
+ openDialog(x?: number, y?: number): HTMLElement;
372
423
  destroyDialog(): void;
373
424
  isDialogShown(): boolean;
374
425
  subscribe(fn: (state: boolean) => void): void;
@@ -405,6 +456,10 @@ export abstract class SettingsBase implements ISettings {
405
456
  getSettingValue<T>(name: string): T;
406
457
  protected abstract getKeyWithPrefix(key: string): string;
407
458
  }
459
+ export class Viewer2DConfiguration extends ViewerConfiguration {
460
+
461
+ constructor(appearance?: ViewerSettings);
462
+ }
408
463
  export interface IAnnotationLayer {
409
464
  get pageDiv(): HTMLDivElement;
410
465
  get div(): HTMLDivElement | null;
@@ -430,32 +485,38 @@ export interface IDocumentPage {
430
485
  }
431
486
  export interface IDocument {
432
487
  loadDocumentAsync(arrayBuffer: ArrayBuffer): Promise<void>;
433
- increaseScale(steps?: number, scaleFactor?: number): void;
434
- decreaseScale(steps?: number, scaleFactor?: number): void;
435
- fit(): void;
488
+ increaseScale(scaleFactor?: number): void;
489
+ decreaseScale(scaleFactor?: number): void;
490
+ fitWidth(): void;
436
491
  getPageAsync(pageNumber: number): Promise<IDocumentPage>;
437
492
  getPageByTarget(element: HTMLElement): IDocumentPage | undefined;
493
+ scrollPageIntoViewAsync(pageNumber: number): Promise<void>;
438
494
  dispose(): void;
439
495
  }
440
496
  export const ZOOM_IN_SCALE_FACTOR = 1.15;
441
497
  export const ZOOM_OUT_SCALE_FACTOR = 0.85;
442
498
  export const ZOOM_MAX_SCALE = 10;
443
499
  export const ZOOM_MIN_SCALE = 4;
444
- export class Viewer2DConfiguration extends ViewerConfiguration {
500
+ export class EventTypes extends CoreEventTypes {
501
+ static PAGE_RENDERED: string;
502
+ static DOCUMENT_ZOOM_IN: string;
503
+ static DOCUMENT_ZOOM_OUT: string;
504
+ static DOCUMENT_FIT_WIDTH: string;
505
+ }
506
+ export class PageRenderedEvent extends Event {
507
+ page: IDocumentPage;
445
508
 
446
- constructor(appearance?: ViewerSettings);
509
+ constructor(type: string, page: IDocumentPage, eventInitDict?: EventInit);
447
510
  }
448
511
  export let ViewerInstance: Viewer2D;
449
512
  export class Viewer2D extends ViewerBase {
450
513
  readonly settings: Readonly<ISettings>;
451
514
  readonly events: Readonly<IEventsDispatcher>;
452
515
  get document(): IDocument;
453
- loadDocument(buffer: ArrayBuffer, options: object, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
516
+ loadDocument(data: ArrayBuffer | string, options: object, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
454
517
  unloadDocument(): void;
455
518
  start(): Promise<number>;
456
519
  finish(): void;
457
- protected zoomIn(event: MouseEvent): void;
458
- protected zoomOut(event: MouseEvent): void;
459
520
  }
460
521
  export class GuiViewer2D extends Viewer2D {
461
522
  loadDocument(buffer: ArrayBuffer, options: object, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
@@ -463,6 +524,14 @@ export class GuiViewer2D extends Viewer2D {
463
524
  onPostExtensionLoad(extension: ExtensionBase): void;
464
525
  protected getToolbarHeight(): number;
465
526
  }
527
+ export function CreateViewer(container: HTMLElement, configuration?: Viewer2DConfiguration): GuiViewer2D;
528
+ export function CreateBasicViewer(container: HTMLElement, configuration?: Viewer2DConfiguration): Viewer2D;
529
+ /**
530
+ * @param options
531
+ * @param callback
532
+ */
533
+ export function Initializer(options: InitializerOptions, callback: InitializeSuccessCallback): void;
534
+ export function shutdown(): void;
466
535
  export class Extension extends ExtensionBase {
467
536
  protected _viewer: Viewer2D;
468
537
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pilotdev/pilot-web-2d",
3
- "version": "23.0.7-alpha.1",
3
+ "version": "23.0.10",
4
4
  "description": "TypeScript definitions for ASCON PilotWeb2D component",
5
5
  "main": "",
6
6
  "types": "index.d.ts",