Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Map

Hierarchy

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

  • new Map(googleMap?: Map, mapOptions?: iMapOptions): Map
  • new Map(parentElement?: HTMLElement, mapOptions?: iMapOptions, existingMap?: Map, internalOnly?: boolean): Map
  • new Map(parentElementId?: string, mapOptions?: iMapOptions, existingMap?: Map, internalOnly?: boolean): Map

Properties

Optional MapOrParentElement

MapOrParentElement: any

active

active: boolean

api

api: Value<string>

apiKO

apiKO: KnockoutObservable<string>

balloon

balloon: any

callbacks

callbacks: object

Type declaration

center

center: any

compositeLayer

compositeLayer: CompositeLayer

debug

debug: boolean

disableHoverClickEvents

disableHoverClickEvents: boolean

disabled

disabled: boolean

draggable

draggable: boolean

drawingEditingEnabled

drawingEditingEnabled: any

Private drawingGroups

drawingGroups: object

Type declaration

Private drawingToolbar

drawingToolbar: DrawingToolbar

drawingToolsHidden

drawingToolsHidden: any

drawings

drawings: any[]

Optional existingMap

existingMap: any

hasExternalLayer

hasExternalLayer: boolean

hullLayer

hullLayer: Layer

Optional internalOnly

internalOnly: boolean

isMouseHovering

isMouseHovering: KnockoutObservable<boolean>

koLayers

koLayers: KnockoutObservableArray<Layer>

Take advantage of KnockoutJS to assist with events for Map.layers

Private koLayersSubscription

koLayersSubscription: KnockoutSubscription

Private lastHoverUniqueId

lastHoverUniqueId: string

lastMouseHoverParams

lastMouseHoverParams: KnockoutObservable<MouseHoverParameters>

Private lastPrepareRequestId

lastPrepareRequestId: string

layers

layers: Layer[]

mapDrawingInterface

mapDrawingInterface: any

mapId

mapId: string

mapIndex

mapIndex: number

Key of this Map object within ml.ui.map.allcreated[].

mapOptions

mapOptions: iMapOptions

mapeditor

mapeditor: MapEditor

markerLayer

markerLayer: Layer

markers

markers: any[]

mlhidetiptimeout

mlhidetiptimeout: any

moving

moving: any

onInternalMapAvailableCallbacks

onInternalMapAvailableCallbacks: function

Type declaration

    • (): void
    • Returns void

outerDiv

outerDiv: Element

parentElement

parentElement: HTMLElement

pendingLayer

pendingLayer: Layer

pointLayer

pointLayer: Layer

prevMapObject

prevMapObject: Map

Previous Map class object if the map has been Regenerated().

projection

projection: string

reference

reference: Map

Private rightClickAuxSemaphore

rightClickAuxSemaphore: number

searchBox

searchBox: any

toolTip

toolTip: any

Protected triggerTimeout

triggerTimeout: object

Type declaration

  • [key: string]: number

zoom

zoom: Value<number>

Private zzClickListners

zzClickListners: any[]

zzLastHoverMarker

zzLastHoverMarker: any

zzLayerLastHover

zzLayerLastHover: Layer

zzMap

zzMapDiv

zzMapDiv: Element

Private zzOnSearchResult

zzOnSearchResult: Function

zzSearchBoxCallback

zzSearchBoxCallback: any

Methods

Protected _triggerEvents

  • _triggerEvents(event: string, value: iMapOptions): void

addClickListner

  • addClickListner(func: any): void
  • Parameters

    • func: any

    Returns void

addControl

  • Provides an API-agnostic interface for adding controls to the map

    Parameters

    Returns void

addDrawing

  • addDrawing(json: any, callback?: (Anonymous function)): this
  • adds a single drawing to the map via json

    Parameters

    • json: any

      json representation of a drawing to add to the map

    • Default value callback: (Anonymous function) = (drawing?: IDrawing) => { }

      optional callback triggered with drawing svg object

    Returns this

    this map object for method chaining

addDrawings

  • addDrawings(drawings: any): void
  • Parameters

    • drawings: any

    Returns void

addLayer

  • addLayer(layer: any): void
  • Parameters

    • layer: any

    Returns void

addMarker

  • addMarker(ll: LatLng, htmlOrDiv?: any, onClick?: Function, keepMarker?: boolean): any
  • Parameters

    • ll: LatLng
    • Optional htmlOrDiv: any
    • Optional onClick: Function
    • Default value keepMarker: boolean = false

    Returns any

Private appendOuterDiv

  • appendOuterDiv(parent: any): void
  • Parameters

    • parent: any

    Returns void

Private buildMenu

  • buildMenu(curLayer: Layer, response: any, tableInfo: StoredTable, canGeoCode: boolean, canFilter: boolean, canEdit: boolean, canDriveTime: boolean, ll: LatLng, e?: LeafletMouseEvent): void
  • Parameters

    • curLayer: Layer
    • response: any
    • tableInfo: StoredTable
    • canGeoCode: boolean
    • canFilter: boolean
    • canEdit: boolean
    • canDriveTime: boolean
    • ll: LatLng
    • Optional e: LeafletMouseEvent

    Returns void

cancelDelayHideTooltip

  • cancelDelayHideTooltip(): void
  • Returns void

cancelEvents

  • cancelEvents(disable?: boolean): void
  • Parameters

    • Default value disable: boolean = false

    Returns void

clearAllLayers

  • clearAllLayers(): void
  • Returns void

clearAllMarkers

  • clearAllMarkers(force?: boolean): void
  • Parameters

    • Default value force: boolean = false

    Returns void

clearClickListners

  • clearClickListners(): void
  • Returns void

click

  • click(ll: any, ignoreMotion?: any, zoom?: number): void
  • Parameters

    • ll: any
    • Optional ignoreMotion: any
    • Optional zoom: number

    Returns void

closeBalloon

  • closeBalloon(): this
  • Returns this

createMarker

  • createMarker(ll: any, opts: any): any
  • Parameters

    • ll: any
    • opts: any

    Returns any

createSearchBox

  • createSearchBox(): void
  • Returns void

Private debugItemClickEvent

  • debugItemClickEvent(layerId: string, innerHTML: string): void
  • Parameters

    • layerId: string
    • innerHTML: string

    Returns void

Private delayHideTooltip

  • delayHideTooltip(): void
  • Returns void

deleteShape

destroyAllAnimationLayers

  • destroyAllAnimationLayers(): void
  • Returns void

destroyAllLayers

  • destroyAllLayers(): void
  • Returns void

destroyAllNonAnimationLayers

  • destroyAllNonAnimationLayers(): void
  • Returns void

disableDrawing

  • disableDrawing(): this
  • Returns this

disableDrawingEditing

  • disableDrawingEditing(): this
  • Returns this

disableTooltip

  • disableTooltip(): void
  • Returns void

draw

  • draw(): void
  • Returns void

Private driveTime

  • Parameters

    Returns void

editShape

enableDrawing

  • enableDrawing(opts?: object): this
  • Parameters

    • Optional opts: object
      • Optional hideCallback?: function
          • (): void
          • Returns void

    Returns this

enableDrawingEditing

  • enableDrawingEditing(): this
  • Returns this

enableTooltip

  • enableTooltip(): void
  • Returns void

Private filterLayersOnRightClick

  • filterLayersOnRightClick(r: any, topLayer: Layer): void
  • Parameters

    Returns void

getDrawingGroup

getDrawingManager

  • getDrawingManager(): any
  • returns the DrawingManager for the map assumes MapDrawingInterface has been set

    Returns any

    DrawingManager object for the map

getDrawings

  • getDrawings(): any
  • Returns any

getDrawingsAsJSON

  • getDrawingsAsJSON(): any
  • Returns any

getHighestZIndex

  • getHighestZIndex(): number
  • Returns number

getInternalMap

  • getInternalMap(): any
  • Returns any

getLayerById

  • getLayerById(layerId: string): Layer
  • finds map layer by id, returns layer if it exists, otherwise null

    Parameters

    • layerId: string

      the numeric id of the layer to search for

    Returns Layer

getLayers

getMDI

  • getMDI(): any
  • Returns any

getMapDrawingInterface

  • getMapDrawingInterface(): any
  • sets a map drawing interface if not present and returns it

    Returns any

    MapDrawingInterface for the map

getNextZIndex

  • getNextZIndex(): number
  • Returns number

Private getParentElement

  • getParentElement(elementReference: any): HTMLElement
  • Parameters

    • elementReference: any

    Returns HTMLElement

getResolution

  • getResolution(lat?: number, zoom?: number): number
  • Parameters

    • Optional lat: number
    • Optional zoom: number

    Returns number

getSortedActionHashes

  • getSortedActionHashes(onlyVisible?: boolean): Array<any>
  • Parameters

    • Default value onlyVisible: boolean = false

    Returns Array<any>

getTopLayer

getVisibleBB

getVisibleLayers

  • getVisibleLayers(excludeExternal?: boolean): Layer[]
  • Parameters

    • Default value excludeExternal: boolean = false

    Returns Layer[]

handleMouseLeave

  • handleMouseLeave(): void
  • Returns void

hideDrawingTools

  • hideDrawingTools(): this
  • Returns this

hideLoadingIndicator

  • hideLoadingIndicator(): void
  • Returns void

hover

  • hover(ll: LatLng, ignoreMotion?: any, e?: any, mapTile?: MapTile): void
  • Parameters

    • ll: LatLng
    • Optional ignoreMotion: any
    • Optional e: any
    • Optional mapTile: MapTile

    Returns void

Private initCompositeLayer

Protected initMapOpenLayers

  • initMapOpenLayers(callback?: function): void
  • Parameters

    • Optional callback: function

    Returns void

invalidateSize

  • invalidateSize(): void
  • Returns void

Private isLayerDrawing

  • isLayerDrawing(id: string): boolean
  • Parameters

    • id: string

    Returns boolean

isWGS84Projection

  • isWGS84Projection(): boolean
  • Returns boolean

layerHide

  • layerHide(layer: any): void
  • Parameters

    • layer: any

    Returns void

layerOrder

  • layerOrder(showLayer?: any): void
  • Parameters

    • Optional showLayer: any

    Returns void

load

mapHasShapeLayer

  • mapHasShapeLayer(): boolean
  • Returns boolean

notifyCompositLayer

  • notifyCompositLayer(): void
  • Returns void

off

  • off(event: string, id: string): boolean
  • Parameters

    • event: string
    • id: string

    Returns boolean

on

  • on(event: string, callback: function): string

Protected onDrawToZoomClick

  • onDrawToZoomClick(): void
  • Returns void

onInternalMapAvailable

  • onInternalMapAvailable(callback: function): void
  • Parameters

    • callback: function
        • (): void
        • Returns void

    Returns void

Private onIsMouseHoveringChanged

  • onIsMouseHoveringChanged(newValue: boolean): void
  • Parameters

    • newValue: boolean

    Returns void

openBalloon

  • openBalloon(latLng: any, html: any, debug?: any, options?: any): this
  • Parameters

    • latLng: any
    • html: any
    • Optional debug: any
    • Optional options: any

    Returns this

openDrawingMaskingEditor

  • openDrawingMaskingEditor(drawingSvg: Drawing): void
  • opens the drawing masking editor for a given drawing assumes MapDrawingInterface set and DrawingManager present

    Parameters

    • drawingSvg: Drawing

      the drawing for which we want a masking editor

    Returns void

openDrawingNavigator

  • openDrawingNavigator(): void
  • opens the drawing navigator for the map assumes MapDrawingInterface set and DrawingManager present

    Returns void

Private prepareHoverBound

printBounds

  • printBounds(o?: object): string
  • Parameters

    • Optional o: object
      • Optional bounds?: LatLngBB
      • Optional layerOnly?: boolean
      • Optional magnify?: number
      • Optional zoom?: number

    Returns string

refresh

  • refresh(): void
  • Returns void

removeAllDrawings

  • removeAllDrawings(): this
  • removes all drawings from the map

    Returns this

    this map object for method chaining

removeDrawing

  • removeDrawing(d: any): this
  • removes a single drawing from the map via drawing object or ID

    Parameters

    • d: any

      drawing instance or drawing ID

    Returns this

    this map object for method chaining

removeLayerLastHover

  • removeLayerLastHover(): Layer

removeMarker

  • removeMarker(marker: any): void
  • Parameters

    • marker: any

    Returns void

reorderLayersByZindex

  • reorderLayersByZindex(returnLayers?: boolean): Array<Layer>
  • Parameters

    • Optional returnLayers: boolean

    Returns Array<Layer>

Private reverseGeocode

  • reverseGeocode(ll: LatLng): void
  • Parameters

    Returns void

rightClick

  • rightClick(ll: LatLng, e?: LeafletMouseEvent): void
  • Parameters

    • ll: LatLng
    • Optional e: LeafletMouseEvent

    Returns void

rightClickAux

  • rightClickAux(layers: Layer[], idx: number, canGeoCode: boolean, canDriveTime: boolean, ll: LatLng, e?: LeafletMouseEvent): void
  • Parameters

    • layers: Layer[]
    • idx: number
    • canGeoCode: boolean
    • canDriveTime: boolean
    • ll: LatLng
    • Optional e: LeafletMouseEvent

    Returns void

save

setBounds

  • Parameters

    • sw: any
    • ne: any
    • Default value maxZoom: number = null
    • Default value minZoom: number = null
    • Optional options: mluiMapApiSetBoundsOptions

    Returns void

setDraggable

  • setDraggable(bool: any): void
  • Parameters

    • bool: any

    Returns void

setMapDrawingInterface

  • setMapDrawingInterface(): boolean
  • Returns boolean

showDrawingTools

  • showDrawingTools(opt?: object): this
  • Parameters

    • Optional opt: object
      • Optional hideCallback?: function
          • (): void
          • Returns void

    Returns this

showLoadingIndicator

  • showLoadingIndicator(): void
  • Returns void

topLayerIsShape

  • topLayerIsShape(): boolean
  • Returns boolean

triggerEvents

  • triggerEvents(event: string, value: iMapOptions): void

triggerOnInternalMapAvailableCallbacks

  • triggerOnInternalMapAvailableCallbacks(): void
  • Returns void

unload

  • unload(): void
  • Returns void

updateAllLayersZIndex

  • updateAllLayersZIndex(): void
  • Returns void

updateBaseLayer

  • updateBaseLayer(externalService: iLayerService): any
  • updateBaseLayer(baseLayer: string): any
  • updateBaseLayer(baseLayerOrExternalService: string | iLayerService): any
  • Parameters

    Returns any

  • Parameters

    • baseLayer: string

    Returns any

  • Parameters

    Returns any

Private visible

  • visible(): void
  • Returns void

zoomToBoundingBox

  • zoomToBoundingBox(boundBox: string, maxZoom?: number): void
  • Parameters

    • boundBox: string
    • Default value maxZoom: number = null

    Returns void

zoomToExtents

  • zoomToExtents(): void
  • zoomToExtents(vizLayers?: Layer[], maxZoom?: number): void
  • zoomToExtents(options?: zoomToExtentsOptions): void
  • Returns void

  • Parameters

    • Optional vizLayers: Layer[]
    • Optional maxZoom: number

    Returns void

  • Parameters

    Returns void

Private zzApiChange

  • zzApiChange(value: any): void
  • Parameters

    • value: any

    Returns void

Private zzClick

  • zzClick(ll: any, index: any, ignoreMovement: any, zoom: number): void
  • Parameters

    • ll: any
    • index: any
    • ignoreMovement: any
    • zoom: number

    Returns void

Private zzCreateMarkerESRI

  • zzCreateMarkerESRI(options: any): void
  • Parameters

    • options: any

    Returns void

Private zzDisableTooltip

  • zzDisableTooltip(): void
  • Returns void

Private zzHover

  • zzHover(baseParameters: MapHoverParameters, index: any, uniqueHoverId: string, ignoreMovement?: boolean): void
  • Parameters

    • baseParameters: MapHoverParameters
    • index: any
    • uniqueHoverId: string
    • Optional ignoreMovement: boolean

    Returns void

Private zzHoverCursor

Private zzHoverLayerCleanup

  • zzHoverLayerCleanup(layers: Layer[], nextLayerIndex: number): void
  • Parameters

    • layers: Layer[]
    • nextLayerIndex: number

    Returns void

Private zzMapInit

  • zzMapInit(callback?: function, googleMap?: Map): void
  • PRIVATE METHHODS

    Parameters

    • Optional callback: function
    • Optional googleMap: Map

    Returns void

Private zzPrepareHovers

  • Parameters

    Returns void

Private zzSetMapCenter

  • zzSetMapCenter(ll: any): void
  • Parameters

    • ll: any

    Returns void

Private zzSetZoom

  • zzSetZoom(zoom: any): void
  • Parameters

    • zoom: any

    Returns void

Object literals

index

index: object

DisplayOrder

DisplayOrder: Array<undefined>

StackOrder

StackOrder: Array<undefined>

Visible

Visible: Array<undefined>

ZOrder

ZOrder: Array<undefined>

Static drawToZoom

drawToZoom: object

util methods for draw to zoom buttons / functionality could also move into separate object/file, made sense as static attribute on Map

getDrawingOptions

  • getDrawingOptions(): object
  • Returns object

    default drawing options used for draw to zoom drawing

    • attributes: object
      • fill: string
      • stroke: string
      • stroke-dasharray: string
      • stroke-opacity: number
      • stroke-width: number

getIconHTML

  • getIconHTML(): string
  • Returns string

    markup used for draw to zoom buttons

getTitle

  • getTitle(): string
  • Returns string

    string used as title attribute on draw to zoom buttons

Generated using TypeDoc