@yamcs/opi 1.2.6 → 1.2.8

package/dist/types/Widget.d.ts

@@ -1,112 +1,118 @@
-import { ActionSet } from './actions';
-import { Color } from './Color';
-import { Display } from './Display';
-import { Graphics } from './Graphics';
-import { Bounds } from './positioning';
-import { PropertyListener, PropertySet } from './properties';
-import { PV } from './pv/PV';
-import { RuleSet } from './rules';
-import { ScaleOptions } from './scale';
-import { ScriptSet } from './scripts';
-import { AbstractContainerWidget } from './widgets/others/AbstractContainerWidget';
-import { XMLNode } from './XMLNode';
-export declare abstract class Widget {
-    readonly display: Display;
-    readonly parent?: AbstractContainerWidget | undefined;
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    private _value;
-    protected fillRoundRectangleBackgroundBorder: boolean;
-    private holderRegion?;
-    properties: PropertySet;
-    readonly vars: Map<string, any>;
-    constructor(display: Display, parent?: AbstractContainerWidget | undefined);
-    parseNode(node: XMLNode): void;
-    drawHolder(g: Graphics): void;
-    beforeDrawBorder(g: Graphics): void;
-    private drawBorderStyle;
-    drawDecoration(g: Graphics): void;
-    drawOverlay(g: Graphics): void;
-    drawSelection(ctx: CanvasRenderingContext2D): void;
-    requestRepaint(): void;
-    resolvePath(path: string): string;
-    /**
-     * Bounds of this widget (within its parent).
-     * Bounds cover the entire widget: area + ornaments.
-     */
-    get bounds(): Bounds;
-    get unscaledBounds(): Bounds;
-    /**
-     * Area where the widget can draw.
-     * (this is smaller than the actual widget bounds).
-     */
-    get area(): Bounds;
-    private drawShadowBorder;
-    private drawDashedBorder;
-    executeAction(index: number): void;
-    expandMacro(text: string): string;
-    get pv(): PV | undefined;
-    isMinorSeverity(): boolean;
-    isMajorSeverity(): boolean;
-    get alarm(): boolean;
-    get alarmSensitiveBackgroundColor(): Color;
-    get alarmSensitiveForegroundColor(): Color;
-    get scale(): number;
-    get value(): any;
-    set value(value: any);
-    addPropertyListener(propertyName: string, listener: PropertyListener<any>): void;
-    removePropertyListener(propertyName: string, listener: PropertyListener<any>): void;
-    /**
-     * Returns this widget as an image.
-     */
-    toDataURL(type?: string, quality?: any): string;
-    get wuid(): string;
-    get name(): string;
-    get holderX(): number;
-    get holderY(): number;
-    get holderWidth(): number;
-    get holderHeight(): number;
-    get borderAlarmSensitive(): boolean;
-    get backgroundAlarmSensitive(): boolean;
-    get foregroundAlarmSensitive(): boolean;
-    get pvName(): string | undefined;
-    get pvValue(): any;
-    get borderColor(): Color;
-    get borderStyle(): number;
-    get borderWidth(): number;
-    get backgroundColor(): Color;
-    get enabled(): boolean;
-    get foregroundColor(): Color;
-    get tooltip(): string | undefined;
-    get transparent(): boolean;
-    get visible(): boolean;
-    get actions(): ActionSet;
-    get scripts(): ScriptSet;
-    get rules(): RuleSet;
-    get scaleOptions(): ScaleOptions;
-    get widgetType(): string | undefined;
-    get text(): string;
-    /**
-     * Called exactly once post-construct. A destroyed widget will
-     * never be re-inited.
-     */
-    init(): void;
-    /**
-     * Called when a widget should temporarily hide content
-     * (tab switch).
-     *
-     * Most widgets don't need to override, but it used by some
-     * that position HTML on top of the canvas.
-     *
-     * Unhide should occur upon the next draw request.
-     */
-    hide(): void;
-    /**
-     * Called when a widget will never be used again.
-     * (display close).
-     */
-    destroy(): void;
-    abstract draw(g: Graphics): void;
-}
+import { ActionSet } from "./actions";
+import { Action } from "./actions/Action";
+import { Color } from "./Color";
+import { Display } from "./Display";
+import { Graphics } from "./Graphics";
+import { Bounds } from "./positioning";
+import { PropertyListener, PropertySet } from "./properties";
+import { PV } from "./pv/PV";
+import { RuleSet } from "./rules";
+import { ScaleOptions } from "./scale";
+import { ScriptSet } from "./scripts";
+import { AbstractContainerWidget } from "./widgets/others/AbstractContainerWidget";
+import { XMLNode } from "./XMLNode";
+export declare abstract class Widget {
+    readonly display: Display;
+    readonly parent?: AbstractContainerWidget | undefined;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    private _value;
+    protected fillRoundRectangleBackgroundBorder: boolean;
+    private holderRegion?;
+    properties: PropertySet;
+    readonly vars: Map<string, any>;
+    private pvs;
+    constructor(display: Display, parent?: AbstractContainerWidget | undefined);
+    parseNode(node: XMLNode): void;
+    getHookedActions(): Action[];
+    drawHolder(g: Graphics): void;
+    beforeDrawBorder(g: Graphics): void;
+    private drawBorderStyle;
+    private isDisconnected;
+    drawDecoration(g: Graphics): void;
+    drawOverlay(g: Graphics): void;
+    drawSelection(ctx: CanvasRenderingContext2D): void;
+    requestRepaint(): void;
+    resolvePath(path: string): string;
+    /**
+     * Bounds of this widget (within its parent).
+     * Bounds cover the entire widget: area + ornaments.
+     */
+    get bounds(): Bounds;
+    get unscaledBounds(): Bounds;
+    /**
+     * Area where the widget can draw.
+     * (this is smaller than the actual widget bounds).
+     */
+    get area(): Bounds;
+    private drawShadowBorder;
+    private drawDashedBorder;
+    executeActionByIndex(index: number): void;
+    executeAction(action: Action): void;
+    expandMacro(text: string): string;
+    private loadFont;
+    get pv(): PV | undefined;
+    isMinorSeverity(): boolean;
+    isMajorSeverity(): boolean;
+    get alarm(): boolean;
+    get alarmSensitiveBackgroundColor(): Color;
+    get alarmSensitiveForegroundColor(): Color;
+    get scale(): number;
+    get value(): any;
+    set value(value: any);
+    addPropertyListener(propertyName: string, listener: PropertyListener<any>): void;
+    removePropertyListener(propertyName: string, listener: PropertyListener<any>): void;
+    /**
+     * Returns this widget as an image.
+     */
+    toDataURL(type?: string, quality?: any): string;
+    get wuid(): string;
+    get name(): string;
+    get holderX(): number;
+    get holderY(): number;
+    get holderWidth(): number;
+    get holderHeight(): number;
+    get borderAlarmSensitive(): boolean;
+    get backgroundAlarmSensitive(): boolean;
+    get foregroundAlarmSensitive(): boolean;
+    get pvName(): string | undefined;
+    get pvValue(): any;
+    get borderColor(): Color;
+    get borderStyle(): number;
+    get borderWidth(): number;
+    get backgroundColor(): Color;
+    get enabled(): boolean;
+    get foregroundColor(): Color;
+    get tooltip(): string | undefined;
+    get transparent(): boolean;
+    get visible(): boolean;
+    get actions(): ActionSet;
+    get scripts(): ScriptSet;
+    get rules(): RuleSet;
+    get scaleOptions(): ScaleOptions;
+    get widgetType(): string | undefined;
+    get text(): string;
+    /**
+     * Called exactly once post-construct. A destroyed widget will
+     * never be re-inited.
+     */
+    init(): void;
+    /**
+     * Called when a widget should temporarily hide content
+     * (tab switch).
+     *
+     * Most widgets don't need to override, but it used by some
+     * that position HTML on top of the canvas.
+     *
+     * Unhide should occur upon the next draw request.
+     */
+    hide(): void;
+    /**
+     * Called when a widget will never be used again.
+     * (display close).
+     */
+    destroy(): void;
+    abstract draw(g: Graphics): void;
+}

package/dist/types/XMLNode.d.ts

@@ -1,83 +1,83 @@
-import { ActionSet } from './actions';
-import { Color } from './Color';
-import { ColorMap } from './ColorMap';
-import { Font } from './Font';
-import { MacroSet } from './macros';
-import { RuleSet } from './rules';
-import { AutoScaleWidgets, ScaleOptions } from './scale';
-import { ScriptSet } from './scripts';
-export declare class XMLNode {
-    private node;
-    constructor(node: Node);
-    get name(): string;
-    static parseFromXML(xml: string): XMLNode;
-    /**
-    * Searches for a direct child with the specified name.
-    *
-    * @throws when no such child was found
-    */
-    getNode(name: string): XMLNode;
-    /**
-    * Searches for all direct children with the specified name.
-    * If this name is undefined, all children are returned.
-    */
-    getNodes(name?: string): XMLNode[];
-    hasNode(name: string): boolean;
-    hasAttribute(name: string): boolean;
-    /**
-     * Returns the inner content of this node as a string
-     */
-    getTextContent(defaultValue?: string): string;
-    /**
-     * Parses the child node contents of the given parent node as a string.
-     *
-     * @throws when no such child was found and defaultValue was undefined
-     */
-    getString(name: string, defaultValue?: string): string;
-    getStringAttribute(name: string): string;
-    /**
-     * Parses the child node contents of the given parent node as a float.
-     *
-     * @throws when no such child was found and defaultValue was undefined.
-     */
-    getFloat(name: string, defaultValue?: number): number;
-    /**
-     * Parses the child node contents of the given parent node as an integer.
-     *
-     * @throws when no such child was found and defaultValue was undefined.
-     */
-    getInt(name: string, defaultValue?: number): number;
-    getIntAttribute(name: string): number;
-    /**
-     * Parses the child node contents of the given parent node as a boolean.
-     *
-     * @throws when no such child was found and defaultValue was undefined.
-     */
-    getBoolean(name: string, defaultValue?: boolean): boolean;
-    getBooleanAttribute(name: string, defaultValue?: boolean): boolean;
-    /**
-     * Parses the child node contents as a color.
-     *
-     * @throws when no such child was found and defaultValue was undefined.
-     */
-    getColor(name: string, defaultValue?: Color): Color;
-    /**
-    * Parses the child node contents as a font.
-    */
-    getFont(name: string): Font;
-    getPoints(name: string): {
-        x: number;
-        y: number;
-    }[];
-    getStringList(name: string): string[];
-    getStringTable(name: string): string[][];
-    getScripts(name: string): ScriptSet;
-    getScaleOptions(name: string): ScaleOptions;
-    getAutoScaleWidgets(name: string): AutoScaleWidgets;
-    getColorMap(name: string): ColorMap | undefined;
-    getRules(name: string): RuleSet;
-    getMacros(name: string): MacroSet;
-    getActions(name: string): ActionSet;
-    private parseColorNode;
-    private findChild;
-}
+import { ActionSet } from "./actions";
+import { Color } from "./Color";
+import { ColorMap } from "./ColorMap";
+import { Font } from "./Font";
+import { MacroSet } from "./macros";
+import { RuleSet } from "./rules";
+import { AutoScaleWidgets, ScaleOptions } from "./scale";
+import { ScriptSet } from "./scripts";
+export declare class XMLNode {
+    private node;
+    constructor(node: Node);
+    get name(): string;
+    static parseFromXML(xml: string): XMLNode;
+    /**
+     * Searches for a direct child with the specified name.
+     *
+     * @throws when no such child was found
+     */
+    getNode(name: string): XMLNode;
+    /**
+     * Searches for all direct children with the specified name.
+     * If this name is undefined, all children are returned.
+     */
+    getNodes(name?: string): XMLNode[];
+    hasNode(name: string): boolean;
+    hasAttribute(name: string): boolean;
+    /**
+     * Returns the inner content of this node as a string
+     */
+    getTextContent(defaultValue?: string): string;
+    /**
+     * Parses the child node contents of the given parent node as a string.
+     *
+     * @throws when no such child was found and defaultValue was undefined
+     */
+    getString(name: string, defaultValue?: string): string;
+    getStringAttribute(name: string): string;
+    /**
+     * Parses the child node contents of the given parent node as a float.
+     *
+     * @throws when no such child was found and defaultValue was undefined.
+     */
+    getFloat(name: string, defaultValue?: number): number;
+    /**
+     * Parses the child node contents of the given parent node as an integer.
+     *
+     * @throws when no such child was found and defaultValue was undefined.
+     */
+    getInt(name: string, defaultValue?: number): number;
+    getIntAttribute(name: string): number;
+    /**
+     * Parses the child node contents of the given parent node as a boolean.
+     *
+     * @throws when no such child was found and defaultValue was undefined.
+     */
+    getBoolean(name: string, defaultValue?: boolean): boolean;
+    getBooleanAttribute(name: string, defaultValue?: boolean): boolean;
+    /**
+     * Parses the child node contents as a color.
+     *
+     * @throws when no such child was found and defaultValue was undefined.
+     */
+    getColor(name: string, defaultValue?: Color): Color;
+    /**
+     * Parses the child node contents as a font.
+     */
+    getFont(name: string): Font;
+    getPoints(name: string): {
+        x: number;
+        y: number;
+    }[];
+    getStringList(name: string): string[];
+    getStringTable(name: string): string[][];
+    getScripts(name: string): ScriptSet;
+    getScaleOptions(name: string): ScaleOptions;
+    getAutoScaleWidgets(name: string): AutoScaleWidgets;
+    getColorMap(name: string): ColorMap | undefined;
+    getRules(name: string): RuleSet;
+    getMacros(name: string): MacroSet;
+    getActions(name: string): ActionSet;
+    private parseColorNode;
+    private findChild;
+}

package/dist/types/actions/Action.d.ts

@@ -0,0 +1,10 @@
+import { PropertySet } from "../properties";
+import { Widget } from "../Widget";
+import { XMLNode } from "../XMLNode";
+export declare abstract class Action {
+    properties: PropertySet;
+    constructor();
+    parseNode(node: XMLNode): void;
+    abstract execute(widget: Widget): void;
+    get description(): string;
+}

package/dist/types/actions/ExecuteCommandAction.d.ts

@@ -0,0 +1,10 @@
+import { Widget } from "../Widget";
+import { Action } from "./Action";
+export declare class ExecuteCommandAction extends Action {
+    constructor();
+    execute(widget: Widget): void;
+    get command(): string;
+    get commandDirectory(): string;
+    get waitTime(): number;
+    toString(): string;
+}

package/dist/types/actions/ExecuteJavaScriptAction.d.ts

@@ -0,0 +1,10 @@
+import { Widget } from "../Widget";
+import { Action } from "./Action";
+export declare class ExecuteJavaScriptAction extends Action {
+    constructor();
+    execute(widget: Widget): void;
+    get path(): string;
+    get embedded(): boolean;
+    get scriptText(): string;
+    toString(): string;
+}

package/dist/types/actions/OpenDisplayAction.d.ts

@@ -0,0 +1,11 @@
+import { MacroSet } from "../macros";
+import { Widget } from "../Widget";
+import { Action } from "./Action";
+export declare class OpenDisplayAction extends Action {
+    constructor();
+    execute(widget: Widget): void;
+    get macros(): MacroSet;
+    get path(): string;
+    get mode(): number;
+    toString(): string;
+}

package/dist/types/actions/OpenFileAction.d.ts

@@ -0,0 +1,8 @@
+import { Widget } from "../Widget";
+import { Action } from "./Action";
+export declare class OpenFileAction extends Action {
+    constructor();
+    execute(widget: Widget): void;
+    get path(): string;
+    toString(): string;
+}

package/dist/types/actions/OpenWebpageAction.d.ts

@@ -0,0 +1,8 @@
+import { Widget } from "../Widget";
+import { Action } from "./Action";
+export declare class OpenWebpageAction extends Action {
+    constructor();
+    execute(widget: Widget): void;
+    get hyperlink(): string;
+    toString(): string;
+}

package/dist/types/actions/PlaySoundAction.d.ts

@@ -0,0 +1,8 @@
+import { Widget } from "../Widget";
+import { Action } from "./Action";
+export declare class PlaySoundAction extends Action {
+    constructor();
+    execute(widget: Widget): void;
+    get path(): string;
+    toString(): string;
+}

package/dist/types/actions/WritePVAction.d.ts

@@ -0,0 +1,11 @@
+import { Widget } from "../Widget";
+import { Action } from "./Action";
+export declare class WritePVAction extends Action {
+    constructor();
+    execute(widget: Widget): void;
+    get pvName(): string;
+    get value(): string;
+    get timeout(): number;
+    get confirmMessage(): string;
+    toString(): string;
+}

package/dist/types/actions.d.ts

@@ -1,64 +1,10 @@
-export declare class ActionSet {
-    actions: (Action | null)[];
-    hookFirstActionToClick: boolean;
-    hookAllActionsToClick: boolean;
-    add(action: Action | null): void;
-    isClickable(): boolean | 0;
-    getAction(index: number): Action | null | undefined;
-    getClickActions(): number[];
-    toString(): string;
-}
-declare type Action = ExecuteCommandAction | ExecuteJavaScriptAction | OpenDisplayAction | OpenFileAction | OpenWebpageAction | WritePVAction | PlaySoundAction;
-export declare class OpenDisplayAction {
-    path: string;
-    readonly type = "OPEN_DISPLAY";
-    mode?: number;
-    description?: string;
-    constructor(path: string);
-    toString(): string;
-}
-export declare class OpenFileAction {
-    readonly type = "OPEN_FILE";
-    path?: string;
-    description?: string;
-    toString(): string;
-}
-export declare class ExecuteJavaScriptAction {
-    embedded: boolean;
-    readonly type = "EXECUTE_JAVASCRIPT";
-    text?: string;
-    path?: string;
-    description?: string;
-    constructor(embedded: boolean);
-    toString(): string;
-}
-export declare class ExecuteCommandAction {
-    readonly type = "EXECUTE_CMD";
-    command?: string;
-    commandDirectory?: string;
-    waitTime?: number;
-    description?: string;
-    toString(): string;
-}
-export declare class WritePVAction {
-    pvName: string;
-    value: string;
-    readonly type = "WRITE_PV";
-    confirmMessage?: string;
-    description?: string;
-    constructor(pvName: string, value: string);
-    toString(): string;
-}
-export declare class PlaySoundAction {
-    readonly type = "PLAY_SOUND";
-    path?: string;
-    description?: string;
-    toString(): string;
-}
-export declare class OpenWebpageAction {
-    readonly type = "OPEN_WEBPAGE";
-    hyperlink?: string;
-    description?: string;
-    toString(): string;
-}
-export {};
+import { Action } from "./actions/Action";
+export declare class ActionSet {
+    actions: (Action | null)[];
+    hookFirstActionToClick: boolean;
+    hookAllActionsToClick: boolean;
+    add(action: Action | null): void;
+    isClickable(): boolean | 0;
+    getAction(index: number): Action | null | undefined;
+    toString(): string;
+}

package/dist/types/events.d.ts

@@ -1,41 +1,41 @@
-export interface OPIEvent {
-    detail?: any;
-}
-export interface OPIEventMap {
-    [index: string]: OPIEvent;
-    'closedisplay': CloseDisplayEvent;
-    'opendisplay': OpenDisplayEvent;
-    'openpv': OpenPVEvent;
-    'selection': SelectionEvent;
-    'scale': ScaleEvent;
-}
-export interface SelectionEvent extends OPIEvent {
-    selected: string[];
-}
-/**
- * A script or a button requested to open another display.
- */
-export interface OpenDisplayEvent extends OPIEvent {
-    path: string;
-    replace: boolean;
-}
-/**
- * The user has selected a widget with a navigable PV.
- */
-export interface OpenPVEvent extends OPIEvent {
-    pvName: string;
-}
-/**
- * A script or a button requested to close the current display.
- */
-export interface CloseDisplayEvent extends OPIEvent {
-}
-/**
- * This display scale has changed.
- */
-export interface ScaleEvent extends OPIEvent {
-    scale: number;
-}
-export declare type OPIEventHandlers = {
-    [index: string]: Array<(ev: OPIEvent) => void>;
-};
+export interface OPIEvent {
+    detail?: any;
+}
+export interface OPIEventMap {
+    [index: string]: OPIEvent;
+    closedisplay: CloseDisplayEvent;
+    opendisplay: OpenDisplayEvent;
+    openpv: OpenPVEvent;
+    selection: SelectionEvent;
+    scale: ScaleEvent;
+}
+export interface SelectionEvent extends OPIEvent {
+    selected: string[];
+}
+/**
+ * A script or a button requested to open another display.
+ */
+export interface OpenDisplayEvent extends OPIEvent {
+    path: string;
+    replace: boolean;
+}
+/**
+ * The user has selected a widget with a navigable PV.
+ */
+export interface OpenPVEvent extends OPIEvent {
+    pvName: string;
+}
+/**
+ * A script or a button requested to close the current display.
+ */
+export interface CloseDisplayEvent extends OPIEvent {
+}
+/**
+ * This display scale has changed.
+ */
+export interface ScaleEvent extends OPIEvent {
+    scale: number;
+}
+export type OPIEventHandlers = {
+    [index: string]: Array<(ev: OPIEvent) => void>;
+};