Class RequestBuilder

An abstract MapGuide service client

export
abstract
implements: {IMapGuideClient}

Hierarchy

RequestBuilder
- MapAgentRequestBuilder

Implements

IMapGuideClient

Index

Constructors

constructor

Properties

agentUri

Methods

Constructors

constructor

new RequestBuilder(agentUri: string): RequestBuilder

Parameters
- agentUri: string
Returns RequestBuilder

Properties

Protected agentUri

agentUri: string

Methods

Abstract createRuntimeMap

createRuntimeMap(options: ICreateRuntimeMapOptions): Promise<RuntimeMap>

Implementation of IMapGuideClient.createRuntimeMap

Creates a runtime map from the specified map definition

Parameters
- options: ICreateRuntimeMapOptions
Returns Promise<RuntimeMap>

Abstract createRuntimeMap_v4

createRuntimeMap_v4(options: ICreateRuntimeMapOptions): Promise<RuntimeMap>

Parameters
- options: ICreateRuntimeMapOptions
Returns Promise<RuntimeMap>

Abstract createSession

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

Implementation of IMapGuideClient.createSession

Creates a new MapGuide session

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

Abstract describeRuntimeMap

describeRuntimeMap(options: IDescribeRuntimeMapOptions): Promise<RuntimeMap>

Implementation of IMapGuideClient.describeRuntimeMap

Describes a runtime map

Parameters
- options: IDescribeRuntimeMapOptions
Returns Promise<RuntimeMap>

Abstract describeRuntimeMap_v4

describeRuntimeMap_v4(options: IDescribeRuntimeMapOptions): Promise<RuntimeMap>

Parameters
- options: IDescribeRuntimeMapOptions
Returns Promise<RuntimeMap>

Abstract getResource

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

Implementation of IMapGuideClient.getResource

Retrieves the requested resource

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

Abstract getServerSessionTimeout

getServerSessionTimeout(session: string): Promise<number>

Parameters
- session: string
Returns Promise<number>

Abstract getSiteVersion

getSiteVersion(): Promise<SiteVersionResponse>

Returns Promise<SiteVersionResponse>

Abstract getTileTemplateUrl

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

Implementation of IMapGuideClient.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

Abstract queryMapFeatures

queryMapFeatures(options: IQueryMapFeaturesOptions): Promise<QueryMapFeaturesResponse>

Implementation of IMapGuideClient.queryMapFeatures

Performs a map selection query on the current map

Parameters
- options: IQueryMapFeaturesOptions
Returns Promise<QueryMapFeaturesResponse>

Abstract queryMapFeatures_v4

queryMapFeatures_v4(options: IQueryMapFeaturesOptions): Promise<QueryMapFeaturesResponse>

Implementation of IMapGuideClient.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