Class MapViewerContainer

Hierarchy

Component<MapViewerContainerProps, any>
- MapViewerContainer

Implements

IMapViewer

Index

Constructors

constructor

Properties

Methods

Object literals

contextTypes

Constructors

constructor

new MapViewerContainer(props: MapViewerContainerProps): MapViewerContainer

Parameters
- props: MapViewerContainerProps
Returns MapViewerContainer

Properties

context

context: any

props

props: Readonly<object> & Readonly<MapViewerContainerProps>

refs

refs: object

Type declaration

[key: string]: ReactInstance

state

state: Readonly<any>

Methods

addHandler

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

Parameters
- eventName: string
- handler: Function
Returns void

addInteraction

addInteraction<T>(interaction: T): T

Type parameters
- T: Interaction
Parameters
- interaction: T
Returns T

addLayer

addLayer<T>(name: string, layer: T): T

Type parameters
- T: Base
Parameters
- name: string
- layer: T
Returns T

addOverlay

addOverlay(overlay: Overlay): void

Parameters
- overlay: Overlay
Returns void

cancelDigitization

cancelDigitization(): void

Returns void

clearSelection

clearSelection(): void

Returns void

componentDidMount

componentDidMount(): void

Returns void

componentWillReceiveProps

componentWillReceiveProps(nextProps: MapViewerContainerProps): void

Parameters
- nextProps: MapViewerContainerProps
Returns void

digitizeCircle

digitizeCircle(handler: DigitizerCallback<Circle>, prompt?: undefined | string): void

Parameters
- handler: DigitizerCallback<Circle>
- Optional prompt: undefined | string
Returns void

digitizeLine

digitizeLine(handler: DigitizerCallback<LineString>, prompt?: undefined | string): void

Parameters
- handler: DigitizerCallback<LineString>
- Optional prompt: undefined | string
Returns void

digitizeLineString

digitizeLineString(handler: DigitizerCallback<LineString>, prompt?: undefined | string): void

Parameters
- handler: DigitizerCallback<LineString>
- Optional prompt: undefined | string
Returns void

digitizePoint

digitizePoint(handler: DigitizerCallback<Point>, prompt?: undefined | string): void

Parameters
- handler: DigitizerCallback<Point>
- Optional prompt: undefined | string
Returns void

digitizePolygon

digitizePolygon(handler: DigitizerCallback<Polygon>, prompt?: undefined | string): void

Parameters
- handler: DigitizerCallback<Polygon>
- Optional prompt: undefined | string
Returns void

digitizeRectangle

digitizeRectangle(handler: DigitizerCallback<Polygon>, prompt?: undefined | string): void

Parameters
- handler: DigitizerCallback<Polygon>
- Optional prompt: undefined | string
Returns void

forceUpdate

forceUpdate(callBack?: undefined | function): void

Parameters
- Optional callBack: undefined | function
Returns void

getActiveTool

getActiveTool(): ActiveMapTool.Zoom | ActiveMapTool.Select | ActiveMapTool.Pan | ActiveMapTool.None

Returns ActiveMapTool.Zoom | ActiveMapTool.Select | ActiveMapTool.Pan | ActiveMapTool.None

getCurrentExtent

getCurrentExtent(): Bounds

Returns Bounds

getCurrentView

getCurrentView(): IMapView

Returns IMapView

getLayer

getLayer<T>(name: string, factory: function): T

Type parameters
- T: Base
Parameters
- name: string
- factory: function
  - - (): T
    - Returns T
Returns T

getMetersPerUnit

getMetersPerUnit(): number

Returns number

getOLFactory

getOLFactory(): IOLFactory

Returns IOLFactory

getProjection

getProjection(): ol.ProjectionLike

Returns ol.ProjectionLike

getResolution

getResolution(): number

Returns number

getSelection

getSelection(): QueryMapFeaturesResponse | null

Returns QueryMapFeaturesResponse | null

getSelectionXml

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

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

getSize

getSize(): [number, number]

Returns [number, number]

getViewForExtent

getViewForExtent(extent: Bounds): IMapView

Parameters
- extent: Bounds
Returns IMapView

hasLayer

hasLayer(name: string): boolean

Parameters
- name: string
Returns boolean

initialView

initialView(): void

Returns void

isDigitizing

isDigitizing(): boolean

Returns boolean

isFeatureTooltipEnabled

isFeatureTooltipEnabled(): boolean

Returns boolean

queryMapFeatures

queryMapFeatures(options: IQueryMapFeaturesOptions, success?: undefined | function, failure?: undefined | function): void

Parameters
- options: IQueryMapFeaturesOptions
- Optional success: undefined | function
- Optional failure: undefined | function
Returns void

refreshMap

refreshMap(mode?: RefreshMode): void

Parameters
- Optional mode: RefreshMode
Returns void

removeHandler

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

Parameters
- eventName: string
- handler: Function
Returns void

removeInteraction

removeInteraction<T>(interaction: T): void

Type parameters
- T: Interaction
Parameters
- interaction: T
Returns void

removeLayer

removeLayer(name: string): Base | undefined

Parameters
- name: string
Returns Base | undefined

removeOverlay

removeOverlay(overlay: Overlay): void

Parameters
- overlay: Overlay
Returns void

render

render(): Element

Returns Element

scaleToResolution

scaleToResolution(scale: number): number

Parameters
- scale: number
Returns number

selectByGeometry

selectByGeometry(geom: Geometry): void

Parameters
- geom: Geometry
Returns void

setActiveTool

setActiveTool(tool: ActiveMapTool.Zoom | ActiveMapTool.Select | ActiveMapTool.Pan | ActiveMapTool.None): void

Parameters
- tool: ActiveMapTool.Zoom | ActiveMapTool.Select | ActiveMapTool.Pan | ActiveMapTool.None
Returns void

setFeatureTooltipEnabled

setFeatureTooltipEnabled(enabled: boolean): void

Parameters
- enabled: boolean
Returns void

setSelectionXml

setSelectionXml(xml: string, queryOpts?: IQueryMapFeaturesOptions, success?: undefined | function, failure?: undefined | function): void

Parameters
- xml: string
- Optional queryOpts: IQueryMapFeaturesOptions
- Optional success: undefined | function
- Optional failure: undefined | function
Returns void

setState

setState<K>(f: function, callback?: undefined | function): void
setState<K>(state: Pick<any, K>, callback?: undefined | function): void

Type parameters
- K: keyof S
Parameters
- f: function
  - - (prevState: any, props: MapViewerContainerProps): Pick<any, K>
    - Parameters
      - prevState: any
      - props: MapViewerContainerProps
      Returns Pick<any, K>
- Optional callback: undefined | function
Returns void
Type parameters
- K: keyof S
Parameters
- state: Pick<any, K>
- Optional callback: undefined | function
Returns void

zoomDelta

zoomDelta(delta: number): void

Parameters
- delta: number
Returns void

zoomToExtent

zoomToExtent(extent: Bounds): void

Parameters
- extent: Bounds
Returns void

zoomToView

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

Parameters
- x: number
- y: number
- scale: number
Returns void

Static Optional componentDidMount

componentDidMount(): void

Returns void

Static Optional componentDidUpdate

componentDidUpdate(prevProps: Readonly<MapViewerContainerProps>, prevState: Readonly<any>, prevContext: any): void

Parameters
- prevProps: Readonly<MapViewerContainerProps>
- prevState: Readonly<any>
- prevContext: any
Returns void

Static Optional componentWillMount

componentWillMount(): void

Returns void

Static Optional componentWillReceiveProps

componentWillReceiveProps(nextProps: Readonly<MapViewerContainerProps>, nextContext: any): void

Parameters
- nextProps: Readonly<MapViewerContainerProps>
- nextContext: any
Returns void

Static Optional componentWillUnmount

componentWillUnmount(): void

Returns void

Static Optional componentWillUpdate

componentWillUpdate(nextProps: Readonly<MapViewerContainerProps>, nextState: Readonly<any>, nextContext: any): void

Parameters
- nextProps: Readonly<MapViewerContainerProps>
- nextState: Readonly<any>
- nextContext: any
Returns void

Static Optional shouldComponentUpdate

shouldComponentUpdate(nextProps: Readonly<MapViewerContainerProps>, nextState: Readonly<any>, nextContext: any): boolean

Parameters
- nextProps: Readonly<MapViewerContainerProps>
- nextState: Readonly<any>
- nextContext: any
Returns boolean

Object literals

Static contextTypes

contextTypes: object

store

store: Requireable<any> = PropTypes.object

Generated using TypeDoc