Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumerations

Interfaces

Type aliases

Variables

Functions

Type aliases

Bounds: [number, number, number, number]

A bounding box array

ClientKind: "mapagent" | "mapguide-rest"

The type of client

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

Valid command targets for an InvokeURL command

Coordinate2D: [number, number]

A 2d coordinate (renamed to Coordinate2D from Coordinate in 0.13)

Dictionary<T>: {}

Type alias for a dictionary-like structure

Type parameters

  • T

Type declaration

  • [key: string]: T
DigitizerCallback<T>: (geom: T) => void

Type parameters

  • T: olGeometry

Type declaration

    • (geom: T): void
    • Function signature for a digitization callback

      Parameters

      • geom: T

      Returns void

DispatcherFunc: (dispatch: ReduxDispatch, getState: () => Readonly<IApplicationState>, viewer?: IMapViewer, parameters?: any) => any

Type declaration

FlyoutVisibilitySet: {}

Defines the visibility of flyout menus

Type declaration

  • [flyoutId: string]: boolean | undefined
GenericEvent: any
GenericEventHandler: (e: GenericEvent) => void

Type declaration

IModalReducerState: {}

Type declaration

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

Valid image formats

LayerExtensions: IWmsLayerExtensions

Layer extension data

since

0.13

LayerTransparencySet: {}

A set of layer transpareny values by layer name

Type declaration

  • [layerName: string]: number
MapLoadIndicatorPositioning: "top" | "bottom"

The positioning of the map load indicator

ReducerFunction<TState>: (state: TState, action: ViewerAction) => TState

Type parameters

  • TState

Type declaration

    • Describes a redux reducer function

      Parameters

      Returns TState

ReduxDispatch: (action: ViewerAction | ReduxThunkedAction) => void

Type declaration

ReduxThunkedAction: (dispatch: ReduxDispatch, getState: () => Readonly<IApplicationState>) => any

Type declaration

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

The spatial operator to use for selection operations

Size: { h: number; w: number }

Defines a size

Type declaration

  • h: number
  • w: number
Size2: [number, number]

A size quantity

since

0.13

TemplateReducerFunction: (origState: ITemplateReducerState, currentState: ITemplateReducerState, action: ViewerAction) => ITemplateReducerState

Type declaration

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

Use UnitOfMeasure enum instead

Variables

BLANK_SIZE: Size = ...

The default blank size

DEFAULT_MODAL_POSITION: [number, number] = ...

The default modal dialog position

since

0.14.8

DEFAULT_MODAL_SIZE: [number, number] = ...

The default modal dialog size

KC_ESCAPE: 27 = 27

Keyboard code for ESCAPE

KC_U: 85 = 85

Keyboard code for the letter U

MG_BASE_LAYER_GROUP_NAME: "Base Tile Layers" = "Base Tile Layers"

The default group name for MapGuide tiled layers. This value is not meant for localized display

since

0.13

MG_LAYER_TYPE_NAME: "MapGuide" = "MapGuide"

The type name for a MapGuide layer

since

0.13

Functions

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

    export

    Returns boolean

    false

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

    export

    Returns boolean

    true

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

    export

    Returns void

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

    export

    Parameters

    Returns IMapView | undefined

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

    remarks

    This does not include "non-visual" base layers such as UTFGrid tilesets

    export
    since

    0.14.9 Removed includeNonVisual parameter

    Parameters

    Returns IExternalBaseLayer[] | undefined

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

    export

    Parameters

    Returns IMapView | undefined

  • Helper function to get the mapguide-specific sub state of the current map group

    export
    since

    0.14

    Parameters

    Returns IMapGuideSubState | undefined

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

    export

    Parameters

    Returns RuntimeMap | undefined

  • Determines if the given external base layer is one with a visual representation

    since

    0.14.9

    Parameters

    Returns boolean

Generated using TypeDoc