Class InstanceAPI

constructor

• new InstanceAPI(element, configs?, options?): InstanceAPI

• Parameters

  • element: HTMLElement

  • Optional configs: RampConfigs

  • Optional options: RampOptions

  Returns InstanceAPI

Readonly $element

Readonly $i18n

Readonly $vApp

Readonly event

Readonly fixture

Readonly geo

Readonly notify

Readonly panel

startRequired

Readonly ui

animate

• get animate(): boolean

• The current animation status.

  Returns boolean

  Memberof

  InstanceAPI

isFullscreen

• get isFullscreen(): boolean

• Whether the app is fullscreen.

  Returns boolean

  Memberof

  InstanceAPI

language

• get language(): string

• The current locale string for the app.

  Returns string

  Memberof

  InstanceAPI

screenSize

• get screenSize(): null | string

• The 'screen' size for the app. Returns the largest screen class on the element; 'lg', 'md', 'sm' or 'xs'.

  Returns null | string

  Memberof

  InstanceAPI

started

• get started(): boolean

• Whether the app has been started.

  Returns boolean

  Memberof

  InstanceAPI

component

• component(id): any

• Retrieves a global Vue component by its id.

  Parameters

  • id: string

  Returns any

  Memberof

  InstanceAPI

• component<VC>(id, vueConstructor): VC

• Registers a global Vue component given an id and a constructor.

  Type Parameters

  • VC extends ComponentPublicInstanceConstructor<{
        $: ComponentInternalInstance;
        $attrs: Data;
        $data: {};
        $el: any;
        $emit: ((event, ...args) => void);
        $forceUpdate: (() => void);
        $nextTick: (<T>(this, fn?) => Promise<void>);
        $options: ComponentOptionsBase<Readonly<ExtractPropTypes<{}>>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, {}, {}, string, {}> & MergedComponentOptionsOverride;
        $parent: null | ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        $props: {
            class?: unknown;
            key?: string | number | symbol;
            onVnodeBeforeMount?: VNodeMountHook | VNodeMountHook[];
            onVnodeBeforeUnmount?: VNodeMountHook | VNodeMountHook[];
            onVnodeBeforeUpdate?: VNodeUpdateHook | VNodeUpdateHook[];
            onVnodeMounted?: VNodeMountHook | VNodeMountHook[];
            onVnodeUnmounted?: VNodeMountHook | VNodeMountHook[];
            onVnodeUpdated?: VNodeUpdateHook | VNodeUpdateHook[];
            ref?: VNodeRef;
            ref_for?: boolean;
            ref_key?: string;
            style?: unknown;
        };
        $refs: Data;
        $root: null | ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}>;
        $slots: Readonly<InternalSlots>;
        $watch<T>(source, cb, options?) => WatchStopHandle;
    } & Readonly<ExtractPropTypes<{}>> & ShallowUnwrapRef<{}> & ExtractComputedReturns<ComputedOptions> & MethodOptions & ComponentCustomProperties & {}, any, any, any, ComputedOptions, MethodOptions> & ComponentOptionsBase<Readonly<ExtractPropTypes<{}>>, {}, {}, ComputedOptions, MethodOptions, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, {}, {}, string, {}, VC> & VNodeProps & AllowedComponentProps & ComponentCustomProps

  Parameters

  • id: string

  • vueConstructor: any

  Returns VC

  Memberof

  InstanceAPI

getConfig

• getConfig(): any

• Gets the [cloned] config linked to the current language of the app.

  Returns any

  Memberof

  InstanceAPI

reload

• reload(configs?, options?): void

• Reloads Vue R4MP instance with a new config

  Parameters

  • Optional configs: RampConfigs

    language-keyed R4MP config

  • Optional options: RampOptions

    startup options for this R4MP instance

  Returns void

scrollToInstance

• scrollToInstance(): void

• If scrollToInstance is set to true in the configuration file, scrolls the browser to this RAMP component.

  Returns void

  Memberof

  InstanceAPI

setLanguage

• setLanguage(language): void

• Sets the language of the app to the specified string (e.g. 'en' or 'fr').

  Parameters

  • language: string

    The locale string to switch to

  Returns void

  Memberof

  InstanceAPI

start

• start(): void

• Returns void

toggleFullscreen

• toggleFullscreen(): void

• Toggles fullscreen for the app.

  Returns void

  Memberof

  InstanceAPI

updateAlert

• updateAlert(alert): void

• Updates the screen reader alert. Use this to inform screen reader users of visual changes in the app (pieces of ui appearing/leaving).

  Parameters

  • alert: string

    the alert to make available to screen readers

  Returns void

  Memberof

  InstanceAPI

useStore

• useStore<T>(id): undefined | Readonly<T>

• Returns the pinia store of the specified id, if it exists, else returns undefined.

  Type Parameters

  • T

  Parameters

  • id: string

    the id of the store to return

  Returns undefined | Readonly<T>

  Memberof

  InstanceAPI