highcharts
Version:
JavaScript charting framework
234 lines (233 loc) • 7.59 kB
JavaScript
/* *
*
* (c) 2010-2026 Highsoft AS
* Author: Torstein Hønsi
*
* A commercial license may be required depending on use.
* See www.highcharts.com/license
*
*
* */
'use strict';
/* *
*
* Definitions
*
* */
/**
* A contour plot is a graphical representation of three-dimensional data
*
* @productdesc {highcharts}
* Requires `modules/contour`.
*
* @sample highcharts/demo/contour-mountain/
*
* @extends plotOptions.scatter
* @excluding animationLimit, cluster, connectEnds, connectNulls,
* cropThreshold, dashStyle, dragDrop, getExtremesFromAll,
* jitter, legendSymbolColor, linecap, pointInterval,
* pointIntervalUnit, pointRange, pointStart, shadow,
* softThreshold, stacking, step, threshold
*
* @product highcharts highmaps
* @optionparent plotOptions.contour
*/
const ContourSeriesDefaults = {
/**
* This must be set to `'value'` to make the colorAxis track with the contour
* plot.
*/
colorKey: 'value',
clip: false,
/**
* Whether to use gradually transitioning color gradients between contour
* levels. When disabled, each contour level is filled with a single flat
* color.
*
* @type {boolean}
* @default false
* @apioption plotOptions.contour.smoothColoring
*/
/**
* This setting controls the visibility and size of contour lines. For now,
* only '1' and '0' are valid options, effectively controlling the
* visibility of the lines.
*
* @type {number}
* @default 1
* @apioption plotOptions.contour.lineWidth
*/
/**
* The interval between contour lines. Determines the spacing of value
* levels where lines are drawn on the plot. By default, the interval is
* calculated using the value range.
*
* @type {number}
* @apioption plotOptions.contour.contourInterval
*/
/**
* The offset for contour line positioning. Shifts the contour levels so
* lines and bands are drawn at `contourOffset + n * contourInterval`
* instead of `n * contourInterval`.
*
* Example: with `contourInterval: 10` and `contourOffset: 5`, levels are
* at 5, 15, 25, etc. Use this to align levels with a reference value
* without changing the data. Non-positive values are treated as 0.
*
* @type {number}
* @default 0
* @apioption plotOptions.contour.contourOffset
*/
/**
* @excluding radius, enabledThreshold, fillColor, lineColor
*/
marker: {
/**
* A predefined shape or symbol for the marker. When undefined, the
* symbol is pulled from options.symbols. Other possible values are
* `'circle'`, `'square'`,`'diamond'`, `'triangle'`,
* `'triangle-down'`, `'rect'`, `'ellipse'`, and `'cross'`.
*
* Additionally, the URL to a graphic can be given on this form:
* `'url(graphic.png)'`. Note that for the image to be applied to
* exported charts, its URL needs to be accessible by the export
* server.
*
* Custom callbacks for symbol path generation can also be added to
* `Highcharts.SVGRenderer.prototype.symbols`. The callback is then
* used by its method name, as shown in the demo.
*
* @sample {highcharts} highcharts/plotoptions/series-marker-symbol/
* Predefined, graphic and custom markers
* @sample {highstock} highcharts/plotoptions/series-marker-symbol/
* Predefined, graphic and custom markers
*/
symbol: 'cross',
states: {
/**
* @excluding radius, radiusPlus
*/
hover: {
/**
* Color of the marker outline. Defaults to `'black'`.
*
* @type {string}
*
* @default black
*
* @apioption plotOptions.contour.marker.states.hover.lineColor
*/
lineColor: 'black'
}
}
},
states: {
hover: {
/** @ignore-option */
halo: void 0
}
},
zIndex: 0
};
/**
* A contour plot is a graphical representation of three-dimensional data
* in two dimensions using contour lines or color-coded regions.
*
* @productdesc {highcharts}
* Requires `modules/contour`.
*
* @sample highcharts/demo/contour-mountain/
* Simple contour
*
* @extends series,plotOptions.contour
* @excluding cropThreshold, dataParser, dataURL, dragDrop ,pointRange,
* stack, allowPointSelect, boostBlending, boostThreshold, color,
* colorIndex, connectEnds, connectNulls, crisp, dashStyle,
* inactiveOtherPoints, jitter, linecap, negativeColor,
* pointInterval, pointStart, pointIntervalUnit, lineWidth,
* onPoint, pointPlacement, shadow, stacking, step, threshold,
* zoneAxis, zones, onPoint, grouping, groupPadding,
* groupZPadding
*
*
* @product highcharts highmaps
* @apioption series.contour
*/
/**
* An array of data points for the series. For the `contour` series
* type, points can be given in the following ways:
*
* 1. An array of arrays with 3 or 2 values. In this case, the values
* correspond to `x,y,value`. If the first value is a string, it is
* applied as the name of the point, and the `x` value is inferred.
* Unlike the heatmap, the contour series data points, do not have to appear
* in any specific order.
*
* ```js
* data: [
* [0, 9, 7],
* [1, 10, 4],
* [2, 6, 3]
* ]
* ```
*
* 2. An array of objects with named values. The following snippet shows only a
* few settings, see the complete options set below. If the total number of data
* points exceeds the series' [turboThreshold](#series.contour.turboThreshold),
* this option is not available.
*
* ```js
* data: [{
* x: 1,
* y: 3,
* value: 10,
* name: "Point2"
* }, {
* x: 1,
* y: 7,
* value: 10,
* name: "Point1"
* }]
* ```
*
* @sample {highcharts} highcharts/chart/reflow-true/
* Numerical values
* @sample {highcharts} highcharts/series/data-array-of-arrays/
* Arrays of numeric x and y
* @sample {highcharts} highcharts/series/data-array-of-arrays-datetime/
* Arrays of datetime x and y
* @sample {highcharts} highcharts/series/data-array-of-name-value/
* Arrays of point.name and y
* @sample {highcharts} highcharts/series/data-array-of-objects/
* Config objects
*
* @type {Array<Array<number>|*>}
* @extends series.line.data
* @product highcharts highmaps
* @apioption series.contour.data
*/
/**
* The value of the point, resulting in a color controlled by options
* as set in the [colorAxis](#colorAxis) configuration.
*
* @type {number}
* @product highcharts highmaps
* @apioption series.contour.data.value
*/
/**
* The x value of the point. For datetime axes,
* the X value is the timestamp in milliseconds since 1970.
*
* @type {number}
* @product highcharts highmaps
* @apioption series.contour.data.x
*/
/**
* The y value of the point.
*
* @type {number}
* @product highcharts highmaps
* @apioption series.contour.data.y
*/
''; // Keeps doclets above separate
export default ContourSeriesDefaults;