"areaInteractionFlag","areaInteractionFlags","areaPlotInteractionFlags", "areaPlotInteractionFlag"

Defines the possible interactions with the trend area.

Synopsis

trendObj.areaInteractionFlags(int area, string flags);

getValue(trendObj, "areaInteractionFlags", int area, string &flags);

setValue(trendObj, "areaInteractionFlags", int area, string flags);

trendObj.areaPlotInteractionFlags(int area, string flag, bool value);

getValue(trendObj, "areaPlotInteractionFlags", int area, string &flag, bool value);

setValue(trendObj, "areaPlotInteractionFlags", int area, string flag, bool value);

Parameter

Parameter Description
trendObj Trend for which the attributed should be get
area Area ID
flags Flags that should be used for the area
value TRUE enables the flag. FALSE = disables the flag.

Description

The function specifies which interactions can be used for the trend area. The areaInteractionFlags attribute works for all plot area and the scales whereas the areaPlotInteractionFlags attribute only works for plot area.

For the functions areaInteractionFlags as well as areaPlotInteractionFlags the separate flags can be combined using the pipe character "|". areaInteractionFlag only supports one flag at a time. Possible flags are:

  • NoInteraction -- Defines if the user can interact with the trend area at all
  • PanTime -- Defines if the user can pan the time axis
  • PanValue -- Defines if the user can pan the value axis
  • Pan (Combination of the flags PanTime and PanValue) -- Defines if the user can pan at all
  • ZoomTime -- Defines if the user can zoom the time axis
  • ZoomValue -- Defines if the user can zoom the value axis
  • Zoom (Combination of the flags ZoomTime and ZoomValue) -- Defines if the user can zoom at all
  • ContextMenu -- Defines if a context menu is available for right cliks or long taps.
  • FullInteraction (Combination of the flags Pan, Zoom and ContextMenu)

Assignment

Trend