A super module that collects available sub-modules.
- Source:
Methods
(static) addFilterButton(column, value) → {string}
Add a button to request filtering an attribute
Parameters:
Name | Type | Description |
---|---|---|
column |
string | |
value |
string |
Returns:
span placeholder
- Type
- string
(static) computeSize(geometry) → {Object}
Computes the size of a given geometry and generates a table with the properties.
Parameters:
Name | Type | Description |
---|---|---|
geometry |
Object | The geometry object to compute the size for. |
Returns:
- A table with the computed properties.
- Type
- Object
(static) concatIfDefined(values) → {string}
Concats values if every value is defined (not null or undefined)
Parameters:
Name | Type | Description |
---|---|---|
values |
string | any amount of values: concat1, concat2, ... |
Returns:
string
- Type
- string
(static) createFilterDropdown(values, separator, long, lat) → {HTMLSelectElement}
Creates a dropdown filter element with given values.
Parameters:
Name | Type | Description |
---|---|---|
values |
string | A string of values separated by the specified separator. |
separator |
string | The character used to separate the values in the string. |
long |
number | The longitude value to be used in the event. |
lat |
number | The latitude value to be used in the event. |
Returns:
The created dropdown element.
- Type
- HTMLSelectElement
(static) displayIFDOIcons(featureProperties) → {HTMLElement}
Parameters:
Name | Type | Description |
---|---|---|
featureProperties |
object |
Returns:
div placeholder
- Type
- HTMLElement
(static) displayImage(src, width, height, srcset) → {HTMLElement}
Parameters:
Name | Type | Description |
---|---|---|
src |
string | |
width |
string | (optional) |
height |
string | (optional) |
srcset |
string | (optional) |
- Source:
Returns:
div placeholder
- Type
- HTMLElement
(static) displayLayerLegend(layer) → {string}
Display a layers legend graphic
Parameters:
Name | Type | Description |
---|---|---|
layer |
Layer |
Returns:
Legend Graphic
- Type
- string
(static) displayVideo(media, width, height, thumbnail, cover, poster) → {HTMLElement}
Parameters:
Name | Type | Description |
---|---|---|
media |
string | |
width |
string | |
height |
string | |
thumbnail |
string | (optional) |
cover |
string | (optional) |
poster |
string | (optional) |
- Source:
Returns:
div placeholder
- Type
- HTMLElement
(static) displayVideoPlayerKeys() → {HTMLElement}
- Source:
Returns:
div placeholder
- Type
- HTMLElement
(static) encodeURLComponent(str) → {string}
Encode String to URL Compatible characters
Parameters:
Name | Type | Description |
---|---|---|
str |
string | url compponent |
Returns:
encoded string
- Type
- string
(static) formatDate(date) → {HTMLElement}
Make ISO Timestring more readable
Parameters:
Name | Type | Description |
---|---|---|
date |
string | in ISO format |
Returns:
formatted date in a span
- Type
- HTMLElement
(static) formatGeometry(geometry, name) → {HTMLElement}
Format lat/lng from the geometry object of a Feature
to a readable string with decimal degrees
Parameters:
Name | Type | Description |
---|---|---|
geometry |
* | |
name |
* |
Returns:
formatted lat/lng in a span
- Type
- HTMLElement
(static) formatLatLng(lat, lng) → {HTMLElement}
Format lat/lng to a readable string with decimal degrees
Parameters:
Name | Type | Description |
---|---|---|
lat |
* | |
lng |
* |
Returns:
formatted lat/lng in a span
- Type
- HTMLElement
(static) formatUnit(value, unit, targetUnit, precision) → {HTMLElement}
Simple unit formatter. Find the best unit prefix.
Parameters:
Name | Type | Description |
---|---|---|
value |
number | |
unit |
string | |
targetUnit |
string | |
precision |
number |
Returns:
span contianing result
- Type
- HTMLElement
(static) generateTable(properties, count, excludedKeys, annotations) → {HTMLElement}
Creates a table element from the given properties object.
Parameters:
Name | Type | Description |
---|---|---|
properties |
object | |
count |
number | default = 0 to print all properties |
excludedKeys |
string | comma seperated list of excluded keys |
annotations |
string | default = "false" |
Returns:
The created table element.
- Type
- HTMLElement
(static) getBathymetryGrayIndex(currentProperties, allFeatures) → {string}
Returns the GRAY_INDEX for bathymetry raster data
Parameters:
Name | Type | Description |
---|---|---|
currentProperties |
object | |
allFeatures |
Array.<object> |
Returns:
string
- Type
- string
(static) getMarehubOverviewValue(properties, column, unit) → {string}
Prints the value with unit if only one value exists
Parameters:
Name | Type | Description |
---|---|---|
properties |
* | |
column |
* | |
unit |
* |
Returns:
value
- Type
- string
(static) hideOnGalleryEnd() → {string}
Prevents content from being rendered by inserting a comment if the site matches
Returns:
html comment close
- Type
- string
(static) hideOnGalleryStart() → {string}
Prevents content from being rendered by inserting a comment if the site matches
Returns:
html comment open
- Type
- string
(static) isDefined(valueToCheck, then, else_) → {any}
Only returns the given string if the first value is not null or undefined
Parameters:
Name | Type | Description |
---|---|---|
valueToCheck |
any | |
then |
any | |
else_ |
any |
Returns:
given value
- Type
- any
(static) joinArray(inputArray, separator) → {string}
Join Array values as a string
Parameters:
Name | Type | Description |
---|---|---|
inputArray |
Array.<string> | |
separator |
string |
Returns:
- Type
- string
(static) lto(lat, lng) → {HTMLElement}
A function for doing a search request in the elasticsearch index
Parameters:
Name | Type | Description |
---|---|---|
lat |
string | |
lng |
string |
Returns:
container for search results
- Type
- HTMLElement
(static) marehubOverviewPlot(properties, data) → {string}
Creates an overview plot for the measurements layers
Parameters:
Name | Type | Description |
---|---|---|
properties |
object | |
data |
object | response |
Returns:
span placeholder
- Type
- string
(static) measurementsLayerOverview(layer, data) → {HTMLDivElement}
Creates a container element and plots data from MeasurementsLayer
Parameters:
Name | Type | Description |
---|---|---|
layer |
Object | The layer object to be used for plotting. |
data |
Object | The data to be plotted in the container. |
Returns:
Plot Container
- Type
- HTMLDivElement
(static) noCopy() → {HTMLElement}
Prevents the copy button to be displayed in a table row
Returns:
temporary
- Type
- HTMLElement
(static) openColorPicker(layer, properties, key) → {HTMLElement}
Creates a color picker element for a given layer and properties.
Parameters:
Name | Type | Description |
---|---|---|
layer |
Object | The layer object that contains the active layer. |
properties |
Object | The properties object where the color key is stored. |
key |
string | The key in the properties object that holds the color value. |
Returns:
The span element containing the color picker.
- Type
- HTMLElement
(static) openLabelSelection(layer, properties, key) → {HTMLElement}
Opens a label selection window for a given layer and updates the label based on user input.
Parameters:
Name | Type | Description |
---|---|---|
layer |
Object | The layer object to update. |
properties |
Object | The properties object containing the label key. |
key |
string | The key in the properties object for the label. |
Returns:
The span element containing the label link.
- Type
- HTMLElement
(static) parseJSON(jsonstring, keys) → {string}
Parses a json string and outputs the value of the given property
Parameters:
Name | Type | Description |
---|---|---|
jsonstring |
sring | |
keys |
sring | any amount of keys |
Returns:
resolved value
- Type
- string
(static) parseMarkdown(markdown, maxHeight, simplifiedAutoLink) → {HTMLElement}
Parse markdown
Parameters:
Name | Type | Description |
---|---|---|
markdown |
string | |
maxHeight |
number | |
simplifiedAutoLink |
boolean | default is false |
Returns:
div containing parsed markdown
- Type
- HTMLElement
(static) plot(valueX, valueY, labelX, labelY) → {HTMLElement}
Creates an elementary plot
Parameters:
Name | Type | Description |
---|---|---|
valueX |
* | |
valueY |
* | |
labelX |
string | |
labelY |
string |
Returns:
span placeholder
- Type
- HTMLElement
(static) round(num, decimals) → {string}
Round a number to the given decimals
Parameters:
Name | Type | Description |
---|---|---|
num |
string | |
decimals |
string |
Returns:
formatted number
- Type
- string
(static) setTitle(values) → {function}
Defines the title in data-title for the whole popup feature.
The PopupRenderer will extract the title from that property to display
it in the header. This is directly set in the container.
Parameters:
Name | Type | Description |
---|---|---|
values |
string | multiple arguments to concat if needed |
Returns:
callback function to set the containers title
- Type
- function
(static) splitString(str, subStr, index) → {string}
Split a string at a substring and return the given index
Parameters:
Name | Type | Description |
---|---|---|
str |
string | |
subStr |
string | |
index |
number |
Returns:
formatted string
- Type
- string
(static) staOverview(datastreams, layer) → {string}
Parameters:
Name | Type | Description |
---|---|---|
datastreams |
object | |
layer |
Layer |
Returns:
div placeholder
- Type
- string
(static) staThingImages(images) → {HTMLDivElement|undefined}
Generates a div element containing images and their captions.
Parameters:
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
images |
Array | An array of image objects.
Properties
|
Returns:
A div element containing the images and captions, or undefined if no images are provided.
- Type
- HTMLDivElement | undefined
(static) substring(str, startIndex, endIndex) → {string}
Split a string at an index and get the substring
Parameters:
Name | Type | Description |
---|---|---|
str |
string | |
startIndex |
number | |
endIndex |
number |
Returns:
string
- Type
- string
(static) toLowerCase(value) → {string}
Converts the given string to lowercase.
Parameters:
Name | Type | Description |
---|---|---|
value |
string | The string to be converted to lowercase. |
Returns:
The lowercase version of the input string.
- Type
- string
(static) toUpperCase(value) → {string}
Converts a given string to uppercase.
Parameters:
Name | Type | Description |
---|---|---|
value |
string | The string to be converted to uppercase. |
Returns:
The uppercase version of the input string.
- Type
- string