velocity params Schema #
undefined#/properties/postProcess/items/allOf/12/properties/params
Parameters to be passed to the velocity module
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | specSchema.schema.json* |
params Type #
object (velocity params)
velocity params Properties #
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| identity | string |
Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| timeField | string |
Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| targetSpeed | string |
Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| targetBearing | string |
Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| targetDirection | string |
Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| targetSpeedUnit | Not specified | Optional | cannot be null | specSchema (Unified Pipeline Specification) |
identity #
The field that identifies rows to be included in calculations of velocity
identity
- is optional
- type:
string - cannot be null
- Unstructured type
timeField #
The field representing the time to be used in calculations of velocity
timeField
- is optional
- type:
string - cannot be null
- Unstructured type
targetSpeed #
targetSpeed TODO
targetSpeed
- is optional
- type:
string - cannot be null
- Unstructured type
targetBearing #
targetBearing TODO
targetBearing
- is optional
- type:
string - cannot be null
- Unstructured type
targetDirection #
targetDirection TODO
targetDirection
- is optional
- type:
string - cannot be null
- Unstructured type
targetSpeedUnit #
The unit of speed to display
targetSpeedUnit
- is optional
- type: unknown (targetSpeedUnit)
- cannot be null
- defined in: targetSpeedUnit
targetSpeedUnit Constraints #
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"default" |
|
"kmh" |
|
"mph" |