Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "api/common"

Index

Type aliases

Bounds

Bounds: [number, number, number, number]

A bounding box array

ClientKind

ClientKind: "mapagent" | "mapguide-rest"

The type of client

CommandTarget

CommandTarget: "TaskPane" | "NewWindow" | "SpecifiedFrame"

Valid command targets for an InvokeURL command

Coordinate

Coordinate: [number, number]

A 2d coordinate

Dictionary

Dictionary: object

Type alias for a dictionary-like structure

Type declaration

  • [key: string]: T

DigitizerCallback

DigitizerCallback: function

Function signature for a digitization callback

Type declaration

    • (geom: T): void
    • Parameters

      • geom: T

      Returns void

DispatcherFunc

DispatcherFunc: function

Describes a function that is called when a command is invoked

Type declaration

FlyoutVisibilitySet

FlyoutVisibilitySet: object

Defines the visibility of flyout menus

Type declaration

  • [flyoutId: string]: boolean | undefined

GenericEvent

GenericEvent: any

GenericEventHandler

GenericEventHandler: function

Type declaration

IModalReducerState

IModalReducerState: object

Type declaration

IToolbarReducerState

IToolbarReducerState: any

ImageFormat

ImageFormat: "PNG" | "PNG8" | "JPG" | "GIF"

Valid image formats

LayerTransparencySet

LayerTransparencySet: object

Type declaration

  • [layerName: string]: number

MapLoadIndicatorPositioning

MapLoadIndicatorPositioning: "top" | "bottom"

ReducerFunction

ReducerFunction: function

Describes a redux reducer function

Type declaration

ReduxActionCreator

ReduxActionCreator: ReduxAction | ReduxThunkedAction | Action

Describes a redux action creator

ReduxDispatch

ReduxDispatch: Dispatch<any>

Describes a redux dispatcher function. A redux dispatch pushes new state to the redux store

ReduxThunkedAction

ReduxThunkedAction: function

Describes a thunked redux action. Thunked redux actions are generally used for actions that push state asynchronously (eg. In response to an AJAX request)

Type declaration

SelectionVariant

SelectionVariant: "INTERSECTS" | "TOUCHES" | "WITHIN" | "ENVELOPEINTERSECTS"

UnitName

UnitName: "Unknown" | "Inches" | "Feet" | "Yards" | "Miles" | "Nautical Miles" | "Millimeters" | "Centimeters" | "Meters" | "Kilometers" | "Degrees" | "Decimal Degrees" | "Degrees Minutes Seconds" | "Pixels"

Variables

Const DEFAULT_MODAL_SIZE

DEFAULT_MODAL_SIZE: [number, number] = [ 300, 500 ]

The default modal dialog size

Const KC_ESCAPE

KC_ESCAPE: 27 = 27

Const KC_U

KC_U: 85 = 85

Functions

ALWAYS_FALSE

  • ALWAYS_FALSE(): boolean
  • A function that always returns false

    export

    Returns boolean

    false

ALWAYS_TRUE

  • ALWAYS_TRUE(): boolean
  • A function that always returns true

    export

    Returns boolean

    true

NOOP

  • NOOP(): void
  • A function that does nothing

    export

    Returns void

getCurrentView

  • Helper function to get the current view from the application state

    export

    Parameters

    Returns IMapView | undefined

getExternalBaseLayers

  • Helper function to get the current set of available external base layers from the application state

    export

    Parameters

    Returns IExternalBaseLayer[] | undefined

getInitialView

  • Helper function to get the initial map view from the application state

    export

    Parameters

    Returns IMapView | undefined

getRuntimeMap

  • Helper function to get the current runtime map state from the application state

    export

    Parameters

    Returns RuntimeMap | undefined

getSelectionSet

Generated using TypeDoc