RAMP4 - v4.21.0
    Preparing search index...

    Class InstanceAPI

    Index

    Constructors

    constructor

    Properties

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

    Accessors

    animate isFullscreen keyboardNav language screenSize started

    Methods

    component containsValidHtml getConfig reload representsObject scrollToInstance setLanguage start toggleFullscreen updateAlert useStore

    Constructors

    Properties

    $element: App<Element>

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

    $i18n: Composer
    $rootEl: Element

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

    $vApp: ComponentPublicInstance

    The instance of Vue R4MP application controlled by this InstanceAPI.

    InstanceAPI

    dev: DevAPI
    event: EventAPI
    fixture: FixtureAPI
    geo: GeoAPI
    notify: NotificationAPI
    panel: PanelAPI
    startRequired: boolean = false
    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;
    }

    Type Declaration

    • escapeHtml: (content: string) => string
    • exposeMeasurements: boolean
    • exposeOids: boolean
    • formatNumber: (num: number) => string
    • getZoomIcon: () => string
    • isPlainText: (content: any) => boolean

      Return whether the string should be interpreted as plain text. Returns false if input is not string

    • maptip: MaptipAPI
    • scrollToInstance: boolean
    • suppressNumberLocalization: boolean

    Accessors

    • get animate(): boolean

      The current animation status.

      Returns boolean

      InstanceAPI

    • get isFullscreen(): boolean

      Whether the app is fullscreen.

      Returns boolean

      InstanceAPI

    • get language(): string

      The current locale string for the app.

      Returns string

      InstanceAPI

    • get screenSize(): string | null

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

      Returns string | null

      InstanceAPI

    • get started(): boolean

      Whether the app has been started.

      Returns boolean

      InstanceAPI

    Methods

    • Retrieves a global Vue component by its id.

      Parameters

      • id: string

      Returns any

      InstanceAPI

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

      Type Parameters

      • VC extends DefineComponent

      Parameters

      • id: string
      • vueConstructor: any

      Returns VC

      InstanceAPI

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

      Parameters

      • content: string

      Returns boolean

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

      Returns RampConfig

      InstanceAPI

    • Reloads Vue R4MP instance, with the option of providing a new config

      Parameters

      • Optionalconfigs: RampConfigs

        language-keyed R4MP config. if missing, the existing configs will be used

      • Optionaloptions: RampOptions

        startup options for this R4MP instance

      Returns void

    • Return whether the string represents an object or array

      Parameters

      • content: string

      Returns boolean

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

      Returns void

      InstanceAPI

    • 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

      InstanceAPI

    • Toggles fullscreen for the app.

      Returns void

      InstanceAPI

    • 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

      InstanceAPI

    • 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 Readonly<T> | undefined

      InstanceAPI

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods