Class MapViewerContext

Provides contextual information for a map viewer

export

Hierarchy

MapViewerContext

Constructors

constructor

new MapViewerContext(map: olMap, callback: IMapViewerContextCallback, initTooltipEnabled: boolean): MapViewerContext

Parameters
- map: olMap
- callback: IMapViewerContextCallback
- initTooltipEnabled: boolean
Returns MapViewerContext

Accessors

isMouseOverTooltip

get isMouseOverTooltip(): boolean

Returns boolean

Methods

clearMouseTooltip

clearMouseTooltip(): void

Returns void

enableFeatureTooltips

enableFeatureTooltips(enabled: boolean): void

Parameters
- enabled: boolean
Returns void

getLayerSet

getLayerSet(name: string, bCreate?: boolean, props?: IMapViewerContextProps): MgLayerSet

Parameters
- name: string
- Default value bCreate: boolean = false
- Optional props: IMapViewerContextProps
Returns MgLayerSet

getOverviewMap

getOverviewMap(): olOverviewMap

Returns olOverviewMap

handleFeatureTooltipMouseMove

handleFeatureTooltipMouseMove(e: GenericEvent): void

Parameters
- e: GenericEvent
Returns void

handleMouseTooltipMouseMove

handleMouseTooltipMouseMove(e: GenericEvent): void

Parameters
- e: GenericEvent
Returns void

hideSelectedVectorFeaturesTooltip

hideSelectedVectorFeaturesTooltip(): void

Returns void

initContext

initContext(layerSet: MgLayerSet, locale?: undefined | string, overviewMapElementSelector?: undefined | function): void

Parameters
- layerSet: MgLayerSet
- Optional locale: undefined | string
- Optional overviewMapElementSelector: undefined | function
Returns void

initLayerSet

initLayerSet(props: IMapViewerContextProps): MgLayerSet

Parameters
- props: IMapViewerContextProps
Returns MgLayerSet

isFeatureTooltipEnabled

isFeatureTooltipEnabled(): boolean

Returns boolean

queryFeatureTooltip

queryFeatureTooltip(pixel: [number, number]): void

Parameters
- pixel: [number, number]
Returns void

queryWmsFeatures

queryWmsFeatures(map: olMap, layerMgr: ILayerManager, coord: Coordinate2D): void

Parameters
- map: olMap
- layerMgr: ILayerManager
- coord: Coordinate2D
Returns void

refreshMap

refreshMap(name: string, mode?: RefreshMode): void

Parameters
- name: string
- Default value mode: RefreshMode = RefreshMode.LayersOnly | RefreshMode.SelectionOnly
Returns void

refreshOnStateChange

refreshOnStateChange(map: RuntimeMap, showGroups: string[] | undefined, showLayers: string[] | undefined, hideGroups: string[] | undefined, hideLayers: string[] | undefined): void

Parameters
- map: RuntimeMap
- showGroups: string[] | undefined
- showLayers: string[] | undefined
- hideGroups: string[] | undefined
- hideLayers: string[] | undefined
Returns void

setMouseTooltip

setMouseTooltip(text: string): void

Parameters
- text: string
Returns void

showSelectedFeature

showSelectedFeature(mapExtent: Bounds, size: Size, map: RuntimeMap, selectionColor: string, featureXml: string | undefined): Promise<void>

Parameters
- mapExtent: Bounds
- size: Size
- map: RuntimeMap
- selectionColor: string
- featureXml: string | undefined
Returns Promise<void>

showSelectedVectorFeatures

showSelectedVectorFeatures(features: Collection<Feature>, pixel: [number, number], locale?: undefined | string): void

Parameters
- features: Collection<Feature>
- pixel: [number, number]
- Optional locale: undefined | string
Returns void

updateOverviewMapElement

updateOverviewMapElement(overviewMapElementSelector: function): void

Parameters
- overviewMapElementSelector: function
  - - (): null | Element
    - Returns null | Element
Returns void

Generated using TypeDoc