epos documentation
  1. Interfaces
  2. ParameterDefinitions

File

src/api/webApi/data/parameterDefinitions.interface.ts

Index

Methods

Methods

filterOutSpatialParamValues
filterOutSpatialParamValues(values: Array)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:51
Parameters :
Name Type Optional
values Array<ParameterValue> No
Returns : Array<ParameterValue>
filterOutTemporalParamValues
filterOutTemporalParamValues(values: Array)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:53
Parameters :
Name Type Optional
values Array<ParameterValue> No
Returns : Array<ParameterValue>
filterParamValues
filterParamValues(paramDefsToFilterBy: Array, values: Array, filterIn: boolean)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:55
Parameters :
Name Type Optional
paramDefsToFilterBy Array<ParameterDefinition> No
values Array<ParameterValue> No
filterIn boolean No
Returns : Array<ParameterValue>
get
get(index: number)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:25
Parameters :
Name Type Optional
index number No
Returns : ParameterDefinition
getDefaultParameterValues
getDefaultParameterValues()
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:36
Returns : Array<ParameterValue>
getOtherParameters
getOtherParameters()
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:33
Returns : null | Array
getParameter
getParameter(key: string)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:34
Parameters :
Name Type Optional
key string No
Returns : ParameterDefinition
getParameterByProperty
getParameterByProperty(property: ParameterProperty)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:35
Parameters :
Name Type Optional
property ParameterProperty No
Returns : ParameterDefinition
getParameters
getParameters()
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:30
Returns : Array<ParameterDefinition>
getSpatialBounds
getSpatialBounds(paramValues: Array)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:48
Parameters :
Name Type Optional
paramValues Array<ParameterValue> No
Returns : BoundingBox
getSpatialParameters
getSpatialParameters()
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:31
Returns : null | Array
getTemporalParameters
getTemporalParameters()
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:32
Returns : null | Array
getTemporalRange
getTemporalRange(paramValues: Array)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:49
Parameters :
Name Type Optional
paramValues Array<ParameterValue> No
Returns : TemporalRange
hasSpatialParameters
hasSpatialParameters()
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:28
Returns : boolean
hasTemporalParameters
hasTemporalParameters()
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:29
Returns : boolean
replaceParamValueInArray
replaceParamValueInArray(params: Array, paramName: string, newValue: ParameterValue)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:61
Parameters :
Name Type Optional
params Array<ParameterValue> No
paramName string No
newValue ParameterValue No
Returns : void
size
size()
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:26
Returns : number
updateSpatialParamsUsingBounds
updateSpatialParamsUsingBounds(boundingBox: BoundingBox, paramsToUpdate: Array)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:38
Parameters :
Name Type Optional
boundingBox BoundingBox No
paramsToUpdate Array<ParameterValue> No
Returns : Array<ParameterValue>
updateTemporalParamsUsingRange
updateTemporalParamsUsingRange(tempRange: TemporalRange, paramsToUpdate: Array)
Defined in src/api/webApi/data/parameterDefinitions.interface.ts:43
Parameters :
Name Type Optional
tempRange TemporalRange No
paramsToUpdate Array<ParameterValue> No
Returns : Array<ParameterValue> 
import { ParameterDefinition } from './parameterDefinition.interface';
import { ParameterValue } from './parameterValue.interface';
import { BoundingBox } from './boundingBox.interface';
import { TemporalRange } from './temporalRange.interface';
import { ParameterProperty } from './parameterProperty.enum';


export interface ParameterDefinitions {

  get(index: number): ParameterDefinition;
  size(): number;

  hasSpatialParameters(): boolean;
  hasTemporalParameters(): boolean;
  getParameters(): Array<ParameterDefinition>;
  getSpatialParameters(): null | Array<ParameterDefinition>;
  getTemporalParameters(): null | Array<ParameterDefinition>;
  getOtherParameters(): null | Array<ParameterDefinition>;
  getParameter(key: string): ParameterDefinition;
  getParameterByProperty(property: ParameterProperty): ParameterDefinition;
  getDefaultParameterValues(): Array<ParameterValue>;

  updateSpatialParamsUsingBounds(
    boundingBox: BoundingBox,
    paramsToUpdate: Array<ParameterValue>,
  ): Array<ParameterValue>;

  updateTemporalParamsUsingRange(
    tempRange: TemporalRange,
    paramsToUpdate: Array<ParameterValue>,
  ): Array<ParameterValue>;

  getSpatialBounds(paramValues: Array<ParameterValue>): BoundingBox;
  getTemporalRange(paramValues: Array<ParameterValue>): TemporalRange;

  filterOutSpatialParamValues(values: Array<ParameterValue>): Array<ParameterValue>;

  filterOutTemporalParamValues(values: Array<ParameterValue>): Array<ParameterValue>;

  filterParamValues(
    paramDefsToFilterBy: Array<ParameterDefinition>,
    values: Array<ParameterValue>,
    filterIn: boolean,
  ): Array<ParameterValue>;

  replaceParamValueInArray(params: Array<ParameterValue>, paramName: string, newValue: ParameterValue): void;
}

results matching ""

    No results matching ""