Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Layer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Constructor.

    Parameters

    • Default value map: Map = new Map()

      Reference to the MapLarge Map instance.

    • Default value opt: IMlUiLayerOptionsInterface = new LayerOptions()

      New Layer instance options.

    • Default value onLoad: function = null

      Called after the Leaflet API map is ready.

        • (): void
        • Returns void

    • Default value triggerCallback: string = null

      Used by UI components internally to tag Layer change events that they triggered with their changes.

    Returns Layer

Properties

APIManagerRequest

APIManagerRequest: any

actionHash

actionHash: string

Private allowDisplaySettingsPerRecord

allowDisplaySettingsPerRecord: boolean

animationchild

animationchild: any

api

api: any

bindableMap

bindableMap: Value<Map>

callbacks

callbacks: object

Type declaration

clickDashboard

clickDashboard: IDashboardOptions

clickPins

clickPins: any

clickPinsBindable

clickPinsBindable: Value<any>

clickTemplate

clickTemplate: string

createHoverImageMarker

createHoverImageMarker: zzCreateHoverImageMarker

Private dashboardCustomBooleans

dashboardCustomBooleans: Array<object>

dashboardScope

dashboardScope: IScope

Private debounceHoverImage

debounceHoverImage: number

debouncedLoadOpts

debouncedLoadOpts: any

Private debouncedLoadTimeout

debouncedLoadTimeout: any

deleted

deleted: boolean

drawings

drawings: any[]

dropdownGroup

dropdownGroup: number

Protected events

events: object

Type declaration

filterString

filterString: string

halt

halt: boolean

hoverDefault

hoverDefault: string

hoverDownShift

hoverDownShift: Value<number>

hoverFields

hoverFields: string[]

hoverImage

hoverImage: any

hoverLeftShift

hoverLeftShift: Value<number>

hoverPositionOffset

hoverPositionOffset: object

Type declaration

  • x: number
  • y: number

hoverSubFields

hoverSubFields: any[]

hoverTemplate

hoverTemplate: string

id

id: string

internalLayer

internalLayer: APILayer

isBaseLayer

isBaseLayer: boolean

isComposite

isComposite: any

isReady

isReady: boolean

isShowing

isShowing: boolean

lastEventLatLng

lastEventLatLng: object

Type declaration

  • lat: number
  • lng: number

lastHoverCount

lastHoverCount: number

lastHoverTM

lastHoverTM: number

lastMarker

lastMarker: any

Private lastPrepareRequestHoverGridId

lastPrepareRequestHoverGridId: string

Private layerHoverGrid

layerHoverGrid: LayerHoverGrid

layerString

layerString: string

legend

legend: any

linkedCharts

linkedCharts: any[]

listMax

listMax: any

map

map: Map

Reference to the MapLarge Map instance.

markSpotHTML

markSpotHTML: object

Type declaration

markerLayer

markerLayer: any

markers

markers: Array<any>

Private o

o: any

oldInternalLayer

oldInternalLayer: APILayer

onLoad

onLoad: function

Called after the Leaflet API map is ready.

Type declaration

    • (): void
    • Returns void

opacity

opacity: Value<string>

opt

New Layer instance options.

originalOptions

originalQuery

originalQuery: any

originalTableName

originalTableName: string

pending

pending: boolean

Private pendingTimeout

pendingTimeout: number

projection

projection: string

queryEscape

queryEscape: boolean

ready

ref

ref: any

reference

reference: Layer

Protected refreshInterval

refreshInterval: Interval

Private resizeBalloons

resizeBalloons: object

Type declaration

  • [latLng: string]: object
    • forceResize: function
      • forceResize(): void
      • Returns void

servers

servers: any[]

Private settingsDialogDefinition

settingsDialogDefinition: IControlDefinition<any>

shaderString

shaderString: string

showID

showID: number

source

source: TileSource

stackOrder

stackOrder: number

toggleId

toggleId: any

trackClick

trackClick: Value<boolean>

trackHover

trackHover: Value<boolean>

transform

transform: TransformLL

treatasvisible

treatasvisible: boolean

triggerCallback

triggerCallback: string

Used by UI components internally to tag Layer change events that they triggered with their changes.

Protected triggerTimeout

triggerTimeout: object

Type declaration

  • [key: string]: number

version

version: string

visible

visible: Value<boolean>

waitingOn

waitingOn: any

zIndex

zIndex: Value<string>

Private zzClickFunc

zzClickFunc: any

Private zzHoverFieldsCommaDel

zzHoverFieldsCommaDel: string

zzHoverFunc

zzHoverFunc: any

Private zzLastInfo

zzLastInfo: any

Private zzLastList

zzLastList: any

Private zzLastListInProcess

zzLastListInProcess: boolean

zzLastrowIndex

zzLastrowIndex: number

zzListFunc

zzListFunc: any

Private zzMoving

zzMoving: any

Private zzRandIncrement

zzRandIncrement: number

Private zzUniqueImgID

zzUniqueImgID: number

Methods

ZoomToEvent

  • ZoomToEvent(lat?: number, lng?: number, zoomToDialog?: boolean, event?: MouseEvent): void
  • Parameters

    • Optional lat: number
    • Optional lng: number
    • Optional zoomToDialog: boolean
    • Optional event: MouseEvent

    Returns void

Private _opacityChange

  • _opacityChange(value: any): void
  • Parameters

    • value: any

    Returns void

Protected _triggerEvents

addDrawings

  • addDrawings(): void
  • Returns void

addMarker

  • addMarker(ll: any, imgURL: any, opts: any): boolean
  • Parameters

    • ll: any
    • imgURL: any
    • opts: any

    Returns boolean

Private addPinnedPopup

  • addPinnedPopup(positionInfo: PinnedPopup, updateBindable?: boolean): void
  • Parameters

    • positionInfo: PinnedPopup
    • Default value updateBindable: boolean = true

    Returns void

Private assignLayerID

  • assignLayerID(): void
  • Returns void

Private clearDebounceHoverImage

  • clearDebounceHoverImage(): void
  • Returns void

clickIndex

  • clickIndex(index: any): void
  • Parameters

    • index: any

    Returns void

Protected configureRefresh

  • configureRefresh(): void
  • Returns void

Private createCustomBooleanControls

Private createDashboard

  • Parameters

    Returns void

Private createHoverImageMarkerImage

  • createHoverImageMarkerImage(params: LayerHoverParameters, zoom: number, rowIndex: number, dotLat: number, dotLng: number): void
  • Parameters

    Returns void

Private createHoverImageMarkerImageDebounced

  • createHoverImageMarkerImageDebounced(params: LayerHoverParameters, zoom: number, rowIndex: number, dotLat: number, dotLng: number): void
  • Parameters

    Returns void

Private createHoverUI

  • createHoverUI(params: LayerHoverParameters, map: Map, rowIndex: number, resolution: number, lat: number, lng: number, lngOffset: number, toolTipString: string, useLastMousePosition: boolean, debounceMarker: boolean): void
  • Parameters

    • params: LayerHoverParameters
    • map: Map
    • rowIndex: number
    • resolution: number
    • lat: number
    • lng: number
    • lngOffset: number
    • toolTipString: string
    • useLastMousePosition: boolean
    • debounceMarker: boolean

    Returns void

Private createToolbarWrapper

  • createToolbarWrapper(itemHtml: string | HTMLElement, scope: IScope): HTMLElement
  • Parameters

    • itemHtml: string | HTMLElement
    • scope: IScope

    Returns HTMLElement

debouncedLoad

  • debouncedLoad(json: any): void
  • Parameters

    • json: any

    Returns void

Private debugItemClickEvent

  • debugItemClickEvent(listItem: LayerListItem, innerHTML: string): void
  • Parameters

    Returns void

drawCanvas

  • drawCanvas(tileX: any, tileY: any, z: any, marker: any, canvas: any): any
  • Parameters

    • tileX: any
    • tileY: any
    • z: any
    • marker: any
    • canvas: any

    Returns any

fetchClickedShapeIndex

  • fetchClickedShapeIndex(lat: any, lng: any, zoom: any, callback: function): void
  • Parameters

    • lat: any
    • lng: any
    • zoom: any
    • callback: function
        • (response: any): void
        • Parameters

          • response: any

          Returns void

    Returns void

Private finalizeBalloonOpen

  • finalizeBalloonOpen(map: Map, itemHtml: string | HTMLElement, latLng: LatLng, scope?: IScope): void
  • Parameters

    • map: Map
    • itemHtml: string | HTMLElement
    • latLng: LatLng
    • Optional scope: IScope

    Returns void

Protected getDefaultVisibility

  • getDefaultVisibility(): any
  • Returns any

getHoverFields

  • getHoverFields(): string
  • Returns string

getIcon

  • getIcon(data: object, zoom: number): string
  • Parameters

    • data: object
      • index: any
    • zoom: number

    Returns string

getInternalLayer

  • getInternalLayer(): any
  • Returns any

getLayerExtents

  • getLayerExtents(): JQueryPromise<object>
  • Returns JQueryPromise<object>

getList

  • getList(bb: any, listMax: any, oneTimeCall?: any): void
  • Parameters

    • bb: any
    • listMax: any
    • Optional oneTimeCall: any

    Returns void

getTileURL

  • getTileURL(x: any, y: any, zoom: any): string
  • Parameters

    • x: any
    • y: any
    • zoom: any

    Returns string

getZIndex

  • getZIndex(): string
  • Returns string

Private handleHoverForAnimation

  • handleHoverForAnimation(params: LayerHoverParameters, isVisible: boolean, isTracking: boolean): boolean

Private handleHoverForDataObject

Private handleHoverForMarkerLayer

  • handleHoverForMarkerLayer(params: LayerHoverParameters, isVisible: boolean, isTracking: boolean): boolean

Private handleHoverForMouseover

Private handleHoverRowIndex

hide

  • hide(): void
  • Returns void

hoverIndex

  • hoverIndex(index: any, ignoreTemplate?: boolean, showOnRowIndexMatch?: boolean): void
  • Parameters

    • index: any
    • Default value ignoreTemplate: boolean = true
    • Default value showOnRowIndexMatch: boolean = false

    Returns void

Private initPins

  • initPins(): void
  • Returns void

Private isValidHoverCoordinate

  • isValidHoverCoordinate(latlng: number): boolean
  • Parameters

    • latlng: number

    Returns boolean

isWGS84Projection

  • isWGS84Projection(): boolean
  • Returns boolean

listAll

  • listAll(callback: Function, max?: number): void
  • Parameters

    • callback: Function
    • Optional max: number

    Returns void

load

  • Reconfigures a layer instance with a new layerJSON. This method must handle situations where it is called while already processing a previous request. When multiple calls to this method are made, we only process the latest (using debounce).

    Parameters

    • opt: IMlUiLayerOptionsInterface

      New layerJSON.

    • Default value newLayer: boolean = false

      Default is false, only set to true when called from the Layer.constructor method.

    • Default value triggerCallback: string = null

      Used by UI components internally to tag Layer change events that they triggered with their changes.

    • Optional onShowCallback: any

    Returns void

markSpot

  • markSpot(lat: any, lng: any, rowIndex: number): void
  • Parameters

    • lat: any
    • lng: any
    • rowIndex: number

    Returns void

off

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

    • event: string
    • id: string

    Returns boolean

oldOff

  • oldOff(evt: string, callback?: function): boolean
  • removes an event listener callback removes all callbacks for event if no callback provided

    Parameters

    • evt: string

      the event we want to remove

    • Optional callback: function

      the optional callback we want to remove for the given event

        • (): void
        • Returns void

    Returns boolean

oldOn

  • oldOn(evt: string, callback: function): function
  • adds an event listener/callback

    Parameters

    • evt: string

      the event we want to listen for

    • callback: function

      the callback to be fired when the event is triggered

        • (): void
        • Returns void

    Returns function

      • (): void
      • Returns void

oldTrigger

  • oldTrigger(evt: string, ...args: Array<any>): void
  • trigger an event

    Parameters

    • evt: string

      name of event to trigger

    • Rest ...args: Array<any>

      args to be applied to the callbacks for the given event

    Returns void

on

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

onReady

  • onReady(callback: function): void

positionBottom

  • positionBottom(): void
  • Returns void

private

Private querySourceTable

  • querySourceTable(query: any): string
  • Parameters

    • query: any

    Returns string

refresh

  • refresh(callback?: (Anonymous function), seconds?: number): boolean
  • Refresh the layer data, if a new table version has been uploaded.

    Parameters

    • Default value callback: (Anonymous function) = (response: LayerRefreshResponse) => { }

      Called when processing is complete returning a status, the Layer object and next table information object.

    • Optional seconds: number

      If null a single refresh will be performed. 0 will cancel any automatic refreshing. Non-zero will setup an automatic refreshing every X seconds.

    Returns boolean

remove

  • remove(quiet?: boolean, onRemoveCallback?: function, noCallInternalLayer?: boolean): void
  • Parameters

    • Default value quiet: boolean = false
    • Optional onRemoveCallback: function
        • (): void
        • Returns void

    • Optional noCallInternalLayer: boolean

    Returns void

removeDrawings

  • removeDrawings(): void
  • Returns void

removeLastMarker

  • removeLastMarker(): void
  • Returns void

Private removeLastMarkerAndTooltip

  • removeLastMarkerAndTooltip(): void
  • Returns void

removeLegend

  • removeLegend(): boolean
  • Returns boolean

Private removeMapTooltip

  • removeMapTooltip(): void
  • Returns void

Private removePinnedPopup

  • removePinnedPopup(latLng: LatLng, updateBindable?: boolean): void
  • Parameters

    • latLng: LatLng
    • Default value updateBindable: boolean = true

    Returns void

resetLastSeenHoverIndex

  • resetLastSeenHoverIndex(): void
  • Returns void

Private runNextLayerFunc

Private runNextLayersCleanupFunc

save

setClickPins

  • setClickPins(pins: any[]): void
  • Parameters

    • pins: any[]

    Returns void

setLegend

  • setLegend(title: string, scale: Scale, min: number, max: number): boolean
  • Parameters

    • title: string
    • scale: Scale
    • min: number
    • max: number

    Returns boolean

Private setPopupPosition

  • setPopupPosition(latLng: LatLng, newPosition: string): void
  • Parameters

    • latLng: LatLng
    • newPosition: string

    Returns void

setZIndex

  • setZIndex(i?: string): void
  • Parameters

    • Default value i: string = this.opt.zIndex

    Returns void

show

  • show(onShowCallback?: any): void
  • Parameters

    • Optional onShowCallback: any

    Returns void

sourceTable

  • sourceTable(): string
  • Returns string

switchLayers

  • switchLayers(idToToggleWith: any): void
  • Parameters

    • idToToggleWith: any

    Returns void

Protected testZoomVisibilityRule

  • testZoomVisibilityRule(zoom: number): void
  • Parameters

    • zoom: number

    Returns void

thumbnail

  • thumbnail(options: object): void
  • Parameters

    • options: object
      • callback: function
          • (response: object): void
          • Parameters

            • response: object
              • Optional data?: string

            Returns void

      • Optional format?: string
      • Optional height?: number
      • Optional preserveratio?: boolean
      • Optional width?: number

    Returns void

toggle

  • toggle(idToToggleWith: any): void
  • Parameters

    • idToToggleWith: any

    Returns void

toggleShowHide

  • toggleShowHide(): void
  • Returns void

triggerEvents

urlFunc

  • urlFunc(path: any, query: any): any
  • Parameters

    • path: any
    • query: any

    Returns any

zoomToExtents

  • zoomToExtents(): void
  • zoomToExtents(options?: zoomToExtentsOptions, callback?: function): void
  • zoomToExtents(maxZoom?: number, callback?: function): void
  • Returns void

  • Parameters

    Returns void

  • Parameters

    • Optional maxZoom: number
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

Private zzBaseUrl

  • zzBaseUrl(path: any, query: any): string
  • Parameters

    • path: any
    • query: any

    Returns string

zzBuildLayerHoverParameters

Private zzCreateHoverImageMarker

  • zzCreateHoverImageMarker(img: any, dotLat: any, dotLng: any, hoveredIndex?: boolean): void
  • Parameters

    • img: any
    • dotLat: any
    • dotLng: any
    • Optional hoveredIndex: boolean

    Returns void

Private zzDataToString

  • zzDataToString(data: any): string
  • Parameters

    • data: any

    Returns string

Private zzHide

  • zzHide(): void
  • Returns void

zzMapClicked

  • zzMapClicked(lat: any, lng: any, zoom: any, nextLayerFunc: any, nextLayerIndex: any): boolean
  • Parameters

    • lat: any
    • lng: any
    • zoom: any
    • nextLayerFunc: any
    • nextLayerIndex: any

    Returns boolean

Private zzMapClickedIndex

  • zzMapClickedIndex(index: any): void
  • Parameters

    • index: any

    Returns void

zzMapHover

zzMapHoverCleanup

  • zzMapHoverCleanup(): void
  • Returns void

zzMapHoverCursor

Private zzMapHoveredIndex

  • zzMapHoveredIndex(index: any, ignoreTemplate?: boolean, showOnRowIndexMatch?: boolean): void
  • Parameters

    • index: any
    • Default value ignoreTemplate: boolean = true
    • Default value showOnRowIndexMatch: boolean = false

    Returns void

zzPrepareHover

Private zzShow

  • zzShow(): void
  • Returns void

Private zzShowHide

  • zzShowHide(show: any): void
  • Parameters

    • show: any

    Returns void

Private zzShowWaiting

  • zzShowWaiting(): void
  • Returns void

Static createClickDashboardScope

Static getLayerByID

  • getLayerByID(map: Map, layerID: string): Layer | Boolean
  • Parameters

    • map: Map
    • layerID: string

    Returns Layer | Boolean

Generated using TypeDoc