Interface IMapGuideViewerSupport

MapGuide-specific viewer functionality

export
interface: IMapGuideViewerSupport
since: 0.14

Hierarchy

IMapGuideViewerSupport

Implemented by

MapGuideMapProviderContext

Index

Methods

Methods

clearSelection

clearSelection(): void

Clears the map selection

memberof
IMapViewer

Returns void

getSelection

getSelection(): null | QueryMapFeaturesResponse

Gets the current selection model

memberof
IMapViewer

Returns null | QueryMapFeaturesResponse

getSelectionXml

getSelectionXml(selection: FeatureSet, layerIds?: string[]): string

Gets the current selection model as a selection XML string

memberof
IMapViewer

Parameters
- selection: FeatureSet
- Optional layerIds: string[]
Returns string

getSessionId

getSessionId(): string

Gets the current session id

memberof
IMapViewer

Returns string

isFeatureTooltipEnabled

isFeatureTooltipEnabled(): boolean

Gets whether feature tooltips are enabled

memberof
IMapViewer

Returns boolean

queryMapFeatures

queryMapFeatures(options: IQueryMapFeaturesOptions, success?: (res: QueryMapFeaturesResponse) => void, failure?: (err: Error) => void): void

Performs a map selection by the given query options

memberof
IMapViewer

Parameters
- options: IQueryMapFeaturesOptions
- Optional success: (res: QueryMapFeaturesResponse) => void
  - - (res: QueryMapFeaturesResponse): void
    - Parameters
      - res: QueryMapFeaturesResponse
      Returns void
- Optional failure: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void

selectByGeometry

selectByGeometry(geom: Geometry, selectionMethod?: SelectionVariant): void

Performs a map selection by the given geometry

memberof
IMapViewer

Parameters
- geom: Geometry
  
  The geometry to select with
- Optional selectionMethod: SelectionVariant
  
  The selection method
Returns void

setFeatureTooltipEnabled

setFeatureTooltipEnabled(enabled: boolean): void

Enables/disables feature tooltips

memberof
IMapViewer

Parameters
- enabled: boolean
Returns void

setSelectionXml

setSelectionXml(xml: string, queryOpts?: Partial<IQueryMapFeaturesOptions>, success?: (res: QueryMapFeaturesResponse) => void, failure?: (err: Error) => void): void

Sets the selection XML

memberof
IMapViewer

Parameters
- xml: string
- Optional queryOpts: Partial<IQueryMapFeaturesOptions>
- Optional success: (res: QueryMapFeaturesResponse) => void
  - - (res: QueryMapFeaturesResponse): void
    - Parameters
      - res: QueryMapFeaturesResponse
      Returns void
- Optional failure: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void

Generated using TypeDoc