Automatically Displaying Properties on a Dashboard Tile

Add properties, or key-value pairs, to a tag or notebook (.ipynb) to automatically populate them on a dashboard tile when you add the data source to a tile.

Adding Properties to a Tag

Manually add properties to a tag so they display on a tile containing the tag.

  1. In Tags, double-click the tag you want to use as a data source for the dashboard tile.
  2. Click Add Property and define the property you want to automatically populate on the tile when you add the tag as a data source. Refer to the following table to determine which properties you want to add.
    Property on the tileDescriptionKeyExample value
    TitleName you want the tile to displaydisplayNameFailed tests
    UnitsUnit of measurement, quantity, or classification of the dataunits
    • Tests
    • km/s
    NavigationLink to data source in the SystemLink web applicationhyperlink#tagviewer/tag/d725064a-b04a/f00.bar
    Note These are the only properties you can define to automatically display on a tile for a tag.
  3. Repeat step 2 to add more properties.
  4. Click Save.

Adding Properties to a Notebook

Manually add properties to a notebook (.ipynb) so they display on a tile containing the notebook.

  1. In Jupyter, double-click the notebook you want to use as a data source for a dashboard tile.
  2. Define the properties in a code cell of the notebook. Refer to the following table to determine how you want to define the style of your tile.
    Property on the tileDescriptionProperty typeKeyExample value
    • X Label
    • Y Label
    Name for the X and Y axes on a graph tileGlobalaxis_labels['x index', 'Day']
    Tick labelName for a data point on the graphGlobaltick_labels[{'x': 0, 'label': 'January'}, {'x': 1, 'label': 'February'}]
    OrientationLayout of the tileGlobalorientationVERTICAL
    Plot colorsColors you want to add to differentiate data plots on the graphPlotplot_color
    • CSS color name (e.g. blue)
    • Hex string (e.g. #0000ff)
    • RGB string (e.g. rgb(0,0,255))
    Plot styleType of graph you want to use to display the dataPlotplot_style
    • LINE
    • BAR
    • POINT
    • SCATTER
    For example, your code cell may look like the following:
    # Result
    sb.glue('navigation', '#testmonitor/testresults/config/...')
    sb.glue('title', 'Image')
    sb.glue('axis_labels', ['x index', 'Value'])
    sb.glue('tick_labels', ticks)
    sb.glue('orientation', 'VERTICAL')
    sb.glue('result', result)
    Note The result in sb.glue('result', result) is an array of objects. For example, your code cell may look like the following:
    {
       plot_style: "BAR",
       plot_color: "rbg(0,0,255)"
       data_format: "XY",
       data_frame: {,…}}
    }
    
  3. Click Save.
When you add the tag or notebook to a tile in Dashboards, the properties you added automatically display on the tile. Refer to Visualizing Data on a Tile Dashboard for more information.