epos documentation
  1. Classes
  2. DataConfigurableParamValues

File

src/utility/configurables/dataConfigurableParamValues.ts

Extends

DataConfigurable

Index

Properties
Methods

Constructor

constructor(injector: Injector, distributionDetails: DistributionDetails, paramValues: Array, spatialOverrides?: BoundingBox, temporalOverrides?: TemporalRange)
Defined in src/utility/configurables/dataConfigurableParamValues.ts:23
Parameters :
Name Type Optional
injector Injector No
distributionDetails DistributionDetails No
paramValues Array<ParameterValue> No
spatialOverrides BoundingBox Yes
temporalOverrides TemporalRange Yes

Properties

Public Readonly actions
Type : null | Array<DataConfigurableAction>
Inherited from DataConfigurable
Defined in DataConfigurable:56

An array of DataConfigurableActions that can be applied to this configurable.
Public changed
Default value : false
Inherited from DataConfigurable
Defined in DataConfigurable:49

Whether any of the #newParamValues have changed or not.
Public Readonly context
Type : string
Inherited from DataConfigurable
Defined in DataConfigurable:44
Public Readonly currentParamValues
Type : Array<ParameterValue>
Inherited from DataConfigurable
Defined in DataConfigurable:61

An array of ParameterValue objects representing values that have been applied to any visualizations etc.
Public Readonly distributionDetails
Type : DistributionDetails
Inherited from DataConfigurable
Defined in DataConfigurable:107
The detailed search result (distribution) object that a configuration is applied to.
Public Readonly id
Type : string
Inherited from DataConfigurable
Defined in DataConfigurable:64

the object's identifier.
Public Readonly isDownloadable
Type : boolean
Inherited from DataConfigurable
Defined in DataConfigurable:38

Copied from DistributionDetails
Public Readonly isGraphable
Type : boolean
Inherited from DataConfigurable
Defined in DataConfigurable:40

Copied from DistributionDetails
Public Readonly isMappable
Type : boolean
Inherited from DataConfigurable
Defined in DataConfigurable:36

Copied from DistributionDetails
Public Readonly isTabularable
Type : boolean
Inherited from DataConfigurable
Defined in DataConfigurable:42

Copied from DistributionDetails
Public loading
Default value : false
Inherited from DataConfigurable
Defined in DataConfigurable:53

Whether the #newParamValues are in the process of being applied or not.
Public Readonly name
Type : string
Inherited from DataConfigurable
Defined in DataConfigurable:66

the object's name.
Private newParamValues
Type : Array<ParameterValue>
Inherited from DataConfigurable
Defined in DataConfigurable:89

An array of ParameterValue objects that have been changed and have not yet been applied to any visualizations etc.
Private Readonly parameterDefinitions
Type : ParameterDefinitions
Inherited from DataConfigurable
Defined in DataConfigurable:69

The ParameterDefinitions retrieved from a DistributionDetails item.
Public sameAsDefaults
Default value : true
Inherited from DataConfigurable
Defined in DataConfigurable:51

Whether all of the #newParamValues are the same as the defaults or not.
Private Readonly showSpatialCoverageSrc
Default value : new BehaviorSubject<boolean>(false)
Inherited from DataConfigurable
Defined in DataConfigurable:72

Whether a user has selected to show the spatial coverage for this item or not.
Public showSpatialObs
Default value : this.showSpatialCoverageSrc.asObservable()
Inherited from DataConfigurable
Defined in DataConfigurable:74
Private spatialLinked
Default value : false
Inherited from DataConfigurable
Defined in DataConfigurable:92

Whether any spatial parameter values in this configuration are linked to page-wide values.
Public Readonly styleObs
Default value : this.styleSource.asObservable()
Inherited from DataConfigurable
Defined in DataConfigurable:79
Private Readonly styleSource
Default value : new BehaviorSubject<null | Style>(null)
Inherited from DataConfigurable
Defined in DataConfigurable:77

An rxjs/BehaviorSubject holding the Style object for this configurable.
Private temporalLinked
Default value : false
Inherited from DataConfigurable
Defined in DataConfigurable:94

Whether any temporal parameter values in this configuration are linked to page-wide values.
Protected triggerReloadFunc
Type : function
Inherited from DataConfigurable
Defined in DataConfigurable:83

A function that will trigger a reload of visual representations of this object.
Public valid
Default value : true
Inherited from DataConfigurable
Defined in DataConfigurable:47

Whether all #newParamValues are valid or not.

Methods

Protected evaluateActionVisibility
evaluateActionVisibility()
Inherited from DataConfigurable
Defined in DataConfigurable:365

Calls the DataConfigurableAction function on all #actions.

Returns : void
Public getCurrentSpatialBounds
getCurrentSpatialBounds()
Inherited from DataConfigurable
Defined in DataConfigurable:249
Returns : BoundingBox
Public getCurrentTemporalRange
getCurrentTemporalRange()
Inherited from DataConfigurable
Defined in DataConfigurable:264
Returns : TemporalRange
Public getDistributionDetails
getDistributionDetails()
Inherited from DataConfigurable
Defined in DataConfigurable:141

Retrieves the DistributionDetails that this object was created with.

Returns : DistributionDetails
Public getDownloadableFormats
getDownloadableFormats()
Inherited from DataConfigurable
Defined in DataConfigurable:176

Returns an Array of DistributionFormats available on this configurable, that are classified as downloadable.

Returns : Array<DistributionFormat>
Public getGraphableFormats
getGraphableFormats()
Inherited from DataConfigurable
Defined in DataConfigurable:184

Returns an Array of DistributionFormats available on this configurable, that are classified as graphable.

Returns : Array<DistributionFormat>
Public getMappableableFormats
getMappableableFormats()
Inherited from DataConfigurable
Defined in DataConfigurable:169

Returns an Array of DistributionFormats available on this configurable, that are classified as mappable.

Returns : Array<DistributionFormat>
Public getNewParameterValues
getNewParameterValues()
Inherited from DataConfigurable
Defined in DataConfigurable:320

Retrieves the #newParamValues variable.

Returns : Array<ParameterValue>
Public getNewSpatialBounds
getNewSpatialBounds()
Inherited from DataConfigurable
Defined in DataConfigurable:252
Returns : BoundingBox
Public getNewTemporalRange
getNewTemporalRange()
Inherited from DataConfigurable
Defined in DataConfigurable:267
Returns : TemporalRange
Public getParameterDefinitions
getParameterDefinitions()
Inherited from DataConfigurable
Defined in DataConfigurable:314

Retrieves the ParameterDefinitions from the DistributionDetails that this object was created with.

Returns : ParameterDefinitions
Public getShowSpatialCoverage
getShowSpatialCoverage()
Inherited from DataConfigurable
Defined in DataConfigurable:302
Returns : boolean
Public getSpatialCoverage
getSpatialCoverage()
Inherited from DataConfigurable
Defined in DataConfigurable:306
Returns : null | SpatialRange
Public getStyle
getStyle()
Inherited from DataConfigurable
Defined in DataConfigurable:207

Returns the style in #styleSource.

Returns : null | Style
Public isOnlyDownloadable
isOnlyDownloadable()
Inherited from DataConfigurable
Defined in DataConfigurable:324
Returns : boolean
Public isSpatialLinked
isSpatialLinked()
Inherited from DataConfigurable
Defined in DataConfigurable:237

returns the value of the the #spatialLinked variable.

Returns : boolean
Public isTemporalLinked
isTemporalLinked()
Inherited from DataConfigurable
Defined in DataConfigurable:256
Returns : boolean
Protected paramsSameAsDefaults
paramsSameAsDefaults()
Inherited from DataConfigurable
Defined in DataConfigurable:393
Returns : boolean
Protected paramValuesSame
paramValuesSame(params1: Array, params2: Array)
Inherited from DataConfigurable
Defined in DataConfigurable:380

This function compares two Arrays of ParameterValues. As default value on param definitions are now set to "" on init if not set, ths number of param values should be constant.

Parameters :
Name Type Optional Description
params1 Array<ParameterValue> No

First set of ParameterValues.
params2 Array<ParameterValue> No

Second set of ParameterValues.
Returns : boolean

true if all values in params1 are equivalent to the item with the same key in params2. As default value on param definitions are now set to "" on init if not set, ths number of param values should be constant.
Public reload
reload(newConfigurable?: DataConfigurable)
Inherited from DataConfigurable
Defined in DataConfigurable:286

The reload function in TypeScript triggers a reload with optional new configuration after a delay. method is an optional parameter of type DataConfigurable. It is used to provide a new configuration for reloading data. If a newConfigurable object is provided, it will be used for reloading data; otherwise, the method will which the method is being called.

Parameters :
Name Type Optional Description
newConfigurable DataConfigurable Yes
  • The newConfigurable parameter in the reload method is an optional parameter of type DataConfigurable. It is used to provide a new configuration for reloading data. If a newConfigurable object is provided, it will be used for reloading data; otherwise, the method will
Protected resetParameterValues
resetParameterValues()
Inherited from DataConfigurable
Defined in DataConfigurable:332

Sets the #newParamValues variable to a copy of the #currentParamValues variable, as it was after initialisation.

Returns : void
Public setLoading
setLoading(loading: boolean)
Inherited from DataConfigurable
Defined in DataConfigurable:159

Sets the internal #loading variable before calling #updateActionsEnabledStatus.

Parameters :
Name Type Optional
loading boolean No
Public setNewParams
setNewParams(newParamValues: Array)
Inherited from DataConfigurable
Defined in DataConfigurable:227

The function setNewParams updates parameter values and related properties, and returns the instance for chaining. parameter values. the class.

Parameters :
Name Type Optional Description
newParamValues Array<ParameterValue> No
  • An array of new parameter values that will be used to update the current parameter values.
Protected setParameterValuesToDefaults
setParameterValuesToDefaults()
Inherited from DataConfigurable
Defined in DataConfigurable:339

Sets the #newParamValues variable to the default values obtained from the #distributionDetails object.

Returns : void
Public setShowSpatialCoverage
setShowSpatialCoverage(show: boolean)
Inherited from DataConfigurable
Defined in DataConfigurable:296
Parameters :
Name Type Optional
show boolean No
Public setSpatialLinked
setSpatialLinked(linked: boolean)
Inherited from DataConfigurable
Defined in DataConfigurable:244

Sets the value of the the #spatialLinked variable and calls reload.

Parameters :
Name Type Optional Description
linked boolean No

Whether spatially linked or not.
Public setStyle
setStyle(style: null | Style, force)
Inherited from DataConfigurable
Defined in DataConfigurable:198

The function setStyle updates the style of an element if it is different from the current style or if forced to do so. or an object of type Style. a default value of false. It is used to determine whether the style should be set even if it is the same as the current style. If force is set to true, the style will be

Parameters :
Name Type Optional Default value Description
style null | Style No
  • The style parameter in the setStyle method can be either null or an object of type Style.
force No false
  • The force parameter in the setStyle method is a boolean parameter with a default value of false. It is used to determine whether the style should be set even if it is the same as the current style. If force is set to true, the style will be
Public setTemporalLinked
setTemporalLinked(linked: boolean)
Inherited from DataConfigurable
Defined in DataConfigurable:259
Parameters :
Name Type Optional
linked boolean No
Public setTriggerReloadFunc
setTriggerReloadFunc(func: (configurable: DataConfigurable) => void)
Inherited from DataConfigurable
Defined in DataConfigurable:271
Parameters :
Name Type Optional
func function No
Public setValid
setValid(valid: boolean)
Inherited from DataConfigurable
Defined in DataConfigurable:149

Sets the internal #valid variable before calling #updateActionsEnabledStatus.

Parameters :
Name Type Optional Description
valid boolean No

Whether this object is valid or not.
Protected updateActionsEnabledStatus
updateActionsEnabledStatus()
Inherited from DataConfigurable
Defined in DataConfigurable:355

Calls the DataConfigurableAction function on all #actions using the #valid, #changed and #loading values.

Returns : void
Public watchStyle
use styleobs instead
watchStyle()
Inherited from DataConfigurable
Defined in DataConfigurable:215

Returns an rxjs/Observable object from #styleSource, containing the current style.

Returns : Observable<null | Style> 
import { DataConfigurable } from './dataConfigurable.abstract';
import { ParameterValue } from 'api/webApi/data/parameterValue.interface';
import { DistributionDetails } from 'api/webApi/data/distributionDetails.interface';
import { Injector } from '@angular/core';
import { BoundingBox } from 'api/webApi/data/boundingBox.interface';
import { TemporalRange } from 'api/webApi/data/temporalRange.interface';

export class DataConfigurableParamValues extends DataConfigurable {
  constructor(
    protected injector: Injector,
    distributionDetails: DistributionDetails,
    paramValues: Array<ParameterValue>,
    spatialOverrides?: BoundingBox,
    temporalOverrides?: TemporalRange,
  ) {
    super(distributionDetails, paramValues, spatialOverrides, temporalOverrides);
  }


}

results matching ""

    No results matching ""