Creates an instance of FixtureAPI.
FixtureAPI
Readonly $iThe instance of RampMap API scoped to a single Vue R4MP application.
APIScope
The 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 fixtures 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 loadDefaultFixtures 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 fixtures can be provided on the optional parameter if one wishes to omit some of the standard fixtures.
FixtureAPI
Optional fixtureNames: string[]list of built-in fixtures names to add. omission means all built-in fixtures will be added
resolves with array of default fixtures
Finds and returns a FixtureBase object with the id specified.
FixtureAPI
subclass of the FixtureBase; defaults to FixtureBase
fixture id or FixtureBase item
Finds and returns a collection of FixtureBase objects given a list of ids.
This can be useful when retrieving several fixtures at one time as follows:
const [one, two, three] = rInstance.fixture.get(['fixture-one', 'fixture-two', 'fixture-three']);
FixtureAPI
subclass of the FixtureBase; defaults to FixtureBase
a list of fixture ids
Generated using TypeDoc
A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.
Export