Module: Portfolio

Classes

FolioConfig
PortfolioConfig
PortfoliosConfig
FolioDownloader

Methods

(static) runPortfolio(portfoliosState)

Run a portfolio

Parameters:
Name Type Description
portfoliosState PortfoliosState

The porfolio to run

Source:

(inner) getBaseLayerFromTheme(baseLayers, theme) → {BaseLayerState}

Get the base layer from theme config

Parameters:
Name Type Description
baseLayers BaseLayersState

The base layers

theme ThemeConfig

The theme config

Source:
Returns:

The base layer

Type
BaseLayerState

(inner) getHighlightPrint(mapProjection, projectProjection) → {object}

Get highlight print parameters

Parameters:
Name Type Description
mapProjection string

The map projection

projectProjection string

The project projection

Source:
Returns:

The highlight print parameters

Type
object

(inner) getLayersInMapGroupFromTheme(mapGroup, theme) → {Array.<MapLayerState>}

Get map layers in group from theme config

Parameters:
Name Type Description
mapGroup MapGroupState

The map group

theme ThemeConfig

The theme config

Source:
Returns:

The map layers

Type
Array.<MapLayerState>

(inner) getLayersStylesFromTheme(themeName) → {Array.<{layer:string, style:string}>}

The layers and styles from theme config

Parameters:
Name Type Description
themeName string

The theme name

Source:
Returns:

list of layer and style

Type
Array.<{layer:string, style:string}>

(inner) getMapId(printTemplate) → {null|string}

Get the map id of the print template

Parameters:
Name Type Description
printTemplate object

a print template configuration

Source:
Returns:

The first map id not overview in the print template

Type
null | string

(inner) getPrintScales() → {Array.<number>}

Get the print scales from the map resolutions.

Source:
Returns:

The print scales

Type
Array.<number>

(inner) getPrintTemplate(name) → {undefined|object}

Get the print template by name

Parameters:
Name Type Description
name string

the print template title

Source:
Returns:

the print template configuration

Type
undefined | object

(inner) getWmsGetPrintParameters(template, mapId, crs, extent, scale, theme, highlightPrint) → {object}

Get the GetPrint request parameters

Parameters:
Name Type Description
template string

the template name/title

mapId string

The map id

crs string

The print projection

extent Array.<number>

The print extent

scale string

The print scale

theme string

The theme name

highlightPrint object

The highlight print parameters

Source:
Returns:

The GetPrint request parameters

Type
object

Classes

FolioConfig
PortfolioConfig
PortfoliosConfig
FolioDownloader

Methods

(static) runPortfolio(portfoliosState)

Run a portfolio

Parameters:
Name Type Description
portfoliosState PortfoliosState

The porfolio to run

Source:

(inner) getBaseLayerFromTheme(baseLayers, theme) → {BaseLayerState}

Get the base layer from theme config

Parameters:
Name Type Description
baseLayers BaseLayersState

The base layers

theme ThemeConfig

The theme config

Source:
Returns:

The base layer

Type
BaseLayerState

(inner) getHighlightPrint(mapProjection, projectProjection) → {object}

Get highlight print parameters

Parameters:
Name Type Description
mapProjection string

The map projection

projectProjection string

The project projection

Source:
Returns:

The highlight print parameters

Type
object

(inner) getLayersInMapGroupFromTheme(mapGroup, theme) → {Array.<MapLayerState>}

Get map layers in group from theme config

Parameters:
Name Type Description
mapGroup MapGroupState

The map group

theme ThemeConfig

The theme config

Source:
Returns:

The map layers

Type
Array.<MapLayerState>

(inner) getLayersStylesFromTheme(themeName) → {Array.<{layer:string, style:string}>}

The layers and styles from theme config

Parameters:
Name Type Description
themeName string

The theme name

Source:
Returns:

list of layer and style

Type
Array.<{layer:string, style:string}>

(inner) getMapId(printTemplate) → {null|string}

Get the map id of the print template

Parameters:
Name Type Description
printTemplate object

a print template configuration

Source:
Returns:

The first map id not overview in the print template

Type
null | string

(inner) getPrintScales() → {Array.<number>}

Get the print scales from the map resolutions.

Source:
Returns:

The print scales

Type
Array.<number>

(inner) getPrintTemplate(name) → {undefined|object}

Get the print template by name

Parameters:
Name Type Description
name string

the print template title

Source:
Returns:

the print template configuration

Type
undefined | object

(inner) getWmsGetPrintParameters(template, mapId, crs, extent, scale, theme, highlightPrint) → {object}

Get the GetPrint request parameters

Parameters:
Name Type Description
template string

the template name/title

mapId string

The map id

crs string

The print projection

extent Array.<number>

The print extent

scale string

The print scale

theme string

The theme name

highlightPrint object

The highlight print parameters

Source:
Returns:

The GetPrint request parameters

Type
object