MarkValueOptions class (Graph)

MarkValueOptions()

new MarkValueOptions()

The MarkValueOptions object is used to configure the highlighting of chart or axis zones based on specific values or value ranges.

For instance, the "start" option:

valueAxis: { mark: { shape: "blue", start: 100, end: 200 } }
highlights the chart with a blue color between the values of 100 and 200 on the value-axis.
Since:
  • 4.4
MarkValueOptions

Members

(static) end :number

The end field defines the value where the mark-zone range ends. If neither the start nor end value is provided, a single line will be shown instead of a rectangle.
Type:
  • number
Example
null {null}, the end field is ignored (default)
 100 {number}, the mark-zone ends at value 100
end

(static) shape :any

The shape field defines the shape to apply on the chart/axis's background. The shape can be a string expression that defines shape's name within the exontrol.Shape.Graph or exontrol.Shape namespace, a CSS color, a JSON string-representation of an object of exontrol.Def.Shape type or an object of {normal,hover,click,disabled} type. The normal,hover,click and disabled are objects of exontrol.Def.Shape type.
Type:
  • any
Example
"" {string}, null {null}, no shape is applied
 "red" {string}, fills the object's background in red (CSS color)
 '{"fillColor": "red"}' or '{"normal":{"fillColor": "red"}}' {string}, fills the object's background in red (JSON-representation of an object of exontrol.Def.Shape type)
 "xxx" {string}, indicates that exontrol.Shapes.Graph.xxx or exontrol.Shapes.xxx is applied on the object's background. If the xxx field is missing, no custom shape is applied (no default object's shape is be applied)
 exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace
shape

(static) showIn :Graph.ShowInEnum

The showIn field specifies the part of the control where the highlight appears, such as the axis, chart, or both.
Type:
Example
null {null} or exontrol.Graph.ShowInEnum.exChart {number} or 1 {number} or "chart" {string}, the highlight appears in chart section only (default)
 exontrol.Graph.ShowInEnum.exAxis {number} or 2 {number} or "axis" {string}, the highlight appears in axis section only
 "axis,chart" {string}, the highlight appears in both sections axis and chart
showIn

(static) start :number

The start field defines the value where the mark-zone range begins. If neither the start nor end value is provided, a single line will be shown instead of a rectangle.
Type:
  • number
Example
null {null}, the start field is ignored (default)
 100 {number}, the mark-zone starts at value 100
start