Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "actions/map"

Index

Functions

addMapLayerBusyWorker

  • Adds a busy worker for the given external layer for the given map

    export
    since

    0.13

    Parameters

    • mapName: string
    • layerName: string

    Returns IAddMapLayerBusyWorkerAction

invokeCommand

mapLayerAdded

  • NOTE: Dispatching this action does not add the layer to the map. This is a means to notify others that a new layer has been added. It is expected to be dispatched by any component that is managing layers

    export
    since

    0.13

    Parameters

    Returns IAddedLayerAction

mapResized

  • Sends a map resized notification

    export

    Parameters

    • width: number
    • height: number

    Returns IMapResizedAction

nextView

  • Goes to the next view on the navigation stack

    export

    Parameters

    • mapName: string

      The name of the current runtime amp

    Returns IMapNextViewAction

previousView

  • Goes back to the previous view on the navigation stack

    export

    Parameters

    • mapName: string

      The name of the current runtime map

    Returns IMapPreviousViewAction

queryMapFeatures

removeMapLayer

  • Removes a given external layer for the given map

    export
    since

    0.13

    Parameters

    • mapName: string
    • layerName: string

    Returns IRemoveLayerAction

removeMapLayerBusyWorker

  • Removes a busy worker for the given external layer for the given map

    export
    since

    0.13

    Parameters

    • mapName: string
    • layerName: string

    Returns IRemoveMapLayerBusyWorkerAction

setActiveMap

  • Sets the active runtime map

    export

    Parameters

    • mapName: string

      The name of the runtime map to set as active

    Returns ISetActiveMapAction

setActiveTool

setBaseLayer

  • Set the given external base layer as the active base layer

    export

    Parameters

    • mapName: string

      The name of the current runtime map

    • layerName: string

      The name of the external base layer to set as active

    Returns IMapSetBaseLayerAction

setBusyCount

  • Sets the busy count of the viewer. A value greater than zero signifies that the viewer is currently busy performing various actions (eg. Loading/Rendering the current map image)

    export

    Parameters

    • busyCount: number

      The current busy count

    Returns IMapSetBusyCountAction

setCurrentView

  • Sets the current map view.

    NOTE: Subscribing components are not guaranteed to receive every new view change sent by calling this method. For purposes of optimization, views passed in that are "close enough" to the current view are not dispatched to subscribing components.

    export

    Parameters

    Returns ReduxThunkedAction

setFeatureTooltipsEnabled

setLayerTransparency

  • Set the transparency for the given OL layer

    export

    Parameters

    • mapName: string

      The name of the current runtime map

    • layerName: string

      The name of the OL layer

    • opacity: number

      A value between 0 and 1. 1 - Fully Opaque, 0 - Fully Transparent

    Returns IMapSetLayerTransparencyAction

setManualFeatureTooltipsEnabled

setMapLayerIndex

  • Sets the display order index for the given external layer for the given map

    export
    since

    0.13

    Parameters

    • mapName: string
    • layerName: string
    • index: number

    Returns ISetLayerIndexAction

setMapLayerOpacity

  • Sets the opacity for the given external layer for the given map

    export
    since

    0.13

    Parameters

    • mapName: string
    • layerName: string
    • opacity: number

    Returns ISetLayerOpacityAction

setMapLayerVectorStyle

setMapLayerVisibility

  • Sets the visibility for the given external layer for the given map

    export
    since

    0.13

    Parameters

    • mapName: string
    • layerName: string
    • visible: boolean

    Returns ISetLayerVisibilityAction

setMouseCoordinates

  • Sets the current mouse coordinates

    export

    Parameters

    • mapName: string

      The name of the current runtime map

    • coord: any

      The current mouse coordinates

    Returns IMapSetMouseCoordinatesAction

setScale

  • Sets the view scale

    export

    Parameters

    • mapName: string

      The name of the current runtime map

    • scale: number

      The scale to set

    Returns IMapSetScaleAction

setSelection

  • Sets the selection set for the given map

    export

    Parameters

    • mapName: string

      The name of the current runtime map

    • selectionSet: any

      The selection set to apply

    Returns IMapSetSelectionAction

setViewRotation

setViewRotationEnabled

setViewSizeUnits

showSelectedFeature

  • Shows the selected feature on the map

    export

    Parameters

    • mapName: string
    • layerId: string
    • selectionKey: string

    Returns IShowSelectedFeatureAction

Generated using TypeDoc