Package org.eclipse.tracecompass.incubator.scripting.ui.views

Class ViewModule

java.lang.Object

org.eclipse.tracecompass.incubator.scripting.ui.views.ViewModule

public class ViewModule
extends Object

Scripting module that allow to interact with views using EASE in the Trace Compass UI. Example scripts using views can be found here:

• A scripted time graph data provider with script-defined entries and arrows, in javascript
• A basic analysis, building an state system and showing its data in a time graph, in python

Author:

Geneviève Bastien

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODULE_ID	Module identifier.

Constructor Summary

Constructors

Constructor	Description
ViewModule()

Method Summary

Modifier and Type	Method	Description
void	openHistogramChartView(ITmfTreeXYDataProvider<ITmfTreeDataModel> dataProvider)	Open a histogram chart for a scripted XY data provider
void	openScatterChartView(ITmfTreeXYDataProvider<ITmfTreeDataModel> dataProvider)	Open a scatter chart for a scripted XY data provider
void	openTimeGraphView(ITimeGraphDataProvider<TimeGraphEntryModel> dataProvider)	Open a time graph view with a data provider
void	openXYChartView(ITmfTreeXYDataProvider<ITmfTreeDataModel> dataProvider)	Open a XY chart for a scripted data provider
void	showView(String viewId, String secondaryId)	Open any view in Trace Compass, using its view ID, with an optional secondary ID.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODULE_ID

public static final String MODULE_ID

Module identifier.

See Also:

• Constant Field Values

Constructor Details

ViewModule

public ViewModule()

Method Details

openTimeGraphView

public void openTimeGraphView(ITimeGraphDataProvider<TimeGraphEntryModel> dataProvider)

Open a time graph view with a data provider

Parameters:

dataProvider - The data provider used to populate the view

showView

public void showView(String viewId,
 @ScriptParameter(defaultValue="")
 String secondaryId)

Open any view in Trace Compass, using its view ID, with an optional secondary ID. For many views that are common for many analyses, for example, the table views, scatter views, statistics, flame chart/graph, the secondary ID is the ID of the analysis. This value can be found by selecting the analysis that will be the source of the view and looking in the 'Properties' view for the ID property. For example, to open a table view for the LTTng-UST CallStack (Incubator) analysis, the follow call can be make

 showView(org.eclipse.tracecompass.analysis.timing.ui.views.segmentstore.table.SegmentStoreTableView.ID, "org.eclipse.tracecompass.incubator.callstack.core.lttng.ust");
 

Parameters:

viewId - The ID of the view to display

secondaryId - The secondary ID, if required.

openXYChartView

public void openXYChartView(ITmfTreeXYDataProvider<ITmfTreeDataModel> dataProvider)

Open a XY chart for a scripted data provider

Parameters:

dataProvider - The data provider used to populate the view

openHistogramChartView

public void openHistogramChartView(ITmfTreeXYDataProvider<ITmfTreeDataModel> dataProvider)

Open a histogram chart for a scripted XY data provider

Parameters:

dataProvider - The data provider used to populate the view

openScatterChartView

public void openScatterChartView(ITmfTreeXYDataProvider<ITmfTreeDataModel> dataProvider)

Open a scatter chart for a scripted XY data provider

Parameters:

dataProvider - The data provider used to populate the view