Class MapAPI

Hierarchy

APIBase
- MapAPI

Constructors

constructor

new MapAPI(apiClient: APIClient, options: ClientOptions): MapAPI
Parameters
- apiClient: APIClient
- options: ClientOptions
Returns MapAPI
Overrides APIBase.constructor
- Defined in api/MapAPI.ts:22

Properties

`Protected` `Readonly`apiClient

apiClient: APIClient

`Protected` `Readonly`options

options: ClientOptions

Methods

getBounds

getBounds(): Promise<Bounds>
/bounds/ returns the maximum bounds of the map

Returns Promise<Bounds>
- Defined in api/MapAPI.ts:27

getLegend

getLegend(themeId: string | number): Promise<MapLegend>
Parameters
- themeId: string | number
Returns Promise<MapLegend>
- Defined in api/MapAPI.ts:33

getLoad

getLoad(): Promise<Record<string, number>>
Returns Promise<Record<string, number>>
- Defined in api/MapAPI.ts:39

getLocation

getLocation(
idOrSlug: string | number,
options?: MapLocationOptions,
): Promise<Location>
Parameters
- idOrSlug: string | number
- options: MapLocationOptions = {}
Returns Promise<Location>
- Defined in api/MapAPI.ts:45

getLocationDisplay

getLocationDisplay(idOrSlug: string | number): Promise<LocationDetails>
Parameters
- idOrSlug: string | number
Returns Promise<LocationDetails>
- Defined in api/MapAPI.ts:63

getLocationGeometry

getLocationGeometry(idOrSlug: string | number): Promise<LocationGeometry>
Parameters
- idOrSlug: string | number
Returns Promise<LocationGeometry>
- Defined in api/MapAPI.ts:72

getLocations

getLocations(options?: MapLocationQueryOptions): Promise<Location[]>
Parameters
- options: MapLocationQueryOptions = {}
Returns Promise<Location[]>
- Defined in api/MapAPI.ts:81

getLocationsFull

getLocationsFull(options?: MapLocationQueryOptions): Promise<Location[]>
Parameters
- options: MapLocationQueryOptions = {}
Returns Promise<Location[]>
- Defined in api/MapAPI.ts:96

getMyPositions

getMyPositions(): Promise<Position[]>
Returns Promise<Position[]>
- Defined in api/MapAPI.ts:111

getPositionById

getPositionById(positionId: string | number): Promise<Position>
Parameters
- positionId: string | number
Returns Promise<Position>
- Defined in api/MapAPI.ts:117

getProjection

getProjection(): Promise<Projection>
Returns Promise<Projection>
- Defined in api/MapAPI.ts:123

getQuests

getQuests(questType?: string, level?: number): Promise<Quest[]>
Parameters
- OptionalquestType: string
- Optionallevel: number
Returns Promise<Quest[]>
- Defined in api/MapAPI.ts:129

getSettings

getSettings(): Promise<MapSettings>
Returns Promise<MapSettings>
- Defined in api/MapAPI.ts:144

getWifiData

getWifiData(): Promise<Record<string, unknown>>
Returns Promise<Record<string, unknown>>
- Defined in api/MapAPI.ts:150

setApiUrl

setApiUrl(newURL: string): void
Set a new API URL.
Parameters
- newURL: string
  The new API url
Returns void
Inherited from APIBase.setApiUrl
- Defined in api/APIBase.ts:18

setPosition

setPosition(
    positionId: string | number,
    coordinatesId: string | null,
    timeout?: number | null,
): Promise<Position>
Parameters
- positionId: string | number
- coordinatesId: string | null
- Optionaltimeout: number | null
Returns Promise<Position>
- Defined in api/MapAPI.ts:156

updateLoad

updateLoad(aps: Record<string, number>): Promise<void>
Parameters
- aps: Record<string, number>
Returns Promise<void>
- Defined in api/MapAPI.ts:169