Class GeoAPI

constructor

• new GeoAPI(iApi: InstanceAPI): GeoAPI

  Parameters

  • iApi: InstanceAPI

    the RAMP instance

  Returns GeoAPI

attributes

geom

layer

map

proj

query

shared

symbology

proxy

• 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

getGeolocation

• getGeolocation(hideFailNotification?: boolean): Promise<GeolocationResult>

  Gets the geolocation of the user's browser. May prompt the user for permission. Will also emit event 'map/geolocate' when done.

  Parameters

  • OptionalhideFailNotification: boolean = false

    option to suppress a RAMP notification if the request fails

  Returns Promise<GeolocationResult>

  resolves with an object containing the these properties: - success (boolean) - coord (Point) location in lat lon if successful - error ('permission' | 'internal') if not successful, indicates if it's a permission problem or something else