Class InstanceAPI

Constructors

constructor

Properties

$element $i18n $rootEl $vApp event fixture geo notify panel startRequired ui

Accessors

animate isFullscreen language screenSize started

Methods

component containsValidHtml getConfig reload representsObject scrollToInstance setLanguage start toggleFullscreen updateAlert useStore

Constructors

constructor

Properties

Readonly$element

$element: App<Element>

An object of type VueApp<Element> that represents the RAMP instance within the Vue app

Readonly$i18n

$i18n: Composer<{}, {}, {}, string, never, string>

Readonly$rootEl

$rootEl: Element

An object of type Element that represents the root DOM element for the RAMP instance

Readonly$vApp

$vApp: ComponentPublicInstance

The instance of Vue R4MP application controlled by this InstanceAPI.

Memberof

InstanceAPI

Readonlyevent

event: EventAPI

Readonlyfixture

fixture: FixtureAPI

Readonlygeo

geo: GeoAPI

Readonlynotify

notify: NotificationAPI

Readonlypanel

panel: PanelAPI

startRequired

startRequired: boolean = false

Readonlyui

ui: {
    escapeHtml: ((content: string) => string);
    exposeMeasurements: boolean;
    exposeOids: boolean;
    formatNumber: ((num: number) => string);
    getZoomIcon: (() => string);
    isPlainText: ((content: any) => boolean);
    maptip: MaptipAPI;
    scrollToInstance: boolean;
    suppressNumberLocalization: boolean;
}

Accessors

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

Methods

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 DefineComponent

    Parameters

    • id: string
    • vueConstructor: any

    Returns VC

    Memberof

    InstanceAPI

containsValidHtml

  • containsValidHtml(content): boolean

  • Return whether the string contains valid html content (i.e. a html element with opening and closing tags)

    Parameters

    • content: string

    Returns boolean

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

    • Optionalconfigs: RampConfigs

      language-keyed R4MP config

    • Optionaloptions: RampOptions

      startup options for this R4MP instance

    Returns void

representsObject

  • representsObject(content): boolean

  • Return whether the string represents an object or array

    Parameters

    • content: string

    Returns boolean

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

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods