Class ViewerApiShim

Hierarchy

Component<ViewerApiShimProps, any>
- ViewerApiShim

Index

Constructors

constructor

Properties

Accessors

mapInit

Methods

Constructors

constructor

new ViewerApiShim(props: ViewerApiShimProps): ViewerApiShim

Parameters
- props: ViewerApiShimProps
Returns ViewerApiShim

Properties

context

context: any

props

props: Readonly<object> & Readonly<ViewerApiShimProps>

refs

refs: object

Type declaration

[key: string]: ReactInstance

state

state: Readonly<any>

Accessors

mapInit

get mapInit(): boolean

Indicates if the map frame is ready

Although this not part of the "public" API, most AJAX viewer examples test for this flag anyways, so we might as well emulate it here

Returns boolean

Methods

ClearSelection

ClearSelection(): void

Returns void

DigitizeCircle

DigitizeCircle(handler: function): void

Parameters
- handler: function
  - - (circle: IAjaxViewerCircle): void
    - Parameters
      - circle: IAjaxViewerCircle
      Returns void
Returns void

DigitizeLine

DigitizeLine(handler: function): void

Parameters
- handler: function
  - - (geom: AjaxViewerLineStringOrPolygon): void
    - Parameters
      - geom: AjaxViewerLineStringOrPolygon
      Returns void
Returns void

DigitizeLineString

DigitizeLineString(handler: function): void

Parameters
- handler: function
  - - (geom: AjaxViewerLineStringOrPolygon): void
    - Parameters
      - geom: AjaxViewerLineStringOrPolygon
      Returns void
Returns void

DigitizePoint

DigitizePoint(handler: function): void

Parameters
- handler: function
  - - (geom: IAjaxViewerPoint): void
    - Parameters
      - geom: IAjaxViewerPoint
      Returns void
Returns void

DigitizePolygon

DigitizePolygon(handler: function): void

Parameters
- handler: function
  - - (geom: AjaxViewerLineStringOrPolygon): void
    - Parameters
      - geom: AjaxViewerLineStringOrPolygon
      Returns void
Returns void

DigitizeRectangle

DigitizeRectangle(handler: function): void

Parameters
- handler: function
  - - (geom: IAjaxViewerRect): void
    - Parameters
      - geom: IAjaxViewerRect
      Returns void
Returns void

ExecuteMapAction

ExecuteMapAction(code: AjaxViewerMapActionCode.PanMode | AjaxViewerMapActionCode.PanUp | AjaxViewerMapActionCode.PanDown | AjaxViewerMapActionCode.PanRight | AjaxViewerMapActionCode.PanLeft | AjaxViewerMapActionCode.ZoomMode | AjaxViewerMapActionCode.ZoomIn | AjaxViewerMapActionCode.ZoomOut | AjaxViewerMapActionCode.ZoomRect | AjaxViewerMapActionCode.ZoomSelection | AjaxViewerMapActionCode.ZoomExtents | AjaxViewerMapActionCode.PrevView | AjaxViewerMapActionCode.NextView | AjaxViewerMapActionCode.InitialView | AjaxViewerMapActionCode.SelectionMode | AjaxViewerMapActionCode.SelectRadius | AjaxViewerMapActionCode.SelectPolygon | AjaxViewerMapActionCode.ClearSelection | AjaxViewerMapActionCode.RefreshMap | AjaxViewerMapActionCode.CopyMap | AjaxViewerMapActionCode.About): void

Parameters
- code: AjaxViewerMapActionCode.PanMode | AjaxViewerMapActionCode.PanUp | AjaxViewerMapActionCode.PanDown | AjaxViewerMapActionCode.PanRight | AjaxViewerMapActionCode.PanLeft | AjaxViewerMapActionCode.ZoomMode | AjaxViewerMapActionCode.ZoomIn | AjaxViewerMapActionCode.ZoomOut | AjaxViewerMapActionCode.ZoomRect | AjaxViewerMapActionCode.ZoomSelection | AjaxViewerMapActionCode.ZoomExtents | AjaxViewerMapActionCode.PrevView | AjaxViewerMapActionCode.NextView | AjaxViewerMapActionCode.InitialView | AjaxViewerMapActionCode.SelectionMode | AjaxViewerMapActionCode.SelectRadius | AjaxViewerMapActionCode.SelectPolygon | AjaxViewerMapActionCode.ClearSelection | AjaxViewerMapActionCode.RefreshMap | AjaxViewerMapActionCode.CopyMap | AjaxViewerMapActionCode.About
Returns void

GetCenter

GetCenter(): IAjaxViewerPoint | null

Returns IAjaxViewerPoint | null

GetLayers

GetLayers(onlyVisible: boolean, onlySelectable: boolean): IAjaxViewerLayer[]

Parameters
- onlyVisible: boolean
- onlySelectable: boolean
Returns IAjaxViewerLayer[]

GetMapHeight

GetMapHeight(): number

Returns number

GetMapName

GetMapName(): string | undefined

Returns string | undefined

GetMapUnitsType

GetMapUnitsType(): string

Returns string

GetMapWidth

GetMapWidth(): string

Returns string

GetMetersPerUnit

GetMetersPerUnit(): number | null

Returns number | null

GetScale

GetScale(): number | null

Returns number | null

GetSelectedBounds

GetSelectedBounds(): IAjaxViewerBounds | null

Returns IAjaxViewerBounds | null

GetSelectedCount

GetSelectedCount(): number

Returns number

GetSelectedFeatures

GetSelectedFeatures(): IAjaxViewerSelectionSet

Returns IAjaxViewerSelectionSet

GetSelectedLayers

GetSelectedLayers(): IAjaxViewerLayer[]

Returns IAjaxViewerLayer[]

GetSelectionXML

GetSelectionXML(): string

Returns string

GetSessionId

GetSessionId(): string | undefined

Returns string | undefined

IsDigitizing

IsDigitizing(): boolean

Returns boolean

IsEnglishUnits

IsEnglishUnits(): boolean

Returns boolean

IsLatLongDisplayUnits

IsLatLongDisplayUnits(): boolean

Returns boolean

MapUnitsToLatLon

MapUnitsToLatLon(x: number, y: number): IAjaxViewerPoint

Parameters
- x: number
- y: number
Returns IAjaxViewerPoint

Refresh

Refresh(): void

Returns void

ScreenToMapUnits

ScreenToMapUnits(x: number, y: number): IAjaxViewerPoint

Parameters
- x: number
- y: number
Returns IAjaxViewerPoint

SetEnglishUnits

SetEnglishUnits(usEnglish: boolean): void

Parameters
- usEnglish: boolean
Returns void

SetLatLongDisplayUnits

SetLatLongDisplayUnits(latLon: boolean): void

Parameters
- latLon: boolean
Returns void

SetSelectionXML

SetSelectionXML(xmlSet: string): void

Parameters
- xmlSet: string
Returns void

Submit

Submit(url: string, params: string[], frameTarget: string): void

Parameters
- url: string
- params: string[]
- frameTarget: string
Returns void

ZoomToScale

ZoomToScale(scale: number): void

Parameters
- scale: number
Returns void

ZoomToView

ZoomToView(x: number, y: number, scale: number, refresh: boolean): void

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

componentDidMount

componentDidMount(): void

Returns void

componentWillReceiveProps

componentWillReceiveProps(nextProps: ViewerApiShimProps): void

Parameters
- nextProps: ViewerApiShimProps
Returns void

deregisterForEvent

deregisterForEvent(eventID: number, callback: Function): void

Parameters
- eventID: number
- callback: Function
Returns void

forceUpdate

forceUpdate(callBack?: undefined | function): void

Parameters
- Optional callBack: undefined | function
Returns void

getClient

getClient(): Client | undefined

Returns Client | undefined

getFusionAPI

getFusionAPI(): any

Returns any

goHome

goHome(): void

Returns void

registerForEvent

registerForEvent(eventID: number, callback: Function): void

Parameters
- eventID: number
- callback: Function
Returns void

render

render(): Element

Returns Element

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: ViewerApiShimProps): Pick<any, K>
    - Parameters
      - prevState: any
      - props: ViewerApiShimProps
      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

triggerFusionEvent

triggerFusionEvent(eventID: number, ...args: any[]): void

Parameters
- eventID: number
- Rest ...args: any[]
Returns void

Static Optional componentDidMount

componentDidMount(): void

Returns void

Static Optional componentDidUpdate

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

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

Static Optional componentWillMount

componentWillMount(): void

Returns void

Static Optional componentWillReceiveProps

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

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

Static Optional componentWillUnmount

componentWillUnmount(): void

Returns void

Static Optional componentWillUpdate

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

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

Static Optional shouldComponentUpdate

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

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

Generated using TypeDoc