Time Series Customization

Customize how time series data appears in the Label Editor. Configure its initial appearance during upload, update saved settings with the SDK, or use the editor controls.

Customize Channels in the Editor

Use the channel controls to show or hide channels, choose colors, switch between lines and points, and adjust line width or point size. For a chart tile, open Time series style settings in its toolbar. Cursor demonstrating how to hide acc_z with the eye control, then change acc_x from a line to points

Cursor demonstrating how to hide acc_z with the eye control, then change acc_x from a line to points

Configure Channels in Upload JSON

Register CSV files with the time_series top-level key in your upload JSON. Add optional settings to set channel labels, colors, visibility, and rendering styles before annotators open the file.

Time series upload JSON

{
  "time_series": [
    {
      "objectUrl": "s3://my-bucket/robot-arm/pick-and-place/accelerometer.csv",
      "title": "Robot arm — pick-and-place accelerometer",
      "clientMetadata": {
        "robot_type": "robot_arm",
        "task": "pick_and_place"
      },
      "settings": {
        "channels": {
          "acc_x": {
            "label": "Acceleration X",
            "color": "#2563eb",
            "hidden": false,
            "style": "line",
            "lineWidth": 2
          },
          "acc_y": {
            "label": "Acceleration Y",
            "color": "#f97316",
            "hidden": false,
            "style": "points",
            "pointRadius": 3
          }
        }
      }
    }
  ]
}

The settings object is optional, and channels you omit use the default appearance. Use CSV header names such as acc_x as channel keys. With SDK v0.1.205 or later, label and color are optional; omitted values use the header name and the editor’s palette. See channel view settings for defaults. Use lineWidth from 0.5 to 6 for a line channel, or pointRadius from 1 to 8 for a points channel. Set hidden to true to hide a channel initially. Register the JSON through Manual Data Registration or the SDK registration flow.

Build the Upload with SDK Classes

You can build the same registration payload with SDK classes instead of writing JSON. Replace the private key, folder, and integration placeholders with your own values. See SDK authentication for client setup.

from encord import EncordUserClient
from encord.storage import (
    DataUploadItems,
    DataUploadTimeSeries,
    TimeSeriesLineChannelViewSettings,
    TimeSeriesPointsChannelViewSettings,
    TimeSeriesViewSettings,
)

client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path="<private_key_path>"
)
folder = client.get_storage_folder("<folder_id>")

settings = TimeSeriesViewSettings(
    channels={
        "acc_x": TimeSeriesLineChannelViewSettings(
            label="Acceleration X",
            color="#2563eb",
            hidden=False,
            line_width=2,
        ),
        "acc_y": TimeSeriesPointsChannelViewSettings(
            label="Acceleration Y",
            color="#f97316",
            hidden=False,
            point_radius=3,
        ),
    }
)
upload = DataUploadItems(
    time_series=[
        DataUploadTimeSeries(
            object_url="s3://my-bucket/robot-arm/pick-and-place/accelerometer.csv",
            title="Robot arm — pick-and-place accelerometer",
            client_metadata={"robot_type": "robot_arm", "task": "pick_and_place"},
            settings=settings,
        )
    ]
)
job_id = folder.add_private_data_to_folder_start(
    integration_id="<integration_id>",
    private_files=upload,
)
result = folder.add_private_data_to_folder_get_result(job_id, timeout_seconds=60)
print(result)

The line and points classes set the corresponding style value automatically. Inspect the returned status and any upload errors. If registration is still pending, poll the same job again.

Update Channel Settings with the SDK

Use StorageItem.update(timeseries_settings=...) to change the saved settings of an existing time series file. To retain other configured channels, include their existing settings in the update:

from encord import EncordUserClient
from encord.storage import TimeSeriesLineChannelViewSettings, TimeSeriesViewSettings

client = EncordUserClient.create_with_ssh_private_key(
    ssh_private_key_path="<private_key_path>"
)

item = client.get_storage_item("<time_series_file_id>")
channels = dict(item.timeseries_settings.channels) if item.timeseries_settings else {}
channels["acc_x"] = TimeSeriesLineChannelViewSettings(
    label="Acceleration X",
    color="#2563eb",
    hidden=False,
    line_width=2,
)
item.update(timeseries_settings=TimeSeriesViewSettings(channels=channels))

For a local CSV upload, pass the same TimeSeriesViewSettings object as settings to StorageFolder.upload_time_series(). See the SDK upload and configuration guide for a complete example.

Overview

LiDAR, Radar and Sensor Data

Time Series Data

Visual Data

Audio Data

Text, HTML, and PDFs

DICOM and NIFTI

Multimodal

Geospatial Data

Time Series Customization

Customize Channels in the Editor

Configure Channels in Upload JSON

Build the Upload with SDK Classes

Update Channel Settings with the SDK

​Customize Channels in the Editor

​Configure Channels in Upload JSON

​Build the Upload with SDK Classes

​Update Channel Settings with the SDK

Customize Channels in the Editor

Configure Channels in Upload JSON

Build the Upload with SDK Classes

Update Channel Settings with the SDK