RAMP4 - v4.21.0
    Preparing search index...

    A base class for anything requiring access to the InstanceApi and instance of Vue app controlled by it.

    APIScope

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

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

    APIScope

    layerCount: number = 0
    sublayerCount: number = 0

    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

    Methods

    • Get layer info from a file url or data

      Parameters

      • url: string

        a service url to load, name of file if file data is provided

      • fileType: LayerType

        format of the file (layer type)

      • OptionalfileData: ArrayBuffer

        raw file data buffer

      Returns Promise<LayerInfo | undefined>

      LayerInfo object

    • Get layer info from a service url

      Parameters

      • url: string

        a service url to load

      • serviceType: string

        type of layer

      • nested: boolean

        whether sublayers should be organized hierarchically

      • Optionalsignal: AbortSignal

        abort signal to cancel the request

      Returns Promise<LayerInfo | undefined>

      LayerInfo object