Class: BuildSpecModel

Tools.Print BuildSpecModel

BuildSpecModel.

new BuildSpecModel()

modules/tools/print_/buildSpec.js, line 21
Model to generate the buildSpec JSON that is send to the mapfish-print-3 service.
Fires:
Listens to Events:

Extends

Methods

addFeatureToGeoJsonList(feature, geojsonList){void}

modules/tools/print_/buildSpec.js, line 634
adds the feature to the geojson list
Name Type Description
feature ol.Feature the feature can be clustered
geojsonList Array.<GeoJSON> -

addFeatureToGeoJsonList(feature, geojsonList){void}

addons/printLGB/buildSpec.js, line 663
adds the feature to the geojson list
Name Type Description
feature ol.Feature the feature can be clustered
geojsonList Array.<GeoJSON> -

addGfiFeature(layers, coordinates){void}

modules/tools/print_/buildSpec.js, line 1077
Name Type Description
layers Array.<Object> layers attribute of the map spec
coordinates Array.<number> the coordinates of the gfi

addGfiFeature(layers, coordinates){void}

addons/printLGB/buildSpec.js, line 1102
Name Type Description
layers Object layers attribute of the map spec
coordinates Array.<Number> the coordinates of the gfi

addZero(hex){string}

modules/tools/print_/buildSpec.js, line 816
add zero to hex if required
Name Type Description
hex string hexadecimal value
Returns:
value

buildFillStyle(style, obj){Object}

modules/tools/print_/buildSpec.js, line 549
Generates the Fill Style
Name Type Description
style ol.style Style of layer.
obj Object current style object .
Returns:
Fill Style for mapfish print.

buildFillStyle(style, obj){Object}

addons/printLGB/buildSpec.js, line 578
Generates the Fill Style
Name Type Description
style ol.style Style of layer.
obj Object current style object .
Returns:
Fill Style for mapfish print.

buildGfi(isGfiSelected, gfiArray){void}

modules/tools/print_/buildSpec.js, line 1049
gets array with [GfiContent, layername, coordinates] of actual gfi empty array if gfi is not active. coordinates not needed, yet.
Name Type Description
isGfiSelected boolean flag if gfi has to be printed
gfiArray Array array

buildGfi(isGfiSelected, gfiArray){void}

addons/printLGB/buildSpec.js, line 1074
gets array with [GfiContent, layername, coordinates] of actual gfi empty array if gfi is not active. coordinates not needed, yet.
Name Type Description
isGfiSelected boolean flag if gfi has to be printed
gfiArray Array array

buildGraphicPath(){String}

modules/tools/print_/buildSpec.js, line 439
derives the url of the image from the server the app is running on if the app is running on localhost the images from test.geoportal-hamburg.de are used
Returns:
to image directory

buildGraphicPath(){String}

addons/printLGB/buildSpec.js, line 481
derives the url of the image from the server the app is running on if the app is running on localhost the images from test.geoportal-hamburg.de are used
Returns:
to image directory

buildImageWms(layer){Object}

modules/tools/print_/buildSpec.js, line 278
Returns image wms layer information
Name Type Description
layer ol.layer.Image image layer with image wms source
Returns:
wms layer spec

buildImageWms(layer){Object}

addons/printLGB/buildSpec.js, line 320
Returns image wms layer information
Name Type Description
layer ol.layer.Image image layer with image wms source
Returns:
wms layer spec

buildLayers(layerList){void}

modules/tools/print_/buildSpec.js, line 150
Defines the layers attribute of the map spec
Name Type Description
layerList Array.<ol.layer.Layer> All visible layers on the map.

buildLayers(layerList){void}

addons/printLGB/buildSpec.js, line 125
Defines the layers attribute of the map spec
Name Type Description
layerList Array.<ol.layer.Layer> All visible layers on the map.

buildLayerType(layer, currentResolution){Object}

modules/tools/print_/buildSpec.js, line 201
returns layerinfoy by layer type
Name Type Description
layer ol.layer ol.Layer with deatures
currentResolution Number Current map resolution
Returns:
LayerObject for mapfish print.

buildLayerType(layer, currentResolution){Object}

addons/printLGB/buildSpec.js, line 176
returns layerinfo by layer type
Name Type Description
layer ol.layer ol.Layer with deatures
currentResolution Number Current map resolution
Returns:
LayerObject for mapfish print.

buildLegend(isLegendSelected, legendParams, isMetaDataAvailable){void}

modules/tools/print_/buildSpec.js, line 826
gets legendParams and builds legend object for mapfish print
Name Type Description
isLegendSelected Boolean flag if legend has to be printed
legendParams Array.<Object> params derived from legend module
isMetaDataAvailable Boolean flag to print metadata

buildLegend(isLegendSelected, legendParams, isMetaDataAvailable){void}

addons/printLGB/buildSpec.js, line 851
gets legendParams and builds legend object for mapfish print
Name Type Description
isLegendSelected Boolean flag if legend has to be printed
legendParams Array.<Object> params derived from legend module
isMetaDataAvailable Boolean flag to print metadata

buildLineStringStyle(style, layer){Object}

modules/tools/print_/buildSpec.js, line 531
Generates the LineString Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
LineString Style for mapfish print.

buildLineStringStyle(style, layer){Object}

addons/printLGB/buildSpec.js, line 560
Generates the LineString Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
LineString Style for mapfish print.

buildPointStyle(style, layer){Object}

modules/tools/print_/buildSpec.js, line 385
Generates the point Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Point Style for mapfish print.

buildPointStyle(style, layer){Object}

addons/printLGB/buildSpec.js, line 427
Generates the point Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Point Style for mapfish print.

buildPointStyleCircle(style){Object}

modules/tools/print_/buildSpec.js, line 400
Generates the point Style for circle style
Name Type Description
style ol.style Style of layer.
Returns:
Circle Style for mapfish print.

buildPointStyleCircle(style){Object}

addons/printLGB/buildSpec.js, line 442
Generates the point Style for circle style
Name Type Description
style ol.style Style of layer.
Returns:
Circle Style for mapfish print.

buildPointStyleIcon(style, layer){Object}

modules/tools/print_/buildSpec.js, line 424
Generates the point Style for icons
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Icon Style for mapfish print.

buildPointStyleIcon(style, layer){Object}

addons/printLGB/buildSpec.js, line 466
Generates the point Style for icons
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Icon Style for mapfish print.

buildPolygonStyle(style, layer){Object}

modules/tools/print_/buildSpec.js, line 508
Generates the polygon Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Polygon Style for mapfish print.

buildPolygonStyle(style, layer){Object}

addons/printLGB/buildSpec.js, line 537
Generates the polygon Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Polygon Style for mapfish print.

buildScale(scale){void}

modules/tools/print_/buildSpec.js, line 1132
Creates the scale string.
Name Type Description
scale String Scale of map.

buildScale(scale){void}

addons/printLGB/buildSpec.js, line 1157
Creates the scale string.
Name Type Description
scale String Scale of map.

buildStrokeStyle(style, obj){Object}

modules/tools/print_/buildSpec.js, line 604
Generates the Stroke Style
Name Type Description
style ol.style Style of layer.
obj Object Style object for mapfish print.
Returns:
LineString Style for mapfish print.

buildStrokeStyle(style, obj){Object}

addons/printLGB/buildSpec.js, line 633
Generates the Stroke Style
Name Type Description
style ol.style Style of layer.
obj Object Style object for mapfish print.
Returns:
LineString Style for mapfish print.

buildStyle(layer, features, geojsonList){Object}

modules/tools/print_/buildSpec.js, line 318
Generates the style for mapfish print.
Name Type Description
layer ol.layer ol-Layer with features.
features Array.<ol.feature> Array of features.
geojsonList Array.<Object> Array of geojsons.
Returns:
style for mapfish print.

buildStyle(layer, features, geojsonList){Object}

addons/printLGB/buildSpec.js, line 360
Generates the style for mapfish print.
Name Type Description
layer ol.layer ol-Layer with features.
features Array.<ol.feature> Array of features.
geojsonList Array.<Object> Array of geojsons.
Returns:
style for mapfish print.

buildTextStyle(style){Object}

modules/tools/print_/buildSpec.js, line 455
Generates the text Style
Name Type Description
style ol.style Style of layer.
See:
Returns:
Text Style for mapfish print.

buildTextStyle(style){Object}

addons/printLGB/buildSpec.js, line 496
Generates the text Style
Name Type Description
style ol.style Style of layer.
Returns:
Text Style for mapfish print.

buildTileWms(layer){Object}

modules/tools/print_/buildSpec.js, line 252
returns tile wms layer information
Name Type Description
layer ol.layer.Tile tile layer with tile wms source
Returns:
wms layer spec

buildTileWms(layer){Object}

addons/printLGB/buildSpec.js, line 230
returns tile wms layer information
Name Type Description
layer ol.layer.Tile tile layer with tile wms source
Returns:
wms layer spec

buildTileWmts(layer){Object}

addons/printLGB/buildSpec.js, line 256
returns tile wmts layer information
Name Type Description
layer ol.layer.Tile tile layer with tile wmts source
Returns:
wms layer spec

buildVector(layer, features){object}

modules/tools/print_/buildSpec.js, line 301
returns vector layer information
Name Type Description
layer ol.layer.Vector vector layer with vector source
features Array.<ol.feature> vectorfeatures
Returns:
geojson layer spec

buildVector(layer, features){object}

addons/printLGB/buildSpec.js, line 343
returns vector layer information
Name Type Description
layer ol.layer.Vector vector layer with vector source
features Array.<ol.feature> vectorfeatures
Returns:
geojson layer spec

changeLang(lng){Void}

addons/printLGB/buildSpec.js, line 1231
change language - sets default values for the language
Name Type Description
lng String the language changed to

cleanupUrl(url){string}

addons/printLGB/buildSpec.js, line 308
Fixup lower / uppercase issues on some layers for print servlet
Name Type Description
url string The URL
Returns:
modified URL

colorStringToRgbArray(colorString){Array.<Number>|String}

modules/tools/print_/buildSpec.js, line 567
Checks if colorString starts with "rgb" then calls a parsing function.
Name Type Description
colorString String rgb or rgba string
Returns:
parsed rgb-string as number array

colorStringToRgbArray(colorString){Array|String}

addons/printLGB/buildSpec.js, line 596
Checks if colorString starts with "rgb" then calls a parsing function.
Name Type Description
colorString Number | String rgb or rgba string
Returns:
parsed rgb-string as number array

componentToHex(c){string}

addons/printLGB/buildSpec.js, line 839
Convert the component to hex value
Name Type Description
c string component value
Returns:
value for component

convertFeatureToGeoJson(feature){object}

modules/tools/print_/buildSpec.js, line 660
converts an openlayers feature to a GeoJSON feature object
Name Type Description
feature ol.Feature the feature to convert
Returns:
object

convertFeatureToGeoJson(feature){object}

addons/printLGB/buildSpec.js, line 689
converts an openlayers feature to a GeoJSON feature object
Name Type Description
feature ol.Feature the feature to convert
Returns:
object

createLegendImageUrl(path){String}

modules/tools/print_/buildSpec.js, line 1028
Creates the legend image url.
Name Type Description
path String Path.
Returns:
Url for legend path.

createLegendImageUrl(path){String}

addons/printLGB/buildSpec.js, line 1053
Creates the legend image url.
Name Type Description
path String Path.
Returns:
Url for legend path.

createStyleWmsLegendList(legendObjects){Array.<Object>}

modules/tools/print_/buildSpec.js, line 993
Creates a legend list for all style wms styyled layers.
Name Type Description
legendObjects Array.<Object> Special styleWMS params
Returns:
legend list from stlyed wms layer for mapfish print.

createStyleWmsLegendList(legendObjects){Array.<Object>}

addons/printLGB/buildSpec.js, line 1018
Creates a legend list for all style wms styyled layers.
Name Type Description
legendObjects Array.<Object> Special styleWMS params
Returns:
legend list from stlyed wms layer for mapfish print.

createWfsLegendList(urls, legendNames, layerName){Array.<Object>}

modules/tools/print_/buildSpec.js, line 942
Creates wfs legend list for mapfish print
Name Type Description
urls String | Array.<String> Urls of legends.
legendNames Array.<String> Names of legend.
layerName String Name of layer.
Returns:
List of wfs legends to mapfish print template.

createWfsLegendList(urls, legendNames, layerName){Array.<Object>}

addons/printLGB/buildSpec.js, line 967
Creates wfs legend list for mapfish print
Name Type Description
urls String | Array.<String> Urls of legends.
legendNames Array.<String> Names of legend.
layerName String Name of layer.
Returns:
List of wfs legends to mapfish print template.

createWfsLegendObject(url, label){Object}

modules/tools/print_/buildSpec.js, line 966
Creates legend object for wfs layer for mapfish print
Name Type Description
url String Url of image.
label String Label.
Returns:
wfs legend object

createWfsLegendObject(url, label){Object}

addons/printLGB/buildSpec.js, line 991
Creates legend object for wfs layer for mapfish print
Name Type Description
url String Url of image.
label String Label.
Returns:
wfs legend object

createWmsLegendList(urls){Array.<Object>}

modules/tools/print_/buildSpec.js, line 913
Creates the wms legend list for mapfish print
Name Type Description
urls Array.<String> params for wms legend cration.
Returns:
prepared wms legens for mapfish print.

createWmsLegendList(urls){Array.<Object>}

addons/printLGB/buildSpec.js, line 938
Creates the wms legend list for mapfish print
Name Type Description
urls Array.<String> params for wms legend cration.
Returns:
prepared wms legens for mapfish print.

fetchedMetaData(cswObj){void}

modules/tools/print_/buildSpec.js, line 33
Fetches the metadata object and checks if object is from own request. If so it removes the unique id from the unique id list.
Name Type Description
cswObj Object Object from csw parser.

fetchedMetaData(cswObj){void}

addons/printLGB/buildSpec.js, line 37
Fetches the metadata object and checks if object is from own request. If so it removes the unique id from the unique id list.
Name Type Description
cswObj Object Object from csw parser.

getChildModelIfGroupLayer(model, layerId){Backbone.Model}

modules/tools/print_/buildSpec.js, line 776
Checks if model is a Group Model. If so, then the child model corresponding to layerId is returned. Otherwise the model is returned
Name Type Description
model Backbone.Model Layer model from ModelList
layerId String Id of layer model to return
Returns:
layer model

getChildModelIfGroupLayer(model, layerId){Backbone.Model}

addons/printLGB/buildSpec.js, line 799
Checks if model is a Group Model. If so, then the child model corresponding to layerId is returned. Otherwise the model is returned
Name Type Description
model Backbone.Model Layer model from ModelList
layerId String Id of layer model to return
Returns:
layer model

getDrawLayerInfo(layer, extent){Object|undefined}

modules/tools/print_/buildSpec.js, line 182
Sorts the features of the draw layer by z-index and returns the vector object for mapfish-print-3
Name Type Description
layer ol.layer ol.Layer with features.
extent ol.extent Extent uses to filter the feature by extent.
Returns:
VectorObject for mapfish print.

getDrawLayerInfo(layer, extent){Object|undefined}

addons/printLGB/buildSpec.js, line 157
Sorts the features of the draw layer by z-index and returns the vector object for mapfish-print-3
Name Type Description
layer ol.layer ol.Layer with features.
extent ol.extent Extent uses to filter the feature by extent.
Returns:
VectorObject for mapfish print.

getFeatureStyle(feature, layer){Array.<ol.style.Style>}

modules/tools/print_/buildSpec.js, line 687
Name Type Description
feature ol.Feature -
layer ol.layer.Vector -
Returns:
or an array of styles

getFeatureStyle(feature, layer){Array.<ol.style.Style>}

addons/printLGB/buildSpec.js, line 710
Name Type Description
feature ol.Feature -
layer ol.layer.Vector -
Returns:
or an array of styles

getFillFromSVG(svgString){String}

modules/tools/print_/buildSpec.js, line 1012
Returns Fill color from SVG as hex.
Name Type Description
svgString String String of SVG.
Returns:
Fill color as hex.

getFillFromSVG(svgString){String}

addons/printLGB/buildSpec.js, line 1037
Returns Fill color from SVG as hex.
Name Type Description
svgString String String of SVG.
Returns:
Fill color as hex.

getImageName(imageSrc){String}

modules/tools/print_/buildSpec.js, line 622
Returns the image name of the src url.
Name Type Description
imageSrc String Url of image source
Returns:
Image name.

getImageName(imageSrc){String}

addons/printLGB/buildSpec.js, line 651
Returns the image name of the src url.
Name Type Description
imageSrc String Url of image source
Returns:
Image name.

getLabelAlign(style){String}

modules/tools/print_/buildSpec.js, line 483
gets the indicator of how to align the text with respect to the geometry. this property must have 2 characters, the x-align and the y-align.
Name Type Description
style ol.style Style of layer.
Returns:
placement indicator

getLabelAlign(style){String}

addons/printLGB/buildSpec.js, line 516
gets the indicator of how to align the text with respect to the geometry. this property must have 2 characters, the x-align and the y-align.
Name Type Description
style ol.style Style of layer.
Returns:
placement indicator

getMetaData(layerName){void}

modules/tools/print_/buildSpec.js, line 869
Requests the metadata for given layer name
Name Type Description
layerName String name of current layer
Fires:

getMetaData(layerName){void}

addons/printLGB/buildSpec.js, line 894
Requests the metadata for given layer name
Name Type Description
layerName String name of current layer
Fires:

getStyleAttribute(layer, feature, isNewVectorStyle){String}

modules/tools/print_/buildSpec.js, line 742
Name Type Description
layer ol.Layer -
feature ol.feature the feature of current layer
isNewVectorStyle Boolean check if it is the new vector style
Returns:
attribute by whose value the feature is styled

getStyleAttribute(layer, feature, isNewVectorStyle){String}

addons/printLGB/buildSpec.js, line 765
Name Type Description
layer ol.Layer -
feature ol.feature the feature of current layer
isNewVectorStyle Boolean check if it is the new vector style
Returns:
attribute by whose value the feature is styled

getStylingRule(layer, feature, styleAttribute){string}

modules/tools/print_/buildSpec.js, line 707
returns the rule for styling a feature
Name Type Description
layer ol.Feature -
feature ol.Feature -
styleAttribute string the attribute by whose value the feature is styled
Returns:
ECQL Expression

getStylingRule(layer, feature, styleAttribute){string}

addons/printLGB/buildSpec.js, line 730
returns the rule for styling a feature
Name Type Description
layer ol.Feature -
feature ol.Feature -
styleAttribute string the attribute by whose value the feature is styled
Returns:
ECQL Expression

isFilled(string){boolean}

modules/tools/print_/buildSpec.js, line 140
Returns true, if the given string is not empty or undefined
Name Type Description
string string to check
Returns:
if string has content

isInScaleRange(layerMinRes, layerMaxRes, currentResolution){Boolean}

modules/tools/print_/buildSpec.js, line 237
Checks if layer is in the visible resolution range.
Name Type Description
layerMinRes Number Maximum resolution of layer.
layerMaxRes Number Minimum resolution of layer.
currentResolution Number Current map resolution.
Returns:
Flag if layer is in visible resolution.

isInScaleRange(layerMinRes, layerMaxRes, currentResolution){Boolean}

addons/printLGB/buildSpec.js, line 215
Checks if layer is in the visible resolution range.
Name Type Description
layerMinRes Number Maximum resolution of layer.
layerMaxRes Number Minimum resolution of layer.
currentResolution Number Current map resolution.
Returns:
Flag if layer is in visible resolution.

isOwnMetaRequest(uniqueIdList, uniqueId){Boolean}

modules/tools/print_/buildSpec.js, line 46
Checks if csw request belongs to this model.
Name Type Description
uniqueIdList Array.<String> List of all metaRequest-ids belonging to this model.
uniqueId String Response unique-id from Cswparser.
Returns:
Flag if csw response is from own metaRequest.

isOwnMetaRequest(uniqueIdList, uniqueId){Boolean}

addons/printLGB/buildSpec.js, line 50
Checks if csw request belongs to this model.
Name Type Description
uniqueIdList Array.<String> List of all metaRequest-ids belonging to this model.
uniqueId String Response unique-id from Cswparser.
Returns:
Flag if csw response is from own metaRequest.

parseAddressToString(addressObj){String}

modules/tools/print_/buildSpec.js, line 89
Parses the address object to a string.
Name Type Description
addressObj Object Address Object
Name Type Description
street String Street name.
housenr String House number.
postalCode String Postal Code.
city String City.
Returns:
The parsed String.

parseAddressToString(addressObj){String}

addons/printLGB/buildSpec.js, line 93
Parses the address object to a string.
Name Type Description
addressObj Object Address Object
Name Type Description
street String Street name.
housenr String House number.
postalCode String Postal Code.
city String City.
Returns:
The parsed String.

prepareGfiAttributes(gfiAttributes){Array.<Object>}

modules/tools/print_/buildSpec.js, line 1113
parses gfiAttributes object with key value pairs into array[objects] with attributes key and value
Name Type Description
gfiAttributes Object gfi Mapping attributes
Returns:
array[objects] with key- and value attributes

prepareGfiAttributes(gfiAttributes){Array.<Object>}

addons/printLGB/buildSpec.js, line 1138
parses gfiAttributes object with key value pairs into array[objects] with attributes key and value
Name Type Description
gfiAttributes Object gfi Mapping attributes
Returns:
array[objects] with key- and value attributes

prepareLegendAttributes(layerParam){Array.<Object>}

modules/tools/print_/buildSpec.js, line 891
Prepares Attributes for legend in mapfish-print template
Name Type Description
layerParam Object Params of layer.
Returns:
prepared legend attributes.

prepareLegendAttributes(layerParam){Array.<Object>}

addons/printLGB/buildSpec.js, line 916
Prepares Attributes for legend in mapfish-print template
Name Type Description
layerParam Object Params of layer.
Returns:
prepared legend attributes.

removeUniqueIdFromList(uniqueIdList, uniqueId){void}

modules/tools/print_/buildSpec.js, line 56
Removes the uniqueId from the uniqueIdList, because the request returned something.
Name Type Description
uniqueIdList Array.<String> List of all metaRequest-ids belonging to this model.
uniqueId String Response unique-id from Cswparser.

removeUniqueIdFromList(uniqueIdList, uniqueId){void}

addons/printLGB/buildSpec.js, line 60
Removes the uniqueId from the uniqueIdList, because the request returned something.
Name Type Description
uniqueIdList Array.<String> List of all metaRequest-ids belonging to this model.
uniqueId String Response unique-id from Cswparser.

rgbArrayToHex(rgb){string}

modules/tools/print_/buildSpec.js, line 793
Converts an rgb array to hexcode. Default is the open layers default color. It also checks if rgb is an hexcode, if true it will be returned.
Name Type Description
rgb Array.<number> a rgb color represented as an array
Returns:
hex color

rgbArrayToHex(rgb){string}

addons/printLGB/buildSpec.js, line 816
Converts an rgb array to hexcode. Default is the open layers default color. It also checks if rgb is an hexcode, if true it will be returned.
Name Type Description
rgb Array.<Number> a rgb color represented as an array
Returns:
hex color

rgbStringToRgbArray(colorString){Array.<Number>}

modules/tools/print_/buildSpec.js, line 582
Parses a given rgb- or rgba-string to an numbers array.
Name Type Description
colorString String rgb or rgba string
Returns:
parsed rgb-string as number array

rgbStringToRgbArray(colorString){Array.<Number>}

addons/printLGB/buildSpec.js, line 611
Parses a given rgb- or rgba-string to an numbers array.
Name Type Description
colorString String rgb or rgba string
Returns:
parsed rgb-string as number array

setGfi(value){void}

modules/tools/print_/buildSpec.js, line 1179
Setter for gfi
Name Type Description
value String Value

setGfi(value){void}

addons/printLGB/buildSpec.js, line 1204
Setter for gfi
Name Type Description
value String Value

setLegend(value){void}

modules/tools/print_/buildSpec.js, line 1161
Setter for Legend
Name Type Description
value String Value

setLegend(value){void}

addons/printLGB/buildSpec.js, line 1186
Setter for Legend
Name Type Description
value String Value

setMetadata(value){void}

modules/tools/print_/buildSpec.js, line 1143
Setter for Metadata
Name Type Description
value String Value

setMetadata(value){void}

addons/printLGB/buildSpec.js, line 1168
Setter for Metadata
Name Type Description
value String Value

setScale(value){void}

modules/tools/print_/buildSpec.js, line 1188
Setter for scale
Name Type Description
value String Value

setScale(value){void}

addons/printLGB/buildSpec.js, line 1213
Setter for scale
Name Type Description
value String Value

setShowGfi(value){void}

modules/tools/print_/buildSpec.js, line 1170
Setter for showGfi
Name Type Description
value Boolean Value

setShowGfi(value){void}

addons/printLGB/buildSpec.js, line 1195
Setter for showGfi
Name Type Description
value Boolean Value

setShowLegend(value){void}

modules/tools/print_/buildSpec.js, line 1152
Setter for showLegend
Name Type Description
value Boolean Value

setShowLegend(value){void}

addons/printLGB/buildSpec.js, line 1177
Setter for showLegend
Name Type Description
value Boolean Value

setUniqueIdList(value){void}

modules/tools/print_/buildSpec.js, line 1197
Setter for uniqueIdList
Name Type Description
value String Value

setUniqueIdList(value){void}

addons/printLGB/buildSpec.js, line 1222
Setter for uniqueIdList
Name Type Description
value String Value

updateMetaData(layerName, parsedData){void}

modules/tools/print_/buildSpec.js, line 66
Updates the metadata from the metadata response.
Name Type Description
layerName String name of layer.
parsedData Object parsedCswData.

updateMetaData(layerName, parsedData){void}

addons/printLGB/buildSpec.js, line 70
Updates the metadata from the metadata response.
Name Type Description
layerName String name of layer.
parsedData Object parsedCswData.

Tools.Print BuildSpecModel

BuildSpecModel.

new BuildSpecModel()

addons/printLGB/buildSpec.js, line 23
Model to generate the buildSpec JSON that is send to the mapfish-print-3 service.
Fires:
Listens to Events:

Extends

Methods

addFeatureToGeoJsonList(feature, geojsonList){void}

modules/tools/print_/buildSpec.js, line 634
adds the feature to the geojson list
Name Type Description
feature ol.Feature the feature can be clustered
geojsonList Array.<GeoJSON> -

addFeatureToGeoJsonList(feature, geojsonList){void}

addons/printLGB/buildSpec.js, line 663
adds the feature to the geojson list
Name Type Description
feature ol.Feature the feature can be clustered
geojsonList Array.<GeoJSON> -

addGfiFeature(layers, coordinates){void}

modules/tools/print_/buildSpec.js, line 1077
Name Type Description
layers Array.<Object> layers attribute of the map spec
coordinates Array.<number> the coordinates of the gfi

addGfiFeature(layers, coordinates){void}

addons/printLGB/buildSpec.js, line 1102
Name Type Description
layers Object layers attribute of the map spec
coordinates Array.<Number> the coordinates of the gfi

addZero(hex){string}

modules/tools/print_/buildSpec.js, line 816
add zero to hex if required
Name Type Description
hex string hexadecimal value
Returns:
value

buildFillStyle(style, obj){Object}

modules/tools/print_/buildSpec.js, line 549
Generates the Fill Style
Name Type Description
style ol.style Style of layer.
obj Object current style object .
Returns:
Fill Style for mapfish print.

buildFillStyle(style, obj){Object}

addons/printLGB/buildSpec.js, line 578
Generates the Fill Style
Name Type Description
style ol.style Style of layer.
obj Object current style object .
Returns:
Fill Style for mapfish print.

buildGfi(isGfiSelected, gfiArray){void}

modules/tools/print_/buildSpec.js, line 1049
gets array with [GfiContent, layername, coordinates] of actual gfi empty array if gfi is not active. coordinates not needed, yet.
Name Type Description
isGfiSelected boolean flag if gfi has to be printed
gfiArray Array array

buildGfi(isGfiSelected, gfiArray){void}

addons/printLGB/buildSpec.js, line 1074
gets array with [GfiContent, layername, coordinates] of actual gfi empty array if gfi is not active. coordinates not needed, yet.
Name Type Description
isGfiSelected boolean flag if gfi has to be printed
gfiArray Array array

buildGraphicPath(){String}

modules/tools/print_/buildSpec.js, line 439
derives the url of the image from the server the app is running on if the app is running on localhost the images from test.geoportal-hamburg.de are used
Returns:
to image directory

buildGraphicPath(){String}

addons/printLGB/buildSpec.js, line 481
derives the url of the image from the server the app is running on if the app is running on localhost the images from test.geoportal-hamburg.de are used
Returns:
to image directory

buildImageWms(layer){Object}

modules/tools/print_/buildSpec.js, line 278
Returns image wms layer information
Name Type Description
layer ol.layer.Image image layer with image wms source
Returns:
wms layer spec

buildImageWms(layer){Object}

addons/printLGB/buildSpec.js, line 320
Returns image wms layer information
Name Type Description
layer ol.layer.Image image layer with image wms source
Returns:
wms layer spec

buildLayers(layerList){void}

modules/tools/print_/buildSpec.js, line 150
Defines the layers attribute of the map spec
Name Type Description
layerList Array.<ol.layer.Layer> All visible layers on the map.

buildLayers(layerList){void}

addons/printLGB/buildSpec.js, line 125
Defines the layers attribute of the map spec
Name Type Description
layerList Array.<ol.layer.Layer> All visible layers on the map.

buildLayerType(layer, currentResolution){Object}

modules/tools/print_/buildSpec.js, line 201
returns layerinfoy by layer type
Name Type Description
layer ol.layer ol.Layer with deatures
currentResolution Number Current map resolution
Returns:
LayerObject for mapfish print.

buildLayerType(layer, currentResolution){Object}

addons/printLGB/buildSpec.js, line 176
returns layerinfo by layer type
Name Type Description
layer ol.layer ol.Layer with deatures
currentResolution Number Current map resolution
Returns:
LayerObject for mapfish print.

buildLegend(isLegendSelected, legendParams, isMetaDataAvailable){void}

modules/tools/print_/buildSpec.js, line 826
gets legendParams and builds legend object for mapfish print
Name Type Description
isLegendSelected Boolean flag if legend has to be printed
legendParams Array.<Object> params derived from legend module
isMetaDataAvailable Boolean flag to print metadata

buildLegend(isLegendSelected, legendParams, isMetaDataAvailable){void}

addons/printLGB/buildSpec.js, line 851
gets legendParams and builds legend object for mapfish print
Name Type Description
isLegendSelected Boolean flag if legend has to be printed
legendParams Array.<Object> params derived from legend module
isMetaDataAvailable Boolean flag to print metadata

buildLineStringStyle(style, layer){Object}

modules/tools/print_/buildSpec.js, line 531
Generates the LineString Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
LineString Style for mapfish print.

buildLineStringStyle(style, layer){Object}

addons/printLGB/buildSpec.js, line 560
Generates the LineString Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
LineString Style for mapfish print.

buildPointStyle(style, layer){Object}

modules/tools/print_/buildSpec.js, line 385
Generates the point Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Point Style for mapfish print.

buildPointStyle(style, layer){Object}

addons/printLGB/buildSpec.js, line 427
Generates the point Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Point Style for mapfish print.

buildPointStyleCircle(style){Object}

modules/tools/print_/buildSpec.js, line 400
Generates the point Style for circle style
Name Type Description
style ol.style Style of layer.
Returns:
Circle Style for mapfish print.

buildPointStyleCircle(style){Object}

addons/printLGB/buildSpec.js, line 442
Generates the point Style for circle style
Name Type Description
style ol.style Style of layer.
Returns:
Circle Style for mapfish print.

buildPointStyleIcon(style, layer){Object}

modules/tools/print_/buildSpec.js, line 424
Generates the point Style for icons
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Icon Style for mapfish print.

buildPointStyleIcon(style, layer){Object}

addons/printLGB/buildSpec.js, line 466
Generates the point Style for icons
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Icon Style for mapfish print.

buildPolygonStyle(style, layer){Object}

modules/tools/print_/buildSpec.js, line 508
Generates the polygon Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Polygon Style for mapfish print.

buildPolygonStyle(style, layer){Object}

addons/printLGB/buildSpec.js, line 537
Generates the polygon Style
Name Type Description
style ol.style Style of layer.
layer ol.layer Ol-layer.
Returns:
Polygon Style for mapfish print.

buildScale(scale){void}

modules/tools/print_/buildSpec.js, line 1132
Creates the scale string.
Name Type Description
scale String Scale of map.

buildScale(scale){void}

addons/printLGB/buildSpec.js, line 1157
Creates the scale string.
Name Type Description
scale String Scale of map.

buildStrokeStyle(style, obj){Object}

modules/tools/print_/buildSpec.js, line 604
Generates the Stroke Style
Name Type Description
style ol.style Style of layer.
obj Object Style object for mapfish print.
Returns:
LineString Style for mapfish print.

buildStrokeStyle(style, obj){Object}

addons/printLGB/buildSpec.js, line 633
Generates the Stroke Style
Name Type Description
style ol.style Style of layer.
obj Object Style object for mapfish print.
Returns:
LineString Style for mapfish print.

buildStyle(layer, features, geojsonList){Object}

modules/tools/print_/buildSpec.js, line 318
Generates the style for mapfish print.
Name Type Description
layer ol.layer ol-Layer with features.
features Array.<ol.feature> Array of features.
geojsonList Array.<Object> Array of geojsons.
Returns:
style for mapfish print.

buildStyle(layer, features, geojsonList){Object}

addons/printLGB/buildSpec.js, line 360
Generates the style for mapfish print.
Name Type Description
layer ol.layer ol-Layer with features.
features Array.<ol.feature> Array of features.
geojsonList Array.<Object> Array of geojsons.
Returns:
style for mapfish print.

buildTextStyle(style){Object}

modules/tools/print_/buildSpec.js, line 455
Generates the text Style
Name Type Description
style ol.style Style of layer.
See:
Returns:
Text Style for mapfish print.

buildTextStyle(style){Object}

addons/printLGB/buildSpec.js, line 496
Generates the text Style
Name Type Description
style ol.style Style of layer.
Returns:
Text Style for mapfish print.

buildTileWms(layer){Object}

modules/tools/print_/buildSpec.js, line 252
returns tile wms layer information
Name Type Description
layer ol.layer.Tile tile layer with tile wms source
Returns:
wms layer spec

buildTileWms(layer){Object}

addons/printLGB/buildSpec.js, line 230
returns tile wms layer information
Name Type Description
layer ol.layer.Tile tile layer with tile wms source
Returns:
wms layer spec

buildTileWmts(layer){Object}

addons/printLGB/buildSpec.js, line 256
returns tile wmts layer information
Name Type Description
layer ol.layer.Tile tile layer with tile wmts source
Returns:
wms layer spec

buildVector(layer, features){object}

modules/tools/print_/buildSpec.js, line 301
returns vector layer information
Name Type Description
layer ol.layer.Vector vector layer with vector source
features Array.<ol.feature> vectorfeatures
Returns:
geojson layer spec

buildVector(layer, features){object}

addons/printLGB/buildSpec.js, line 343
returns vector layer information
Name Type Description
layer ol.layer.Vector vector layer with vector source
features Array.<ol.feature> vectorfeatures
Returns:
geojson layer spec

changeLang(lng){Void}

addons/printLGB/buildSpec.js, line 1231
change language - sets default values for the language
Name Type Description
lng String the language changed to

cleanupUrl(url){string}

addons/printLGB/buildSpec.js, line 308
Fixup lower / uppercase issues on some layers for print servlet
Name Type Description
url string The URL
Returns:
modified URL

colorStringToRgbArray(colorString){Array.<Number>|String}

modules/tools/print_/buildSpec.js, line 567
Checks if colorString starts with "rgb" then calls a parsing function.
Name Type Description
colorString String rgb or rgba string
Returns:
parsed rgb-string as number array

colorStringToRgbArray(colorString){Array|String}

addons/printLGB/buildSpec.js, line 596
Checks if colorString starts with "rgb" then calls a parsing function.
Name Type Description
colorString Number | String rgb or rgba string
Returns:
parsed rgb-string as number array

componentToHex(c){string}

addons/printLGB/buildSpec.js, line 839
Convert the component to hex value
Name Type Description
c string component value
Returns:
value for component

convertFeatureToGeoJson(feature){object}

modules/tools/print_/buildSpec.js, line 660
converts an openlayers feature to a GeoJSON feature object
Name Type Description
feature ol.Feature the feature to convert
Returns:
object

convertFeatureToGeoJson(feature){object}

addons/printLGB/buildSpec.js, line 689
converts an openlayers feature to a GeoJSON feature object
Name Type Description
feature ol.Feature the feature to convert
Returns:
object

createLegendImageUrl(path){String}

modules/tools/print_/buildSpec.js, line 1028
Creates the legend image url.
Name Type Description
path String Path.
Returns:
Url for legend path.

createLegendImageUrl(path){String}

addons/printLGB/buildSpec.js, line 1053
Creates the legend image url.
Name Type Description
path String Path.
Returns:
Url for legend path.

createStyleWmsLegendList(legendObjects){Array.<Object>}

modules/tools/print_/buildSpec.js, line 993
Creates a legend list for all style wms styyled layers.
Name Type Description
legendObjects Array.<Object> Special styleWMS params
Returns:
legend list from stlyed wms layer for mapfish print.

createStyleWmsLegendList(legendObjects){Array.<Object>}

addons/printLGB/buildSpec.js, line 1018
Creates a legend list for all style wms styyled layers.
Name Type Description
legendObjects Array.<Object> Special styleWMS params
Returns:
legend list from stlyed wms layer for mapfish print.

createWfsLegendList(urls, legendNames, layerName){Array.<Object>}

modules/tools/print_/buildSpec.js, line 942
Creates wfs legend list for mapfish print
Name Type Description
urls String | Array.<String> Urls of legends.
legendNames Array.<String> Names of legend.
layerName String Name of layer.
Returns:
List of wfs legends to mapfish print template.

createWfsLegendList(urls, legendNames, layerName){Array.<Object>}

addons/printLGB/buildSpec.js, line 967
Creates wfs legend list for mapfish print
Name Type Description
urls String | Array.<String> Urls of legends.
legendNames Array.<String> Names of legend.
layerName String Name of layer.
Returns:
List of wfs legends to mapfish print template.

createWfsLegendObject(url, label){Object}

modules/tools/print_/buildSpec.js, line 966
Creates legend object for wfs layer for mapfish print
Name Type Description
url String Url of image.
label String Label.
Returns:
wfs legend object

createWfsLegendObject(url, label){Object}

addons/printLGB/buildSpec.js, line 991
Creates legend object for wfs layer for mapfish print
Name Type Description
url String Url of image.
label String Label.
Returns:
wfs legend object

createWmsLegendList(urls){Array.<Object>}

modules/tools/print_/buildSpec.js, line 913
Creates the wms legend list for mapfish print
Name Type Description
urls Array.<String> params for wms legend cration.
Returns:
prepared wms legens for mapfish print.

createWmsLegendList(urls){Array.<Object>}

addons/printLGB/buildSpec.js, line 938
Creates the wms legend list for mapfish print
Name Type Description
urls Array.<String> params for wms legend cration.
Returns:
prepared wms legens for mapfish print.

fetchedMetaData(cswObj){void}

modules/tools/print_/buildSpec.js, line 33
Fetches the metadata object and checks if object is from own request. If so it removes the unique id from the unique id list.
Name Type Description
cswObj Object Object from csw parser.

fetchedMetaData(cswObj){void}

addons/printLGB/buildSpec.js, line 37
Fetches the metadata object and checks if object is from own request. If so it removes the unique id from the unique id list.
Name Type Description
cswObj Object Object from csw parser.

getChildModelIfGroupLayer(model, layerId){Backbone.Model}

modules/tools/print_/buildSpec.js, line 776
Checks if model is a Group Model. If so, then the child model corresponding to layerId is returned. Otherwise the model is returned
Name Type Description
model Backbone.Model Layer model from ModelList
layerId String Id of layer model to return
Returns:
layer model

getChildModelIfGroupLayer(model, layerId){Backbone.Model}

addons/printLGB/buildSpec.js, line 799
Checks if model is a Group Model. If so, then the child model corresponding to layerId is returned. Otherwise the model is returned
Name Type Description
model Backbone.Model Layer model from ModelList
layerId String Id of layer model to return
Returns:
layer model

getDrawLayerInfo(layer, extent){Object|undefined}

modules/tools/print_/buildSpec.js, line 182
Sorts the features of the draw layer by z-index and returns the vector object for mapfish-print-3
Name Type Description
layer ol.layer ol.Layer with features.
extent ol.extent Extent uses to filter the feature by extent.
Returns:
VectorObject for mapfish print.

getDrawLayerInfo(layer, extent){Object|undefined}

addons/printLGB/buildSpec.js, line 157
Sorts the features of the draw layer by z-index and returns the vector object for mapfish-print-3
Name Type Description
layer ol.layer ol.Layer with features.
extent ol.extent Extent uses to filter the feature by extent.
Returns:
VectorObject for mapfish print.

getFeatureStyle(feature, layer){Array.<ol.style.Style>}

modules/tools/print_/buildSpec.js, line 687
Name Type Description
feature ol.Feature -
layer ol.layer.Vector -
Returns:
or an array of styles

getFeatureStyle(feature, layer){Array.<ol.style.Style>}

addons/printLGB/buildSpec.js, line 710
Name Type Description
feature ol.Feature -
layer ol.layer.Vector -
Returns:
or an array of styles

getFillFromSVG(svgString){String}

modules/tools/print_/buildSpec.js, line 1012
Returns Fill color from SVG as hex.
Name Type Description
svgString String String of SVG.
Returns:
Fill color as hex.

getFillFromSVG(svgString){String}

addons/printLGB/buildSpec.js, line 1037
Returns Fill color from SVG as hex.
Name Type Description
svgString String String of SVG.
Returns:
Fill color as hex.

getImageName(imageSrc){String}

modules/tools/print_/buildSpec.js, line 622
Returns the image name of the src url.
Name Type Description
imageSrc String Url of image source
Returns:
Image name.

getImageName(imageSrc){String}

addons/printLGB/buildSpec.js, line 651
Returns the image name of the src url.
Name Type Description
imageSrc String Url of image source
Returns:
Image name.

getLabelAlign(style){String}

modules/tools/print_/buildSpec.js, line 483
gets the indicator of how to align the text with respect to the geometry. this property must have 2 characters, the x-align and the y-align.
Name Type Description
style ol.style Style of layer.
Returns:
placement indicator

getLabelAlign(style){String}

addons/printLGB/buildSpec.js, line 516
gets the indicator of how to align the text with respect to the geometry. this property must have 2 characters, the x-align and the y-align.
Name Type Description
style ol.style Style of layer.
Returns:
placement indicator

getMetaData(layerName){void}

modules/tools/print_/buildSpec.js, line 869
Requests the metadata for given layer name
Name Type Description
layerName String name of current layer
Fires:

getMetaData(layerName){void}

addons/printLGB/buildSpec.js, line 894
Requests the metadata for given layer name
Name Type Description
layerName String name of current layer
Fires:

getStyleAttribute(layer, feature, isNewVectorStyle){String}

modules/tools/print_/buildSpec.js, line 742
Name Type Description
layer ol.Layer -
feature ol.feature the feature of current layer
isNewVectorStyle Boolean check if it is the new vector style
Returns:
attribute by whose value the feature is styled

getStyleAttribute(layer, feature, isNewVectorStyle){String}

addons/printLGB/buildSpec.js, line 765
Name Type Description
layer ol.Layer -
feature ol.feature the feature of current layer
isNewVectorStyle Boolean check if it is the new vector style
Returns:
attribute by whose value the feature is styled

getStylingRule(layer, feature, styleAttribute){string}

modules/tools/print_/buildSpec.js, line 707
returns the rule for styling a feature
Name Type Description
layer ol.Feature -
feature ol.Feature -
styleAttribute string the attribute by whose value the feature is styled
Returns:
ECQL Expression

getStylingRule(layer, feature, styleAttribute){string}

addons/printLGB/buildSpec.js, line 730
returns the rule for styling a feature
Name Type Description
layer ol.Feature -
feature ol.Feature -
styleAttribute string the attribute by whose value the feature is styled
Returns:
ECQL Expression

isFilled(string){boolean}

modules/tools/print_/buildSpec.js, line 140
Returns true, if the given string is not empty or undefined
Name Type Description
string string to check
Returns:
if string has content

isInScaleRange(layerMinRes, layerMaxRes, currentResolution){Boolean}

modules/tools/print_/buildSpec.js, line 237
Checks if layer is in the visible resolution range.
Name Type Description
layerMinRes Number Maximum resolution of layer.
layerMaxRes Number Minimum resolution of layer.
currentResolution Number Current map resolution.
Returns:
Flag if layer is in visible resolution.

isInScaleRange(layerMinRes, layerMaxRes, currentResolution){Boolean}

addons/printLGB/buildSpec.js, line 215
Checks if layer is in the visible resolution range.
Name Type Description
layerMinRes Number Maximum resolution of layer.
layerMaxRes Number Minimum resolution of layer.
currentResolution Number Current map resolution.
Returns:
Flag if layer is in visible resolution.

isOwnMetaRequest(uniqueIdList, uniqueId){Boolean}

modules/tools/print_/buildSpec.js, line 46
Checks if csw request belongs to this model.
Name Type Description
uniqueIdList Array.<String> List of all metaRequest-ids belonging to this model.
uniqueId String Response unique-id from Cswparser.
Returns:
Flag if csw response is from own metaRequest.

isOwnMetaRequest(uniqueIdList, uniqueId){Boolean}

addons/printLGB/buildSpec.js, line 50
Checks if csw request belongs to this model.
Name Type Description
uniqueIdList Array.<String> List of all metaRequest-ids belonging to this model.
uniqueId String Response unique-id from Cswparser.
Returns:
Flag if csw response is from own metaRequest.

parseAddressToString(addressObj){String}

modules/tools/print_/buildSpec.js, line 89
Parses the address object to a string.
Name Type Description
addressObj Object Address Object
Name Type Description
street String Street name.
housenr String House number.
postalCode String Postal Code.
city String City.
Returns:
The parsed String.

parseAddressToString(addressObj){String}

addons/printLGB/buildSpec.js, line 93
Parses the address object to a string.
Name Type Description
addressObj Object Address Object
Name Type Description
street String Street name.
housenr String House number.
postalCode String Postal Code.
city String City.
Returns:
The parsed String.

prepareGfiAttributes(gfiAttributes){Array.<Object>}

modules/tools/print_/buildSpec.js, line 1113
parses gfiAttributes object with key value pairs into array[objects] with attributes key and value
Name Type Description
gfiAttributes Object gfi Mapping attributes
Returns:
array[objects] with key- and value attributes

prepareGfiAttributes(gfiAttributes){Array.<Object>}

addons/printLGB/buildSpec.js, line 1138
parses gfiAttributes object with key value pairs into array[objects] with attributes key and value
Name Type Description
gfiAttributes Object gfi Mapping attributes
Returns:
array[objects] with key- and value attributes

prepareLegendAttributes(layerParam){Array.<Object>}

modules/tools/print_/buildSpec.js, line 891
Prepares Attributes for legend in mapfish-print template
Name Type Description
layerParam Object Params of layer.
Returns:
prepared legend attributes.

prepareLegendAttributes(layerParam){Array.<Object>}

addons/printLGB/buildSpec.js, line 916
Prepares Attributes for legend in mapfish-print template
Name Type Description
layerParam Object Params of layer.
Returns:
prepared legend attributes.

removeUniqueIdFromList(uniqueIdList, uniqueId){void}

modules/tools/print_/buildSpec.js, line 56
Removes the uniqueId from the uniqueIdList, because the request returned something.
Name Type Description
uniqueIdList Array.<String> List of all metaRequest-ids belonging to this model.
uniqueId String Response unique-id from Cswparser.

removeUniqueIdFromList(uniqueIdList, uniqueId){void}

addons/printLGB/buildSpec.js, line 60
Removes the uniqueId from the uniqueIdList, because the request returned something.
Name Type Description
uniqueIdList Array.<String> List of all metaRequest-ids belonging to this model.
uniqueId String Response unique-id from Cswparser.

rgbArrayToHex(rgb){string}

modules/tools/print_/buildSpec.js, line 793
Converts an rgb array to hexcode. Default is the open layers default color. It also checks if rgb is an hexcode, if true it will be returned.
Name Type Description
rgb Array.<number> a rgb color represented as an array
Returns:
hex color

rgbArrayToHex(rgb){string}

addons/printLGB/buildSpec.js, line 816
Converts an rgb array to hexcode. Default is the open layers default color. It also checks if rgb is an hexcode, if true it will be returned.
Name Type Description
rgb Array.<Number> a rgb color represented as an array
Returns:
hex color

rgbStringToRgbArray(colorString){Array.<Number>}

modules/tools/print_/buildSpec.js, line 582
Parses a given rgb- or rgba-string to an numbers array.
Name Type Description
colorString String rgb or rgba string
Returns:
parsed rgb-string as number array

rgbStringToRgbArray(colorString){Array.<Number>}

addons/printLGB/buildSpec.js, line 611
Parses a given rgb- or rgba-string to an numbers array.
Name Type Description
colorString String rgb or rgba string
Returns:
parsed rgb-string as number array

setGfi(value){void}

modules/tools/print_/buildSpec.js, line 1179
Setter for gfi
Name Type Description
value String Value

setGfi(value){void}

addons/printLGB/buildSpec.js, line 1204
Setter for gfi
Name Type Description
value String Value

setLegend(value){void}

modules/tools/print_/buildSpec.js, line 1161
Setter for Legend
Name Type Description
value String Value

setLegend(value){void}

addons/printLGB/buildSpec.js, line 1186
Setter for Legend
Name Type Description
value String Value

setMetadata(value){void}

modules/tools/print_/buildSpec.js, line 1143
Setter for Metadata
Name Type Description
value String Value

setMetadata(value){void}

addons/printLGB/buildSpec.js, line 1168
Setter for Metadata
Name Type Description
value String Value

setScale(value){void}

modules/tools/print_/buildSpec.js, line 1188
Setter for scale
Name Type Description
value String Value

setScale(value){void}

addons/printLGB/buildSpec.js, line 1213
Setter for scale
Name Type Description
value String Value

setShowGfi(value){void}

modules/tools/print_/buildSpec.js, line 1170
Setter for showGfi
Name Type Description
value Boolean Value

setShowGfi(value){void}

addons/printLGB/buildSpec.js, line 1195
Setter for showGfi
Name Type Description
value Boolean Value

setShowLegend(value){void}

modules/tools/print_/buildSpec.js, line 1152
Setter for showLegend
Name Type Description
value Boolean Value

setShowLegend(value){void}

addons/printLGB/buildSpec.js, line 1177
Setter for showLegend
Name Type Description
value Boolean Value

setUniqueIdList(value){void}

modules/tools/print_/buildSpec.js, line 1197
Setter for uniqueIdList
Name Type Description
value String Value

setUniqueIdList(value){void}

addons/printLGB/buildSpec.js, line 1222
Setter for uniqueIdList
Name Type Description
value String Value

updateMetaData(layerName, parsedData){void}

modules/tools/print_/buildSpec.js, line 66
Updates the metadata from the metadata response.
Name Type Description
layerName String name of layer.
parsedData Object parsedCswData.

updateMetaData(layerName, parsedData){void}

addons/printLGB/buildSpec.js, line 70
Updates the metadata from the metadata response.
Name Type Description
layerName String name of layer.
parsedData Object parsedCswData.