"areaViewportTimeRange"
Activates a viewport widget which is placed over the plot area.
Synopsis
trendObj.areaViewportTimeRange(int area, time start, time stop)
getValue(trendObj, "areaViewportTimeRange", int area, time start, time
stop);
setValue(trendObj, "areaViewportTimeRange", int area, time start, time
stop);
Parameter
| Parameter | Description |
|---|---|
| trendObj | Trend for which the attributed should be get. |
| area | ID of the area for which the attribute should be get. |
| start | Starting time of the displayed range inside of the viewport |
| stop | Stopping time of the displayed range inside of the viewport |
Description
The function allows to open a viewport widget which is than activated and placed over the trend plot area including the time axis. Inside of the viewport widget a shorter time frame can be selected for the displayed and connected areas ("linkAreas"). The start and stop time of the viewport widget define the initial size of the displayed time range inside of the trend widget.
Please note, that the correct order of the function calls for areaViewportTimeRange and "linkAreas" must be used.
As first step the areaViewportTimeRange must be called for a specific area. Afterwards this area must be linked with the main area of the trend with the "linkAreas" function. For linkAreas the main trend area (e.g. area 0) must be started before the viewport area (e.g. area 1). For the example area IDs the correct function call would look like this: linkAreas(0,1);
The viewport can also be styled by using CSS. More information can be found here. Available CSS Classes for the viewport can be found here.
Assignment
Trend
