Class: LegendModel

Extends

• Core.ModelList.Tool

Methods

changeLang(lng){Void}

modules/legend/model.js, line 1095

change language - sets default values for the language

Name	Type	Description
lng	String	the language changed to

colorToRgb(color){string}

modules/legend/model.js, line 1054

Returns a rgb color string that can be interpreted in SVG.

Name	Type	Description
color	Array.<integer>	color set in style

Returns:

color

copyOtherParamsStyleWMS(nameOfLayerToExclude){Array}

modules/legend/model.js, line 109

todo

Name	Type	Description
nameOfLayerToExclude	*	todo

Returns:

paramsStyleWMS

createCircleSVG(style){string}

modules/legend/model.js, line 965

Creates an SVG for a circle

Name	Type	Description
style	vectorStyle	feature styles

createCircleSVGOld(style){string}

modules/legend/model.js, line 594

Creates an SVG for a circle

Name	Type	Description
style	vectorStyle	feature styles

Deprecated

• with new vectorStyle module

createImageSVG(style){string}

modules/legend/model.js, line 576

Creates an SVG with embedded image

Name	Type	Description
style	vectorStyle	feature styles

createLineSVG(style){string}

modules/legend/model.js, line 995

Creates an SVG for a line

Name	Type	Description
style	vectorStyle	feature styles

createLineSVGOld(style){string}

modules/legend/model.js, line 625

Creates an SVG for a line

Name	Type	Description
style	vectorStyle	feature styles

Deprecated

• with new vectorStyle module

createPolygonSVG(style){string}

modules/legend/model.js, line 1024

Creates an SVG for a polygon

Name	Type	Description
style	vectorStyle	feature styles

createPolygonSVGOld(style){string}

modules/legend/model.js, line 655

Creates an SVG for a polygon

Name	Type	Description
style	vectorStyle	feature styles

Deprecated

• with new vectorStyle module

determineValueNameOld(style, layername){string}

modules/legend/model.js, line 558

Determines the name of a feature to display in the legend. The attributes are considered in the order legendValue, styleFieldValue and layerName.

Name	Type	Description
style	VectorStyle	Style created by vectorStyle.
layername	string	Layername defined in config.

Deprecated

• with new vectorStyle module

Returns:

name for the layer in legend

drawAdvancedStyle(type, style, layername, image){Array}

modules/legend/model.js, line 930

Draw advanced styles in legend

Name	Type	Description
type	ol.style	type of point
style	ol.style	style from features
layername	String	Name of layer
image	Array	should contain the image source for legend elements

Returns:

allItems

drawAdvancedStyleOld(style, layername, image, name){Array}

modules/legend/model.js, line 689

Draw advanced styles in legend

Name	Type	Description
style	ol.style	style from features
layername	String	Name of layer
image	Array	should contain the image source for legend elements
name	Array	should contain the names for legend elements

Deprecated

• with new vectorStyle module

Returns:

allItems

drawIntervalCircleBars(scalingAttribute, advancedStyle, layername, image, name){Array}

modules/legend/model.js, line 763

Draw advanced styles for interval circle bars in legend

Name	Type	Description
scalingAttribute	String	attribute that contains the values of a feature
advancedStyle	ol.style	copy of style
layername	String	Name des Layers
image	Array	should contain the image source for legend elements
name	Array	should contain the names for legend elements

drawNominalCircleSegmentsStyle(styleScalingValues, scalingValueDefaultColor, scalingAttribute, advancedStyle, image, name){Array}

modules/legend/model.js, line 729

Draw advanced styles for nominal circle segments in legend

Name	Type	Description
styleScalingValues	Object	contains values to be draw in legend
scalingValueDefaultColor	Array	color for default value
scalingAttribute	String	attribute that contains the values of a feature
advancedStyle	ol.style	copy of style
image	Array	should contain the image source for legend elements
name	Array	should contain the names for legend elements

filterLayersForLegend(){Array.<Layer>}

modules/legend/model.js, line 199

Returns sorted and filtered layer list for legend.

Fires:

• Core.ModelList#event:RadioRequestModelListGetModelsByAttributes
• Core#event:RadioTriggerMapChange

Returns:

and filtered layers

getLegend(layer){Object}

modules/legend/model.js, line 87

Creates the legend information for one layer and returns it

Name	Type	Description
layer	Object	requested layer

Returns:

legend information

getLegendDefinition(layername, typ, legendURL, styleId, layerSources){Object}

modules/legend/model.js, line 224

Checks the layer and returns the layer definition

Name	Type	Description
layername	String	name of the layer
typ	String	type of the layer
legendURL	Array.<String>	optional only if typ !== GROUP
styleId	String	optional only if typ === WFS
layerSources	Array.<Object>	optional only if typ === GROUP

Returns:

legend definition

getLegendParamsForLines(legendInfo, layername){object}

modules/legend/model.js, line 858

Creates the legend for a line style

Name	Type	Description
legendInfo	VectorStyle	prepared legend infos of vectorstyle
layername	string	layername defined in config

Returns:

definition for a line

getLegendParamsForLinesOld(layername, style){object}

modules/legend/model.js, line 470

Creates the legend for a line style

Name	Type	Description
layername	string	layername defined in config
style	VectorStyle	style created by vectorStyle

Deprecated

• with new vectorStyle module

Returns:

definition for a line

getLegendParamsForPoint(legendInfo, layername){object}

modules/legend/model.js, line 893

Creates the legend for a point style. The Styles Circle and Advanced are processed separately.

Name	Type	Description
legendInfo	VectorStyle	prepared legend infos of vectorstyle
layername	string	layername defined in config

Returns:

definition for a point

getLegendParamsForPointOld(styleSubClass, layername, style){object}

modules/legend/model.js, line 522

Creates the legend for a point style. The Styles Circle and Advanced are processed separately.

Name	Type	Description
styleSubClass	string	name of subclass defined in style
layername	string	layername defined in config
style	VectorStyle	style created by vectorStyle

Deprecated

• with new vectorStyle module

Returns:

definition for a point

getLegendParamsForPolygons(legendInfo, layername){object}

modules/legend/model.js, line 875

Creates the legend for a polygon style

Name	Type	Description
legendInfo	VectorStyle	prepared legend infos of vectorstyle
layername	string	layername defined in config

Returns:

definition for a polygon

getLegendParamsForPolygonsOld(layername, style){object}

modules/legend/model.js, line 495

Creates the legend for a polygon style

Name	Type	Description
layername	string	layername defined in config
style	VectorStyle	style created by vectorStyle

Deprecated

• with new vectorStyle module

Returns:

definition for a polygon

getLegendParamsFromURL(layername, legendURL, typ){object}

modules/legend/model.js, line 306

Creates legend object by url

Name	Type	Description
layername	string	Name of layer to use in legend view
legendURL	Array.<string>	optional URL of image
typ	string	type layertype

Returns:

legend item

getLegendParamsFromVector(layername, styleId, legendURL){object}

modules/legend/model.js, line 793

Creates legend object for vector layer using it's style

Name	Type	Description
layername	string	Name of layer to use in legend view
styleId	integer	styleId
legendURL	string | Array.<sting>	can be a image path as sting or array of strings

Fires:

• VectorStyle#event:RadioRequestStyleListReturnModelById

Returns:

Name	Type	Description
legendObject	object	legend item Name Type Description legendname string layername legend Array.<object> Array of legend entries in this particular layer e.g. because of multiple categories Name Type Description legendname string name of legend entry img string svg typ=svg string fixed type

getLegendParamsFromVectorOld(layername, styleId){object}

modules/legend/model.js, line 358

Creates legend object for vector layer using it's style

Name	Type	Description
layername	string	Name of layer to use in legend view
styleId	integer	styleId

Deprecated

• with new vectorStyle module

Fires:

• VectorStyle#event:RadioRequestStyleListReturnModelById

Returns:

Name	Type	Description
legendObject	object	legend item Name Type Description legendname string layername legend Array.<object> Array of legend entries in this particular layer e.g. because of multiple categories Name Type Description legendname string name of legend entry img string svg typ=svg string fixed type

getLegendParamsFromWMS(layername, legendURL){object}

modules/legend/model.js, line 322

Creates legend object for WMS

Name	Type	Description
layername	string	Name of layer to use in legend view
legendURL	Array.<string>	optional URL of image

Returns:

legend item

resetParamsStyleWMSArray(layer){void}

modules/legend/model.js, line 126

todo

Name	Type	Description
layer	*	todo

setLayerList(){void}

modules/legend/model.js, line 181

Sets the legend information for all visible layers

setStartX(value){void}

modules/legend/model.js, line 1079

Sets the Start X value of the legend window in touchmove

Name	Type	Description
value	Number	Start X position

setStartY(value){void}

modules/legend/model.js, line 1087

Sets the Start Y value of the legend window in touchmove

Name	Type	Description
value	Number	Start Y position

setWindowLeft(value){void}

modules/legend/model.js, line 1063

Sets the left position of the legend window in touchmove

Name	Type	Description
value	Number	Left position

setWindowTop(value){void}

modules/legend/model.js, line 1071

Sets the top position of the legend window in touchmove

Name	Type	Description
value	Number	Top position

updateLegendFromStyleWMSArray(){void}

modules/legend/model.js, line 153

todo

updateParamsStyleWMSArray(params){void}

modules/legend/model.js, line 97

todo

Name	Type	Description
params	*	todo

Events

inherited changeIsActive

devtools/jsdoc/events.js, line 2210

Fired when param isActive changes

inherited RadioRequestToolGetCollection

devtools/jsdoc/events.js, line 2205

Delivers an array with configured tools

inherited RadioRequestToolGetSupportedIn3d

devtools/jsdoc/events.js, line 2169

Delivers an array with toll which supported in 3d-Mode /** -------------------- TOOLS.VIRTUALCITY --------------------

inherited RadioRequestToolGetSupportedOnlyIn3d

devtools/jsdoc/events.js, line 2164

Delivers an array with toll which supported only in 3d-Mode

inherited RadioRequestToolGetSupportedOnlyInOblique

devtools/jsdoc/events.js, line 2200

Delivers an array with toll which supported only in Oblique-Mode