# View Module

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

## Method Overview

Method | Description
--- | ---
openHistogramChartView() | Open a histogram chart for a scripted XY data provider
openScatterChartView() | Open a scatter chart for a scripted XY data provider
openTimeGraphView() | Open a time graph view with a data provider
openXYChartView() | Open a XY chart for a scripted data provider
showView() | Open any view in Trace Compass, using its view ID, with an optional secondary ID.

## Methods

### openHistogramChartView

void openHistogramChartView(ITmfTreeXYDataProvider<ITmfTreeDataModel> dataProvider)

Open a histogram chart for a scripted XY data provider

dataProvider
  The data provider used to populate the view

### openScatterChartView

void openScatterChartView(ITmfTreeXYDataProvider<ITmfTreeDataModel> dataProvider)

Open a scatter chart for a scripted XY data provider

dataProvider
  The data provider used to populate the view

### openTimeGraphView

void openTimeGraphView(ITimeGraphDataProvider<TimeGraphEntryModel> dataProvider)

Open a time graph view with a data provider

dataProvider
  The data provider used to populate the view

### openXYChartView

void openXYChartView(ITmfTreeXYDataProvider<ITmfTreeDataModel> dataProvider)

Open a XY chart for a scripted data provider

dataProvider
  The data provider used to populate the view

### showView

void showView(String viewId, [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");

viewId
  The ID of the view to display
secondaryId
  The secondary ID, if required.Optional: defaults to <"">.