Readonly
dateThe timestamp.
Optional
Readonly
metadataAttached metadata.
Readonly
streamThe stream ID.
Optional
Readonly
tagsThe tag values.
Get this instance as a simple object.
The following basic properties will be set on the returned object:
streamId
- the stream IDdate
- the timestampsourceId
- the metadata source IDnodeId
or locationId
- either the node ID or location ID from the metadatatags
- any tags (as an Array)Beyond that, all instantaneous, accumulating, and status properties will be included. If duplicate property names exist between the different classifications, the first-available value will be used.
Optional
meta: DatumStreamMetadata | DatumStreamMetadataRegistryOptional
meta: DatumStreamMetadata | DatumStreamMetadataRegistryOptional
withoutStatistics: booleana metadata instance or metadata registry to encode the property names with;
falls back to the meta
class property if not provided
if true
then omit statistic properties (when available)
an object populated with all available properties
Get the property values for a given samples type.
the type of property values to return
the property values for the given type, or undefined if none available
Get this object as a standard JSON encoded string value.
This method returns the JSON form of the result of toJsonObject().
Optional
registry: DatumStreamMetadataRegistrya stream metadata registry to encode as a registry-indexed stream datum
the JSON encoded string
Get this object as an array suitable for encoding into a standard stream datum JSON string.
Optional
registry: DatumStreamMetadataRegistrya stream metadata registry to encode as a registry-indexed stream datum
the datum stream array object
Generated using TypeDoc
Common API for stream and stream aggregate datum.