Readonly $iThe instance of RampMap API scoped to a single Vue R4MP application.
APIScope
Private Readonly _eventA vue instance that provides an event bus for all events.
EventAPI
Private Readonly _eventPrivate _funPrivate Readonly _nameThe instance of Vue R4MP application controlled by this InstanceAPI.
This is just a shorthand for this.$iApi.$vApp.
APIScope
Loads the set of standard, built-in event handlers to the R4MP Vue instance. This will quickly set up the vanilla version of RAMP. Note this function is automatically run by the instance startup unless the loadDefaultEvents option is set to false. The function is exposed to allow custom pages the ability to call it at a different point in the startup. Also, a subset of standard event handlers can be provided on the optional parameter if one wishes to omit some of the standard handlers.
Optional eventHandlerNames: string[]list of built-in event handler names to add. omission means all built-in event handlers will be added
resolves with array of event handler names
EventAPI
Private defaultPrivate findPrivate handlerAdds an event handler to an event.
name of the event to react to
function to execute when event triggers
Optional handlerName: string = ''name of the handler (for reference). a name will be generated if not provided.
the handler name
EventAPI
Adds an event handler to an event that will be respected once. After the handler reacts to the event, it will be removed.
name of the event to react to once
function to execute when event triggers
Optional handlerName: string = ''name of the handler (for reference). a name will be generated if not provided.
the handler name
EventAPI
Generated using TypeDoc
A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.
Export