RAMP4 - v4.21.0
    Preparing search index...

    Class GeoAPI

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

    APIScope

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    $iApi attributes geom layer map proj query shared symbology

    Accessors

    $element $vApp proxy

    Constructors

    Properties

    $iApi: InstanceAPI

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

    APIScope

    attributes: AttributeAPI
    geom: GeometryAPI
    layer: LayerAPI
    map: MapAPI
    proj: ProjectionAPI
    query: QueryAPI
    shared: SharedUtilsAPI
    symbology: SymbologyAPI

    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 proxy(): string

      Read the current proxy setting, returns url string, empty string if no proxy

      Returns string

    • set proxy(proxyUrl: string): void

      Set a proxy service to allow consumption of cross-domain non-CORS resources.

      Parameters

      • proxyUrl: string

        Url to proxy or empty string to clear. Must be relative url on host domain, or full url to CORS supported server

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors