Options
All
  • Public
  • Public/Protected
  • All
Menu

Module containers/hooks

Index

Functions

Functions

getActiveMapBranch

useActiveMapBranch

useActiveMapClientSelectionSet

useActiveMapExternalBaseLayers

  • Gets the current set of available external base layers

    since

    0.14 New required includeNonVisual parameter

    since

    0.14.9 Removed includeNonVisual parameter. Let the hook caller determine themselves if non-visual base layers should be omitted

    Returns undefined | IExternalBaseLayer[]

    The current set of available external base layers

useActiveMapHeight

  • useActiveMapHeight(): undefined | number

  • Returns undefined | number

useActiveMapInitialExternalLayers

useActiveMapInitialView

  • useActiveMapInitialView(): undefined | IMapView

useActiveMapLayers

useActiveMapName

  • useActiveMapName(): undefined | string

  • Returns undefined | string

useActiveMapSelectionSet

useActiveMapView

  • useActiveMapView(): undefined | IMapView

useActiveMapWidth

  • useActiveMapWidth(): undefined | number

  • Returns undefined | number

useAvailableMaps

useConfiguredAgentKind

useConfiguredAgentUri

  • useConfiguredAgentUri(): undefined | string

  • Returns undefined | string

useConfiguredCancelDigitizationKey

  • useConfiguredCancelDigitizationKey(): number

  • Returns number

useConfiguredCapabilities

useConfiguredCoordinateDecimals

  • useConfiguredCoordinateDecimals(): number

  • Returns number

useConfiguredCoordinateFormat

  • useConfiguredCoordinateFormat(): undefined | string

  • Returns undefined | string

useConfiguredCoordinateProjection

  • useConfiguredCoordinateProjection(): string

  • Returns string

useConfiguredLoadIndicatorColor

  • useConfiguredLoadIndicatorColor(): string

  • Returns string

useConfiguredLoadIndicatorPositioning

useConfiguredManualFeatureTooltips

  • useConfiguredManualFeatureTooltips(): boolean

  • Returns boolean

useConfiguredUndoLastPointKey

  • useConfiguredUndoLastPointKey(): number

  • Returns number

useCurrentMouseCoordinates

useCustomAppSettings

  • useCustomAppSettings(): undefined | Dictionary<string>

  • Gets custom app settings

    since

    0.14

    Returns undefined | Dictionary<string>

useInitError

useInitErrorOptions

  • useInitErrorOptions(): any

  • Returns any

useInitErrorStack

  • useInitErrorStack(): boolean

  • Returns boolean

useInitWarnings

  • useInitWarnings(): string[]

  • Returns string[]

useIsContextMenuOpen

  • useIsContextMenuOpen(): boolean

  • Returns boolean

useLastDispatchedAction

  • useLastDispatchedAction(): any

  • Returns any

usePrevious

  • usePrevious<T>(value: T): undefined | T

  • Type parameters

    • T

    Parameters

    • value: T

    Returns undefined | T

useReducedToolbarAppState

  • useReducedToolbarAppState(): { activeTool: ActiveMapTool; busyWorkerCount: number; featureTooltipsEnabled: boolean; hasClientSelection: boolean; hasNextView: boolean; hasPreviousView: boolean; hasSelection: boolean; stateless: boolean; visibleAndSelectableWmsLayerCount: number }

  • Returns { activeTool: ActiveMapTool; busyWorkerCount: number; featureTooltipsEnabled: boolean; hasClientSelection: boolean; hasNextView: boolean; hasPreviousView: boolean; hasSelection: boolean; stateless: boolean; visibleAndSelectableWmsLayerCount: number }

    • activeTool: ActiveMapTool
    • busyWorkerCount: number
    • featureTooltipsEnabled: boolean
    • hasClientSelection: boolean
    • hasNextView: boolean
    • hasPreviousView: boolean
    • hasSelection: boolean
    • stateless: boolean
      since

      0.14

    • visibleAndSelectableWmsLayerCount: number

useTaskPaneInitialUrl

  • useTaskPaneInitialUrl(): undefined | string

  • Returns undefined | string

useTaskPaneLastUrlPushed

  • useTaskPaneLastUrlPushed(): boolean

  • Returns boolean

useTaskPaneNavigationIndex

  • useTaskPaneNavigationIndex(): number

  • Returns number

useTaskPaneNavigationStack

  • useTaskPaneNavigationStack(): string[]

  • Returns string[]

useTemplateCustomData

  • useTemplateCustomData(key: string): any
  • since

    0.14.8

    Parameters

    • key: string

    Returns any

useTemplateInitialInfoPaneWidth

  • useTemplateInitialInfoPaneWidth(): number

  • Returns number

useTemplateInitialTaskPaneWidth

  • useTemplateInitialTaskPaneWidth(): number

  • Returns number

useTemplateLegendVisible

  • useTemplateLegendVisible(): boolean

  • Returns boolean

useTemplateSelectionVisible

  • useTemplateSelectionVisible(): boolean

  • Returns boolean

useTemplateTaskPaneVisible

  • useTemplateTaskPaneVisible(): boolean

  • Returns boolean

useViewerActiveFeatureSelectionColor

  • useViewerActiveFeatureSelectionColor(): string

  • Returns string

useViewerActiveTool

useViewerBusyCount

  • useViewerBusyCount(): number

  • Returns number

useViewerFeatureTooltipsEnabled

  • useViewerFeatureTooltipsEnabled(): boolean

  • Returns boolean

useViewerFlyouts

  • useViewerFlyouts(): any

  • Returns any

useViewerImageFormat

useViewerIsStateless

  • useViewerIsStateless(): boolean

  • Gets whether the viewer is in stateless mode

    since

    0.14

    Returns boolean

    true if the viewer is in stateless mode

useViewerLocale

  • useViewerLocale(): string

  • Returns string

useViewerPointSelectionBuffer

  • useViewerPointSelectionBuffer(): number

  • Returns number

useViewerSelectCanDragPan

  • useViewerSelectCanDragPan(): boolean
  • since

    0.14.2

    Returns boolean

useViewerSelectionColor

  • useViewerSelectionColor(): string

  • Returns string

useViewerSelectionImageFormat

useViewerSizeUnits

useViewerViewRotation

  • useViewerViewRotation(): number

  • Returns number

useViewerViewRotationEnabled

  • useViewerViewRotationEnabled(): boolean

  • Returns boolean

Generated using TypeDoc