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

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 +68 -16
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -109,16 +109,26 @@ export class CoreEventTypes {
109
109
  static VIEWER_MOUSE_MOVE_EVENT: string;
110
110
  static VIEWER_MOUSE_UP_EVENT: string;
111
111
  static VIEWER_MOUSE_LONG_TOUCH_EVENT: string;
112
+ static VIEWER_TOUCHSTART_EVENT: string;
113
+ static VIEWER_TOUCHEND_EVENT: string;
112
114
  static SETTING_CHANGED_EVENT: string;
113
115
  static SETTING_RESET_EVENT: string;
114
116
  static SETTING_LANGUAGE_CHANGED_EVENT: string;
115
117
  static SETTING_THEME_CHANGED_EVENT: string;
116
118
  }
119
+ export namespace ControlState {
120
+ enum State {
121
+ ACTIVE = 0,
122
+ INACTIVE = 1,
123
+ DISABLED = 2
124
+ }
125
+ }
117
126
  export interface IControl {
118
127
  container: HTMLElement;
119
128
  getId(): string;
120
129
  setToolTip(tooltipText: string): void;
121
130
  setText(text: string): void;
131
+ setState(state: ControlState.State): void;
122
132
  }
123
133
  export class Control implements IControl {
124
134
  container: HTMLElement;
@@ -129,6 +139,7 @@ export class Control implements IControl {
129
139
  getId(): string;
130
140
  setToolTip(tooltipText: string): void;
131
141
  setText(text: string): void;
142
+ setState(state: ControlState.State): void;
132
143
  }
133
144
  export enum ToolbarPosition {
134
145
  TOP_FIXED = "ascn-toolbar-position-fixed-top",
@@ -178,11 +189,15 @@ export class ExtensionBase {
178
189
  * @returns {string} Returns the name of the extension.
179
190
  */
180
191
  getName(): string;
192
+ addCursorPhantomFromSvg(template: string): void;
193
+ removeCursorPhantom(): void;
181
194
  onMouseDown(event: MouseEvent): void;
182
195
  onMouseMove(event: MouseEvent): void;
183
196
  onMouseUp(event: MouseEvent): void;
184
197
  onMouseLongTouch(event: MouseEvent): void;
185
198
  onToolbarCreated(toolbar: Toolbar): void;
199
+ onTouchStart(event: TouchEvent): void;
200
+ onTouchEnd(event: TouchEvent): void;
186
201
  protected bindDomEvents(): void;
187
202
  }
188
203
  export class ExtensionManager {
@@ -282,13 +297,6 @@ export class EventsDispatcherCore implements IEventsDispatcher {
282
297
  removeEvent(type: string): void;
283
298
  clearListeners(): void;
284
299
  }
285
- export namespace ControlState {
286
- enum State {
287
- ACTIVE = 0,
288
- INACTIVE = 1,
289
- DISABLED = 2
290
- }
291
- }
292
300
  export class Button extends Control {
293
301
 
294
302
  constructor(id: string);
@@ -324,6 +332,7 @@ export class SubMenu implements IMenu {
324
332
  readonly controls: IControl[];
325
333
  set selectedIndex(value: number);
326
334
  get selectedIndex(): number;
335
+ setEnabled(index: number, value: boolean): void;
327
336
  addControl(control: IControl, index?: number): void;
328
337
  removeControl(index?: number): void;
329
338
  clearList(): void;
@@ -345,6 +354,40 @@ export class ComboButton extends Control {
345
354
  setText(text: string): void;
346
355
  setFromSvgTemlate(template: string): void;
347
356
  }
357
+ export class Checkbox {
358
+
359
+ constructor(id: string, checked: boolean, disabled: boolean, placeholder: string);
360
+ get checked(): boolean;
361
+ set checked(value: boolean);
362
+ get disabled(): boolean;
363
+ set disabled(value: boolean);
364
+ get label(): HTMLLabelElement;
365
+ onChange(value: boolean): void;
366
+ createElement(): Element;
367
+ }
368
+ interface ISelectItem {
369
+ text: string;
370
+ value: string;
371
+ }
372
+ export class Select {
373
+
374
+ constructor(id: string, items: ISelectItem[], placeholder: string);
375
+ get select(): HTMLElement;
376
+ get disabled(): boolean;
377
+ set disabled(value: boolean);
378
+ get selectedIndex(): number;
379
+ set selectedIndex(value: number);
380
+ get placeholder(): string;
381
+ set placeholder(value: string);
382
+ get label(): HTMLElement;
383
+ get previousSelectedIndex(): number;
384
+ onChange({ index, value }: {
385
+ index: any;
386
+ value: any;
387
+ }): void;
388
+ update(array: ISelectItem[], selectedIndex?: number): void;
389
+ }
390
+ export {};
348
391
  export class ViewerToolbar extends Toolbar {
349
392
  }
350
393
  interface ElementClass {
@@ -362,13 +405,13 @@ export class Dialog extends Control {
362
405
  setDialogContent(value: HTMLElement): Dialog;
363
406
  setHeader(value: HTMLElement): Dialog;
364
407
  setCaption(value: string): Dialog;
365
- setIcon(iconClassName: string): Dialog;
408
+ setSvgIcon(template: string): Dialog;
366
409
  setFooter(value: HTMLElement): Dialog;
367
410
  setDialogElementClassNames(value: ElementClass): Dialog;
368
411
  setResizable(value: boolean): Dialog;
369
412
  setWindowOptions(value: IWindowStateOptions): Dialog;
370
413
  setDraggable(value: boolean): Dialog;
371
- openDialog(): HTMLElement;
414
+ openDialog(x?: number, y?: number): HTMLElement;
372
415
  destroyDialog(): void;
373
416
  isDialogShown(): boolean;
374
417
  subscribe(fn: (state: boolean) => void): void;
@@ -405,6 +448,10 @@ export abstract class SettingsBase implements ISettings {
405
448
  getSettingValue<T>(name: string): T;
406
449
  protected abstract getKeyWithPrefix(key: string): string;
407
450
  }
451
+ export class Viewer2DConfiguration extends ViewerConfiguration {
452
+
453
+ constructor(appearance?: ViewerSettings);
454
+ }
408
455
  export interface IAnnotationLayer {
409
456
  get pageDiv(): HTMLDivElement;
410
457
  get div(): HTMLDivElement | null;
@@ -428,29 +475,34 @@ export interface IDocumentPage {
428
475
  update(params?: IPageUpdateParams): void;
429
476
  dispose(): any;
430
477
  }
478
+ export class PageRenderedEvent extends Event {
479
+ page: IDocumentPage;
480
+
481
+ constructor(type: string, page: IDocumentPage, eventInitDict?: EventInit);
482
+ }
483
+ export class EventTypes extends CoreEventTypes {
484
+ static PAGE_RENDERED: string;
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;
488
+ increaseScale(scaleFactor?: number): void;
489
+ decreaseScale(scaleFactor?: number): void;
435
490
  fit(): 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 {
445
-
446
- constructor(appearance?: ViewerSettings);
447
- }
448
500
  export let ViewerInstance: Viewer2D;
449
501
  export class Viewer2D extends ViewerBase {
450
502
  readonly settings: Readonly<ISettings>;
451
503
  readonly events: Readonly<IEventsDispatcher>;
452
504
  get document(): IDocument;
453
- loadDocument(buffer: ArrayBuffer, options: object, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
505
+ loadDocument(data: ArrayBuffer | string, options: object, onSuccessCallback: SuccessCallback, onErrorCallback: ErrorCallback): void;
454
506
  unloadDocument(): void;
455
507
  start(): Promise<number>;
456
508
  finish(): void;
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.8",
4
4
  "description": "TypeScript definitions for ASCON PilotWeb2D component",
5
5
  "main": "",
6
6
  "types": "index.d.ts",