@yamcs/opi 1.2.6 → 1.2.8

package/dist/types/Color.d.ts

@@ -1,36 +1,36 @@
-export declare class Color {
-    red: number;
-    green: number;
-    blue: number;
-    alpha: number;
-    static TRANSPARENT: Color;
-    static BLACK: Color;
-    static BLUE: Color;
-    static CYAN: Color;
-    static DARK_GRAY: Color;
-    static GRAY: Color;
-    static GREEN: Color;
-    static LIGHT_BLUE: Color;
-    static ORANGE: Color;
-    static PINK: Color;
-    static PURPLE: Color;
-    static RED: Color;
-    static WHITE: Color;
-    static YELLOW: Color;
-    static BUTTON: Color;
-    static BUTTON_DARKER: Color;
-    static BUTTON_DARKEST: Color;
-    static BUTTON_LIGHTEST: Color;
-    constructor(red: number, green: number, blue: number, alpha?: number);
-    withAlpha(alpha: number): Color;
-    mixWith(color: Color, weight: number): Color;
-    brighter(): Color;
-    darker(): Color;
-    contrast(): Color;
-    hex(): string;
-    /** @scriptapi */
-    getRGBValue(): this;
-    /** @scriptapi */
-    equals(other: Color): boolean;
-    toString(): string;
-}
+export declare class Color {
+    red: number;
+    green: number;
+    blue: number;
+    alpha: number;
+    static TRANSPARENT: Color;
+    static BLACK: Color;
+    static BLUE: Color;
+    static CYAN: Color;
+    static DARK_GRAY: Color;
+    static GRAY: Color;
+    static GREEN: Color;
+    static LIGHT_BLUE: Color;
+    static ORANGE: Color;
+    static PINK: Color;
+    static PURPLE: Color;
+    static RED: Color;
+    static WHITE: Color;
+    static YELLOW: Color;
+    static BUTTON: Color;
+    static BUTTON_DARKER: Color;
+    static BUTTON_DARKEST: Color;
+    static BUTTON_LIGHTEST: Color;
+    constructor(red: number, green: number, blue: number, alpha?: number);
+    withAlpha(alpha: number): Color;
+    mixWith(color: Color, weight: number): Color;
+    brighter(): Color;
+    darker(): Color;
+    contrast(): Color;
+    hex(): string;
+    /** @scriptapi */
+    getRGBValue(): this;
+    /** @scriptapi */
+    equals(other: Color): boolean;
+    toString(): string;
+}

package/dist/types/ColorMap.d.ts

@@ -1,23 +1,23 @@
-declare type rgb = [number, number, number];
-export declare class ColorMap {
-    readonly code: number;
-    private interpolate;
-    readonly autoscale: boolean;
-    private values;
-    private colors;
-    private entries;
-    private dirty;
-    constructor(code: number, interpolate: boolean, autoscale: boolean);
-    addMapping(value: number, red: number, green: number, blue: number): void;
-    private compile;
-    lookup(value: number): rgb;
-    getMinMax(): number[];
-    /**
-     * Returns the index of the value in the sorted entry list.
-     * If the value is not found, returns a negative number
-     * describing which (when negated), tells the insert
-     * position of the provide value.
-     */
-    private binarySearch;
-}
-export {};
+type rgb = [number, number, number];
+export declare class ColorMap {
+    readonly code: number;
+    private interpolate;
+    readonly autoscale: boolean;
+    private values;
+    private colors;
+    private entries;
+    private dirty;
+    constructor(code: number, interpolate: boolean, autoscale: boolean);
+    addMapping(value: number, red: number, green: number, blue: number): void;
+    private compile;
+    lookup(value: number): rgb;
+    getMinMax(): number[];
+    /**
+     * Returns the index of the value in the sorted entry list.
+     * If the value is not found, returns a negative number
+     * describing which (when negated), tells the insert
+     * position of the provide value.
+     */
+    private binarySearch;
+}
+export {};

package/dist/types/ConsoleHandler.d.ts

@@ -1,10 +1,10 @@
-export interface ConsoleHandler {
-    writeInfo(message: string): void;
-    writeError(message: string): void;
-    writeWarning(message: string): void;
-}
-export declare class DefaultConsoleHandler implements ConsoleHandler {
-    writeInfo(message: string): void;
-    writeError(message: string): void;
-    writeWarning(message: string): void;
-}
+export interface ConsoleHandler {
+    writeInfo(message: string): void;
+    writeError(message: string): void;
+    writeWarning(message: string): void;
+}
+export declare class DefaultConsoleHandler implements ConsoleHandler {
+    writeInfo(message: string): void;
+    writeError(message: string): void;
+    writeWarning(message: string): void;
+}

package/dist/types/DecimalFormat.d.ts

@@ -1,36 +1,36 @@
-export declare class DecimalFormat {
-    private prefix;
-    private suffix;
-    /**
-     * Grouping size
-     */
-    private comma;
-    /**
-     * Minimum integer digits to be displayed
-     */
-    private minInt;
-    /**
-     * Minimum fractional digits to be displayed
-     */
-    private minFrac;
-    /**
-     * Maximum fractional digits to be displayed
-     */
-    private maxFrac;
-    constructor(formatStr: string);
-    /**
-     * 1223.06 --> $1,223.06
-     */
-    format(numStr: any): any;
-    /**
-     * Converts formatted value back to non-formatted value
-     */
-    private formatBack;
-    /**
-     * We shouldn't return strings like 1.000 in formatBack method.
-     * However, using only Number(str) is not enough, because it omits . in big numbers
-     * like 23423423423342234.34 => 23423423423342236 . There's a conflict in cases
-     * 6143 and 6541.
-     */
-    private getNumericString;
-}
+export declare class DecimalFormat {
+    private prefix;
+    private suffix;
+    /**
+     * Grouping size
+     */
+    private comma;
+    /**
+     * Minimum integer digits to be displayed
+     */
+    private minInt;
+    /**
+     * Minimum fractional digits to be displayed
+     */
+    private minFrac;
+    /**
+     * Maximum fractional digits to be displayed
+     */
+    private maxFrac;
+    constructor(formatStr: string);
+    /**
+     * 1223.06 --> $1,223.06
+     */
+    format(numStr: any): any;
+    /**
+     * Converts formatted value back to non-formatted value
+     */
+    private formatBack;
+    /**
+     * We shouldn't return strings like 1.000 in formatBack method.
+     * However, using only Number(str) is not enough, because it omits . in big numbers
+     * like 23423423423342234.34 => 23423423423342236 . There's a conflict in cases
+     * 6143 and 6541.
+     */
+    private getNumericString;
+}

package/dist/types/DialogHandler.d.ts

@@ -0,0 +1,14 @@
+export interface DialogHandler {
+    openConfirmDialog(title: string, message: string): boolean;
+    openInformationDialog(title: string, message: string): void;
+    openWarningDialog(title: string, message: string): void;
+    openErrorDialog(title: string, message: string): void;
+    openPasswordDialog(title: string, message: string, password: string): boolean;
+}
+export declare class DefaultDialogHandler implements DialogHandler {
+    openConfirmDialog(title: string, message: string): boolean;
+    openInformationDialog(title: string, message: string): void;
+    openWarningDialog(title: string, message: string): void;
+    openErrorDialog(title: string, message: string): void;
+    openPasswordDialog(title: string, message: string, password: string): boolean;
+}

package/dist/types/Display.d.ts

@@ -1,130 +1,141 @@
-import { ConsoleHandler } from './ConsoleHandler';
-import { OPIEvent, OPIEventMap } from './events';
-import { PathResolver } from './PathResolver';
-import { Bounds } from './positioning';
-import { PVEngine } from './pv/PVEngine';
-import { PVProvider } from './pv/PVProvider';
-import { Sample } from './pv/Sample';
-import { Widget } from './Widget';
-import { ActionButton } from './widgets/controls/ActionButton';
-import { BooleanButton } from './widgets/controls/BooleanButton';
-import { BooleanSwitch } from './widgets/controls/BooleanSwitch';
-import { CheckBox } from './widgets/controls/CheckBox';
-import { ChoiceButton } from './widgets/controls/ChoiceButton';
-import { Combo } from './widgets/controls/Combo';
-import { ImageBooleanButton } from './widgets/controls/ImageBooleanButton';
-import { MenuButton } from './widgets/controls/MenuButton';
-import { RadioBox } from './widgets/controls/RadioBox';
-import { Scrollbar } from './widgets/controls/Scrollbar';
-import { TextInput } from './widgets/controls/TextInput';
-import { Arc } from './widgets/graphics/Arc';
-import { Ellipse } from './widgets/graphics/Ellipse';
-import { ImageWidget } from './widgets/graphics/ImageWidget';
-import { Label } from './widgets/graphics/Label';
-import { Polygon } from './widgets/graphics/Polygon';
-import { Polyline } from './widgets/graphics/Polyline';
-import { Rectangle } from './widgets/graphics/Rectangle';
-import { RoundedRectangle } from './widgets/graphics/RoundedRectangle';
-import { ByteMonitor } from './widgets/monitors/ByteMonitor';
-import { Gauge } from './widgets/monitors/Gauge';
-import { ImageBooleanIndicator } from './widgets/monitors/ImageBooleanIndicator';
-import { IntensityGraph } from './widgets/monitors/IntensityGraph';
-import { LED } from './widgets/monitors/LED';
-import { Meter } from './widgets/monitors/Meter';
-import { ProgressBar } from './widgets/monitors/ProgressBar';
-import { Tank } from './widgets/monitors/Tank';
-import { TextUpdate } from './widgets/monitors/TextUpdate';
-import { Thermometer } from './widgets/monitors/Thermometer';
-import { XYGraph } from './widgets/monitors/xygraph/XYGraph';
-import { AbstractContainerWidget } from './widgets/others/AbstractContainerWidget';
-import { DisplayWidget } from './widgets/others/DisplayWidget';
-import { GroupingContainer } from './widgets/others/GroupingContainer';
-import { LinkingContainer } from './widgets/others/LinkingContainer';
-import { TabbedContainer } from './widgets/others/TabbedContainer';
-import { Table } from './widgets/others/Table';
-import { WebBrowser } from './widgets/others/WebBrowser';
-export declare class Display {
-    private readonly targetElement;
-    rootPanel: HTMLDivElement;
-    private g;
-    private ctx;
-    pvEngine: PVEngine;
-    private pathResolver;
-    private consoleHandler;
-    private repaintRequested;
-    private _editMode;
-    private _showGrid;
-    private _showOutline;
-    private _showRuler;
-    private _selection;
-    private _scale;
-    private _transparent;
-    /**
-     * Prefix for images sourced during draw.
-     * (does not include workspace images)
-     */
-    imagesPrefix: string;
-    /**
-     * Prefix for workspace references (images, scripts, displays)
-     */
-    absPrefix: string;
-    relPrefix: string;
-    instance?: DisplayWidget;
-    private eventListeners;
-    private displayRegion;
-    constructor(targetElement: HTMLElement);
-    addProvider(provider: PVProvider): void;
-    addScriptLibrary(name: string, library: any): void;
-    setPathResolver(pathResolver: PathResolver): void;
-    getPathResolver(): PathResolver;
-    setConsoleHandler(consoleHandler: ConsoleHandler): void;
-    getConsoleHandler(): ConsoleHandler;
-    private step;
-    private drawScreen;
-    /**
-     * Request a repaint of the canvas. The repaint is done async from a
-     * UI render loop.
-     */
-    requestRepaint(): void;
-    setTooltip(tooltip: string | undefined): void;
-    createWidget(kind: string, parent: AbstractContainerWidget): LinkingContainer | ActionButton | Arc | BooleanButton | BooleanSwitch | ByteMonitor | CheckBox | ChoiceButton | Combo | Ellipse | Gauge | GroupingContainer | ImageWidget | ImageBooleanButton | ImageBooleanIndicator | IntensityGraph | Label | LED | MenuButton | Meter | Polygon | Polyline | ProgressBar | RadioBox | Rectangle | RoundedRectangle | Scrollbar | TabbedContainer | Table | Tank | TextInput | TextUpdate | Thermometer | WebBrowser | XYGraph | undefined;
-    destroy(): void;
-    resolvePath(path: string, widget?: Widget): string;
-    setSource(href: string): Promise<void>;
-    private setSourceString;
-    private reset;
-    /**
-     * Bounds of this widget relative to the root
-     * of all of its parents.
-     */
-    measureAbsoluteArea(widget: Widget): Bounds;
-    addEventListener<K extends keyof OPIEventMap>(type: K, listener: ((ev: OPIEventMap[K]) => void)): void;
-    removeEventListener<K extends keyof OPIEventMap>(type: K, listener: ((ev: OPIEventMap[K]) => void)): void;
-    fireEvent(type: string, event: OPIEvent): void;
-    get showGrid(): boolean;
-    set showGrid(showGrid: boolean);
-    get showOutline(): boolean;
-    set showOutline(showOutline: boolean);
-    get showRuler(): boolean;
-    set showRuler(showRuler: boolean);
-    get selection(): string[];
-    set selection(selection: string[]);
-    get editMode(): boolean;
-    set editMode(editMode: boolean);
-    get scale(): number;
-    set scale(scale: number);
-    get transparent(): boolean;
-    set transparent(transparent: boolean);
-    get widgets(): Widget[];
-    clearSelection(): void;
-    findWidget(wuid: string): Widget | undefined;
-    findWidgetByName(name: string): Widget | undefined;
-    getPVNames(): string[];
-    getPV(pvName: string): import(".").PV | undefined;
-    setValues(samples: Map<string, Sample>): void;
-    copyCanvas(area?: Bounds): HTMLCanvasElement;
-    /**
-     * Returns this display as an image.
-     */
-    toDataURL(type?: string, quality?: any): string;
-}
+import { ConsoleHandler } from "./ConsoleHandler";
+import { DialogHandler } from "./DialogHandler";
+import { OPIEvent, OPIEventMap } from "./events";
+import { FontResolver } from "./FontResolver";
+import { PathResolver } from "./PathResolver";
+import { Bounds } from "./positioning";
+import { PVEngine } from "./pv/PVEngine";
+import { PVProvider } from "./pv/PVProvider";
+import { Sample } from "./pv/Sample";
+import { Widget } from "./Widget";
+import { ActionButton } from "./widgets/controls/ActionButton";
+import { BooleanButton } from "./widgets/controls/BooleanButton";
+import { BooleanSwitch } from "./widgets/controls/BooleanSwitch";
+import { CheckBox } from "./widgets/controls/CheckBox";
+import { ChoiceButton } from "./widgets/controls/ChoiceButton";
+import { Combo } from "./widgets/controls/Combo";
+import { ImageBooleanButton } from "./widgets/controls/ImageBooleanButton";
+import { MenuButton } from "./widgets/controls/MenuButton";
+import { RadioBox } from "./widgets/controls/RadioBox";
+import { Scrollbar } from "./widgets/controls/Scrollbar";
+import { TextInput } from "./widgets/controls/TextInput";
+import { Arc } from "./widgets/graphics/Arc";
+import { Ellipse } from "./widgets/graphics/Ellipse";
+import { ImageWidget } from "./widgets/graphics/ImageWidget";
+import { Label } from "./widgets/graphics/Label";
+import { Polygon } from "./widgets/graphics/Polygon";
+import { Polyline } from "./widgets/graphics/Polyline";
+import { Rectangle } from "./widgets/graphics/Rectangle";
+import { RoundedRectangle } from "./widgets/graphics/RoundedRectangle";
+import { ByteMonitor } from "./widgets/monitors/ByteMonitor";
+import { Gauge } from "./widgets/monitors/Gauge";
+import { ImageBooleanIndicator } from "./widgets/monitors/ImageBooleanIndicator";
+import { IntensityGraph } from "./widgets/monitors/IntensityGraph";
+import { LED } from "./widgets/monitors/LED";
+import { Meter } from "./widgets/monitors/Meter";
+import { ProgressBar } from "./widgets/monitors/ProgressBar";
+import { Tank } from "./widgets/monitors/Tank";
+import { TextUpdate } from "./widgets/monitors/TextUpdate";
+import { Thermometer } from "./widgets/monitors/Thermometer";
+import { XYGraph } from "./widgets/monitors/xygraph/XYGraph";
+import { AbstractContainerWidget } from "./widgets/others/AbstractContainerWidget";
+import { DisplayWidget } from "./widgets/others/DisplayWidget";
+import { GroupingContainer } from "./widgets/others/GroupingContainer";
+import { LinkingContainer } from "./widgets/others/LinkingContainer";
+import { TabbedContainer } from "./widgets/others/TabbedContainer";
+import { Table } from "./widgets/others/Table";
+import { WebBrowser } from "./widgets/others/WebBrowser";
+export declare class Display {
+    private readonly targetElement;
+    rootPanel: HTMLDivElement;
+    private g;
+    private ctx;
+    pvEngine: PVEngine;
+    private pathResolver;
+    private fontResolver?;
+    private consoleHandler;
+    private dialogHandler;
+    private repaintRequested;
+    private _editMode;
+    private _showGrid;
+    private _showOutline;
+    private _showRuler;
+    private _selection;
+    private _scale;
+    private _transparent;
+    private refreshCycle;
+    /**
+     * Prefix for images sourced during draw.
+     * (does not include workspace images)
+     */
+    imagesPrefix: string;
+    /**
+     * Prefix for workspace references (images, scripts, displays)
+     */
+    absPrefix: string;
+    relPrefix: string;
+    instance?: DisplayWidget;
+    private eventListeners;
+    private displayRegion;
+    constructor(targetElement: HTMLElement);
+    addProvider(provider: PVProvider): void;
+    addScriptLibrary(name: string, library: any): void;
+    setPathResolver(pathResolver: PathResolver): void;
+    getPathResolver(): PathResolver;
+    setConsoleHandler(consoleHandler: ConsoleHandler): void;
+    getConsoleHandler(): ConsoleHandler;
+    setDialogHandler(dialogHandler: DialogHandler): void;
+    getDialogHandler(): DialogHandler;
+    setFontResolver(fontResolver: FontResolver): void;
+    getFontResolver(): FontResolver | undefined;
+    private step;
+    private drawScreen;
+    /**
+     * Request a repaint of the canvas. The repaint is done async from a
+     * UI render loop.
+     */
+    requestRepaint(): void;
+    setTooltip(tooltip: string | undefined): void;
+    createWidget(kind: string, parent: AbstractContainerWidget): LinkingContainer | ActionButton | Arc | BooleanButton | BooleanSwitch | ByteMonitor | CheckBox | ChoiceButton | Combo | Ellipse | Gauge | GroupingContainer | ImageWidget | ImageBooleanButton | ImageBooleanIndicator | IntensityGraph | Label | LED | MenuButton | Meter | Polygon | Polyline | ProgressBar | RadioBox | Rectangle | RoundedRectangle | Scrollbar | TabbedContainer | Table | Tank | TextInput | TextUpdate | Thermometer | WebBrowser | XYGraph | undefined;
+    destroy(): void;
+    resolvePath(path: string, widget?: Widget): string;
+    setSource(href: string): Promise<void>;
+    private setSourceString;
+    getRefreshCycle(): number;
+    setRefreshCycle(refreshCycle: number): void;
+    private reset;
+    /**
+     * Bounds of this widget relative to the root
+     * of all of its parents.
+     */
+    measureAbsoluteArea(widget: Widget): Bounds;
+    addEventListener<K extends keyof OPIEventMap>(type: K, listener: (ev: OPIEventMap[K]) => void): void;
+    removeEventListener<K extends keyof OPIEventMap>(type: K, listener: (ev: OPIEventMap[K]) => void): void;
+    fireEvent(type: string, event: OPIEvent): void;
+    get showGrid(): boolean;
+    set showGrid(showGrid: boolean);
+    get showOutline(): boolean;
+    set showOutline(showOutline: boolean);
+    get showRuler(): boolean;
+    set showRuler(showRuler: boolean);
+    get selection(): string[];
+    set selection(selection: string[]);
+    get editMode(): boolean;
+    set editMode(editMode: boolean);
+    get scale(): number;
+    set scale(scale: number);
+    get transparent(): boolean;
+    set transparent(transparent: boolean);
+    get widgets(): Widget[];
+    clearSelection(): void;
+    findWidget(wuid: string): Widget | undefined;
+    findWidgetByName(name: string): Widget | undefined;
+    getPVNames(): string[];
+    getPV(pvName: string): import(".").PV | undefined;
+    setValues(samples: Map<string, Sample>): void;
+    copyCanvas(area?: Bounds): HTMLCanvasElement;
+    /**
+     * Returns this display as an image.
+     */
+    toDataURL(type?: string, quality?: any): string;
+}

package/dist/types/EventHandler.d.ts

@@ -1,34 +1,34 @@
-import { Display } from './Display';
-import { HitCanvas } from './HitCanvas';
-import { Point } from './positioning';
-export interface OpiMouseEvent {
-    clientX: number;
-    clientY: number;
-    point: Point;
-}
-export interface OpiGrabEvent extends OpiMouseEvent {
-    dx: number;
-    dy: number;
-}
-export declare class EventHandler {
-    private display;
-    private canvas;
-    private hitCanvas;
-    private grabbing;
-    private grabTarget?;
-    private grabPoint?;
-    private documentMouseMoveListener;
-    private documentMouseUpListener;
-    private prevEnteredRegion?;
-    constructor(display: Display, canvas: HTMLCanvasElement, hitCanvas: HitCanvas);
-    private toPoint;
-    private onCanvasClick;
-    private onCanvasMouseDown;
-    private onCanvasMouseUp;
-    private onCanvasMouseOut;
-    private onCanvasMouseMove;
-    private initiateGrab;
-    private onDocumentMouseUp;
-    private onDocumentMouseMove;
-    private selectSingleWidget;
-}
+import { Display } from "./Display";
+import { HitCanvas } from "./HitCanvas";
+import { Point } from "./positioning";
+export interface OpiMouseEvent {
+    clientX: number;
+    clientY: number;
+    point: Point;
+}
+export interface OpiGrabEvent extends OpiMouseEvent {
+    dx: number;
+    dy: number;
+}
+export declare class EventHandler {
+    private display;
+    private canvas;
+    private hitCanvas;
+    private grabbing;
+    private grabTarget?;
+    private grabPoint?;
+    private documentMouseMoveListener;
+    private documentMouseUpListener;
+    private prevEnteredRegion?;
+    constructor(display: Display, canvas: HTMLCanvasElement, hitCanvas: HitCanvas);
+    private toPoint;
+    private onCanvasClick;
+    private onCanvasMouseDown;
+    private onCanvasMouseUp;
+    private onCanvasMouseOut;
+    private onCanvasMouseMove;
+    private initiateGrab;
+    private onDocumentMouseUp;
+    private onDocumentMouseMove;
+    private selectSingleWidget;
+}

package/dist/types/Font.d.ts

@@ -1,13 +1,15 @@
-export declare class Font {
-    name: string;
-    style: number;
-    static ARIAL_9: Font;
-    static ARIAL_10: Font;
-    static ARIAL_11: Font;
-    static ARIAL_12_BOLD: Font;
-    height: number;
-    constructor(name: string, height: number, style: number, pixels: boolean);
-    scale(scale: number): Font;
-    getFontString(): string;
-    preload(): Promise<void>;
-}
+export declare class Font {
+    name: string;
+    style: number;
+    static ARIAL_9: Font;
+    static ARIAL_10: Font;
+    static ARIAL_11: Font;
+    static ARIAL_12_BOLD: Font;
+    height: number;
+    constructor(name: string, height: number, style: number, pixels: boolean);
+    scale(scale: number): Font;
+    getFontString(): string;
+    get bold(): boolean;
+    get italic(): boolean;
+    isWebSafe(): boolean;
+}

package/dist/types/FontResolver.d.ts

@@ -0,0 +1,4 @@
+import { Font } from "./Font";
+export interface FontResolver {
+    resolve(font: Font): FontFace | undefined;
+}