Article For
5.1 5.2

Time Series



Document View

Time Series - Document View

Time Series - Document View

Actions

  1. To view a document's time series, open its document view and click the time series tab on the right.
  2. Click to create a new time series, see more below.
  3. Click to view and modify time series data.

Info

  1. Displays the time series':
    • Name
    • The number of entries it contains
    • The range of time from the first to the last entry in the time series

Time Series View

Time Series View

Time Series View

Actions

  1. Click to add a new entry to this time series (StockPrices), or click the dropdown to create a new time series.
  2. Delete all entries from a specified time range.
  3. Edit entry.

Info

  1. Displays time series entries' data, including -
    • Timestamp
    • Numerical data (1-32 double values)
    • Optional tag string


Create new Time Series (by Creating the First Entry)

  • A time series is created upon the creation of its first entry (and deleted once all entries have been deleted).

  • Click the Add Time Series button from the Document View to create the time series' first entry.

Add Time Series

Add Time Series


Add Time Series Entry

Add Time Series Entry

  1. Enter time series' name.
  2. Select a timestamp for the new entry.
  3. Create an optional tag.
  4. Add one or more numerical values (up to 32 values).
    Named Values Time series entry values can be given meaningful names rather than labels like Value #0 and Value #1.
    To set entry values' names, use Studio's Settings > Time Series view.


Editing an Entry

  • Click the Edit Item button from the Time Series View to edit a time series' entry.
Edit Time Series

Edit Time Series


Edit Time Series Entry

Edit Time Series Entry

  1. Edit the optional tag.
  2. Edit a numerical value.
  3. Delete value.
  4. Add an additional value (up to 32 values).


Deleting a Range of Entries

  • Click the Delete Range button from the Time Series View to delete a range of time series entries.
Delete Range Button

Delete Range Button


Delete Range

Delete Range

To specify a range of time series entries:

  1. Start Date
    Check Use minimum to use the first entry's timestamp as the start of the range,
  2. End Date
    Check Use maximum to use the last entry's timestamp as the end of the range.

  • For either option, you can click the input bar and specify some other date in the date & time dialog shown below.

Delete Range - Pick Date and Time

Delete Range - Pick Date and Time

Querying Time Series

Time Series Query

Time Series Query

Actions

  1. Enter your RQL query in the query box.
    Depicted here is a query to get all the StockPrices time series values from documents in the Companies collection.
    Learn more about time series queries here.

  2. Click to run the query.

Info

  1. Query Results - A list of time series that satisfy the query, with:
    • The ID of the associated document.
    • Number of entries and time range.


Time Series Query - Actions

Time Series Query - Actions

  1. Click to open a tab with the time series query results shown in a table.
    Time Series Query Results Table
  2. Click to open a tab with the time series query results shown in a graph (see below).
  3. Multiple documents selection
    Multiple Selection
    • a. Select multiple documents to plot their time series.
    • b. Click to view the selected documents' time series results in a unified graph.
      Unified Graph


Results in Graph View

Time series results in a graph

Time series results in a graph

  1. A graph of time series results in a selected time frame.
  2. A graph showing all the time series results over time.
  3. The selected time frame.
  4. A legend of time series entries' values.
    The entry values names are set in Studio's Settings > Time Series view.


Time series results in a graph - Actions

Time series results in a graph - Actions

  1. Click to go back to the query results tab.
  2. Display tabs with graph or table results.
  3. Drag or resize the selected time frame to view the corresponding results.
  4. Hover your mouse over the graph to view the data of one particular entry.
  5. Toggle viewing points or a continuous line.
  6. Check/Uncheck to plot or hide time series entries' values on the graph.