Deep Link Interface

The TICS Viewer supports "deep linking" which allows you to quickly access interesting views of the TICS Viewer using bookmarks or hyperlinks. Deep links can also be used to embed visualizations, such as trend diagrams, in your custom dashboard.

To obtain a deep link to a view, simply navigate to the desired view, configure it, and then copy and paste the URL from your browser's address bar. For instance, to obtain a deep link for the trend diagram of the TQI for a specific project, select the project on the TQI Dashboard and open the trend diagram by clicking the icon. Copy the URL from the popup window's address bar to obtain a deep link to this trend diagram.

Although you can copy any URL from the viewer, we do not guarantee that they keep working in future TICS versions. We guarantee that existing links keep working for the following pages:

Deep links contain visualization parameters in the form of &-separated key=value pairs after the # symbol. If multiple values are provided for a key, they are separated by a ,. In addition to the parameters that appear by normally navigating through the UI, there are some additional parameters that you can provide, to further customize the view, as described below.

Chart Parameters

KeyValueEffect
flags m or minimalLayout Minimal layout; hide UI elements surrounding the chart.
This page does not automatically refresh, so it will get out of date after a new analysis is performed.
flags noScale Scaling disabled; all axes will keep their default range instead of scaling to metric values.
w integer Sets the width of the diagram.
h integer Sets the height of the diagram.
You might need to refresh the page after changing the width or height

As an example, suppose that you have the following URL for a bar chart showing the TQI per project:

Chart.html#axes=Project()&metrics=tqi&type=column

Then you can get a minimal layout, with scaling disabled and a width and height of 800 pixels, as follows:

Chart.html#axes=Project()&metrics=tqi&type=column&flags=m,noScale&w=800&h=800

Explorer Parameters

KeyValueEffect
flags m or minimalLayout Minimal layout. Hides the path tree, breadcrumb, and application bar, leaving only the metric table.

As an example, suppose that you have the following URL for the Explorer showing the TQI and LOC per project:

Explorer.html#axes=Project()&metrics=tqi,loc

Then you can get a minimal layout, showing only the metric table, as follows:

Explorer.html#axes=Project()&metrics=tqi,loc&flags=m