Options
All
  • Public
  • Public/Protected
  • All
Menu

This component installs a AJAX/Fusion viewer API compatibility layer when mounted allowing for existing script content to work against this viewer.

export
class

ViewerApiShim

extends

{React.Component<ViewerApiShimProps, any>}

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

Properties

context

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType.

static contextType = MyContext
context!: React.ContextType<typeof MyContext>
deprecated

if used without a type annotation, or without static contextType

see

https://reactjs.org/docs/legacy-context.html

props

props: Readonly<ViewerApiShimProps> & Readonly<object>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<any>

Static Optional contextType

contextType: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}
see

https://reactjs.org/docs/context.html#classcontexttype

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

DigitizeLine

  • DigitizeLine(handler: function): void

DigitizeLineString

  • DigitizeLineString(handler: function): void

DigitizePoint

  • DigitizePoint(handler: function): void

DigitizePolygon

  • DigitizePolygon(handler: function): void

DigitizeRectangle

  • DigitizeRectangle(handler: function): void

ExecuteMapAction

GetCenter

GetLayers

  • 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(): number
  • Returns number

GetMetersPerUnit

  • GetMetersPerUnit(): number | null
  • Returns number | null

GetScale

  • GetScale(): number | null
  • Returns number | null

GetSelectedBounds

GetSelectedCount

  • GetSelectedCount(): number
  • Returns number

GetSelectedFeatures

GetSelectedLayers

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

Refresh

  • Refresh(): void
  • Returns void

ScreenToMapUnits

SetEnglishUnits

  • SetEnglishUnits(usEnglish: boolean): void
  • Parameters

    • usEnglish: boolean

    Returns void

SetLatLongDisplayUnits

  • SetLatLongDisplayUnits(): void
  • Returns void

SetSelectionXML

  • SetSelectionXML(xmlSet: string): void
  • Parameters

    • xmlSet: string

    Returns void

SetStatusMsg

  • SetStatusMsg(msg: string): void
  • Parameters

    • msg: string

    Returns void

Submit

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

    • url: string
    • params: string[]
    • frameTarget: string

    Returns void

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

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

ZoomToScale

  • ZoomToScale(scale: number): void
  • Parameters

    • scale: number

    Returns void

ZoomToView

  • ZoomToView(x: number, y: number, scale: number): void
  • Parameters

    • x: number
    • y: number
    • scale: number

    Returns void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void
  • Returns void

componentDidUpdate

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<ViewerApiShimProps>, nextState: Readonly<any>, nextContext: any): 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

getFusionAPI

  • getFusionAPI(): any
  • Returns any

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<ViewerApiShimProps>, prevState: Readonly<any>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

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>(state: function | null | S | object, callback?: undefined | function): void
  • Type parameters

    • K: keyof any

    Parameters

    • state: function | null | S | object
    • Optional callback: undefined | function

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<ViewerApiShimProps>, nextState: Readonly<any>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    Returns boolean

triggerFusionEvent

  • triggerFusionEvent(eventID: number): void
  • Parameters

    • eventID: number

    Returns void

Generated using TypeDoc