swim-ui documentation
  1. Injectables
  2. ParameterService

File

src/app/services/parameter.service.ts

Description

Interface with SWIM model input catalog (parameters)

Index

Properties
Methods

Constructor

constructor(http: HttpClient, errorHandler: ErrorHandlerService, locale: string)

Class constructor uses http client and router classes

Parameters :
Name Type Optional
http HttpClient No
errorHandler ErrorHandlerService No
locale string No

Methods

addParameter
addParameter()

TODO Add a parameter document to the input catalog

Returns : void
deleteParameter
deleteParameter()

TODO Mark a parameter document for removal

Returns : void
getParameterCatalog
getParameterCatalog(modelId: string)

Get parameters by model id

Parameters :
Name Type Optional Description
modelId string No

model identifier
Returns : void
getParameterMetaByName
getParameterMetaByName(name: string)

Returns metadata by parameter name, does not include set or default values

Parameters :
Name Type Optional Description
name string No

paramName - name identifier for the paramater
Returns : any
getParameterMetaListener
getParameterMetaListener()

Get parameter metadata changes observable object

Returns : any
getParameterUpdateListener
getParameterUpdateListener()

Get parameter catalog changes observable object

Returns : any
Private setLangIndex
setLangIndex()

set the index for the current language

Returns : void
setParameterCatalog
setParameterCatalog(parameters: Parameter[])

Defines the parameter catalog from outside No fetching from the server

Parameters :
Name Type Optional Description
parameters Parameter[] No

list of parameters
Returns : void
updateParameter
updateParameter()

TODO Update a paramater object in the input catalog

Returns : void
updateParamValue
updateParamValue(name: string, value: any)

Update the value of a target parameter (model input)

Parameters :
Name Type Optional Description
name string No

unique name of the parameter
value any No

new value (dataset)
Returns : void

Properties

Public lanIndex
Type : number
Default value : 0

Language Index
Public locale
Type : string
Decorators :
@Inject(LOCALE_ID)
Private parameterCatalog
Type : Parameter[]
Default value : []

Parameter catalog from a specific model
Private parameterCatalogUpdated
Default value : new Subject<Parameter[]>()

Subscribable subject for when the catalog changes
Private parameterMetadataUpdated
Default value : new Subject<any>()

Subscribable subject from when parameter metadata in the catalog is changed

results matching ""

    No results matching ""