OverviewOptions class (Graph)

OverviewOptions()

new OverviewOptions()

The OverviewOptions object defines the configuration options to display

For instance, the "visible" option:

overview: { visible: true }
shows the overview
OverviewOptions

Members

(static) dock :Graph.PanelDockEnum

The dock field specifies the edge of the container the overview-window is anchored to. The overview map is shown from top to bottom when the overview window is docked to the left or right side of the view.
Type:
Example
null {null}, by default, the overview is anchored to the top-side of the view
 "bottom" {string} or exontrol.Graph.PanelDockEnum.exBottom or 2 {number}, the overview is docked to the bottom side of the control
dock

(static) line :LineOptions

The line field defines the configuration options for displaying the lines of values in the overview.
Type:
Example
null {null}, indicates a solid 1-pixel wide overview-line (the color of line is indicated by the color of the serie)
 {color: "red", width: 2} {LineOptions}, indicates a solid-red 2-pixels wide overview-line
line

(static) serie :string

The serie field specifies a serie or multiple series separated by comma to be represented within the overview-map. The format of a particular element of the serie field is "KEY[\[INNER\]][:[COLOR][-fill [FILLCOLOR]]]", where KEY is the name or the index of the serie, INNER is the inner-index of the value to represent (valid for multi-dimensional array only), COLOR specifies a perticular color to show the overview-line for giving serie (if COLOR is missing, the seriesColors option defines the color to show overview-line) and FILLCOLOR specifies a different color to fill the overview-curve. The overview can show lines or surfaces for one or more series.
Type:
  • string
Example
null {null}, by default, the overview-map shows the first serie (while it is valid and compatible with area-chart types)
 "0,1" {string}, indicates that first two series are represented within the overview.
 "0:black,0[1]:red,0[2]:blue,0[3]:green" {string}, shows four overview-lines for the first, second, third and forth-dimension of the same serie (the first serie with the index 0)
 "2:-fill,0" {string}, the overview shows the first and third series (the third serie is filled)
 "0:black-fill rgba(0\\,0\\,0\\,0.25)" {string}, shows the first serie filled with a semi-transparent color and contoured in black
serie

(static) size :number

The size field specifies the size of the control's overview.
Type:
  • number
Example
null {null}, by default, the overview's size is 64-pixels
 32 {number}, sets the overview's size to 32-pixels tall (if anchored to the top or bottom side)
size

(static) visible :boolean

The visible field shows or hides the overview. The overview-window is visible only for area-compatible chart types.
Type:
  • boolean
Example
null {null}, by default, the overview is hidden
 true {boolean}, shows the overview (the overview displays the map of the entire series without a scroll bar)
visible