Class MapAgentRequestBuilder

The mapagent client

export

Hierarchy

RequestBuilder
- MapAgentRequestBuilder

Index

Constructors

constructor

Properties

agentUri

Methods

Constructors

constructor

new MapAgentRequestBuilder(agentUri: string, locale?: string): MapAgentRequestBuilder

Overrides RequestBuilder.constructor
Parameters
- agentUri: string
- locale: string = DEFAULT_LOCALE
Returns MapAgentRequestBuilder

Properties

Protected agentUri

agentUri: string

Methods

createRuntimeMap

createRuntimeMap(options: ICreateRuntimeMapOptions): Promise<RuntimeMap>

Overrides RequestBuilder.createRuntimeMap

Creates a runtime map from the specified map definition

Parameters
- options: ICreateRuntimeMapOptions
Returns Promise<RuntimeMap>

createRuntimeMap_v4

createRuntimeMap_v4(options: ICreateRuntimeMapOptions): Promise<RuntimeMap>

Overrides RequestBuilder.createRuntimeMap_v4
Parameters
- options: ICreateRuntimeMapOptions
Returns Promise<RuntimeMap>

createSession

createSession(username: string, password: string): Promise<string>

Overrides RequestBuilder.createSession

Creates a new MapGuide session

Parameters
- username: string
- password: string
Returns Promise<string>

describeRuntimeMap

describeRuntimeMap(options: IDescribeRuntimeMapOptions): Promise<RuntimeMap>

Overrides RequestBuilder.describeRuntimeMap

Describes a runtime map

Parameters
- options: IDescribeRuntimeMapOptions
Returns Promise<RuntimeMap>

describeRuntimeMap_v4

describeRuntimeMap_v4(options: IDescribeRuntimeMapOptions): Promise<RuntimeMap>

Overrides RequestBuilder.describeRuntimeMap_v4
Parameters
- options: IDescribeRuntimeMapOptions
Returns Promise<RuntimeMap>

get

get<T>(url: string): Promise<T>

Type parameters
- T
Parameters
- url: string
Returns Promise<T>

getResource

getResource<T>(resourceId: string, args?: any): Promise<T>

Overrides RequestBuilder.getResource

Retrieves the requested resource

Type parameters
- T: ResourceBase
Parameters
- resourceId: string
- Optional args: any
Returns Promise<T>

getServerSessionTimeout

getServerSessionTimeout(session: string): Promise<number>

Overrides RequestBuilder.getServerSessionTimeout
Parameters
- session: string
Returns Promise<number>

getSiteVersion

getSiteVersion(): Promise<SiteVersionResponse>

Overrides RequestBuilder.getSiteVersion
Returns Promise<SiteVersionResponse>

getTileTemplateUrl

getTileTemplateUrl(resourceId: string, groupName: string, xPlaceholder: string, yPlaceholder: string, zPlaceholder: string, isXYZ: boolean): string

Overrides RequestBuilder.getTileTemplateUrl

Gets the tile template URL used by the viewer to send tile requests

Parameters
- resourceId: string
- groupName: string
- xPlaceholder: string
- yPlaceholder: string
- zPlaceholder: string
- isXYZ: boolean
Returns string

post

post<T>(url: string, data: any): Promise<T>

Type parameters
- T
Parameters
- url: string
- data: any
Returns Promise<T>

queryMapFeatures

queryMapFeatures(options: IQueryMapFeaturesOptions): Promise<QueryMapFeaturesResponse>

Overrides RequestBuilder.queryMapFeatures

Performs a map selection query on the current map

Parameters
- options: IQueryMapFeaturesOptions
Returns Promise<QueryMapFeaturesResponse>

queryMapFeatures_v4

queryMapFeatures_v4(options: IQueryMapFeaturesOptions): Promise<QueryMapFeaturesResponse>

Overrides RequestBuilder.queryMapFeatures_v4

Performs a map selection query on the current map. Only applicable for use with MapGuide Open Source 4.0 and higher

Parameters
- options: IQueryMapFeaturesOptions
Returns Promise<QueryMapFeaturesResponse>

Generated using TypeDoc