Interface IMapGuideClient

Provides client services for a MapGuide map viewer

export
interface: IMapGuideClient

Hierarchy

IMapGuideClient

Implemented by

Index

Methods

Methods

createRuntimeMap

createRuntimeMap(options: ICreateRuntimeMapOptions): Promise<RuntimeMap>

Creates a runtime map from the specified map definition

abstract
Parameters
- options: ICreateRuntimeMapOptions
Returns Promise<RuntimeMap>

createSession

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

Creates a new MapGuide session

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

describeRuntimeMap

describeRuntimeMap(options: IDescribeRuntimeMapOptions): Promise<RuntimeMap>

Describes a runtime map

abstract
Parameters
- options: IDescribeRuntimeMapOptions
Returns Promise<RuntimeMap>

getResource

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

Retrieves the requested resource

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

getTileTemplateUrl

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

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

since
0.14.8 added isXYZ parameter

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

queryMapFeatures

queryMapFeatures(options: IQueryMapFeaturesOptions): Promise<QueryMapFeaturesResponse>

Performs a map selection query on the current map

abstract
Parameters
- options: IQueryMapFeaturesOptions
Returns Promise<QueryMapFeaturesResponse>

queryMapFeatures_v4

queryMapFeatures_v4(options: IQueryMapFeaturesOptions): Promise<QueryMapFeaturesResponse>

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

abstract
Parameters
- options: IQueryMapFeaturesOptions
Returns Promise<QueryMapFeaturesResponse>

Generated using TypeDoc