Class PanelAPI

A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.

Export

Hierarchy

Constructors

constructor

Properties

$iApi panelStore

Accessors

$element $vApp opened pinned visible

Methods

close expand get isRegistered minimize move open pin register remove setStyle show toggle toggleMinimize

Constructors

constructor

Properties

Readonly $iApi

$iApi: InstanceAPI

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

panelStore

panelStore: Store<"panel", _UnwrapAll<Pick<{
    addRegPromise: ((panelId) => void);
    closePanel: ((panel) => void);
    getRegPromises: ((panelIds) => Promise<void>[]);
    getRemainingWidth: ComputedRef<number>;
    getVisible: ((screenSize) => {
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }[]);
    items: Ref<{
        [name: string]: PanelInstance;
    }>;
    mobileView: Ref<boolean>;
    movePanel: ((panel, direction) => void);
    openPanel: ((panel) => void);
    orderedItems: Ref<{
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }[]>;
    pinned: Ref<null | {
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }>;
    priority: Ref<null>;
    regPromises: Ref<{
        [name: string]: DefPromise;
    }>;
    registerPanel: ((panel) => void);
    remWidth: Ref<number>;
    removePanel: ((panel) => void);
    reorderable: Ref<boolean>;
    setMobileView: ((value) => void);
    setStackWidth: ((value) => void);
    stackWidth: Ref<number>;
    updateVisible: (() => void);
    visible: Ref<{
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }[]>;
}, "items" | "regPromises" | "orderedItems" | "pinned" | "priority" | "visible" | "stackWidth" | "remWidth" | "mobileView" | "reorderable">>, Pick<{
    addRegPromise: ((panelId) => void);
    closePanel: ((panel) => void);
    getRegPromises: ((panelIds) => Promise<void>[]);
    getRemainingWidth: ComputedRef<number>;
    getVisible: ((screenSize) => {
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }[]);
    items: Ref<{
        [name: string]: PanelInstance;
    }>;
    mobileView: Ref<boolean>;
    movePanel: ((panel, direction) => void);
    openPanel: ((panel) => void);
    orderedItems: Ref<{
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }[]>;
    pinned: Ref<null | {
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }>;
    priority: Ref<null>;
    regPromises: Ref<{
        [name: string]: DefPromise;
    }>;
    registerPanel: ((panel) => void);
    remWidth: Ref<number>;
    removePanel: ((panel) => void);
    reorderable: Ref<boolean>;
    setMobileView: ((value) => void);
    setStackWidth: ((value) => void);
    stackWidth: Ref<number>;
    updateVisible: (() => void);
    visible: Ref<{
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }[]>;
}, "getRemainingWidth">, Pick<{
    addRegPromise: ((panelId) => void);
    closePanel: ((panel) => void);
    getRegPromises: ((panelIds) => Promise<void>[]);
    getRemainingWidth: ComputedRef<number>;
    getVisible: ((screenSize) => {
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }[]);
    items: Ref<{
        [name: string]: PanelInstance;
    }>;
    mobileView: Ref<boolean>;
    movePanel: ((panel, direction) => void);
    openPanel: ((panel) => void);
    orderedItems: Ref<{
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }[]>;
    pinned: Ref<null | {
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }>;
    priority: Ref<null>;
    regPromises: Ref<{
        [name: string]: DefPromise;
    }>;
    registerPanel: ((panel) => void);
    remWidth: Ref<number>;
    removePanel: ((panel) => void);
    reorderable: Ref<boolean>;
    setMobileView: ((value) => void);
    setStackWidth: ((value) => void);
    stackWidth: Ref<number>;
    updateVisible: (() => void);
    visible: Ref<{
        $element: { version: string; config: { readonly isNativeTag?: ((tag: string) => boolean) | undefined; performance: boolean; optionMergeStrategies: Record<string, OptionMergeFunction>; ... 5 more ...; unwrapInjectedRef?: boolean | undefined; }; ... 14 more ...; filter?: { ...; } | undefined; };
        $iApi: { readonly fixture: { add: (id: string, constructor?: IFixtureBase | undefined) => Promise<FixtureBase>; remove: <T extends FixtureBase = FixtureBase>(fixtureOrId: string | FixtureBase) => T; ... 5 more ...; readonly $element: { ...; }; }; ... 21 more ...; start: () => void; };
        $vApp: ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        alertName: string;
        button: any;
        controls: any;
        expanded: boolean;
        id: string;
        isLeftMostPanel: boolean;
        isOpen: boolean;
        isPinned: boolean;
        isRightMostPanel: boolean;
        isVisible: boolean;
        route: { screen: string; props?: object | undefined; };
        screens: PanelConfigScreens;
        style: PanelConfigStyle;
        width: undefined | number;
        close() => PanelInstance;
        expand(expand?) => PanelInstance;
        isScreenLoaded(id) => boolean;
        minimize() => PanelInstance;
        move(direction) => PanelInstance;
        open(value?) => PanelInstance;
        pin(value?) => PanelInstance;
        registerScreen(id) => void;
        remove() => PanelInstance;
        setStyles(style, replace?) => PanelInstance;
        show(value) => PanelInstance;
        toggle(value?) => PanelInstance;
        toggleMinimize(value?) => PanelInstance;
    }[]>;
}, "getVisible" | "getRegPromises" | "openPanel" | "closePanel" | "movePanel" | "removePanel" | "setStackWidth" | "setMobileView" | "updateVisible" | "registerPanel" | "addRegPromise">> = ...

Accessors

$element

  • get $element(): App<Element>

  • Returns App<Element>

$vApp

  • get $vApp(): ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

  • The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

    Memberof

    APIScope

    Returns ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>

opened

pinned

visible

Methods

close

expand

  • Expands/collapses the expand state of the panel. Toggles whether the panel expands if no expand value is given.

    Memberof

    PanelAPI

    Parameters

    • value: string | PanelInstance
    • Optional expand: boolean

      Optional. Whether the panel should expand, toggles the value if not set

    Returns null | PanelInstance

get

isRegistered

  • Provides a promise that resolves when the panel(s) have finished registration.

    Memberof

    PanelAPI

    Parameters

    • panelId: string | string[]

      the panel ID(s) for which the promise is requested

    Returns Promise<any>

minimize

move

open

  • Opens a registered panel in the panel stack.

    • rInstance.panel.open('panel-id') -- opens the 'panel-id' panel on the first screen in the set
    • rInstance.panel.open(<PanelInstance>) -- opens the provided PanelInstance object on the first screen in the set
    • rInstance.panel.open({ id: 'panel-id', screen: 'screen-id' }) -- opens the 'panel-id' panel on the 'screen-id' screen
    • rInstance.panel.open({ id: 'panel-id', screen: 'screen-id', props: {... } }) -- opens the 'panel-id' panel on the 'screen-id' screen passing supplied props to it

    Memberof

    PanelAPI

    Parameters

    • value: string | PanelInstance | PanelInstancePath

      a panel id, a PanelInstance object or an object of the form { id: <panel-id>, screen: <id>, props: <object> }.

    Returns PanelInstance

pin

  • Pin/unpin/toggle (if no value provided) pin status of the provided panel. When pinning, automatically unpins any previous pinned panel if exists.

    Memberof

    PanelAPI

    Parameters

    Returns PanelInstance

register

  • Registers a provided panel object and returns the resulting PanelInstance objects. When the panel is registered, all its screens are added to the Vue as components right away.

    Memberof

    PanelAPI

    Parameters

    Returns PanelInstance

  • Registers a set of provided panel objects and returns the resulting PanelInstance object set. When the panel is registered, all its screens are added to the Vue as components right away.

    Memberof

    PanelAPI

    Parameters

    • value: PanelConfigSet

      a set of PanelConfig objects in the form of { [name: string]: PanelConfig } where keys assumed to be ids

    • Optional options: PanelRegistrationOptions

      a set of options that will apply to all the panel in the set

    Returns PanelInstanceSet

remove

setStyle

  • Sets the styles of the specified panel by using a provided CSS styles object.

    Memberof

    PanelAPI

    Parameters

    • value: string | PanelInstance
    • style: object
    • Optional replace: boolean = false

      merge with existing styles if false; replace if true

    Returns null | PanelInstance

show

toggle

toggleMinimize

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc