Organizing Places¶
Places are organized in collections (places collections) container one or more places.
Places Collections¶
A place collection is a container containing places, time intervals and indicator styles.
The place collection has the following properties that can be edited using a data table.
| Property | Description |
|---|---|
| Attribute Key | Attribute of the feature class containing a key to the associated feature of the feature class. |
| Feature class id | The id of the feature class containing spatial information of the places of the feature collection. |
| Scenario id | Id of a scenario containing model input and model output time series. |
Places¶
A place contains the association to features.
| Property | Description |
|---|---|
| Feature id | Id of the feature associated to the place. |
| Attribute value | Value of the attribute identifying the feature of the place in the feature class of the places collection. |
| Category | Category of the place. |
Indicator¶
Indicator of a place, specifying how the value of a place should be calculated for a certain time.
| Property | Description |
|---|---|
| Aggregation Type | Type of aggregation used when calculating indicator values (0=min, 1=max, 2=average, 3=sum). |
| Time Series Type | The type of time series (enum: 0=Observation, 1=SimulationInput, 2=SimulationOutput, 3=None). |
| Time Series Id Type | Type of time series id. (ENUM: 0=TimeSeriesId, 1=ModelSetupInputTimeSeriesId, 2=ModelSetupOutputTimeSeriesId). The type indicates in what table, the time series can be found. |
| Data Source Type | Data source type (0=Scalar, 1=TimeSeries, 2=EnsembleTimeSeries) |
| Quantile | Quantile in case the time series is an ensemble. |
| Time Series Id | Id of the time series. |
| Connection Information | Connection info in case the time series is found in another database or workspace. |
Place Indicator Style¶
Place indicator threshold, specifying the threshold for the place for a certain indicator.
| Property | Description |
|---|---|
| Index | Index (order) of the threshold. |
| Threshold value | Threshold value. |
| Indicator style id | Id of the indicator style. |
Time Intervals¶
Time interval, specifying the time period and time step intervals of the observation period.
| Property | Description |
|---|---|
| Name | Name of the time interval. |
| Start | Start of the time interval. OADate if it is a fixed date else it is a time span in seconds. |
| End | End of the time interval. OADate if it is a fixed date else it is a time span in seconds. |
| Interval Type | Type of the place time interval (0=Fixed, 1=RelativeToNow, 2=RelativeToDateTime, 3=All). |
Indicator Styles¶
Indicator style specifying color and name of an indicator.
| Property | Description |
|---|---|
| Name | Name of the indicator style. |
| Color | The color of the place indicator style as hexadecimal #RRGGBB (e.g. #FF0000 for red). |