Class: MiscellaneousOptions

MiscellaneousOptions()

new MiscellaneousOptions()

The MiscellaneousOptions object defines the control's default miscellaneous options, hold by misc option of the Graph.Options

For instance, the "baseMajorUnits" option:

misc: { baseMajorUnits: "1,5" }
forces the control to use only 1 and 5 or any multiple (10,50,100,...) or subdivision (0.1,0.5,0.01,...) can be a major-unit

Members

(static) allowValueScroll :number

The allowValueScroll option indicates a positive number that defines whether the value-scroll is visible or hidden (valid for area-type charts only). The value-scroll is the vertical-scroll bar for horizontal charts (categories goes horizontally), and horizontal scroll bars for vertical charts (categories goes vertically). By default, the control shows no value-scroll. For instance, the value-scroll could be shown if the control is zoomed.
Type:
  • number
Since:
  • 3.0
Example
0 {number} or null {null}, the value-scroll is not visible
 1 {number}, the value-scroll is visible once the control's zoom is greater than 100 (the control is zoomed)
 2 {number}, the value-scroll is always visible, as the view uses twice the space of the page to show the values

(static) baseMajorUnits :string

The baseMajorUnits field defines the base major-units alternatives (separated by comma) the control uses to calculate the major-unit for the axes
Type:
  • string
Example
"1,2.5,5" {string}, specifies that values of 1, 2.5 and 5 or any multiple or subdivision can be a major-unit
 "1,5" {string}, specifies that values of 1 and 5 or any multiple (10,50,100,...) or subdivision (0.1,0.5,0.01,...) can be a major-unit

(static) categoryAxisPad :number

The categoryAxisPad field specifies the padding for labels and title of the category-axis
Type:
  • number
Example
0 {number}, no padding for for labels and title
 4 {number}, sets a 4-pixels padding

(static) categoryAxisSize :number

The categoryAxisSize field specifies the size (height for horizontal axis and width for vertical axis) to display the category-axis (line and ticks)
Type:
  • number
Example
0 {number}, specifies that the line and ticks of the category-axis is not shown at all
 4 {number}, the category-axis line and ticks are shown on a portion of 4-pixels tall

(static) circularStartAngle :number

The circularStartAngle field specifies the angle (in degrees) to start the circular-compatible charts (radial or pie)
Type:
  • number
Example
0 {number}, the circular-compatible charts start horizontally
 -90 {number}, the circular-compatible charts start vertically

(static) cursorTrans :string

The cursorTrans option defines the transitions (separated by comma) the tooltips of the cursor perform while the pointer hovers the chart
Type:
  • string
Example
null {null}, the cursor performs linear, ease-in, ease-out and ease transitions
 "" {string}, the cursor performs only linear transitions
 "ease" {string}, the cursor performs only ease transitions

(static) digits :number

The digits field specifies the number of digits to appear after the decimal point
Type:
  • number
Example
-1 {number}, no conversion is performed
 0 {number}, all numeric-values are displayed as integers
 2 {number}, all numeric-values show up to two-decimals

(static) extVisibleAfterAxis :number

The extVisibleAfterAxis field indicates the minimum portion (as a proportion of major unit, as a numeric-value between 0 and 1) to extend the axis after the last value of the serie (maximum value)
Type:
  • number
Example
0 {number}, specifies that the axis is not extended after the last value of the serie (maximum value)

(static) extVisibleBeforeAxis :number

The extVisibleBeforeAxis field indicates the minimum portion (as a proportion of major unit, as a numeric-value between 0 and 1) to extend the axis before the first value of the serie (minimum value)
Type:
  • number
Example
0 {number}, specifies that the axis is not extended before the first value of the serie (minimum value)

(static) marginValueRatio :number

The marginValueRatio field specifies the distance (proportionally with the valueSize property) between the first and last value of the same category and its border
Type:
  • number
Example
0 {number}, no margins are defined
 1/4 {number}, the margin is defined as 1/4 of valueSize

(static) newLayoutOnVisibleChange :boolean

The newLayoutOnVisibleChange field specifies whether the control requests for a new layout once the serie's visible property is changed
Type:
  • boolean
Example
false {boolean}, the serie is just hidden, while the minimum-maximum values are kept
 true {boolean}, the control computes a new layout once the serie's visible property is changed (requests for new minimum-maximum values)

(static) paddingInsidePie :number

The paddingInsidePie field specifies the padding between rings of the "pie" chart-type (should be zero or a positive value)
Type:
  • number
Example
null {null}, specifies that no padding between rings of the "pie" chart-type
 12 {number}, the distance between rings of the "pie" chart-type, is 12 pixels

(static) paddingValueRatio :number

The paddingValueRatio field specifies the distance (proportionally with the valueSize property) between two values of the same category
Type:
  • number
Example
0 {number}, no distance between values
 1/8 {number}, the margin is defined as 1/8 of valueSize

(static) radarPolygonal :boolean

The radarPolygonal field specifies whether the radar-compatible chart-types (radararea,radarline,radarcolumn) show as polygonal instead of circular
Type:
  • boolean
Example
false {boolean}, the circular-compatible charts show elliptical
 true {boolean}, the circular-compatible charts show polygonal

(static) radialRotateLabels :boolean

The radialRotateLabels field specifies whether the radial-labels are rotated around the chart
Type:
  • boolean
Example
false {boolean}, the labels are horizontally shown
 true {boolean}, the labels are rotated shown

(static) rangeMajorUnits :array

The rangeMajorUnits field defines the inferior and superior limits of the number of major-unit intervals an axis can display
Type:
  • array
Example
[5,10] {array}, any count of major-unit intervals between 5 and 10 is accepted

(static) showGridLinesIf :number

The showGridLinesIf option specifies the category-unit's minimum size so the category grid-lines are visible
Type:
  • number
Example
null {number}, by default, the showGridLinesIf is 18
 8 {number}, category grid-lines are visible is the category-unit size is greater than 8 pixels

(static) showLabelsIf :number

The showLabelsIf option specifies the category-unit's minimum size so the category labels are visible
Type:
  • number
Example
null {number}, by default, the showLabelsIf is 24
 18 {number}, category labels are visible is the category-unit size is greater than 18 pixels

(static) showTicksIf :number

The showTicksIf option specifies the category-unit's minimum size so the category-ticks are visible
Type:
  • number
Example
null {number}, by default, the showTicksIf is 12
 8 {number}, category-ticks are visible is the category-unit size is greater than 8 pixels

(static) showValueIf :number

The showValueIf option specifies the category-unit's minimum size so the data-values
Type:
  • number
Example
null {number}, by default, the showValueIf is 24
 18 {number}, data-values are visible is the category-unit size is greater than 18 pixels

(static) updateRangeOnScroll :number

The updateRangeOnScroll field specifies the time in ms to update the chart's minimum and maximum values while user scrolls the chart (0 indicates that the chart's minimum and maximum values are updated only when changing the data)
Type:
  • number
Example
0 {number}, the chart's minimum and maximum values are updated once the data is changed
 64 {number}, the chart's minimum and maximum values are updated in 64 ms after user scrolls the chart

(static) valueAxisFitLabel :boolean

The valueAxisFitLabel field ensures that the marginal labels of the value-axis ensure fit the axis's client-rectangle
Type:
  • boolean
Example
false {boolean}, no change
 true {boolean}, the marginal labels are moved to fit the axis's client-rectangle

(static) valueAxisPad :number

The valueAxisPad field specifies the padding for labels and title of the value-axis
Type:
  • number
Example
0 {number}, no padding for for labels and title
 4 {number}, sets a 4-pixels padding

(static) valueAxisSize :number

The valueAxisSize field specifies the size (width for horizontal axis and height for vertical axis) to display the value-axis (line and ticks)
Type:
  • number
Example
0 {number}, specifies that the line and ticks of the value-axis is not shown at all
 4 {number}, the value-axis line and ticks are shown on a portion of 4-pixels wide

(static) valueDistInnerCircular :number

The valueDistInnerCircular field specifies the distance from the edge of the inner circle where the values are displayed
Type:
  • number
Example
0 {number}, the values are shown in the center of the circle
 -0.5 {number}, the values are shown inside the circle at half of its radius
 0.5 {number}, the values are shown outside the circle at half of its radius

(static) valueDistOuterCircular :number

The valueDistOuterCircular field specifies the distance from the edge of the inner circle where the values are displayed
Type:
  • number
Example
0 {number}, the values are shown in the center of the circle
 -0.5 {number}, the values are shown inside the circle at half of its radius
 0.5 {number}, the values are shown outside the circle at half of its radius

(static) valueLineAddAngle :number

The valueLineAddAngle field specifies the additional angle (in degrees) the value-line is rotated by, as explained: null {null}, no effect negative or 0 {number}, if negative or zero all value-lines are rotated by exact angle positive {number}, if positive the value-lines are rotated additionally by specific angle
Type:
  • number
Example
0 {number}, shows vertically value-lines (the value is displayed on top)
 -180 {number}, shows vertically value-lines (the value is displayed on bottom)
 -45 {number}, the value-line is rotated anti-clockwise by 45 degrees
 45 {number}, the value-line is rotated additionally by 45 degrees

(static) valueLineDownAngle :number

The valueLineDownAngle field specifies the angle (in degrees) the value-line is rotated by, when the values goes down. The valueLineUpAngle/valueLineDownAngle has effect for charts of the following types:
  • "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)
Type:
  • number
Example
0 {number}, shows vertically value-lines (the value is displayed on top)
 -180 {number}, shows vertically value-lines (the value is displayed on bottom)
 -45 {number}, the value-line is rotated anti-clockwise by 45 degrees
 45 {number}, the value-line is rotated clockwidt by 45 degrees

(static) valueLineExt :number

The valueLineExt field specifies the distance to extend the value-line by
Type:
  • number
Example
null {null}, no effect
 4 {number}, the value-line is extended by 4 pixels

(static) valueLineUpAngle :number

The valueLineUpAngle field specifies the angle (in degrees) the value-line is rotated by, when the values goes up. The valueLineUpAngle/valueLineDownAngle has effect for charts of the following types:
  • "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)
Type:
  • number
Example
0 {number}, shows vertically value-lines (the value is displayed on top)
 -180 {number}, shows vertically value-lines (the value is displayed on bottom)
 -45 {number}, the value-line is rotated anti-clockwise by 45 degrees
 45 {number}, the value-line is rotated clockwidt by 45 degrees

(static) valueSizeRange :number|array

The valueSizeRange field specifies the lower and upper margins of the valueSize property. The valueSize field specifies the size to show a column or a bar within the chart of area-compatible type. The valueSizeRange field can be any of the following type: valueSizeRange {number}, specifies the lower limit the valueSize can be valueSizeRange {array}, specifies a two-elements array of [min,max] type that defines the lower and upper margins of the valueSize. The negative max value indicates no upper limit (no effect)
Type:
  • number | array
Example
null {number}, by default, the lower limit the valueSize is 2
 4 {number}, specifies the lower limit the valueSize can be is 4
 [8,128] {number}, specifies the the valueSize can be between 8 and 128=