Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a set of layers which are grouped together in a meaningful way for a certain use case. There will typically be multiple layer themes in a site which the end user can toggle between, effectively swapping ou the list of layers with the new list of layers as configured in the selected layer theme. The theme allows for the inclusion/exclusion of layers, and for each layer that is included in the theme, the visibility can be specified.

Hierarchy

  • LayerTheme

Index

Constructors

constructor

  • Initializes a new instance of the LayerTheme class.

    Parameters

    Returns LayerTheme

  • Initializes a new instance of the LayerTheme class.

    Parameters

    Returns LayerTheme

Properties

displayName

displayName: string

The display name of the theme, that can be shown to the end user.

extensions

extensions: Extension[]

The list of {@link geocortex.essentials.Extension} (if any) as defined by the administrator on the server.

id

id: string

The ID of the theme. If the ID is null, it is defined to be the default theme

isActive

isActive: boolean

A boolean indicating if this theme is the currently active theme.

isDefaultTheme

isDefaultTheme: boolean

A boolean indicating whether this is the default theme. This is determined based on whether or not the ID is null. If the ID is null, it is taken to be the default theme. If it is not null, it is not the default theme. The default theme specifies that all layers are included, and the visibilities are as configured in the site map.

layerThemesInfo

layerThemesInfo: LayerThemesInfo

The LayerThemesInfo object contained in the map.

properties

properties: PropertyParam[]

The list of {@geocortex.PropertyParam} objects as defined by the administrator on the server.

Methods

applyToMap

  • applyToMap(): void
  • Applies the theme settings to the map. This method iterates through all the layers in the map and adjusts their visibility and other settings depending on if the layer is in the theme or not. By design, this method will reapply the theme even if the theme has already been applied. It also ensures that the LayerThemesInfo.active theme is set to this theme. In order to call this method, the LayerThemesInfo, and LayerThemesInfo.map properties must be specified in order for this method to get access to the map.

    Returns void