logofirst
logofirst GitHub

TimeSeriesLabels

Use the TimeSeriesLabels tag to create a labeled time range.

Use with the following data types: time series

Parameters

Param Type Default Description
name string Name of the element
toname string Name of the timeseries to label
[choice] single | multiple single Configure whether you can select one or multiple labels
[maxUsages] number Maximum number of times a label can be used per task
[showInline] boolean true Show labels in the same visual line
[opacity] float 0.9 Opacity of the range
[fillColor] string "transparent" Range fill color in hexadecimal or HTML color name
[strokeColor] string "#f48a42" Stroke color in hexadecimal
[strokeWidth] number 1 Width of the stroke

Example

<!--Basic labeling configuration to apply labels to identified regions of a time series with one channel -->
<View>
  <TimeSeriesLabels name="label" toName="ts">
      <Label value="Run"/>
      <Label value="Walk"/>
  </TimeSeriesLabels>

  <TimeSeries name="ts" value="$csv" valueType="url">
     <Channel column="first_column"/>
  </TimeSeries>
</View>