Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
makseq committed Oct 27, 2020
1 parent 925c1b4 commit 708394d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/source/blog/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@
</div>
<div class="category">release notes</div>
<div class="desc">26 Oct 2020, 7 min read</div>
<div class="title">Label Studio 0.8.0 Release - Time series is Everywhere!</div>
<div class="title">Label Studio 0.8.0 Release - Time Series is Everywhere!</div>
</div>
</a>
</div>
Expand Down
9 changes: 4 additions & 5 deletions docs/source/tags/timeseries.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,21 @@
title: TimeSeries
type: tags
order: 306
is_new: t
---

TimeSeries tag can be used to label time series data.
Read more about Time Series Labeling on [template page](../templates/time_series.html) or in our [blog](/blog/release-080-time-series-labeling.html).
Read more about Time Series Labeling on [template page](../templates/time_series.html).

### Parameters

| Param | Type | Description |
| --- | --- | --- |
| name | <code>string</code> | name of the element |
| value | <code>string</code> | key used to lookup the data, it needs to reference either URLs for your time-series if valueType=url, otherwise expects JSON |
| [valueType] | <code>enum</code> | "url" or "json" If set to "url" then it loads value references inside `value` key, otherwise it expects JSON. Defaults to url
| [valueType] | <code>enum</code> | "url" or "json" If set to "url" then it loads value references inside `value` key, otherwise it expects JSON. Defaults to url |
| [timeColumn] | <code>string</code> | column name or index that provides temporal values, if your time-series data has no temporal column then its automatically generated |
| [timeFormat] | <code>string</code> | pattern used to parse values inside timeColumn, parsing provided by d3, and follows `strftime` implementation
| [timeDisplayFormat] | <code>string</code> | format used to display temporal value, can be a number or a date, if a temporal column is a date then use strftime to format it, otherwise, if it's a number then use [d3 number](https://github.com/d3/d3-format#locale_format) formatting
| [timeFormat] | <code>string</code> | pattern used to parse values inside timeColumn, parsing provided by d3, and follows `strftime` implementation |
| [timeDisplayFormat] | <code>string</code> | format used to display temporal value, can be a number or a date, if a temporal column is a date then use strftime to format it, otherwise, if it's a number then use [d3 number](https://github.com/d3/d3-format#locale_format) formatting |
| [sep] | <code>string</code> | separator for you CSV file, default is comma "," |
| [overviewChannels] | <code>string</code> | comma-separated list of channels names or indexes displayed in overview |

Expand Down
13 changes: 7 additions & 6 deletions docs/source/tags/timeserieslabels.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: TimeSeriesLabels
type: tags
order: 423
is_new: t
---

TimeSeriesLabels tag creates labeled time range
Expand All @@ -20,12 +19,14 @@ TimeSeriesLabels tag creates labeled time range
### Example
```html
<View>
<TimeSeriesLabels name="kp-1" toName="img-1">
<Label value="Face"></Label>
<Label value="Nose"></Label>
<View>
<TimeSeriesLabels name="label" toName="ts">
<Label value="Run"/>
<Label value="Walk"/>
</TimeSeriesLabels>
<TimeSeries name="img-1" value="$time">
<Channel value="$col" />

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

0 comments on commit 708394d

Please sign in to comment.