new GV(oGraph)
Defines the graph view of the control, that displays the series. The
oGV field defines the control's base graph-view. Use the
AddGraphView() method to add a new view to the control. Use the
RemoveGraphView() method removes a graph-view already created by
AddGraphView() method.
Parameters:
| Name |
Type |
Description |
oGraph |
Graph
|
Specifies an object of Graph type that defines the owner control of the view to be created. |
Methods
EnsureVisibleClient(clientA, ensureOptsopt)
The EnsureVisibleClient() method ensures that the giving client fits the control's client area.
Parameters:
| Name |
Type |
Attributes |
Description |
clientA |
object
|
|
The client parameter could be any of the following:
- clientA {number[]}, specifies an array of [x,y,width,height] type that indicates the absolute-coordinates of the layout-rectangle to fit into the control's client area
|
ensureOpts |
object
|
<optional>
|
Specifies different options to run the current method as explained:
- force {boolean}, forces the EnsureVisibleClient()'s smooth operation to run, not matter if no zoom/scale or scrol changed
- allowScale {boolean}, updates the control's scale/zoom-factor to ensure full-fit the client
- allowScroll {number}, specifies whether horizontal/vertical is allowed as explained:
- 3 {number}/{null}/{undefined}, allows scrolling horizontal and vertical as required
- 0 {number}, no horizontal or vertical scroll is allowed
- 1 {number}, horizontal scroll is allowed
- 2 {number}, vertical scroll is allowed
- nearestFit {boolean}, ensures that corner of the object nearest the window's client area fits it (it has effect only if the size of the object is greater than size of the window's client area)
- duration {number}, specifies the time in ms the control is smoothly performs the changes
- thisArg {any}, specifies the value of "this" keyword during the cbkI/cbkT callbacks
- cbkR {callback}, specifies a function of callback(p) type that's invoked once the EnsureVisibleClient()'s smooth operation runs (p {number}, specifies the progress of the smooth so far, as a value between 0 and 1)
- cbkI {callback}, specifies a function of callback() type that's invoked once the EnsureVisibleClient()'s smooth operation begins
- cbkT {callback}, specifies a function of callback() type that's invoked once the EnsureVisibleClient()'s smooth operation ends
|
FitToClient(rtLayoutopt)
The FitToClient() method ensures that the entire (null/undefined) or giving layout fits the control's client area.
Parameters:
| Name |
Type |
Attributes |
Description |
rtLayout |
Array.<number>
|
<optional>
|
Indicates null for entire layout or an array of [x,y,width,height] type that defines the absolute-coordinate to fit to client. |
GetAllowActions() → {string}
The GetAllowActions() method gets the actions the user can perform once the control is clicked or touched. The order of the actions is very important, as the control checks each action from left to right until it finds a matching action for the performed mouse/touch event. The first matched action is performed, and the rest of the actions are ignored. So if you want to perform a specific action once the user clicks an item, and perform another action if the user clicks an area that does not contain any item, you should place the first action before the second one in the AllowActions property.
Returns:
Returns the actions the user can perform once the control is clicked or touched. The order of the actions is very important, as the control checks each action from left to right until it finds a matching action for the performed mouse/touch event. The first matched action is performed, and the rest of the actions are ignored. So if you want to perform a specific action once the user clicks an item, and perform another action if the user clicks an area that does not contain any item, you should place the first action before the second one in the AllowActions property.
The format of the property is:
"action(shortcut,shortcut,...),action(shortcut,shortcut,...)..."
where
- "action", defines the action to perform (as defined below)
| Action |
Description |
Flags |
| "fit" |
Fits the drag-area into the control's client area |
- [zoom], specifies that the "fit" action magnifies the chart instead resizing it
|
| "move-value" |
Rearranges values, series, or data through drag-and-drop (available only if the serie's ShowValue property includes exPoint flag) |
- [disableMoveCategory], disables rearranging values/categories (default, if the flag is missing the user changes the control's Order property)
- [enableMoveSerie], enables rearranging series (changes the serie's Position property)
- [enableMoveData], enables rearranging the data of the serie (changes the serie's Data property)
|
| "overview-selection-resize" |
Resizes the graph using the left/right margins of the overview-selection |
|
| "scroll" |
Scrolls the control's content by drag |
- [view], specifies that the "scroll" is possible once the user clicks the view
- [legend], specifies that the "scroll" is possible once the user clicks the legend
|
| "value-resize" |
Resizes the column/bar's size for area-compatible chart types (not available if autoFit property is true) |
|
| "zoom" |
Zooms the control's content at dragging-point |
|
- "shortcut", defines the event's button or/and the modifier-keys that are required to perform the action. The "shortcut" is a combination of none, one or more of the following values:
- "Shift", indicates that the SHIFT key is pressed
- "Ctrl" or "Control", indicates that the CTRL key is pressed
- "Alt" or "Menu", indicates that the ALT key is pressed
- "Meta" , indicates that the META key is pressed
- "LButton", specifies that the mouse's left-button is pressed
- "RButton", specifies that the mouse's right-button is pressed
- "MButton", specifies that the mouse's middle/wheel-button is pressed
- "Long", specifies that the action requires a "long" click or touch before it begins
- "Double", specifies that the action requires a "double" click before it begins (this flag is available for non-dragable actions only such as "edit")
- "+", indicates AND between values
-
Type
-
string
GetAllowDrop() → {boolean}
The GetAllowDrop() method indicates whether the user can drag and drop local files into the control.
Returns:
Returns true, if the user can drag and drop local files into the control.
-
Type
-
boolean
GetAllowStack() → {boolean}
The GetAllowStack() method specifies whether the series are stacked based on the non-empty values defined in the Stack property. When enabled, the series values are visually stacked on top of each other; when disabled, they are displayed independently. The
Stack property determines whether the serie is stacked (same value for multiple series of the same type indicates same stacking-group).
- Since:
Returns:
Returns true if stacking is enabled for the series, or false if it is disabled
-
Type
-
boolean
GetAutoFit() → {boolean}
The GetAutoFit() method indicates whether the elements of the series are resized to fit the control's client-area.
Returns:
Returns true, if the elements of the series are resized to fit the control's client-area.
-
Type
-
boolean
The GetBackground() method indicates the display options to show different parts of the control.
Returns:
Returns the display options to show different parts of the control
-
Type
-
BackgroundOptions
GetCanvasRect() → {Array.<number>}
The GetCanvasRect() method returns the canvas's client rectangle.
Returns:
Returns an array of [x,y,width,height] type that specifies the canvas's client rectangle
-
Type
-
Array.<number>
GetClientRect() → {Array.<number>}
The GetClientRect() method returns the control's client area.
Returns:
Returns an array of [x,y,width,height] type that specifies the control's client area
-
Type
-
Array.<number>
The GetCursor() method gets configuration options to display crosshair over the hover/touch area, tooltips for some or all nearby series data items, as well as tooltips on axes.
Returns:
Returns the configuration options to display crosshair over the hover/touch area, tooltips for some or all nearby series data items, as well as tooltips on axes
-
Type
-
CursorOptions
GetCursors() → {string}
The GetCursors() method retrieves the mouse cursors assigned to different parts of the control. These cursors determine the pointer appearance when the user hovers over specific areas, allowing you to provide visual feedback for interactive regions of the control.
Returns:
A string expression that defines the mouse cursor to display when pointing over different parts of the control.
The format of the property is:
"cursor(part),cursor(part),..."
where:
- "cursor", defines the CSS mouse cursor to display while cursor hovers the part
- "part", defines the name of the part the cursor is applied on (as defined below)
The "cursor" can be any of the following:
| Cursor |
Description |
| "alias" | indicates a shortcut or alias will be created |
| "all-scroll" | indicates scrolling in any direction |
| "auto" | lets the browser decide the cursor based on context |
| "cell" | indicates a table cell |
| "col-resize" | indicates a column can be resized horizontally |
| "context-menu" | indicates a context menu is available |
| "copy" | indicates something will be copied |
| "crosshair" | a precise crosshair cursor |
| "default" | the default arrow cursor |
| "e-resize" | resize east (right edge) |
| "ew-resize" | resize horizontally |
| "grab" | indicates an item can be grabbed |
| "grabbing" | indicates an item is being grabbed |
| "help" | indicates help information is available |
| "move" | indicates something can be moved |
| "n-resize" | resize north (top edge) |
| "ne-resize" | resize northeast (top-right corner) |
| "nesw-resize" | resize along the northeast–southwest axis |
| "no-drop" | indicates dropping is not permitted |
| "not-allowed" | indicates the action is not allowed |
| "ns-resize" | resize vertically |
| "nw-resize" | resize northwest (top-left corner) |
| "nwse-resize" | resize along the northwest–southeast axis |
| "pointer" | the pointer cursor (a hand with a pointing finger) |
| "progress" | indicates background processing |
| "row-resize" | indicates a row can be resized vertically |
| "s-resize" | resize south (bottom edge) |
| "se-resize" | resize southeast (bottom-right corner) |
| "sw-resize" | resize southwest (bottom-left corner) |
| "text" | the text selection cursor (I-beam) |
| "url(...)" | uses a custom cursor image (with optional fallback) |
| "vertical-text" | the vertical text selection cursor |
| "w-resize" | resize west (left edge) |
| "wait" | indicates the program is busy |
| "zoom-in" | indicates zooming in |
| "zoom-out" | indicates zooming out |
The "part" can be any of the following:
| Part |
Description |
| "anchor" (hyperlink) | defines the mouse-cursor when the mouse pointer hovers the anchor (the <a> ex-HTML part marks an anchor or hyperlink element) |
| "legend" | defines the mouse-cursor when the mouse pointer hovers an object of the legend |
| "long" | specifies the mouse-cursor to be shown as soon as a "long" click or touch action begins (see allowActions field) |
| "move-value-drag" | defines the mouse cursor while a value, series, or data point is being dragged, visually indicating an active drag operation and showing which element can be grabbed. This is valid only if allowActions includes the "move-value" action and is typically used with "pointer(valuePoint)" to suggest that the user can click and move the value. Example: when the user clicks a value-point and begins dragging it, the cursor changes to "grabbing(move-value-drag)" to signal that the item is being moved (@since 4.9) |
| "no" | defines the mouse cursor to be shown when a drag-and-drop operation is not allowed (for example, when dropping a value, series, or data point is not permitted in the current area). This is valid only if allowActions includes the "move-value" action and provides immediate visual feedback to prevent accidental operations. Example: when the user drags a value over an invalid target, the cursor changes to "not-allowed(no)" to indicate that the operation is blocked (@since 4.9) |
| "valuePoint" | defines the mouse-cursor when the mouse pointer hovers the value-point |
-
Type
-
string
GetFormatText() → {exontrol.DrawTextFormatEnum}
The GetFormatText() method specifies the format to display the view's invalid label.
Returns:
Returns a value of exontrol.DrawTextFormatEnum type, that defines the format to display the serie's caption.
The exontrol.DrawTextFormatEnum type supports the following flags:
- exTextAlignTop (0x00), justifies the text to the top of the rectangle
- exTextAlignLeft (0x00), aligns text to the left
- exTextAlignCenter (0x01), centers text horizontally in the rectangle
- exTextAlignRight (0x02), aligns text to the right
- exTextAlignVCenter (0x04), centers text vertically
- exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
- exTextAlignMask (0x0F), specifies the mask for text's alignment.
- exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
- exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
- exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
- exPlainText (0x80), treats the text as plain text.
- exTextNoClip (0x0100), draws without clipping.
- exHTMLTextNoColors (0x0200), ignores the and tags.
- exTextCalcRect (0x0400), determines the width and height of the text.
- exHTMLTextNoTags (0x0800), ignores all HTML tags.
- exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
- exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
- exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
-
Type
-
exontrol.DrawTextFormatEnum
GetImageAlign() → {number}
The GetImageAlign() method specifies the alignment of the serie's image.
Returns:
Returns the alignment of the serie's image as explained:
- 0, the image is on the left of the serie's caption
- 1, the image is on the right of the serie's caption
- 2, the image is on the top of the serie's caption
- 3, the image is on the bottom of the serie's caption
-
Type
-
number
GetImageSize() → {any}
The GetImageSize() method defines the size of the serie's image (reserved).
Returns:
Returns the size, range of limits the serie's image is displayed as expalined:
- {null}, Indicates that the serie's image is displayed as it is (full-sized).
- {number}, Specifies that the serie's image is displayed into a square of giving size (same width and height). If 0 the serie displays no image, if negative the serie's image is stretched to giving square, else the serie's picture is scaled to fit the giving rectangle.
- {number[]}, Specifies an array of [aspect-width,aspect-height] type that defines the limits for width or/and height. The aspect-width and aspect-height define the width/height of the serie's picture to scale or stretch to.
-
Type
-
any
GetInvalid() → {string}
The GetInvalid() method specifies the label the control is displaying while no or invalid data.
Returns:
Returns a value of string type, that defines the label the control is displaying while no or invalid data
-
Type
-
string
The GetLegend() method specifies the configuration options to display the view's legend (the legend helps you choose which series to show or hide at runtime).
Returns:
Returns the configuration options to display the view's legend
-
Type
-
LegendOptions
GetLocked() → {boolean}
The GetLocked() method specifies whether the control is locked(protected) or unlocked.
Returns:
Returns true, if the control is locked(protected) or unlocked
-
Type
-
boolean
The GetMisc() method indicates the control's miscellaneous options.
Returns:
Returns the control's miscellaneous options
-
Type
-
MiscellaneousOptions
GetMultiColorSerie() → {boolean}
The GetMultiColorSerie() method determines whether a single data series (single-valid serie) in a chart can use multiple colors for its data points instead of a single uniform color. The
seriesColors field defines the default colors for the chart's series. The
seriesColorsDecrease field defines the default colors for the chart's series (when the value goes down). When all colors are used, new colors are pulled from the start again. The
seriesColorsAreaAlpha field defines the alpha channel for the default colors of the area-type chart's series.
- Since:
Returns:
Returns true if a single series' data points use multiple colors for representation
-
Type
-
boolean
GetOptions() → {object}
The GetOptions() method returns the current options of the control.
Returns:
An object of
Graph.Options type that indicates the options to display the control.
-
Type
-
object
GetOrder() → {string}
The GetOrder() method defines the custom display sequence of values or categories by their zero-based indexes as a string separated by commas.
- Since:
Returns:
Returns a list of value or category indexes in their displayed order, separated by commas. The index is zero-based, meaning the first value has an index of 0, the second an index of 1, and so on. You can specify the order for one or more values; any values not included in the list will be displayed after the specified values, in their original order.
-
Type
-
string
Example
"3,1,2" {string}, indicates that the value with the index 3 is displayed first, followed by the value with index 1, and then the value with index 2
GetOrder
The GetOverview() method specifies the configuration options to display the overview (the overview displays the map of the entire series without a scroll bar).
Returns:
Returns the configuration options to display the overview
-
Type
-
OverviewOptions
GetPad() → {number|Array.<number>|string}
The GetPad() method specifies the space between view's content and its borders.
Returns:
Returns a value that could be:
- {number} a numeric value, to pad horizontal and vertical size with the same value
- {(string|number[])} a "x,y" or [x,y] type to specify the padding on horizontal and vertical side
-
Type
-
number
|
Array.<number>
|
string
GetReadOnly() → {string}
The GetReadOnly() method specifies whether the control is read-only.
Returns:
Returns true, if the control is read-only
-
Type
-
string
The GetScrollBarsOrigin() method specifies the color to highlight the position of the origin (0,0) on the control's scroll bars.
Returns:
Indicates null, to prevent showing the position of origin (0,0) on the control's scroll bars, or a CSS color
-
Type
-
string
The GetScrollPos() method retrieves the horizontal and vertical scroll-position of the control's default view, as an object of {x,y} type.
Returns:
Returns an object of {x,y} type that defines the control's horizontal and vertical scroll-position as explained:
x {number}, indicates the horizontal scroll-position
y {number}, indicates the vertical scroll-position
-
Type
-
object
GetSerieDef() → {object}
The GetSerieDef() method retrieves the default options applied to each newly created series. Existing series are not affected; the defaults apply only to series added afterward. The returned object supports all fields defined by the
SerieOptions type. This method is useful when you need to check or inspect the current default configuration used for new series.
- Since:
Returns:
Returns an object that defines the default options for newly created series, or null if no defaults are set.
-
Type
-
object
GetSerieType() → {string}
The GetSerieType() method specifies the default representation method for the data in all series where the
type property is not explicitly defined. This setting determines how the series will be rendered (e.g., as a line, bar, scatter plot, etc.) when the type is not set for individual series, ensuring a consistent visual presentation across the graph. The
Type property specifies the individual type of the serie.
- Since:
Returns:
Returns the default representation method for the data in all series where the type property is not explicitly defined. The type can be one of the following:
- "area" {string}, an area chart or area graph displays graphically quantitative data. It is based on the line chart. The area between axis and line are commonly emphasized with colors, textures and hatchings. Commonly one compares two or more quantities with an area chart. (data requires array of numbers, supports vertical field, scrollable)
- "line" {string}, a line chart or line graph, also known as curve chart is a type of chart which displays information as a series of data points called 'markers' connected by straight line segments. It is a basic type of chart common in many fields. It is similar to a scatter plot except that the measurement points are ordered (typically by their x-axis value) and joined with straight line segments. A line chart is often used to visualize a trend in data over intervals of time - a time series - thus the line is often drawn chronologically. In these cases they are known as run charts. (data requires array of numbers, supports vertical field, scrollable)
- "column" {string}, a column chart or column graph is a chart or graph that presents categorical data with rectangular columns with heights proportional to the values that they represent. A horizontal column chart is called a bar chart. (data requires array of numbers, supports vertical field, scrollable)
- "waterfall" {string}, a waterfall chart is a form of data visualization that helps in understanding the cumulative effect of sequentially introduced positive or negative values. These intermediate values can either be time based or category based. The waterfall chart is also known as a flying bricks chart or Mario chart due to the apparent suspension of columns (bricks) in mid-air. Often in finance, it will be referred to as a bridge. (data requires array of numbers, supports vertical field, scrollable)
- "radarArea" {string}, a radar chart is a graphical method of displaying multivariate data in the form of a two-dimensional chart of three or more quantitative variables represented on axes starting from the same point. The relative position and angle of the axes is typically uninformative, but various heuristics, such as algorithms that plot data as the maximal total area, can be applied to sort the variables (axes) into relative positions that reveal distinct correlations, trade-offs, and a multitude of other comparative measures. (data requires array of numbers, non-scrollable)
- "radarLine" {string}, similar with radarArea type. (data requires array of numbers, non-scrollable)
- "radarColumn" {string}, displays data in radial columns starting from one center point. The circle is divided into equal portions depending on the number of columns and each column group occupies one portion (similar with "radarArea" type, data requires array of numbers, non-scrollable)
- "pie" {string}, a pie chart (or a circle chart) is a circular statistical graphic which is divided into slices to illustrate numerical proportion. In a pie chart, the arc length of each slice (and consequently its central angle and area) is proportional to the quantity it represents. While it is named for its resemblance to a pie which has been sliced, there are variations on the way it can be presented. (data requires array of numbers, non-scrollable)
- "rangeArea" {string}, a range chart displays sets of data points, each of which is defined by multiple values for the same category, and emphasizes the distance between the two values. The category labels are displayed on the category axis. The plain Range chart fills in the area between the top and the bottom value for each data point. (data requires array of array of two-numbers, such as [[from, to]], supports vertical field, scrollable)
- "rangeColumn" {string}, a range column chart displays information as a range of data by plotting two Y-values (low and high) per data point. The vertical axis shows the values, and the horizontal axis shows the categories they belong to; in multiple-series range column charts, values are grouped by categories. (data requires array of array of two-numbers, such as [[from, to]], supports vertical field, scrollable)
- "polarArea" {string}, represents data points connected with straight line segments that enclose a filled area together with the chart pole (data requires array of array of two-numbers, such as [[angle, value]], non-scrollable)
- "polarLine" {string}, represents data points connected with straight line segments (data requires array of array of two-numbers, such as [[angle, value]], non-scrollable)
- "polarScatter" {string}, shows the serie as non-connected data points (data requires array of array of two-numbers, such as [[angle, value]], non-scrollable)
- "scatter" {string}, a scatter plot (also called a scatterplot, scatter graph, scatter chart, scattergram, or scatter diagram) is a type of plot or mathematical diagram using Cartesian coordinates to display values for typically two variables for a set of data. (data requires array of array of two-numbers, such as [[x, y]], supports vertical field, non-scrollable)
- "scatterLine" {string}, a scatter line chart is similar with "scatter" type, excepts that lines are shown between scatter plots. (data requires array of array of two-numbers, such as [[x, y]], supports vertical field, non-scrollable)
- "scatterArea" {string}, a scatter area chart is similar with "scatterLine" type, excepts that scatter plots zone is filled. (data requires array of array of two-numbers, such as [[x, y]], supports vertical field, non-scrollable)
- "bubble" {string}, a bubble chart or bubble plot is a type of chart that displays three dimensions of data (a bubble chart is an extension of the scatter plot used to look at relationships between three numeric variables.). Each entity with its triplet (v1, v2, v3) of associated data is plotted as a disk that expresses two of the vi values through the disk's xy location and the third through its size. Bubble charts can facilitate the understanding of social, economical, medical, and other scientific relationships. (data requires array of array of three-numbers, such as [[x, y, size]], supports vertical field, non-scrollable)
- "candleStick" {string}, a candlestick chart (also called Japanese candlestick chart or K-line) is a style of financial chart used to describe price movements of a security, derivative, or currency. While similar in appearance to a bar chart, each candleStick represents four important pieces of information for that day: open and close in the thick body, and high and low in the "candle wick". Being densely packed with information, it tends to represent trading patterns over short periods of time, often a few days or a few trading sessions. (data requires array of array of four-numbers, such as [[open, high, low, close]], supports vertical field, scrollable)
- "ohlc" {string}, an open-high-low-close chart (also OHLC) is a type of chart typically used to illustrate movements in the price of a financial instrument over time. Each vertical line on the chart shows the price range (the highest and lowest prices) over one unit of time, e.g., one day or one hour. Tick marks project from each side of the line indicating the opening price (e.g., for a daily bar chart this would be the starting price for that day) on the left, and the closing price for that time period on the right. The bars may be shown in different hues depending on whether prices rose or fell in that period. (data requires array of array of four-numbers, such as [[open, high, low, close]], supports vertical field, scrollable)
-
Type
-
string
GetShapes() → {string}
The GetShapes() method retrieves the shapes assigned to each part of the control. These shapes define the visual appearance of the control's elements, such as borders, fills, and other graphical components. Using this method, you can inspect or modify how each part of the control is drawn, allowing for full customization of its look and feel.
Returns:
A string expression that defines the shapes each part of the control can display.
The format of the property is:
"shape(part),shape(part),..."
where:
- "shape", defines the shape to apply on the UI part as one of the following:
◦ any of 140 color names any browser supports (such as red, blue, green, ...)
◦ hexadecimal colors, is specified with: #RRGGBB, where the RR (red), GG (green) and BB (blue) hexadecimal integers specify the components of the color. All values must be between 00 and FF (such as #0000ff which defines a blue background)
◦ hexadecimal colors with transparency, is specified with: #RRGGBBAA, where AA (alpha) value must be between 00 and FF (such as #0000ff80 which defines a semi-transparent blue background)
◦ RGB colors, is specified with the RGB(red, green, blue) function. Each parameter (red, green, and blue) defines the intensity of the color and can be an integer between 0 and 255( such as rgb(0,0,255) that defines a blue background)
◦ RGBA colors, are an extension of RGB color values with an alpha channel as RGBA(red, green, blue, alpha) function, where the alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque) ( such as rgba(0,0,255,0.5) which defines a semi-transparent blue background)
◦ HSL colors, is specified with the HSL(hue, saturation, lightness) function, where hue is a degree on the color wheel (from 0 to 360) - 0 (or 360) is red, 120 is green, 240 is blue. saturation is a percentage value; 0% means a shade of gray and 100% is the full color. lightness is also a percentage; 0% is black, 100% is white. HSL stands for hue, saturation, and lightness - and represents a cylindrical-coordinate representation of colors (such as hsl(240, 100%, 50%) that defines a blue background)
◦ HSLA colors, are an extension of HSL color values with an alpha channel - which specifies the opacity of the object as HSLA(hue, saturation, lightness, alpha) function, where alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque) (such as hsla(240, 100%, 50%,0.5) that defines a semi-transparent blue background)
◦ a JSON representation of the shape object to apply (while it starts with { character, such as '{"normal": {"primitive": "RoundRect","fillColor":"black","tfi": {"fgColor": "white"}}}')
◦ specifies the name of the field within the exontrol.Shapes.Graph object (while it starts with a lowercase letter, such as shserie which refers to exontrol.Shapes.Graph.shserie shape)
◦ specifies the name of the field within the exontrol.Shapes object (while it starts with an uppercase letter, such as Button which refers to exontrol.Shapes.Button shape)
- "part", defines the name of the part the shape is applied on (as defined below)
The shapes property supports any of the following parts:
| Part |
Description |
Additional |
| "area" | specifies the visual-appearance to show the "area" serie-types | |
| "bubble" |
specifies the visual-appearance to show the "bubble" serie-types |
- size {number}, specifies the maximum-size of the data-point on the chart
|
| "candleStick" |
specifies the visual-appearance to show the "candleStick" serie-types |
- size {number}, specifies the size of the stick
- hollow {boolean}, indicates whether the hollow candlestick representation is displayed (hollow candle means that its closing value is higher (or equal) than opening value of the same period)
|
| "column" | specifies the visual-appearance to show the "column" serie-types | |
| "cursorCategoryAxisTooltip" | defines the visual-appearance to show the tooltip on the category-axes, when the crosshair hovers the category-unit | |
| "cursorLine" | defines the visual-appearance (frameColor, frameSize, frameDash) to display the crosshair over the hover/touch area (showCursorCategoryLine or showCursorValueLine) | |
| "cursorSerieTooltip" | defines the visual-appearance to show the tooltip when the crosshair cursor hovers the charts of the series | |
| "cursorValueAxisTooltip" | defines the visual-appearance to show the tooltip on the value-axes, when the crosshair hovers the value-unit | |
| "cursorXAxisTooltip" | defines the visual-appearance to show the tooltip on the x-axes, when the crosshair hovers the value-unit (available for xy-chart types) | |
| "cursorYAxisTooltip" | defines the visual-appearance to show the tooltip on the y-axes, when the crosshair hovers the value-unit (available for xy-chart types) | |
| "frameFit" | defines the visual-appearance to display the frame while fitting objects into the control's client area by drag | |
| "legendLabel" | defines the visual-appearance of the labels of the visible-series within the map legend | |
| "legendLabelHidden" | defines the visual-appearance of the labels of the hidden-series within the map legend | |
| "legendSymbol" | defines the visual-appearance of the symbols of the visible-series within the map legend | |
| "legendSymbolHidden" | defines the visual-appearance of the symbols of the hidden-series within the map legend | |
| "legendUnit" | defines the visual-appearance of the legend-unit (the client-rectangle that covers the symbol and label of the legend-object) of the visible-series within the map legend | |
| "legendUnitHidden" | defines the visual-appearance of the legend-unit (the client-rectangle that covers the symbol and label of the legend-object) of the hidden-series within the map legend | |
| "line" | specifies the visual-appearance to show the "line" serie-types | |
| "ohlc" |
specifies the visual-appearance to show the "ohlc" serie-types |
- size {number}, specifies the size of the stick
- hollow {boolean}, indicates whether the hollow candlestick representation is displayed (hollow candle means that its closing value is higher (or equal) than opening value of the same period)
|
| "pie" | specifies the visual-appearance to show the "pie" serie-types | |
| "polarArea" | specifies the visual-appearance to show the "polarArea" serie-types | |
| "polarLine" | specifies the visual-appearance to show the "polarLine" serie-types | |
| "polarScatter" |
specifies the visual-appearance to show the "polarScatter" serie-types |
- size {number}, specifies the size of the data-point on the chart
|
| "radarArea" | specifies the visual-appearance to show the "radarArea" serie-types | |
| "radarColumn" | specifies the visual-appearance to show the "radarColumn" serie-types | |
| "radarLine" | specifies the visual-appearance to show the "radarLine" serie-types | |
| "rangeArea" | specifies the visual-appearance to show the "rangeArea" serie-types | |
| "rangeColumn" | specifies the visual-appearance to show the "rangeColumn" serie-types | |
| "scatter" |
specifies the visual-appearance to show the "scatter" serie-types |
- size {number}, specifies the size of the data-point on the chart
|
| "scatterArea" | specifies the visual-appearance to show the "scatterArea" serie-types | |
| "scatterLine" | specifies the visual-appearance to show the "scatterLine" serie-types | |
| "valueBack" | defines the visual-appearance to apply on the value's background | |
| "valueLine" |
defines the visual-appearance for value-lines (the guided line from the value-point to the value itself) |
- length {number}, indicates the horizontal distance between the middle and end points of the value-line
|
| "valuePoint" |
defines the visual-appearance for value-points |
- size {number}, specifies the size of the value-point
- frameColor, defines the color to show the object's frame
- patternColor, defines the color to show the object's pattern
- fillColor, defines the color to show the object's background
- fillGradientColor, defines the gradient type and colors to show the object's background. The fillColor field defines the starting color. The fillGradientColor field has effect only if the fillColor field is defined (not null or undefined).
The ...Color fields supports the following additional values:
- "null", indicates that the value-point uses the serie's value color
- "transparent", specifies that the value-point is not visible (transparent)
|
| "waterFall" |
specifies the visual-appearance to show the "waterFall" serie-types |
- lineSize {number}, defines size of to draw the lines between columns
|
| "select-overview" | defines the visual-appearance to display the overview-selection | |
| "select-overview-resize" | defines the visual-appearance to display left/right resize-margins of the overview-selection | |
| "selectout-overview" | defines the visual-appearance to display the left/right parts outside of the overview-selection | |
-
Type
-
string
Example
The following statements are equivalent:
oGraph.GetShapes() {string}, returns a string expression that defines the shapes each part of the control can display
oGraph.Shapes {string}, returns a string expression that defines the shapes each part of the control can display
where oGraph is an instance of the Graph control.
GetShapes
GetSmooth() → {number}
The GetSmooth() method defines the time in ms the control goes from one layout to another.
Returns:
Returns the time in ms the control goes from one layout to another.
-
Type
-
number
GetSort() → {string}
The GetSort() method indicates the series to be sort, separated by spaces.
Returns:
Returns empty if no serie is sorted, or the list of series to sort, separated by spaces. The format of a particular element of the sort field is "KEY[\[INNER\]][:([A]|D)]", where KEY is the name or the index of the serie, INNER is the inner-index of the value to sort (valid for multi-dimensional array only), A stands for ascending (by default), while D for descending.
-
Type
-
string
GetTfi() → {string|object}
The GetTfi() method gets the
font attributes to apply on captions of the control. The GetTfi() method returns the font attributes as a string representation such as "b monospace 16" or as an object such as {bold: true, fontName: "monospace", fontSize: 16}. Correspondingly, the Tfi property defines the font attributes that are applied to the control's captions and can be set to customize their appearance.
Returns:
Returns the font attributes as a string representation such as "b monospace 16" or as an object such as {bold: true, fontName: "monospace", fontSize: 16}.
The result as a {string} can include any of the following keywords separated by space characters:
- bold, displays the text in bold (equivalent of <b> tag)
- italic, displays the text in italics (equivalent of <i> tag)
- underline, underlines the text (equivalent of <u> tag)
- strikeout, specifies whether the text is strike-through (equivalent of <s> tag)
- <fontName name>, specifies the font's family (equivalent of <font name> tag)
- <fontSize size>, specifies the size of the font (equivalent of <font ;size> tag)
- <fgColor CSSColor>, specifies the text's foreground color (equivalent of <fgcolor> tag)
- <bgColor CSSColor>, specifies the text's background color (equivalent of <bgcolor> tag)
- <shaColor CSSColor;width;offset>, defines the text's shadow (equivalent of <sha color;width;offset> tag)
- <outColor CSSColor>, shows the text with outlined characters (CSScolor) (equivalent of <out color> tag)
- <graColor CSSColor;mode;blend>, defines a gradient text (equivalent of <gra color;mode;blend> tag)
Any other word within the string result that's not recognized as a keyword is interpreted as:
- name of the font (not a number), specifies the font's family (equivalent of <font name> tag)
- size of the font (number), specifies the size of the font (equivalent of <font ;size> tag)
The result as {object} can include any of the following fields:
- bold {boolean}, displays the text in bold (equivalent of <b> tag)
- italic {boolean}, displays the text in italics (equivalent of <i> tag)
- underline {boolean}, underlines the text (equivalent of <u> tag)
- strikeout {boolean}, specifies whether the text is strike-through (equivalent of <s> tag)
- fontName {string}, specifies the font's family (equivalent of <font name> tag)
- fontSize {number}, specifies the size of the font (equivalent of <font ;size> tag)
- fgColor {string}, specifies the text's foreground color (CSScolor) (equivalent of <fgcolor> tag)
- bgColor {string}, specifies the text's background color (CSScolor) (equivalent of <bgcolor> tag)
- shaColor {object}, specifies an object of {color, width, offset} type that defines the text's shadow (equivalent of <sha color;width;offset> tag), where:
- color {string}, defines the color of the text's shadow (CSScolor)
- width {number}, defines the size of the text's shadow
- offset {number}, defines the offset to show the text's shadow relative to the text
- outColor {string}, shows the text with outlined characters (CSScolor) (equivalent of <out color> tag)
- graColor {object}, specifies an object of {color, mode, blend} type that defines a gradient text (equivalent of <gra color;mode;blend> tag), where:
- color {string}, defines the gradient-color (CSScolor)
- mode {number}, defines the gradient direction as 0 (left-right), 1 (default, top-bottom), 2 (left-center-right), and 3 (top-center-bottom)
- blend {number}, defines the gradient blend as a value between 0 and 1
CSSColor or CSS legal color values can be specified by the following methods:
- Hexadecimal colors, is specified with: #RRGGBB, where the RR (red), GG (green) and BB (blue) hexadecimal integers specify the components of the color. All values must be between 00 and FF. For example, #0000ff value is rendered as blue, because the blue component is set to its highest value (ff) and the others are set to 00.
- Hexadecimal colors with transparency, is specified with: #RRGGBBAA, where AA (alpha) value must be between 00 and FF. For example, #0000ff80 defines a semi-transparent blue.
- RGB colors, is specified with the RGB(red, green, blue) function. Each parameter (red, green, and blue) defines the intensity of the color and can be an integer between 0 and 255. For example, rgb(0,0,255) defines the blue color.
- RGBA colors, are an extension of RGB color values with an alpha channel as RGBA(red, green, blue, alpha) function, where the alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque). For example, rgba(0,0,255,0.5) defines a semi-transparent blue.
- HSL colors, is specified with the HSL(hue, saturation, lightness) function, where hue is a degree on the color wheel (from 0 to 360) - 0 (or 360) is red, 120 is green, 240 is blue. saturation is a percentage value; 0% means a shade of gray and 100% is the full color. lightness is also a percentage; 0% is black, 100% is white. HSL stands for hue, saturation, and lightness - and represents a cylindrical-coordinate representation of colors. For example, hsl(240, 100%, 50%) defines the blue color.
- HSLA colors, are an extension of HSL color values with an alpha channel - which specifies the opacity of the object as HSLA(hue, saturation, lightness, alpha) function, where alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque). For example, hsla(240, 100%, 50%,0.5) defines a semi-transparent blue.
- Predefined/Cross-browser color names, 140 color names are predefined in the HTML and CSS color specification. For example, blue defines the blue color.
-
Type
-
string
|
object
Example
The following statements are equivalent:
oGraph.GetTfi() {string}, returns the control's font attributes as a string such as "b monospace 16"
oGraph.Tfi {string}, returns the control's font attributes as a string such as "b monospace 16"
where oGraph is an instance of Graph control
GetTfi
The GetToolTipDelay() method retrieves the time the mouse pointer must hover over an object before the tool tip appears. Setting it to 0 makes tool tips appear immediately, while a higher value (for example, 128) introduces a delay to prevent accidental pop-ups when moving the mouse quickly. The ToolTipPopDelay property determines how long the tool tip remains visible (in milliseconds) if the mouse pointer stays stationary, and the ToolTipWidth property sets the maximum width of the control's tool tip in pixels.
Returns:
Returns how long the mouse pointer must point to an object before the tool tip appears
-
Type
-
number
Example
The following statements are equivalent:
oGraph.GetToolTipDelay() {number}, returns how long the mouse pointer must point to an object before the tool tip appears
oGraph.ToolTipDelay {number}, returns how long the mouse pointer must point to an object before the tool tip appears
where oGraph is an instance of the Graph control.
GetToolTipDelay
The GetToolTipFormat() method specifies the expression to customize the tooltip (shown while the cursor hovers value-points of the chart). The
format-expression supports predefined constants, operators and keywords as explained:
- "value", {number} specifies the data point value
- "name", {string} defines the name of the serie as specified by Name property
- "user", {any} specifies the extra data associated with the serie as specified by UserData property (@since 4.8)
- "index", {number} indicates the index of the category that contains the current value (@since 4.8)
- "category", {string} specifies the category the current value is in (available only if applicable)
- "percent", {number} indicates the percent of the item, as a number between 0 and 100 (available only if applicable)
- "inner", {number} indicates the inner index of the value within the point data. For example, 0 represents the 'open' or 'from' value, 1 represents the 'high' or 'to' value, 2 represents the 'low' value, and 3 represents the 'close' value. This property is defined only for charts that require multi-dimensional arrays, such as candlestick chart types. (available only if applicable)
- "%V0", "%V1", "%V2" or "%V3", {number} retrieve the designated values by referencing %V0 for the open value (for candlestick charts or "from" in column range charts), %V1 for the high value (for candlestick charts or "to" in column range charts), %V2 for the low value (for candlestick charts), and %V3 for the close value (for candlestick charts, defaulting to "value" if unavailable)
Returns:
Returns the format to customize the tooltips
-
Type
-
string
The GetToolTipPopDelay() method returns the duration, in milliseconds, that a tooltip remains visible when the mouse pointer is stationary over a control. The ToolTipPopDelay property is expressed in milliseconds. The ToolTipDelay property defines how long the mouse pointer must hover over an object before the tooltip appears. The ToolTipWidth property specifies the width of the tooltip window in pixels. By default, the tooltip remains visible for 5000 milliseconds.
Returns:
Returns the period in ms of time the tool top remains visible if the mouse pointer is stationary within a control
-
Type
-
number
Example
The following statements are equivalent:
oGraph.GetToolTipPopDelay() {number}, returns the period in ms of time the tool top remains visible if the mouse pointer is stationary within a control
oGraph.ToolTipPopDelay {number}, returns the period in ms of time the tool top remains visible if the mouse pointer is stationary within a control
where oGraph is an instance of the Graph control.
GetToolTipPopDelay
The GetToolTipWidth() method returns the tooltip window's width in pixels. The ToolTipWidth property defines the tooltip window's width in pixels and accepts a numeric value; a value of -1 (default) displays the tooltip on a single line without any width restriction. The ToolTipDelay property specifies the time in milliseconds the mouse pointer must hover over an object before the tooltip appears. The ToolTipPopDelay property specifies how long, in milliseconds, the tooltip remains visible while the mouse pointer stays stationary within the control.
Returns:
Returns the width of the tooltip window, in pixels
-
Type
-
number
Example
The following statements are equivalent:
oGraph.GetToolTipWidth() {number}, returns the width of the tooltip window, in pixels
oGraph.ToolTipWidth {number}, returns the width of the tooltip window, in pixels
where oGraph is an instance of the Graph control.
GetToolTipWidth
The GetValueAxis() method gets the chart's value axes. The unrefered value axes shows the data as provided by the default value axis. The axis option of the
Serie object specifies the name of the value axis to use...
Returns:
Returns the chart's value axes
-
Type
-
ValueAxisOptions
|
Array.<ValueAxisOptions>
GetValueSize() → {number}
The GetValueSize() method gets the size to show a column or a bar within the chart. The valueSize has no effect for xy or circular-compatible chart types. The valueSize has effect for area-compatible chart types as follows:
- "area" {string}, an area chart or area graph displays graphically quantitative data. It is based on the line chart. The area between axis and line are commonly emphasized with colors, textures and hatchings. Commonly one compares two or more quantities with an area chart. (data requires array of numbers, supports vertical field, scrollable)
- "line" {string}, a line chart or line graph, also known as curve chart is a type of chart which displays information as a series of data points called 'markers' connected by straight line segments. It is a basic type of chart common in many fields. It is similar to a scatter plot except that the measurement points are ordered (typically by their x-axis value) and joined with straight line segments. A line chart is often used to visualize a trend in data over intervals of time - a time series - thus the line is often drawn chronologically. In these cases they are known as run charts. (data requires array of numbers, supports vertical field, scrollable)
- "column" {string}, a column chart or column graph is a chart or graph that presents categorical data with rectangular columns with heights proportional to the values that they represent. A horizontal column chart is called a bar chart. (data requires array of numbers, supports vertical field, scrollable)
- "waterfall" {string}, a waterfall chart is a form of data visualization that helps in understanding the cumulative effect of sequentially introduced positive or negative values. These intermediate values can either be time based or category based. The waterfall chart is also known as a flying bricks chart or Mario chart due to the apparent suspension of columns (bricks) in mid-air. Often in finance, it will be referred to as a bridge. (data requires array of numbers, supports vertical field, scrollable)
- "rangeArea" {string}, a range chart displays sets of data points, each of which is defined by multiple values for the same category, and emphasizes the distance between the two values. The category labels are displayed on the category axis. The plain Range chart fills in the area between the top and the bottom value for each data point. (data requires array of array of two-numbers, such as [[from, to]], supports vertical field, scrollable)
- "rangeColumn" {string}, a range column chart displays information as a range of data by plotting two Y-values (low and high) per data point. The vertical axis shows the values, and the horizontal axis shows the categories they belong to; in multiple-series range column charts, values are grouped by categories. (data requires array of array of two-numbers, such as [[from, to]], supports vertical field, scrollable)
- "candleStick" {string}, a candlestick chart (also called Japanese candlestick chart or K-line) is a style of financial chart used to describe price movements of a security, derivative, or currency. While similar in appearance to a bar chart, each candleStick represents four important pieces of information for that day: open and close in the thick body, and high and low in the "candle wick". Being densely packed with information, it tends to represent trading patterns over short periods of time, often a few days or a few trading sessions. (data requires array of array of four-numbers, such as [[open, high, low and close]], supports vertical field, scrollable)
- "ohlc" {string}, an open-high-low-close chart (also OHLC) is a type of chart typically used to illustrate movements in the price of a financial instrument over time. Each vertical line on the chart shows the price range (the highest and lowest prices) over one unit of time, e.g., one day or one hour. Tick marks project from each side of the line indicating the opening price (e.g., for a daily bar chart this would be the starting price for that day) on the left, and the closing price for that time period on the right. The bars may be shown in different hues depending on whether prices rose or fell in that period. (data requires array of array of four-numbers, such as [[open, high, low and close]], supports vertical field, scrollable)
Returns:
Returns the size to show a column or a bar within the chart. The size indicates the width for horizontally-oriented charts or height for the vertically-oriented chart types
-
Type
-
number
GetVisibleRect() → {Array.<number>}
The GetVisibleRect() method indicates the control's visible rectangle.
Returns:
Returns an array of [x,y,width,height] type that specifies the canvas's client rectangle
-
Type
-
Array.<number>
GetWheelChange() → {number}
The GetWheelChange() method defines the amount the calendar scrolls when the user rolls the mouse wheel. This setting allows you to adjust the sensitivity of the mouse wheel interaction with the control.
- Setting wheelChange to 0 disables mouse wheel actions, preventing the control from changing when the wheel is scrolled
- Setting wheelChange to a positive number, such as 5, increases the control's value by that amount each time the wheel is rotated, enabling faster adjustments
By modifying this value, you can fine-tune the control's responsiveness, making it easier for users to perform precise changes or larger adjustments as needed.
Returns:
Specifies the amount by which the scroll box position changes when the user rolls the mouse wheel.
-
Type
-
number
Example
The following statements are equivalent:
oGraph.GetWheelChange() {number}, returns the amount the control scrolls when the user rolls the mouse wheel
oGraph.WheelChange {number}, returns the amount the control scrolls when the user rolls the mouse wheel
where oGraph is an instance of Graph control
GetWheelChange
GetWindowRect() → {Array.<number>}
The GetWindowRect() method returns the window's client area.
Returns:
Returns an array of [x,y,width,height] type that specifies the window's client area
-
Type
-
Array.<number>
The GetXAxis() method gets the configuration-options for x-axis of xy-compatible chart-types ("scatter", "scatterLine" or "bubble").
Returns:
Returns the chart's x-axis.
-
Type
-
ValueAxisOptions
The GetYAxis() method gets the configuration-options for y-ayis of yy-compatible chart-types ("scatter", "scatterLine" or "bubble").
Returns:
Returns the chart's y-ayis.
-
Type
-
ValueAxisOptions
GetZoom() → {number}
The GetZoom() method defines the zoom factor of the control's content. The zoom factor determines how much the control's content is magnified or reduced. Once the user adjusts the browser's zoom level, the control automatically recalculates its zoom factor to maintain the correct scaling of its content. The ZoomLevels property defines the allowed zoom levels the user can select from. By default, the
Zoom property is set to null, indicating a normal view (100% zoom).
Returns:
A numeric value between 10 and 1000 that specifies the zoom factor of the control's content.
-
Type
-
number
GetZoomLevels() → {string}
The GetZoomLevels() method defines the zoom-levels the user can magnify the control's content.
Returns:
Specifies a list of numbers separated by comma that indicates the zoom-levels/zoom-levels the control's content is allowed to zoom.
-
Type
-
string
Home()
The Home() method zooms to 100% and scrolls the control to origin (0,0).
The Scroll() method scrolls the window based on the giving key.
Parameters:
| Name |
Type |
Attributes |
Description |
key |
string
|
|
Specifies a key to determines the direction to scroll the view as follows:
- "Home" {string}, scrolls to the left/top of the control
- "End" {string}, scrolls to the right/end of the control
- "Prior" or "PageUp"{string}, scrolls by a page left/up
- "Next" or "PageDown" {string}, scrolls by a page right/down
- "Up" or "ArrowUp" {string}, scrolls up
- "Down" or "ArrowDown" {string}, scrolls down
- "Left" or "ArrowLeft" {string}, scrolls left
- "Right" or "ArrowRight" {string}, scrolls right
|
count |
object
|
<optional>
|
indicates the number of lines to scroll if key is "Up", "Down", "Left" or "Right" |
SetAllowActions(value)
The SetAllowActions() method customizes the actions the user can perform once the control is clicked or touched. The order of the actions is very important, as the control checks each action from left to right until it finds a matching action for the performed mouse/touch event. The first matched action is performed, and the rest of the actions are ignored. So if you want to perform a specific action once the user clicks an item, and perform another action if the user clicks an area that does not contain any item, you should place the first action before the second one in the AllowActions property.
Parameters:
| Name |
Type |
Description |
value |
string
|
Indicates the actions the user can perform once the control is clicked or touched.
The format of the property is:
"action(shortcut,shortcut,...),action(shortcut,shortcut,...)..."
where
- "action", defines the action to perform (as defined below)
| Action |
Description |
Flags |
| "fit" |
Fits the drag-area into the control's client area |
- [zoom], specifies that the "fit" action magnifies the chart instead resizing it
|
| "move-value" |
Rearranges values, series, or data through drag-and-drop (available only if the serie's ShowValue property includes exPoint flag) |
- [disableMoveCategory], disables rearranging values/categories (default, if the flag is missing the user changes the control's Order property)
- [enableMoveSerie], enables rearranging series (changes the serie's Position property)
- [enableMoveData], enables rearranging the data of the serie (changes the serie's Data property)
|
| "overview-selection-resize" |
Resizes the graph using the left/right margins of the overview-selection |
|
| "scroll" |
Scrolls the control's content by drag |
- [view], specifies that the "scroll" is possible once the user clicks the view
- [legend], specifies that the "scroll" is possible once the user clicks the legend
|
| "value-resize" |
Resizes the column/bar's size for area-compatible chart types (not available if autoFit property is true) |
|
| "zoom" |
Zooms the control's content at dragging-point |
|
- "shortcut", defines the event's button or/and the modifier-keys that are required to perform the action. The "shortcut" is a combination of none, one or more of the following values:
- "Shift", indicates that the SHIFT key is pressed
- "Ctrl" or "Control", indicates that the CTRL key is pressed
- "Alt" or "Menu", indicates that the ALT key is pressed
- "Meta" , indicates that the META key is pressed
- "LButton", specifies that the mouse's left-button is pressed
- "RButton", specifies that the mouse's right-button is pressed
- "MButton", specifies that the mouse's middle/wheel-button is pressed
- "Long", specifies that the action requires a "long" click or touch before it begins
- "Double", specifies that the action requires a "double" click before it begins (this flag is available for non-dragable actions only such as "edit")
- "+", indicates AND between values
|
Example
null {null}, indicates the control's default allowActions value
"" {string}, specifies that no operation is allowed once the user clicks or touches the control
"scroll" {string}, specifies that only "scroll" operation is allowed, no matter of the event's button or modifier-keys is pressed.
"move-value(LButton),scroll" {string}, specifies that the "move-value" action is allowed when the user left-clicks and drags a value. Otherwise, dragging performs a scroll operation
SetAllowActions
SetAllowDrop(value)
The SetAllowDrop() method specifies whether the user can drag and drop local files into the control.
Parameters:
| Name |
Type |
Description |
value |
boolean
|
Indicates whether the user can drag and drop local files into the control. |
Example
false {boolean}, no file can be drop into the control (default)
true {boolean}, the user can drag and drop files into the control
SetAllowDrop
SetAllowStack(value)
The SetAllowStack() method specifies whether the series are stacked based on the non-empty values defined in the Stack property. When enabled, the series values are visually stacked on top of each other; when disabled, they are displayed independently. The
Stack property specifies whether the serie is stacked (same value for multiple series of the same type indicates same stacking-group).
Parameters:
| Name |
Type |
Description |
value |
boolean
|
Specifies a boolean value that determines whether stacking is enabled or disabled for the series. When set to true, stacking is enabled; when set to false, stacking is disabled. |
- Since:
Example
false {boolean}, the series' Stack property is ignored, and no series will be stacked, regardless of the Stack property's value.
true {boolean}, the series values are visually stacked on top of each other, provided the not-empty series' Stack property.
SetAllowStack
SetAutoFit(value)
The SetAutoFit() method specifies whether the elements of the series are resized to fit the control's client-area.
Parameters:
| Name |
Type |
Description |
value |
boolean
|
Indicates whether the elements of the series are resized to fit the control's client-area. |
Example
false {boolean}, the autofit feature is disabled (default)
true {boolean}, resizes the elements of the series to fit the control's content
SetAutoFit
SetBackground(value)
The SetBackground() method defines the display options to show different parts of the control.
Parameters:
| Name |
Type |
Description |
value |
BackgroundOptions
|
A value that indicates the display options to show different parts of the control. |
SetCategoryAxis(category)
The SetCategoryAxis() method defines the chart's category axes (oX).
Parameters:
Example
null {null}, removes the categories of the chart (@since 4.3)
{tfi: "<fgColor red>"} {CategoryAxisOptions}, shows the default category-axis in red
[{categories: [2001,2002,2003]}, {categories: ["A","B","C"], color: "blue"}] {CategoryAxisOptions[]}, defines two category-axis one that displays the 2001, 2002 and 2003, while another displays A, B and C in blue
SetCategoryAxis
SetCursor(value)
The SetCursor() method sets the configuration options to display crosshair over the hover/touch area, tooltips for some or all nearby series data items, as well as tooltips on axes.
Parameters:
| Name |
Type |
Description |
value |
CursorOptions
|
Indicates an object of CursorOptions type that specifies the configuration options to display crosshair over the hover/touch area, tooltips for some or all nearby series data items, as well as tooltips on axes. |
SetCursors(value)
The SetCursors() method assigns or changes the mouse cursors for different parts of the control. These cursors determine the pointer appearance when the user hovers over specific areas, allowing you to provide visual feedback and enhance interactivity for each part of the control.
Parameters:
| Name |
Type |
Description |
value |
string
|
A string expression that defines the mouse cursor to display when pointing over different parts of the control.
The format of the property is:
"cursor(part),cursor(part),..."
where:
- "cursor", defines the CSS mouse cursor to display while cursor hovers the part
- "part", defines the name of the part the cursor is applied on (as defined below)
The "cursor" can be any of the following:
| Cursor |
Description |
| "alias" | indicates a shortcut or alias will be created |
| "all-scroll" | indicates scrolling in any direction |
| "auto" | lets the browser decide the cursor based on context |
| "cell" | indicates a table cell |
| "col-resize" | indicates a column can be resized horizontally |
| "context-menu" | indicates a context menu is available |
| "copy" | indicates something will be copied |
| "crosshair" | a precise crosshair cursor |
| "default" | the default arrow cursor |
| "e-resize" | resize east (right edge) |
| "ew-resize" | resize horizontally |
| "grab" | indicates an item can be grabbed |
| "grabbing" | indicates an item is being grabbed |
| "help" | indicates help information is available |
| "move" | indicates something can be moved |
| "n-resize" | resize north (top edge) |
| "ne-resize" | resize northeast (top-right corner) |
| "nesw-resize" | resize along the northeast–southwest axis |
| "no-drop" | indicates dropping is not permitted |
| "not-allowed" | indicates the action is not allowed |
| "ns-resize" | resize vertically |
| "nw-resize" | resize northwest (top-left corner) |
| "nwse-resize" | resize along the northwest–southeast axis |
| "pointer" | the pointer cursor (a hand with a pointing finger) |
| "progress" | indicates background processing |
| "row-resize" | indicates a row can be resized vertically |
| "s-resize" | resize south (bottom edge) |
| "se-resize" | resize southeast (bottom-right corner) |
| "sw-resize" | resize southwest (bottom-left corner) |
| "text" | the text selection cursor (I-beam) |
| "url(...)" | uses a custom cursor image (with optional fallback) |
| "vertical-text" | the vertical text selection cursor |
| "w-resize" | resize west (left edge) |
| "wait" | indicates the program is busy |
| "zoom-in" | indicates zooming in |
| "zoom-out" | indicates zooming out |
The "part" can be any of the following:
| Part |
Description |
| "anchor" (hyperlink) | defines the mouse-cursor when the mouse pointer hovers the anchor (the <a> ex-HTML part marks an anchor or hyperlink element) |
| "legend" | defines the mouse-cursor when the mouse pointer hovers an object of the legend |
| "long" | specifies the mouse-cursor to be shown as soon as a "long" click or touch action begins (see allowActions field) |
| "move-value-drag" | defines the mouse cursor while a value, series, or data point is being dragged, visually indicating an active drag operation and showing which element can be grabbed. This is valid only if allowActions includes the "move-value" action and is typically used with "pointer(valuePoint)" to suggest that the user can click and move the value. Example: when the user clicks a value-point and begins dragging it, the cursor changes to "grabbing(move-value-drag)" to signal that the item is being moved (@since 4.9) |
| "no" | defines the mouse cursor to be shown when a drag-and-drop operation is not allowed (for example, when dropping a value, series, or data point is not permitted in the current area). This is valid only if allowActions includes the "move-value" action and provides immediate visual feedback to prevent accidental operations. Example: when the user drags a value over an invalid target, the cursor changes to "not-allowed(no)" to indicate that the operation is blocked (@since 4.9) |
| "valuePoint" | defines the mouse-cursor when the mouse pointer hovers the value-point |
|
SetFormatText(value)
The SetFormatText() method changes the format to display the view's invalid label.
Parameters:
| Name |
Type |
Description |
value |
exontrol.DrawTextFormatEnum
|
Specifies a value of exontrol.DrawTextFormatEnum value that defines the format to show the serie's caption.
The exontrol.DrawTextFormatEnum type supports the following flags:
- exTextAlignTop (0x00), justifies the text to the top of the rectangle
- exTextAlignLeft (0x00), aligns text to the left
- exTextAlignCenter (0x01), centers text horizontally in the rectangle
- exTextAlignRight (0x02), aligns text to the right
- exTextAlignVCenter (0x04), centers text vertically
- exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
- exTextAlignMask (0x0F), specifies the mask for text's alignment.
- exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
- exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
- exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
- exPlainText (0x80), treats the text as plain text.
- exTextNoClip (0x0100), draws without clipping.
- exHTMLTextNoColors (0x0200), ignores the and tags.
- exTextCalcRect (0x0400), determines the width and height of the text.
- exHTMLTextNoTags (0x0800), ignores all HTML tags.
- exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
- exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
- exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
|
Example
null {null}, centers the label
32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line label
0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line label right/bottom-aligned
SetFormatText
SetImageAlign(value)
The SetImageAlign() method changes the alignment of the serie's image.
Parameters:
| Name |
Type |
Description |
value |
number
|
Defines the alignment of the serie's image as one of the following:
- 0, the image is on the left of the serie's caption
- 1, the image is on the right of the serie's caption
- 2, the image is on the top of the serie's caption
- 3, the image is on the bottom of the serie's caption
|
Example
null {null}, the image is aligned left to the caption (default)
1 {number}, the image is displayed to the right of the serie's caption
SetImageAlign
SetImageSize(value)
The SetImageSize() method changes the size of the serie's image (reserved).
Parameters:
| Name |
Type |
Description |
value |
any
|
Indicates the size of the serie's image as explained:
- {null}, Indicates that the serie's image is displayed as it is (full-sized).
- {number}, Specifies that the serie's image is displayed into a square of giving size (same width and height). If 0 the serie displays no image, if negative the serie's image is stretched to giving square, else the serie's picture is scaled to fit the giving rectangle.
- {number[]}, Specifies an array of [aspect-width,aspect-height] type that defines the limits for width or/and height. The aspect-width and aspect-height define the width/height of the serie's picture to scale or stretch to.
|
Example
null {null}, Indicates that the serie's image is displayed as it is (full-sized).
0 {number}, no image is displayed
64 {number}, the image is scaled to fit a 64 x 64 rectangle
-64 {number}, the image is strected to a 64 x 64 rectangle
[32,64] {array}, scales the image to the largest ratio-rectangle (32 x 64) that fits the client
[-32,-64] {array}, stretches the image to a 32 x 64 rectangle
SetImageSize
SetInvalid(value)
The SetInvalid() method changes the label the control is displaying while no or invalid data.
Parameters:
| Name |
Type |
Description |
value |
string
|
Specifies a value of string value that defines the label the control is displaying while no or invalid data. The label can include ex-HTML tags, such as , , ... |
Example
null {null}, no label is displayed
"no or invalid data" {number}, defines a label to be shown while the control has no or invalid data
SetInvalid
SetLegend(value)
The SetLegend() method sets the configuration options to display the view's legend (the legend helps you choose which series to show or hide at runtime).
Parameters:
| Name |
Type |
Description |
value |
LegendOptions
|
Indicates an object of LegendOptions type that specifies the configuration options to display the view's legend. |
SetLocked(value)
The SetLocked() method locks or unlocks the control.
Parameters:
| Name |
Type |
Description |
value |
boolean
|
A boolean value that indicates whether the control is locked(protected) or unlocked. |
Example
false {boolean}, unlocks the control (can select any serie)
true {boolean}, locks the control (can't select any serie)
SetLocked
SetMisc(value)
The SetMisc() method defines the control's miscellaneous options.
Parameters:
| Name |
Type |
Description |
value |
MiscellaneousOptions
|
A value that indicates the control's miscellaneous options. |
SetMultiColorSerie(value)
The SetMultiColorSerie() method specifies whether a single data series (single-valid serie) in a chart can use multiple colors for its data points instead of a single uniform color. The
seriesColors field defines the default colors for the chart's series. The
seriesColorsDecrease field defines the default colors for the chart's series (when the value goes down). When all colors are used, new colors are pulled from the start again. The
seriesColorsAreaAlpha field defines the alpha channel for the default colors of the area-type chart's series.
Parameters:
| Name |
Type |
Description |
value |
boolean
|
Indicates whether a single series' data points use multiple colors for representation. |
- Since:
Example
false {boolean}, the entire serie is rendered in a single color
true {boolean}, each data point in the series can have a different color (useful for distinguishing individual values visually) (default)
SetMultiColorSerie
SetOptions(nOptions, bIncludeAllopt) → {boolean}
The SetOptions() method applies new options to the view.
Parameters:
| Name |
Type |
Attributes |
Description |
nOptions |
object
|
|
Specifies an object of Graph.Options type that indicates the new options to apply. |
bIncludeAll |
boolean
|
<optional>
|
Indicates whether all fields of nOptions are included in the serie's oOptions object. |
Returns:
Returns true, if there were options applied to the serie
-
Type
-
boolean
Example
oGraph.Options = {imageAlign: 1, imageSize: 24}, changes the alignment and the size for all images within the control.
The oGraph.Options = value statement is equivalent with oGraph.SetOptions(value) or oGraph.oGV.SetOptions(value)
SetOptions
SetOrder(value)
The SetOrder() method specifies a custom display order for values or categories using their zero-based indexes, provided as a comma-separated string. Assigning a non-empty value lets you define the position of one, multiple, or all values, while empty entries (,,) preserve positions based on the default order. The data values in the chart are arranged using the following properties:
- Sort, sorts the series values in ascending or descending order
- Reverse (option of category-axis), reverses the position of the values as they were added (if no Sort is applied), or reverses the order produced by the Sort property (if Sort is applied)
- Order, repositions values according to their zero-based indexes in a custom sequence
The custom order is cleared when Sort or Reverse is set, leaving the Order property empty. If you want to reset the custom ordering and revert to the original order of values or categories as they were added to the series, you can clear the Order property by setting it to an empty string or null. This action removes any custom ordering and restores the default sequence as specified by Sort and Reverse properties.
Parameters:
| Name |
Type |
Description |
value |
string
|
Indicates a list of value or category indexes in their displayed order, separated by commas. The index is zero-based, meaning the first value has an index of 0, the second an index of 1, and so on. You can specify the order for one or more values; any values not included in the list will be displayed after the specified values, in their original order. |
- Since:
Example
null {null}, the values or categories are displayed in their original order (default)
"8" {string}, index 8 first (move the index 8 to the first position)
",,8" {string}, index 8 third (move the index 8 to the third position)
"8,,1" {string}, index 8 first, index 1 third (move the index 8 to the first position, and index 1 to the third position)
",,9,,1" {string}, index 9 third, index 1 fifth (move the index 9 to the third position, and index 1 to the fifth position; unspecified positions follow the default order of the other indexes)
SetOrder
SetOverview(value)
The SetOverview() method sets the configuration options to display the overview (the overview displays the map of the entire series without a scroll bar).
Parameters:
| Name |
Type |
Description |
value |
OverviewOptions
|
Indicates an object of OverviewOptions type that specifies the configuration options to display the overview. |
SetPad(value)
The SetPad() method changes the serie's padding or the space between view's content and its borders.
Parameters:
| Name |
Type |
Description |
value |
number
|
Array.<number>
|
string
|
Specifies a value that could be:
- {number} a numeric value, to pad horizontal and vertical size with the same value
- {(string|number[])} a "x,y" or [x,y] type to specify the padding on horizontal and vertical side
|
Example
null {null}, indicates that the default padding value of [4,4] is applied
0 {number}, indicates no padding
"8,4" {string}, increases the serie's width with 2 * 8-pixels and serie's height with 2 * 4-pixels
[8,4] {array}, increases the serie's width with 2 * 8-pixels and serie's height with 2 * 4-pixels
SetPad
SetReadOnly(value)
The SetReadOnly() method sets the control in read-only mode.
Parameters:
| Name |
Type |
Description |
value |
boolean
|
A boolean value that indicates whether the control is read-only. |
Example
false {boolean}, the control is not read-only
true {boolean}, the control is in read-only mode
SetReadOnly
The SetScrollBarsOrigin() method defines the color to highlight the position of the origin (0,0) on the control's scroll bars.
Parameters:
| Name |
Type |
Description |
value |
string
|
Specifies null, to prevent showing the position of origin (0,0) on the control's scroll bars, or a CSS color. |
Example
null {null}, hides the origin (0,0) on the control's scroll bar
"black" {string}, shows the origin (0,0) on the control's scroll bar in black
SetScrollBarsOrigin
The SetScrollPos() method scrolls horizontally and/or vertically the control's default view.
Parameters:
| Name |
Type |
Description |
value |
object
|
Specifies an object of {x,y} type that defines the control's horizontal and vertical scroll-position.
Properties
| Name |
Type |
Description |
x |
number
|
indicates the horizontal scroll-position. |
y |
number
|
indicates the vertical scroll-position. |
|
SetSerieDef(value)
The SetSerieDef() method defines the default options applied to each newly created series. Existing series are not affected; the defaults apply only to series added afterward. The serieDef object supports all fields defined by the
SerieOptions type. This method is useful when you want to establish a consistent configuration across all newly added series without setting the same options individually.
Parameters:
| Name |
Type |
Description |
value |
object
|
Specifies an object that defines the default options for new series, or null to remove any previously defined defaults. |
- Since:
Example
null {null}, no default options are applied to new series (default).
{stack: "A", showValue: "point,hit"} {object}, indicates that each new series is added to stack “A”, each data value displays its value point, and the tooltip appears when the cursor hovers over the rectangular hit area of the data point (such as columns or bars).
SetSerieDef
SetSerieType(value)
The SetSerieType() method specifies the default representation method for the data in all series where the
type property is not explicitly defined. This setting determines how the series will be rendered (e.g., as a line, bar, scatter plot, etc.) when the type is not set for individual series, ensuring a consistent visual presentation across the graph. The
Type property defines the individual type of the serie.
Parameters:
| Name |
Type |
Description |
value |
string
|
Specifies the default representation method for the data in all series where the type property is not explicitly, as one of the following:
- "area" {string}, an area chart or area graph displays graphically quantitative data. It is based on the line chart. The area between axis and line are commonly emphasized with colors, textures and hatchings. Commonly one compares two or more quantities with an area chart. (data requires array of numbers, supports vertical field, scrollable)
- "line" {string}, a line chart or line graph, also known as curve chart is a type of chart which displays information as a series of data points called 'markers' connected by straight line segments. It is a basic type of chart common in many fields. It is similar to a scatter plot except that the measurement points are ordered (typically by their x-axis value) and joined with straight line segments. A line chart is often used to visualize a trend in data over intervals of time - a time series - thus the line is often drawn chronologically. In these cases they are known as run charts. (data requires array of numbers, supports vertical field, scrollable)
- "column" {string}, a column chart or column graph is a chart or graph that presents categorical data with rectangular columns with heights proportional to the values that they represent. A horizontal column chart is called a bar chart. (data requires array of numbers, supports vertical field, scrollable)
- "waterfall" {string}, a waterfall chart is a form of data visualization that helps in understanding the cumulative effect of sequentially introduced positive or negative values. These intermediate values can either be time based or category based. The waterfall chart is also known as a flying bricks chart or Mario chart due to the apparent suspension of columns (bricks) in mid-air. Often in finance, it will be referred to as a bridge. (data requires array of numbers, supports vertical field, scrollable)
- "radarArea" {string}, a radar chart is a graphical method of displaying multivariate data in the form of a two-dimensional chart of three or more quantitative variables represented on axes starting from the same point. The relative position and angle of the axes is typically uninformative, but various heuristics, such as algorithms that plot data as the maximal total area, can be applied to sort the variables (axes) into relative positions that reveal distinct correlations, trade-offs, and a multitude of other comparative measures. (data requires array of numbers, non-scrollable)
- "radarLine" {string}, similar with radarArea type. (data requires array of numbers, non-scrollable)
- "radarColumn" {string}, displays data in radial columns starting from one center point. The circle is divided into equal portions depending on the number of columns and each column group occupies one portion (similar with "radarArea" type, data requires array of numbers, non-scrollable)
- "pie" {string}, a pie chart (or a circle chart) is a circular statistical graphic which is divided into slices to illustrate numerical proportion. In a pie chart, the arc length of each slice (and consequently its central angle and area) is proportional to the quantity it represents. While it is named for its resemblance to a pie which has been sliced, there are variations on the way it can be presented. (data requires array of numbers, non-scrollable)
- "rangeArea" {string}, a range chart displays sets of data points, each of which is defined by multiple values for the same category, and emphasizes the distance between the two values. The category labels are displayed on the category axis. The plain Range chart fills in the area between the top and the bottom value for each data point. (data requires array of array of two-numbers, such as [[from, to]], supports vertical field, scrollable)
- "rangeColumn" {string}, a range column chart displays information as a range of data by plotting two Y-values (low and high) per data point. The vertical axis shows the values, and the horizontal axis shows the categories they belong to; in multiple-series range column charts, values are grouped by categories. (data requires array of array of two-numbers, such as [[from, to]], supports vertical field, scrollable)
- "polarArea" {string}, represents data points connected with straight line segments that enclose a filled area together with the chart pole (data requires array of array of two-numbers, such as [[angle, value]], non-scrollable)
- "polarLine" {string}, represents data points connected with straight line segments (data requires array of array of two-numbers, such as [[angle, value]], non-scrollable)
- "polarScatter" {string}, shows the serie as non-connected data points (data requires array of array of two-numbers, such as [[angle, value]], non-scrollable)
- "scatter" {string}, a scatter plot (also called a scatterplot, scatter graph, scatter chart, scattergram, or scatter diagram) is a type of plot or mathematical diagram using Cartesian coordinates to display values for typically two variables for a set of data. (data requires array of array of two-numbers, such as [[x, y]], supports vertical field, non-scrollable)
- "scatterLine" {string}, a scatter line chart is similar with "scatter" type, excepts that lines are shown between scatter plots. (data requires array of array of two-numbers, such as [[x, y]], supports vertical field, non-scrollable)
- "scatterArea" {string}, a scatter area chart is similar with "scatterLine" type, excepts that scatter plots zone is filled. (data requires array of array of two-numbers, such as [[x, y]], supports vertical field, non-scrollable)
- "bubble" {string}, a bubble chart or bubble plot is a type of chart that displays three dimensions of data (a bubble chart is an extension of the scatter plot used to look at relationships between three numeric variables.). Each entity with its triplet (v1, v2, v3) of associated data is plotted as a disk that expresses two of the vi values through the disk's xy location and the third through its size. Bubble charts can facilitate the understanding of social, economical, medical, and other scientific relationships. (data requires array of array of three-numbers, such as [[x, y, size]], supports vertical field, non-scrollable)
- "candleStick" {string}, a candlestick chart (also called Japanese candlestick chart or K-line) is a style of financial chart used to describe price movements of a security, derivative, or currency. While similar in appearance to a bar chart, each candleStick represents four important pieces of information for that day: open and close in the thick body, and high and low in the "candle wick". Being densely packed with information, it tends to represent trading patterns over short periods of time, often a few days or a few trading sessions. (data requires array of array of four-numbers, such as [[open, high, low, close]], supports vertical field, scrollable)
- "ohlc" {string}, an open-high-low-close chart (also OHLC) is a type of chart typically used to illustrate movements in the price of a financial instrument over time. Each vertical line on the chart shows the price range (the highest and lowest prices) over one unit of time, e.g., one day or one hour. Tick marks project from each side of the line indicating the opening price (e.g., for a daily bar chart this would be the starting price for that day) on the left, and the closing price for that time period on the right. The bars may be shown in different hues depending on whether prices rose or fell in that period. (data requires array of array of four-numbers, such as [[open, high, low, close]], supports vertical field, scrollable)
|
- Since:
Example
null {null}, shows the data as columns (by default)
"radarCol" {string}, displays data in radial columns starting from one center point. The circle is divided into equal portions depending on the number of columns and each column group occupies one portion (similar with "radarArea" type, data requires array of numbers, non-scrollable)
"pie" {string}, a pie chart (or a circle chart) is a circular statistical graphic which is divided into slices to illustrate numerical proportion. In a pie chart, the arc length of each slice (and consequently its central angle and area) is proportional to the quantity it represents. While it is named for its resemblance to a pie which has been sliced, there are variations on the way it can be presented. (data requires array of numbers, non-scrollable)
SetSerieType
SetShapes(value)
The SetShapes() method sets or changes the shapes assigned to each part of the control. These shapes determine the visual appearance of the control's elements, such as borders, fills, and other graphical components. Using this method, you can fully customize how each part of the control is drawn and displayed.
Parameters:
| Name |
Type |
Description |
value |
string
|
A string expression that defines the shapes each part of the control can display.
The format of the property is:
"shape(part),shape(part),..."
where:
- "shape", defines the shape to apply on the UI part as one of the following:
◦ any of 140 color names any browser supports (such as red, blue, green, ...)
◦ hexadecimal colors, is specified with: #RRGGBB, where the RR (red), GG (green) and BB (blue) hexadecimal integers specify the components of the color. All values must be between 00 and FF (such as #0000ff which defines a blue background)
◦ hexadecimal colors with transparency, is specified with: #RRGGBBAA, where AA (alpha) value must be between 00 and FF (such as #0000ff80 which defines a semi-transparent blue background)
◦ RGB colors, is specified with the RGB(red, green, blue) function. Each parameter (red, green, and blue) defines the intensity of the color and can be an integer between 0 and 255( such as rgb(0,0,255) that defines a blue background)
◦ RGBA colors, are an extension of RGB color values with an alpha channel as RGBA(red, green, blue, alpha) function, where the alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque) ( such as rgba(0,0,255,0.5) which defines a semi-transparent blue background)
◦ HSL colors, is specified with the HSL(hue, saturation, lightness) function, where hue is a degree on the color wheel (from 0 to 360) - 0 (or 360) is red, 120 is green, 240 is blue. saturation is a percentage value; 0% means a shade of gray and 100% is the full color. lightness is also a percentage; 0% is black, 100% is white. HSL stands for hue, saturation, and lightness - and represents a cylindrical-coordinate representation of colors (such as hsl(240, 100%, 50%) that defines a blue background)
◦ HSLA colors, are an extension of HSL color values with an alpha channel - which specifies the opacity of the object as HSLA(hue, saturation, lightness, alpha) function, where alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque) (such as hsla(240, 100%, 50%,0.5) that defines a semi-transparent blue background)
◦ a JSON representation of the shape object to apply (while it starts with { character, such as '{"normal": {"primitive": "RoundRect","fillColor":"black","tfi": {"fgColor": "white"}}}')
◦ specifies the name of the field within the exontrol.Shapes.Graph object (while it starts with a lowercase letter, such as shserie which refers to exontrol.Shapes.Graph.shserie shape)
◦ specifies the name of the field within the exontrol.Shapes object (while it starts with an uppercase letter, such as Button which refers to exontrol.Shapes.Button shape)
- "part", defines the name of the part the shape is applied on (as defined below)
The shapes property supports any of the following parts:
| Part |
Description |
Additional |
| "area" | specifies the visual-appearance to show the "area" serie-types | |
| "bubble" |
specifies the visual-appearance to show the "bubble" serie-types |
- size {number}, specifies the maximum-size of the data-point on the chart
|
| "candleStick" |
specifies the visual-appearance to show the "candleStick" serie-types |
- size {number}, specifies the size of the stick
- hollow {boolean}, indicates whether the hollow candlestick representation is displayed (hollow candle means that its closing value is higher (or equal) than opening value of the same period)
|
| "column" | specifies the visual-appearance to show the "column" serie-types | |
| "cursorCategoryAxisTooltip" | defines the visual-appearance to show the tooltip on the category-axes, when the crosshair hovers the category-unit | |
| "cursorLine" | defines the visual-appearance (frameColor, frameSize, frameDash) to display the crosshair over the hover/touch area (showCursorCategoryLine or showCursorValueLine) | |
| "cursorSerieTooltip" | defines the visual-appearance to show the tooltip when the crosshair cursor hovers the charts of the series | |
| "cursorValueAxisTooltip" | defines the visual-appearance to show the tooltip on the value-axes, when the crosshair hovers the value-unit | |
| "cursorXAxisTooltip" | defines the visual-appearance to show the tooltip on the x-axes, when the crosshair hovers the value-unit (available for xy-chart types) | |
| "cursorYAxisTooltip" | defines the visual-appearance to show the tooltip on the y-axes, when the crosshair hovers the value-unit (available for xy-chart types) | |
| "frameFit" | defines the visual-appearance to display the frame while fitting objects into the control's client area by drag | |
| "legendLabel" | defines the visual-appearance of the labels of the visible-series within the map legend | |
| "legendLabelHidden" | defines the visual-appearance of the labels of the hidden-series within the map legend | |
| "legendSymbol" | defines the visual-appearance of the symbols of the visible-series within the map legend | |
| "legendSymbolHidden" | defines the visual-appearance of the symbols of the hidden-series within the map legend | |
| "legendUnit" | defines the visual-appearance of the legend-unit (the client-rectangle that covers the symbol and label of the legend-object) of the visible-series within the map legend | |
| "legendUnitHidden" | defines the visual-appearance of the legend-unit (the client-rectangle that covers the symbol and label of the legend-object) of the hidden-series within the map legend | |
| "line" | specifies the visual-appearance to show the "line" serie-types | |
| "ohlc" |
specifies the visual-appearance to show the "ohlc" serie-types |
- size {number}, specifies the size of the stick
- hollow {boolean}, indicates whether the hollow candlestick representation is displayed (hollow candle means that its closing value is higher (or equal) than opening value of the same period)
|
| "pie" | specifies the visual-appearance to show the "pie" serie-types | |
| "polarArea" | specifies the visual-appearance to show the "polarArea" serie-types | |
| "polarLine" | specifies the visual-appearance to show the "polarLine" serie-types | |
| "polarScatter" |
specifies the visual-appearance to show the "polarScatter" serie-types |
- size {number}, specifies the size of the data-point on the chart
|
| "radarArea" | specifies the visual-appearance to show the "radarArea" serie-types | |
| "radarColumn" | specifies the visual-appearance to show the "radarColumn" serie-types | |
| "radarLine" | specifies the visual-appearance to show the "radarLine" serie-types | |
| "rangeArea" | specifies the visual-appearance to show the "rangeArea" serie-types | |
| "rangeColumn" | specifies the visual-appearance to show the "rangeColumn" serie-types | |
| "scatter" |
specifies the visual-appearance to show the "scatter" serie-types |
- size {number}, specifies the size of the data-point on the chart
|
| "scatterArea" | specifies the visual-appearance to show the "scatterArea" serie-types | |
| "scatterLine" | specifies the visual-appearance to show the "scatterLine" serie-types | |
| "valueBack" | defines the visual-appearance to apply on the value's background | |
| "valueLine" |
defines the visual-appearance for value-lines (the guided line from the value-point to the value itself) |
- length {number}, indicates the horizontal distance between the middle and end points of the value-line
|
| "valuePoint" |
defines the visual-appearance for value-points |
- size {number}, specifies the size of the value-point
- frameColor, defines the color to show the object's frame
- patternColor, defines the color to show the object's pattern
- fillColor, defines the color to show the object's background
- fillGradientColor, defines the gradient type and colors to show the object's background. The fillColor field defines the starting color. The fillGradientColor field has effect only if the fillColor field is defined (not null or undefined).
The ...Color fields supports the following additional values:
- "null", indicates that the value-point uses the serie's value color
- "transparent", specifies that the value-point is not visible (transparent)
|
| "waterFall" |
specifies the visual-appearance to show the "waterFall" serie-types |
- lineSize {number}, defines size of to draw the lines between columns
|
| "select-overview" | defines the visual-appearance to display the overview-selection | |
| "select-overview-resize" | defines the visual-appearance to display left/right resize-margins of the overview-selection | |
| "selectout-overview" | defines the visual-appearance to display the left/right parts outside of the overview-selection | |
|
Example
null {null}, specifies the default visual appearance
"" {string}, no shape (no visual appearance is applied to any part of the control)
'{"hover":{"fillColor":"black","tfi":{"fgColor":"white"}}}(valuePoint)' {string}, shows the value-point in white on a black-background, while the cursor hovers it
"xxx(d),yyy(d,m),zzz(y)" {string}, specifies that the exontrol.Shapes.Graph.xxx combined with exontrol.Shapes.Graph.yyy object defines the visual appearance of "d" part of the control, exontrol.Shapes.Graph.yyy object defines the visual appearance of "m" part of the control and exontrol.Shapes.Graph.zzz object defines the visual appearance of "y" part of the control
SetShapes
SetSmooth(value)
The SetSmooth() method changes the time in ms the control goes from one layout to another (0 indicates no smooth-transition is performed).
Parameters:
| Name |
Type |
Description |
value |
number
|
Indicates the time in ms the control goes from one layout to another. |
Example
0 {number}, no smooth changes once the control goes from a layout to another
125 {number}, specifies that a smooth-transition is performed from a layout to another for 125 ms.
SetSmooth
SetSort(value)
The SetSort() method specifies the series to be sort, separated by spaces. The data values in the chart are arranged using the following properties:
- Sort, sorts the series values in ascending or descending order
- Reverse (option of category-axis), reverses the position of the values as they were added (if no Sort is applied), or reverses the order produced by the Sort property (if Sort is applied)
- Order, repositions values according to their zero-based indexes in a custom sequence
The custom order is cleared when Sort or Reverse is set, leaving the Order property empty.
Parameters:
| Name |
Type |
Description |
value |
string
|
Specifies the series to be sorted, separated by spaces. The format of a particular element of the sort field is "KEY[\[INNER\]][:([A]|D)]", where KEY is the name or the index of the serie, INNER is the inner-index of the value to sort (valid for multi-dimensional array only), A stands for ascending (by default), while D for descending. |
Example
"name" {string}, sorts ascending the serie with the giving name
"0 1:D" {string}, sorts ascending the first-serie (for identichal values, the second serie determines the order of the values)
"ohlc[1]" {string}, sorts ascending the serie with the name "ohlc", by the second inner-value (the inner-value defines the element of an array-value, the [index] specifies the index of the inner-value to sort, the [index] is valid for charts that support multi-dimensional arrays such as "rangeColumn", "rangeArea", "candleStick" or "ohlc")
SetSort
SetTfi(value)
The SetTfi() method sets the
font attributes for the control's captions, allowing precise customization of their appearance by specifying the text style (such as bold or italic), font family, and font size, either as a string (e.g., "b monospace 16") or as an object (e.g., {bold: true, italic: false, fontName: "monospace", fontSize: 16}), and immediately applies these settings to update the displayed captions.
Parameters:
| Name |
Type |
Description |
value |
string
|
object
|
Indicates a string representation such as "b monospace 16" or as an object such as {bold: true, fontName: "monospace", fontSize: 16}.
The value as {string} supports any of the following keywords (each keyword can be specified using first letters only such as "b" for "bold) separated by space characters:
- bold, displays the text in bold (equivalent of <b> tag)
- italic, displays the text in italics (equivalent of <i> tag)
- underline, underlines the text (equivalent of <u> tag)
- strikeout, specifies whether the text is strike-through (equivalent of <s> tag)
- <fontName name>, specifies the font's family (equivalent of <font name> tag)
- <fontSize size>, specifies the size of the font (equivalent of <font ;size> tag)
- <fgColor CSSColor>, specifies the text's foreground color (equivalent of <fgcolor> tag)
- <bgColor CSSColor>, specifies the text's background color (equivalent of <bgcolor> tag)
- <shaColor CSSColor;width;offset>, defines the text's shadow (equivalent of <sha color;width;offset> tag)
- <outColor CSSColor>, shows the text with outlined characters (CSScolor) (equivalent of <out color> tag)
- <graColor CSSColor;mode;blend>, defines a gradient text (equivalent of <gra color;mode;blend> tag)
Any other word within the string value that's not recognized as a keyword is interpreted as:
- name of the font (not a number), specifies the font's family (equivalent of <font name> tag)
- size of the font (number), specifies the size of the font (equivalent of <font ;size> tag)
The value as {object} supports any of the following fields:
- bold {boolean}, displays the text in bold (equivalent of <b> tag)
- italic {boolean}, displays the text in italics (equivalent of <i> tag)
- underline {boolean}, underlines the text (equivalent of <u> tag)
- strikeout {boolean}, specifies whether the text is strike-through (equivalent of <s> tag)
- fontName {string}, specifies the font's family (equivalent of <font name> tag)
- fontSize {number}, specifies the size of the font (equivalent of <font ;size> tag)
- fgColor {string}, specifies the text's foreground color (CSScolor) (equivalent of <fgcolor> tag)
- bgColor {string}, specifies the text's background color (CSScolor) (equivalent of <bgcolor> tag)
- shaColor {object}, specifies an object of {color, width, offset} type that defines the text's shadow (equivalent of <sha color;width;offset> tag), where:
- color {string}, defines the color of the text's shadow (CSScolor)
- width {number}, defines the size of the text's shadow
- offset {number}, defines the offset to show the text's shadow relative to the text
- outColor {string}, shows the text with outlined characters (CSScolor) (equivalent of <out color> tag)
- graColor {object}, specifies an object of {color, mode, blend} type that defines a gradient text (equivalent of <gra color;mode;blend> tag), where:
- color {string}, defines the gradient-color (CSScolor)
- mode {number}, defines the gradient direction as 0 (left-right), 1 (default, top-bottom), 2 (left-center-right), and 3 (top-center-bottom)
- blend {number}, defines the gradient blend as a value between 0 and 1
CSSColor or CSS legal color values can be specified by the following methods:
- Hexadecimal colors, is specified with: #RRGGBB, where the RR (red), GG (green) and BB (blue) hexadecimal integers specify the components of the color. All values must be between 00 and FF. For example, #0000ff value is rendered as blue, because the blue component is set to its highest value (ff) and the others are set to 00.
- Hexadecimal colors with transparency, is specified with: #RRGGBBAA, where AA (alpha) value must be between 00 and FF. For example, #0000ff80 defines a semi-transparent blue.
- RGB colors, is specified with the RGB(red, green, blue) function. Each parameter (red, green, and blue) defines the intensity of the color and can be an integer between 0 and 255. For example, rgb(0,0,255) defines the blue color.
- RGBA colors, are an extension of RGB color values with an alpha channel as RGBA(red, green, blue, alpha) function, where the alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque). For example, rgba(0,0,255,0.5) defines a semi-transparent blue.
- HSL colors, is specified with the HSL(hue, saturation, lightness) function, where hue is a degree on the color wheel (from 0 to 360) - 0 (or 360) is red, 120 is green, 240 is blue. saturation is a percentage value; 0% means a shade of gray and 100% is the full color. lightness is also a percentage; 0% is black, 100% is white. HSL stands for hue, saturation, and lightness - and represents a cylindrical-coordinate representation of colors. For example, hsl(240, 100%, 50%) defines the blue color.
- HSLA colors, are an extension of HSL color values with an alpha channel - which specifies the opacity of the object as HSLA(hue, saturation, lightness, alpha) function, where alpha parameter is a number between 0.0 (fully transparent) and 1.0 (fully opaque). For example, hsla(240, 100%, 50%,0.5) defines a semi-transparent blue.
- Predefined/Cross-browser color names, 140 color names are predefined in the HTML and CSS color specification. For example, blue defines the blue color.
|
Example
null {null}, the tfi field is ignored
"bold monospace 16 <fg blue>" {string}, defines Monospace font of 16px height, bold and blue
{bold: true, fontName: "monospace", fontSize: 16, fgColor: "blue"} {object}, defines Monospace font of 16px height, bold and blue
SetTfi
The SetToolTipDelay() method sets the time the mouse pointer must hover over an object before the tool tip appears. Setting it to 0 makes tool tips appear immediately, while a higher value (for example, 128) introduces a delay to prevent accidental pop-ups when moving the mouse quickly across the control. The ToolTipPopDelay property determines how long the tool tip remains visible (in milliseconds) if the mouse pointer stays stationary, and the ToolTipWidth property sets the maximum width of the control's tool tip in pixels.
Parameters:
| Name |
Type |
Description |
value |
number
|
A value that specifies how long the mouse pointer must point to an object before the tool tip appears. |
Example
0 {number}, the tooltip is shown "immediately"
128 {number}, the tooltip is displayed in 128 ms.
SetToolTipDelay
The SetToolTipFormat() method specifies the expression to customize the tooltip (shown while the cursor hovers value-points of the chart).
Parameters:
| Name |
Type |
Description |
value |
string
|
Indicates the format-expression to cusomize the tooltip. The format-expression supports predefined constants, operators and keywords as explained:
- "value", {number} specifies the data point value
- "name", {string} defines the name of the serie as specified by Name property
- "user", {any} specifies the extra data associated with the serie as specified by UserData property (@since 4.8)
- "index", {number} indicates the index of the category that contains the current value (@since 4.8)
- "category", {string} specifies the category the current value is in (available only if applicable)
- "percent", {number} indicates the percent of the item, as a number between 0 and 100 (available only if applicable)
- "inner", {number} indicates the inner index of the value within the point data. For example, 0 represents the 'open' or 'from' value, 1 represents the 'high' or 'to' value, 2 represents the 'low' value, and 3 represents the 'close' value. This property is defined only for charts that require multi-dimensional arrays, such as candlestick chart types. (available only if applicable)
- "%V0", "%V1", "%V2" or "%V3", {number} retrieve the designated values by referencing %V0 for the open value (for candlestick charts or "from" in column range charts), %V1 for the high value (for candlestick charts or "to" in column range charts), %V2 for the low value (for candlestick charts), and %V3 for the close value (for candlestick charts, defaulting to "value" if unavailable)
|
Example
null {null}, the name of the serie followed by the value, "(name ? name + ': ' : '') + value"
"``" {string}, no tooltip is shown
"value format ``" {string}, displays the values using two-decimals (according with the current regional settings)
SetToolTipFormat
The SetToolTipPopDelay() method sets the duration, in milliseconds, that a tooltip remains visible when the mouse pointer is stationary over a control. The ToolTipPopDelay property is expressed in milliseconds. The ToolTipDelay property defines how long the mouse pointer must hover over an object before the tooltip appears. The ToolTipWidth property specifies the width of the tooltip window in pixels. By default, the tooltip remains visible for 5000 milliseconds.
Parameters:
| Name |
Type |
Description |
value |
number
|
A value that specifies the period in ms of time the tool top remains visible if the mouse pointer is stationary within a control. |
Example
0 {number}, no tooltip is shown for any object (disabled)
-1 {number}, the tooltip stays indefinitely (negative)
1000 {number}, the tooltip is visible for 1 second
SetToolTipPopDelay
The SetToolTipWidth() method changes the width of the tooltip window, in pixels. The ToolTipWidth property gets or sets the width of the tooltip window, in pixels. The ToolTipWidth property accepts a number value that specifies the width of the tooltip window, in pixels. The ToolTipDelay property gets or sets how long the mouse pointer must point to an object before the tool tip appears. The ToolTipPopDelay property gets or sets the period in ms of time the tool top remains visible if the mouse pointer is stationary within a control.
Parameters:
| Name |
Type |
Description |
value |
number
|
A value that specifies the width of the tooltip window, in pixels. |
Example
0 {number}, no tooltip is shown for any object (disabled)
-1 {number}, the tooltip's content is displayed on a single line (without limit the width of it)
300 {number}, the tooltip's max-width is 300 pixels
SetToolTipWidth
SetValueAxis(value)
The SetValueAxis() method defines the chart's value axes (oY). The unrefered value axes shows the data as provided by the default value axis. The axis option of the
Serie object specifies the name of the value axis to use...
Parameters:
Example
null {null}, the chart displays and uses a single value-axis
{tfi: "<fgColor red>"} {ValueAxisOptions}, shows the default value-axis in red
[{name: "celsius", min: 0, max: 100, majorUnit: 25}, {name: "kelvin", min: 273.15, max: 373.15, majorUnit: 25}] {ValueAxisOptions[]}, defines two value-axis celsius and kelvin (celsius is the default value axis)
SetValueAxis
SetValueSize(value)
The SetValueSize() method sets the size to show a column or a bar within the chart. The valueSize has no effect for xy or circular-compatible chart types. The valueSize has effect for area-compatible chart types as follows:
- "area" {string}, an area chart or area graph displays graphically quantitative data. It is based on the line chart. The area between axis and line are commonly emphasized with colors, textures and hatchings. Commonly one compares two or more quantities with an area chart. (data requires array of numbers, supports vertical field, scrollable)
- "line" {string}, a line chart or line graph, also known as curve chart is a type of chart which displays information as a series of data points called 'markers' connected by straight line segments. It is a basic type of chart common in many fields. It is similar to a scatter plot except that the measurement points are ordered (typically by their x-axis value) and joined with straight line segments. A line chart is often used to visualize a trend in data over intervals of time - a time series - thus the line is often drawn chronologically. In these cases they are known as run charts. (data requires array of numbers, supports vertical field, scrollable)
- "column" {string}, a column chart or column graph is a chart or graph that presents categorical data with rectangular columns with heights proportional to the values that they represent. A horizontal column chart is called a bar chart. (data requires array of numbers, supports vertical field, scrollable)
- "waterfall" {string}, a waterfall chart is a form of data visualization that helps in understanding the cumulative effect of sequentially introduced positive or negative values. These intermediate values can either be time based or category based. The waterfall chart is also known as a flying bricks chart or Mario chart due to the apparent suspension of columns (bricks) in mid-air. Often in finance, it will be referred to as a bridge. (data requires array of numbers, supports vertical field, scrollable)
- "rangeArea" {string}, a range chart displays sets of data points, each of which is defined by multiple values for the same category, and emphasizes the distance between the two values. The category labels are displayed on the category axis. The plain Range chart fills in the area between the top and the bottom value for each data point. (data requires array of array of two-numbers, such as [[from, to]], supports vertical field, scrollable)
- "rangeColumn" {string}, a range column chart displays information as a range of data by plotting two Y-values (low and high) per data point. The vertical axis shows the values, and the horizontal axis shows the categories they belong to; in multiple-series range column charts, values are grouped by categories. (data requires array of array of two-numbers, such as [[from, to]], supports vertical field, scrollable)
- "candleStick" {string}, a candlestick chart (also called Japanese candlestick chart or K-line) is a style of financial chart used to describe price movements of a security, derivative, or currency. While similar in appearance to a bar chart, each candleStick represents four important pieces of information for that day: open and close in the thick body, and high and low in the "candle wick". Being densely packed with information, it tends to represent trading patterns over short periods of time, often a few days or a few trading sessions. (data requires array of array of four-numbers, such as [[open, high, low and close]], supports vertical field, scrollable)
- "ohlc" {string}, an open-high-low-close chart (also OHLC) is a type of chart typically used to illustrate movements in the price of a financial instrument over time. Each vertical line on the chart shows the price range (the highest and lowest prices) over one unit of time, e.g., one day or one hour. Tick marks project from each side of the line indicating the opening price (e.g., for a daily bar chart this would be the starting price for that day) on the left, and the closing price for that time period on the right. The bars may be shown in different hues depending on whether prices rose or fell in that period. (data requires array of array of four-numbers, such as [[open, high, low and close]], supports vertical field, scrollable)
Parameters:
| Name |
Type |
Description |
value |
number
|
Specifies size to show a column or a bar within the chart. The size indicates the width for horizontally-oriented charts or height for the vertically-oriented chart types. |
Example
4 {number}, sets the column/bar's width to 4-pixels
SetValueSize
SetWheelChange(value)
The SetWheelChange() method changes the amount the calendar scrolls when the user rolls the mouse wheel. This setting allows you to adjust the sensitivity of the mouse wheel interaction with the control.
- Setting wheelChange to 0 disables mouse wheel actions, preventing the control from changing when the wheel is scrolled
- Setting wheelChange to a positive number, such as 5, increases the control's value by that amount each time the wheel is rotated, enabling faster adjustments
By modifying this value, you can fine-tune the control's responsiveness, making it easier for users to perform precise changes or larger adjustments as needed.
Parameters:
| Name |
Type |
Description |
value |
number
|
A value that specifies the amount the control scrolls when the user rolls the mouse wheel. |
Example
0 {number}, locks any action the mouse's wheel performs
18 {number}, scrolls the control by 18-pixels when mouse's wheel is rotated (CTRL + wheel scrolls horizontally)
SetWheelChange
SetXAxis(value)
The SetXAxis() method defines the configuration-options for x-axis of xy-compatible chart-types ("scatter", "scatterLine" or "bubble").
Parameters:
Example
null {null}, the chart displays the default x-axis
{tfi: "<fgColor red>"} {ValueAxisOptions}, shows the x-axis in red
{min: -100, max: 100, majorUnit: 25} {ValueAxisOptions}, redefines the min, max and major intervals for x-axis
SetXAxis
SetYAxis(value)
The SetYAxis() method defines the configuration-options for y-ayis of yy-compatible chart-types ("scatter", "scatterLine" or "bubble").
Parameters:
Example
null {null}, the chart displays the default y-ayis
{tfi: "<fgColor red>"} {ValueAxisOptions}, shows the y-ayis in red
{min: -100, may: 100, majorUnit: 25} {ValueAxisOptions}, redefines the min, may and major intervals for y-ayis
SetYAxis
SetZoom(value)
The SetZoom() method defines the zoom factor of the control's content. The zoom factor determines how much the control's content is magnified or reduced. Once the user adjusts the browser's zoom level, the control automatically recalculates its zoom factor to maintain the correct scaling of its content. The ZoomLevels property defines the allowed zoom levels the user can select from.
Parameters:
| Name |
Type |
Description |
value |
number
|
A numeric value between 10 and 1000 that specifies the zoom factor of the control's content. |
Example
null {null}, Specifies normal-view (100%)
150 {number}, Indicates that the control's content is magnfied to 150%
SetZoom
SetZoomLevels(value)
The SetZoomLevels() method defines the zoomLevels factor of the control's content.
Parameters:
| Name |
Type |
Description |
value |
string
|
specifies a list of numbers separated by comma that indicates the zoom-levels/zoom-levels the control's content is allowed to zoom. |
Example
null {null}, Specifies that the control's zoom factor is always 100%
150 {number}, Specifies that the control's zoom factor is always 150%
"50,100,200,350" {string}, Indicates that the zoom-factor can be any of selected values, and the levels of zoom-factor is 50% to 350%
SetZoomLevels
Smooth(callback, thisArg, oSmoothOptsopt, thisArg)
The Smooth() method performs a smooth-transition from a layout to another. The smooth-transition goes from the current layout to the new layout generated by the callback.
Parameters:
| Name |
Type |
Attributes |
Description |
callback |
callback
|
|
Indicates a callback function that generates the new layout for the control ( such as removing or adding new series to the control). The callback is provided with no arguments. |
thisArg |
any
|
|
Specifies the value of this keyword for callback functions. If missing, the GV object reference is used instead. |
oSmoothOpts |
object
|
<optional>
|
Indicates an object of {cbkR,cbkI,cbkT} type that defines callback to invoke when Smooth operation begins, progress and ends as explained below:
- cbkR {callback}, specifies a function of callback(oSmooth) type that's invoked while Smooth progressively runs
- cbkI {callback}, specifies a function of callback(oSmooth) type that's invoked once the Smooth operation begins
- cbkT {callback}, specifies a function of callback(oSmooth) type that's invoked once the Smooth operation ends
The oSmooth's parameter of cbkI, cbkR or cbkT callbacks is undefined while no animated-smooth, else it includes the following:
- oW {exontrol.W}, indicates the current window as an object of exontrol.W
- oZ {exontrol.WS}, holds the current visible-windows as an object of exontrol.WS([exontrol.W => [x,y,width,height]]) type (before apply the callback)
- oNewZ {exontrol.WS}, holds the new visible-windows as an object of exontrol.WS([exontrol.W => [x,y,width,height]]) type (after callback has been applied)
- rgWFT {object}, holds a collection of changes within windows as an object of exontrol.M1([exontrol.W => {from: [x,y,width,height], to: [x,y,width,height]}]) type
- oWRend {exontrol.W}, indicates the window being rendered during the "Smooth" animation. For instance, if no UI window has been affected, invalidates the current window only, else renders the entire-canvas
- progress {number}, specifies the state of the "Smooth" animation as a value between 0 and 1 (used by oSmooth.oNewZ.cbkget to define the ratio of window's UI rectange from/to)
Additionally, the oSmooth parameter includes the following:
- mV2FT {map}, specifies a map of [view => {"vp":{from,to}}] type that holds the from/to visible-points for each part of each view
|
thisArg |
any
|
|
defines the value of "this" keyword during cbkI, cbkR or cbkT callbacks. |
Soom(zoomTo, oPointAbsopt)
The Soom() method zooms or/and scrolls the control's content.
Parameters:
| Name |
Type |
Attributes |
Description |
zoomTo |
number
|
|
Indicates a numeric value that defines the target-zoom factor as a value between 10 and 1000 (no zoom if null or undefined). |
oPointAbs |
object
|
<optional>
|
Specifies an object of {x,y} or array as [x,y] type that specifies the absolute-coordinates of the point to scroll into the client. |
Example
oGraph.Soom(100, [0,0]), zooms to 100% and brings the origin (0,0) at its original position (Home)
Soom
ValueAutoFit()
The ValueAutoFit() method adjusts the column/bar size so that the entire chart fits within the client rectangle.
onDblClk(event) → {any}
The onDblClk() method occurs once the user double-clicks the view.
Parameters:
| Name |
Type |
Description |
event |
MouseEvent/TouchEvent
|
A MouseEvent object that generated the event. Could be mouse-up or touch-end. |
Returns:
Returns an empty-value to continue the operation, else to cancel any further actions
-
Type
-
any
Events
onanchorclick
The onanchorclick event occurs once the user clicks an anchor element (the <a id;options>
ex-HTML part marks an anchor or hyperlink element).
Parameters:
| Name |
Type |
Description |
oEvent |
object
|
Holds information about anchor being clicked.
Properties
| Name |
Type |
Description |
id |
string
|
specifies null (no identifier has been specified for the anchor) or the anchor's identifier. |
options |
string
|
specifies null (no options has been specified for the anchor) or the anchor's options. |
|
Example
The following samples display information about the element being clicked:
oGraph.Listeners.Add("onanchorclick", function (oEvent)
{
console.log(oEvent);
})
or
oGraph.on("anchorclick", function (oEvent)
{
console.log(oEvent);
})
or
oGraph.oGV.onanchorclick = function (oEvent)
{
console.log(oEvent);
}
where oGraph is an object of Graph type, oGV is member of Graph type, of GV type.
onanchorclick
onclick
The onclick event occurs once the user clicks or double-clicks the control.
Parameters:
| Name |
Type |
Description |
oEvent |
object
|
specifies an object of {dblClick,button,modifiers,..} type, that holds information about the object being clicked.
Properties
| Name |
Type |
Description |
view |
object
|
indicates an object of exontrol.Graph.GV, ... type that specifies the view/window where the click occurred. |
dblClick |
boolean
|
indicates whether the user clicks or double-clicks the serie. |
button |
number
|
indicates which button is pressed while clicking the serie as 1 (left), 2 (right) or 4 (middle). |
modifiers |
number
|
specifies a combination of 1, 2, 4 and 16 according with modifier keys (ALT, CTRL, META and SHIFT), or 0 if no modifier keys. |
x |
string
|
represents the value on the X-axis at the current position (@since 4.7). |
y |
string
|
represents the value on the Y-axis at the current position (@since 4.7). |
valueCategory |
string
|
indicates the value associated with the category under the pointer, even if the cursor does not hover the value itself (@since 4.8). |
value |
number
|
indicates the value of the serie, as defined by the Data property (@since 4.8). |
innerValues |
array
|
holds the inner-values (e.g., Open, Close for candleStick types, or Min, Max for rangeColumn types) (@since 4.8). |
percent |
number
|
specifies the percent of the current value relative to all values (@since 4.8). |
serie |
Serie
|
indicates the Serie the value belongs to (@since 4.8). |
index |
number
|
indicates the index of the category where the value is displayed (@since 4.8). |
|
Example
The following samples display information about the serie being clicked:
oGraph.Listeners.Add("onclick", function (oEvent)
{
console.log(oEvent);
})
or
oGraph.on("click", function (oEvent)
{
console.log(oEvent);
})
or
oGraph.oGV.onclick = function (oEvent)
{
console.log(oEvent);
}
where oGraph is an object of Graph type. The oGV is member of Graph type, of GV type.
onclick
onmovevalue
The onmovevalue event occurs when the user completes a drag-and-drop operation by releasing (dropping) a value, series, or data point to a new position. The event is fired after the related properties are updated to reflect the new arrangement.
The event is triggered only if the allowActions property includes the "move-value" action. Depending on the flags of the "move-value" action, the event occurs as follows:
- When the [disableMoveCategory] flag is not included, dropping a value reorders categories and updates the Order property.
- When the [enableMoveSerie] flag is included, dropping a value reorders entire series and updates the Position property.
- When the [enableMoveData] flag is included, dropping a value reorders data points within a series and updates the Data property.
The onmovevalue event is typically used to handle post-drop actions, such as updating external data sources or refreshing dependent visual elements after the chart layout changes.
- Since:
Example
The following samples demonstrate different ways to implement the onmovevalue event:
oGraph.Listeners.Add("onmovevalue", function ()
{
console.log("onmovevalue");
})
or
oGraph.on("movevalue", function ()a
{
console.log("onmovevalue");
})
or
oGraph.oGV.onmovevalue = function ()
{
* console.log("onmovevalue");
}
where oGraph is an object of GV type
onmovevalue
The onscroll event notifies your application once the view has been scrolled.
Parameters:
| Name |
Type |
Description |
oEvent |
object
|
Specifies an object of {view,type,value} that holds information about the view's scroll that has been changed.
Properties
| Name |
Type |
Description |
view |
GV
|
specifies the view, where the scroll occurs. |
type |
exontrol.SB.ModeEnum
|
specifies the view's scroll that has changed as 0(vertical), 1(horizontal). |
value |
number
|
specifies the scroll's value. |
|
Example
The following samples display the view's scroll position once it is changed:
oGraph.Listeners.Add("onscroll", function (oEvent)
{
console.log(oEvent);
})
or
oGraph.on("scroll", function (oEvent)
{
console.log(oEvent);
})
or
oGraph.oGV.onscroll = function (oEvent)
{
console.log(oEvent);
}
where oGraph is an object of Graph type. The oGV is member of Graph type, of GV type.
onscroll