RAMP4 - v4.21.0
    Preparing search index...

    Allows optional tools to adjust or suppress map identify geometry without making identify depend on those tools.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    The instance of RampMap API scoped to a single Vue R4MP application.

    APIScope

    id: string

    ID of this fixture.

    FixtureInstance

    persist: boolean

    Indicates whether to keep the fixture when the language changes. Defaults to true. If only one config is provided for all languages, the fixture will be kept on language change, regardless of the value of the flag.

    Fixture

    store: Store<"draw">

    Accessors

    • get $element(): App<Element>

      Returns App<Element>

    • get $vApp(): ComponentPublicInstance

      The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

      Returns ComponentPublicInstance

      APIScope

    • get config(): any

      Returns the fixture config section (JSON) taken from the global config.

      Returns any

      FixtureInstance

    Methods

    • Starts a draw-shape JSON file download using the same export format as exportShapes.

      If no selection is supplied, all draw shapes are exported. Supply a shape ID, an array of shape IDs, or an options object with ids to export specific shapes. A custom file name can be supplied either as the second parameter or through the options object.

      Parameters

      • Optionalselection: DrawShapeDownloadSelection

        Optional shape ID selection.

      • OptionalfileName: string

        Optional file name for the downloaded JSON file.

      Returns boolean

      true when a file download was started; false when there are no matching shapes.

    • A helper function to create a "subclass" of the base Vue constructor

      Parameters

      • vueComponent: Record<string, any>
      • Optionaloptions: ComponentOptions = {}

      Returns any

      FixtureInstance

    • Return an alternate geometry to identify against for the supplied map click.

      Return undefined to identify against the original click point. Returning a point preserves normal point identify behavior, including layer tolerance and symbolic hit tests. Returning a line, polygon, or other non-point geometry passes that geometry to identifying layers so they can return features intersecting it.

      Parameters

      Returns BaseGeometry | undefined

    • Get this fixture's config from the layer config with the given layer id Will return undefined if layer config did not specify a config for this fixture

      Parameters

      • layerId: string

        The layer's id

      Returns any

      This fixture's config for the given layer

    • Combines this fixtures configs from layer configs into an indexed-dictionary

      Returns { [layerId: string]: any }

      Dictionary where key is the layer id and the value is this fixture's config for that layer

    • If the panelTeleport property is provided, handle specified panelTeleport for the given fixture.

      Parameters

      • panels: string[]

        list of panel names for the calling fixture

      Returns void

    • If the panelWidth property is provided, handle default and specified panel widths for the given fixture.

      Parameters

      • panels: string[]

        list of panel names for the calling fixture

      Returns void

    • Imports one or more draw shapes from a draw-shape JSON object, a single shape record, an array of shape records, or a URL that resolves to one of those JSON payloads.

      Parameters

      Returns Promise<number>

      Number of valid shapes queued for import.

    • [Optional] Called after the core map logic has executed. If the fixture is added after the map initialization, this is called immediately.

      At this point, any custom content (panels, on-map components, etc.) can be added to R4MP. Custom content can also be added throughout the life of the [module].

      Returns void

      Fixture

    • Helper with programatically creating a component in Vue 3 (replaces the deprecated Vue.extend)

      Parameters

      • component: Component
      • props: any = {}

      Returns { destroy: () => void; el: any; vNode: any }

      FixtureInstance

    • Removes the specified fixture from R4MP instance. This is a proxy to rInstance.fixture.remove(...).

      Returns this

      FixtureInstance

    • Adds missing functions and properties to the object implementing FixtureBase interface. This is only needed for external fixtures as they can't inherit from FixtureInstance.

      TODO: If you know a better way to deep-mixin props/getters/functions from a class into another class instance, please tell me. I honestly don't know 🤷‍♂️.

      Parameters

      Returns FixtureInstance

      FixtureInstance