Home Reference Source Repository
import LayerItsInventory from 'webmapsjs/src/layers/LayerItsInventory.js'
public class | source

LayerItsInventory

Extends:

LayerBaseLayerBaseVectorLayerBaseVectorGeoJson → LayerItsInventory

Its Layer class

Constructor Summary

Public Constructor
public

constructor(options: object)

ITS device layer, types available at http://transportal.cee.wisc.edu/its/inventory/

Method Summary

Public Methods
public

mapMoveMakeGetParams(extent: object, zoomLevel: number)

callback to generate the parameters passed in the get request

Inherited Summary

From class LayerBase
public get

get the legend content

public get

Check if the layer is loaded

public get

get the maximum resolution

public get

get max zoom

public get

get the minimum resolution

public get

get min zoom

public get

Get the layer name

public set

name(newName: string): *

set the layer name

public get

olLayer: ol.layer.Base | undefined: *

public get

Get the layer opacity

public set

opacity(opacity: number): *

Set the layer opacity

public get

get the map get params

public get

source: *

get the layer source

public get

get the url

public get

Get the layer visibility

public set

visible(visibility: boolean): *

Set the layer visibility

public get

get the z index

public set

zIndex(newZ: number): *

set the z index

protected set

legendContent(newVal: string): *

set the legend content directly

protected set

params(newParams: object): *

set the map get params

public
public

id: *

public
protected
public

addLegendContent(additionalContent: string)

add additional content to the legend

public
public

Get the legend html, be sure to only add to the DOM once

public

trick to refresh the layer

protected

base load function, sets _loaded = true if it is not already

From class LayerBaseVector
public get

get if the layer is autoloaded

public get

features: Array<ol.Feature>

array of ol features

public get

mapCrs: string | *

get the map CRS if it is defined by the map move object

public get

get the map move object

public get

map move params

public get

olLayer: ol.layer | Vector | ol.layer.Base | undefined: *

public get

get on demand delay in miliseconds

public get

source: ol.source.Vector

get the layer vector source

public get

style: ol.Style | styleFunc

get the style definition

public set

style(style: ol.Style | styleFunc): *

set the style

public get

Get the layer visibility

public set

Set the layer visibility

public

addFeatures(featureCollection: object)

dummy to be overridden

public

clear()

clear features in the layer

public

mapMoveBefore(zoom: number, evtType: string): boolean

Before call to map move callback, can prevent call by returning false

public

callback function on map move

public

mapMoveMakeGetParams(extent: object, zoomLevel: number)

callback to generate the parameters passed in the get request

From class LayerBaseVectorGeoJson
public

addFeatures(featureCollection: object)

add feature collection

public

callback function on map move

protected

trigger load features

Public Constructors

public constructor(options: object) source

ITS device layer, types available at http://transportal.cee.wisc.edu/its/inventory/

Override:

LayerBaseVectorGeoJson#constructor

Params:

NameTypeAttributeDescription
options object

config

options.id string
  • optional

layer id

options.name string
  • optional
  • default: Unnamed

Layer] - layer name

options.opacity number
  • optional
  • default: 1

opacity

options.visible boolean
  • optional
  • default: true

default visible

options.minZoom number
  • optional
  • default: undefined

min zoom level, 0 - 28

options.maxZoom number
  • optional
  • default: undefined

max zoom level, 0 - 28

options.params object
  • optional
  • default: {}

the get parameters to include to retrieve the layer

options.zIndex number
  • optional
  • default: 0

the z index for the layer

options.loadCallback function
  • optional

function to call on load, context this is the layer object

options.legendCollapse boolean
  • optional
  • default: false

if the legend item should be initially collapsed

options.legendCheckbox boolean
  • optional
  • default: true

if the legend item should have a checkbox for visibility

options.legendContent boolean
  • optional

additional content to add to the legend

options.autoLoad boolean
  • optional
  • default: false

if the layer should auto load if not visible

options.style object | *
  • optional
  • default: undefined

the layer style, use openlayers default style if not defined

options.onDemand boolean
  • optional
  • default: false

if the layer should be loaded by extent on map move

options.onDemandDelay number
  • optional
  • default: 300

delay before the map move callback should be called

options.mapMoveObj MapMoveCls
  • optional
  • default: mapMove

alternate map move object for use with multi map pages

options.itsType string

the ITS device type, use the url flag at http://transportal.cee.wisc.edu/its/inventory/

options.addPopup boolean
  • optional
  • default: true

if the popup should be added automatically

options.itsIcon string
  • optional
  • default: undefined

the ITS device type icon image see http://transportal.cee.wisc.edu/its/inventory/icons/

options.itsLineStyle object
  • optional
  • default: undefined

A single line style

options.itsLineStyle.color string

the line color as rgb or hex

options.itsLineStyle.width number
  • optional
  • default: 5

the line width

options.itsIconConfig object
  • optional
  • default: undefined

The icon subtype configuration

options.itsIconConfig.prop string

The property used to define icon attribute symbolization

options.itsIconConfig.defaultName string

The default name to be used if no other match is found

options.itsIconConfig.defaultIcon string

The default icon to be used for no other matches

options.itsIconConfig.iconArray object
  • optional
  • default: []

an array, items with format [property, name, img]

options.itsLineConfig object
  • optional
  • default: undefined

The property used to define icon attribute symbolization

options.itsLineConfig.prop string

The property used to define icon attribute symbolization

options.itsLineConfig.defaultName string
  • optional
  • default: Other

The default name to be used if no other match is found

options.itsLineConfig.defaultColor string
  • optional
  • default: red

The default line color to be used for no other matches

options.itsLineConfig.defaultWidth number
  • optional

The default line width to be used for no other matches

options.itsLineConfig.lineArray object
  • optional
  • default: []

an array, items with format [property, name, color, optional width = 5]

Public Methods

public mapMoveMakeGetParams(extent: object, zoomLevel: number) source

callback to generate the parameters passed in the get request

Override:

LayerBaseVector#mapMoveMakeGetParams

Params:

NameTypeAttributeDescription
extent object

extent object

extent.minX number

minX

extent.minY number

minY

extent.maxX number

maxX

extent.maxY number

maxY

zoomLevel number

zoom level