Options
All
  • Public
  • Public/Protected
  • All
Menu

ThirdPartyApp

Hierarchy

  • ThirdPartyApp

Implements

Index

Constructors

constructor

  • new ThirdPartyApp(id: string, initializeMap: function, getMapViewpointParams: function, handleViewerPositionUpdatedEvent: function, handleViewpointIndicatorUpdatedEvent: function, sync?: boolean, addViewpointIndicator?: boolean, handleCustomViewpointIndicatorUpdatedEvent?: function): ThirdPartyApp
  • Parameters

    • id: string
    • initializeMap: function
        • (): void
        • Returns void

    • getMapViewpointParams: function
    • handleViewerPositionUpdatedEvent: function
    • handleViewpointIndicatorUpdatedEvent: function
        • (arg: Point): void
        • Parameters

          • arg: Point

          Returns void

    • Default value sync: boolean = false
    • Default value addViewpointIndicator: boolean = false
    • Optional handleCustomViewpointIndicatorUpdatedEvent: function
        • (arg: object): void
        • Parameters

          • arg: object
            • geometry: Geometry
            • id: string

          Returns void

    Returns ThirdPartyApp

Properties

actionButtons

actionButtons: ActionButton[]

actionButtons

allowedOrigins

allowedOrigins: string[] = []

List of allowed origins for CORS.

bridge

bridge: any

The Bridge.

debounceInterval

debounceInterval: number = 500

debounceInterval

debounceTimer

debounceTimer: any = null

debounceTimer

getMapViewpointParams

getMapViewpointParams: function

Optional handleCustomViewpointIndicatorUpdatedEvent

handleCustomViewpointIndicatorUpdatedEvent: function

Type declaration

    • (arg: object): void
    • Parameters

      • arg: object
        • geometry: Geometry
        • id: string

      Returns void

handleViewerPositionUpdatedEvent

handleViewerPositionUpdatedEvent: function

Type declaration

handleViewpointIndicatorUpdatedEvent

handleViewpointIndicatorUpdatedEvent: function

Type declaration

    • (arg: Point): void
    • Parameters

      • arg: Point

      Returns void

id

id: string

id

ignoreNextPositionChange

ignoreNextPositionChange: boolean = false

ignoreNextPositionChange

initializeMap

initializeMap: function

Type declaration

    • (): void
    • Returns void

isDocked

isDocked: boolean = true

isDocked

scales

scales: number[] = [null,591657550.500000,295828775.300000,147914387.600000,73957193.820000,36978596.910000,18489298.450000,9244649.227000,4622324.614000,2311162.307000,1155581.153000,577790.576700,288895.288400,144447.644200,72223.822090,36111.911040,18055.955520,9027.977761,4513.988880,2256.994440,1128.497220]

The scale values to use when converting between a zoom level Based on http://webhelp.esri.com/arcgisserver/9.3/java/index.htm#designing_overlay_gm_mve.htm

statusOverlayElement

statusOverlayElement: HTMLElement

statusOverlayElement

sync

sync: boolean

sync

Methods

debouncedBroadcast

  • debouncedBroadcast(): void
  • Triggers a viewpoint updated message after being debounced.

    Returns void

disconnect

  • disconnect(): void
  • Disconnects the bridge when the window unloads

    Returns void

getActionButtonById

  • Get an action button by id.

    Parameters

    • id: string

    Returns ActionButton

getSavedState

  • getSavedState(): any
  • Get the saved state to store with the integration module. This state will be sent back to the thirdPartyMap when reloaded (like going from the frame to the open window and vice versa). This should be overwritten in the 3rd party map application.

    Returns any

handleClickCenter

  • handleClickCenter(): void
  • Called when the "center" button is clicked/tapped.

    Returns void

handleClickClose

  • handleClickClose(): void
  • Called when the "close" button clicked/tapped.

    Returns void

handleClickDock

  • handleClickDock(): void
  • Called when the "dock" button is clicked/tapped.

    Returns void

handleClickSync

  • handleClickSync(): void
  • Called when the "sync" button is clicked/tapped.

    Returns void

handleViewpointChanged

  • handleViewpointChanged(): void
  • Called whenever the viewpoint changes. Third-party map components should call this when their location is altered.

    Returns void

hideActionButton

  • Hides an action button from the action button panel

    Parameters

    Returns void

initializePane

  • initializePane(): void
  • Initializes this map's container.

    Returns void

initializeViewerBridge

  • initializeViewerBridge(): void
  • Initializes the "bridge" mechanism that allows communication with the viewer.

    Returns void

scaleToZoomLevel

  • scaleToZoomLevel(scale: number): number
  • Zoom to the given scale.

    Parameters

    • scale: number

    Returns number

setSavedState

  • setSavedState(savedState: any): void
  • Set the saved state. This is called when the component is initialized. This should be overwritten in the 3rd party map application.

    Parameters

    • savedState: any

    Returns void

showStatusOverlay

  • showStatusOverlay(showStatus: boolean): void
  • Updates the visibility of the status overlay

    Parameters

    • showStatus: boolean

    Returns void

supportsUndocking

  • supportsUndocking(): boolean
  • Checks whether undocking is supported for the current browser.

    Returns boolean

updateSync

  • updateSync(syncValue: boolean): void
  • Update the sync value for the 3rd party map and updates the button if available.

    Parameters

    • syncValue: boolean

    Returns void

zoomLevelToScale

  • zoomLevelToScale(zoom: number): number
  • Zoom to the given scale.

    Parameters

    • zoom: number

    Returns number