Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MapGuideMapProviderContext

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _activeDrawInteraction

_activeDrawInteraction: null | Draw

Protected _busyWorkers

_busyWorkers: number

Protected _comp

_comp: undefined | IViewerComponent

Protected _layerSetGroups

_layerSetGroups: Dictionary<MgLayerSetGroup>

Protected _mouseTooltip

_mouseTooltip: undefined | MouseTrackingTooltip

Protected _ovMap

_ovMap: undefined | OverviewMap

Protected _select

_select: undefined | Select

Protected _selectTooltip

_selectTooltip: undefined | SelectedFeaturesTooltip

Protected _state

_state: IMapGuideProviderState

Protected _supportsTouch

_supportsTouch: boolean

Indicates if touch events are supported.

Protected _triggerZoomRequestOnMoveEnd

_triggerZoomRequestOnMoveEnd: boolean

Protected _zoomSelectBox

_zoomSelectBox: undefined | DragBox

mockMode

mockMode: undefined | MapGuideMockMode = undefined

Methods

addBaseTileLoadFunction

  • addBaseTileLoadFunction(mapName: string, layerName: string, func: LoadFunction): void

  • Adds a custom tile load function for a given base image tile layer.

    NOTE: Unlike other load function registrations this must be done before the viewer is mounted. New load functions added at runtime will not be recognized

    since

    0.14

    Parameters

    • mapName: string
    • layerName: string

      The base layer this function should apply for

    • func: LoadFunction

      The custom tile load function

    Returns void

addCustomSelectionPopupRenderer

Protected addFeatureToHighlight

  • addFeatureToHighlight(feat: undefined | OLFeature, bAppend: boolean): void

addHandler

  • addHandler(eventName: string, handler: Function): void

addImageLoadFunction

  • addImageLoadFunction(mapName: string, layerName: string, func: LoadFunction): void

  • Adds a custom image load function for a given overlay image layer

    since

    0.14

    Parameters

    • mapName: string
    • layerName: string

      The layer this function should apply for

    • func: LoadFunction

      The custom tile load function

    Returns void

addImageLoaded

  • addImageLoaded(): void

addImageLoading

  • addImageLoading(): void

addInteraction

  • addInteraction<T>(interaction: T): T

addOverlay

  • addOverlay(overlay: Overlay): void

addSubscribers

  • EXPERIMENTAL: Adds the given application state subscribers

    NOTE: Calling this method will trigger a re-render of the component. Due to this quirk, calling this method again while a re-render is taking place may cause the subscriber to not actually be registered. Calling this method multiple times in succession is therefore not advised. If you need to add multiple subscribers, pass an array of the subscribers to register in a single method call.

    Parameters

    Returns string[]

addTileLoadFunction

  • addTileLoadFunction(mapName: string, layerName: string, func: LoadFunction): void

  • Adds a custom tile load function for a given overlay image tile layer

    since

    0.14

    Parameters

    • mapName: string
    • layerName: string

      The layer this function should apply for

    • func: LoadFunction

      The custom tile load function

    Returns void

addWmsQueryAugmentation

Protected applyView

attachToComponent

cancelDigitization

  • cancelDigitization(): void

Protected clearMouseTooltip

  • clearMouseTooltip(): void

clearSelection

  • clearSelection(): void

decrementBusyWorker

  • decrementBusyWorker(): void

detachFromComponent

  • detachFromComponent(): void

digitizeCircle

digitizeLine

digitizeLineString

digitizePoint

digitizePolygon

digitizeRectangle

dismissToast

  • dismissToast(key: string): void

dispatch

  • dispatch(action: any): void

  • Dispatches the given action

    remarks

    Usage outside of the react component context (eg. Plain HTML Task Pane content) should be used sparingly. In particular you should avoid trying to call this method multiple times in succession. You should call this method once in response to a DOM element event (eg. A button click)

    Parameters

    • action: any

    Returns void

Protected ensureAndGetLayerSetGroup

exportImage

getActiveTool

Protected getBaseTileSourceLoaders

  • getBaseTileSourceLoaders(mapName: string): Dictionary<LoadFunction>

getCurrentExtent

getCurrentView

getDefaultLineStyle

getDefaultPointCircleStyle

getDefaultPointIconStyle

getDefaultPolygonStyle

getHookFunction

Protected getImageSourceLoaders

  • getImageSourceLoaders(mapName: string): Dictionary<LoadFunction>

Protected getInitialProviderState

getLayerManager

Protected getLayerManagerForLayerSet

getLayerSetGroup

getMapName

  • getMapName(): string

getMetersPerUnit

  • getMetersPerUnit(): number

Protected getMockMode

getOLFactory

getOLView

  • getOLView(): View

getPointSelectionBox

getProjection

  • getProjection(): ProjectionLike

getProviderName

  • getProviderName(): string

getResolution

  • getResolution(): undefined | number

Protected getScaleForExtent

  • getScaleForExtent(bounds: Bounds): number

getSelectedFeatures

  • getSelectedFeatures(): undefined | Collection<Feature<Geometry>>

  • Returns the collection of selected client-side vector features. This collection is observable, so you may hold onto a reference to this collection and subscribe to events on this collection for when new features are added or removed from this collection

    Returns undefined | Collection<Feature<Geometry>>

getSelection

getSelectionPopupRenderer

getSelectionXml

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

getSessionId

  • getSessionId(): string

getSize

getSubscribers

  • getSubscribers(): string[]

Protected getTileSourceLoaders

  • getTileSourceLoaders(mapName: string): Dictionary<LoadFunction>

getViewForExtent

getViewRotation

  • getViewRotation(): number

Protected handleHighlightHover

  • handleHighlightHover(e: any): void

Protected handleMouseTooltipMouseMove

  • handleMouseTooltipMouseMove(e: any): void

hideAllPopups

  • hideAllPopups(): void

Protected hideSelectedVectorFeaturesTooltip

  • hideSelectedVectorFeaturesTooltip(): void

incrementBusyWorker

  • incrementBusyWorker(): void

Protected initContext

  • initContext(layerSet: MgLayerSetGroup, locale?: string, overviewMapElementSelector?: () => null | Element): void

Protected initLayerSet

initialView

  • initialView(): void

isDigitizing

  • isDigitizing(): boolean

isFeatureTooltipEnabled

  • isFeatureTooltipEnabled(): boolean

isMouseOverTooltip

  • isMouseOverTooltip(): boolean

isReady

  • isReady(): boolean

isViewRotationEnabled

  • isViewRotationEnabled(): boolean

mapguideSupport

Protected onBeforeAttachingLayerSetGroup

Protected onImageError

  • onImageError(e: any): void

onKeyDown

  • onKeyDown(e: any): void

Protected onMapClick

  • onMapClick(e: MapBrowserEvent<any>): void

Protected onMouseMove

  • onMouseMove(e: any): void

Protected onProviderMapClick

  • onProviderMapClick(px: [number, number]): void

Protected onZoomSelectBox

  • onZoomSelectBox(e: any): void

Protected pushDrawInteraction

  • pushDrawInteraction<T>(digitizingType: string, draw: Draw, handler: DigitizerCallback<T>, prompt?: string): void

queryMapFeatures

Protected queryWmsFeatures

  • queryWmsFeatures(mapName: undefined | string, coord: Coordinate2D, bAppendMode: boolean): Promise<boolean>

refreshMap

Protected removeActiveDrawInteraction

  • removeActiveDrawInteraction(): void

removeHandler

  • removeHandler(eventName: string, handler: Function): void

removeInteraction

  • removeInteraction<T>(interaction: T): void

removeOverlay

  • removeOverlay(overlay: Overlay): void

removeSubscribers

  • removeSubscribers(names: string[]): boolean

resolutionToScale

  • resolutionToScale(resolution: number): number

scaleToResolution

  • scaleToResolution(scale: number): number

screenToMapUnits

  • screenToMapUnits(x: number, y: number): [number, number]

selectByGeometry

Protected selectFeaturesByExtent

  • selectFeaturesByExtent(geom: Polygon): void

setActiveTool

setFeatureTooltipEnabled

  • setFeatureTooltipEnabled(enabled: boolean): void

setMockMode

Protected setMouseTooltip

  • setMouseTooltip(text: string): void

setProviderState

setSelectionXml

setToasterRef

  • setToasterRef(ref: RefObject<Toaster>): void

setViewRotation

  • setViewRotation(rotation: number): void

setViewRotationEnabled

  • setViewRotationEnabled(enabled: boolean): void

Protected showSelectedVectorFeatures

  • showSelectedVectorFeatures(features: Collection<OLFeature>, pixel: [number, number], featureToLayerMap: [OLFeature, OLLayer][], locale?: string): void

toastError

  • toastError(iconName: string, message: string | Element): undefined | string

toastPrimary

  • toastPrimary(iconName: string, message: string | Element): undefined | string

toastSuccess

  • toastSuccess(iconName: string, message: string | Element): undefined | string

toastWarning

  • toastWarning(iconName: string, message: string | Element): undefined | string

updateOverviewMapElement

  • updateOverviewMapElement(overviewMapElementSelector: () => null | Element): void

updateSize

  • updateSize(): void

Protected zoomByDelta

  • zoomByDelta(delta: number): void

zoomDelta

  • zoomDelta(delta: number): void

zoomToExtent

  • zoomToExtent(extent: Bounds): void

zoomToView

  • zoomToView(x: number, y: number, scale: number): void

Generated using TypeDoc