highcharts
Version:
JavaScript charting framework
174 lines (173 loc) • 4.96 kB
JavaScript
/* *
*
* (c) 2010-2026 Highsoft AS
* Author: Torstein Hønsi
*
* Extension for radial axes
*
* A commercial license may be required depending on use.
* See www.highcharts.com/license
*
*
* */
;
/**
* Circular axis around the perimeter of a polar chart.
* @internal
*/
const defaultCircularOptions = {
gridLineWidth: 1, // Spokes
labels: {
align: void 0, // Auto
x: 0,
y: void 0 // Auto
},
maxPadding: 0,
minPadding: 0,
showLastLabel: false,
tickLength: 0
};
/**
* The default options extend defaultYAxisOptions.
* @internal
*/
const defaultRadialGaugeOptions = {
endOnTick: false,
gridLineWidth: 0,
labels: {
align: 'center',
distance: -25,
x: 0,
y: void 0 // Auto
},
lineWidth: 1,
minorGridLineWidth: 0,
minorTickInterval: 'auto',
minorTickLength: 10,
minorTickPosition: 'inside',
minorTickWidth: 1,
startOnTick: false,
tickLength: 10,
tickPixelInterval: 100,
tickPosition: 'inside',
tickWidth: 2,
title: {
rotation: 0,
text: ''
},
zIndex: 2 // Behind dials, points in the series group
};
/**
* Radial axis, like a spoke in a polar chart.
* @internal
*/
const defaultRadialOptions = {
/**
* In a polar chart, this is the angle of the Y axis in degrees, where
* 0 is up and 90 is right. The angle determines the position of the
* axis line and the labels, though the coordinate system is unaffected.
* Since v8.0.0 this option is also applicable for X axis (inverted
* polar).
*
* @sample {highcharts} highcharts/xaxis/angle/
* Custom X axis' angle on inverted polar chart
* @sample {highcharts} highcharts/yaxis/angle/
* Dual axis polar chart
*
* @type {number}
* @default 0
* @since 4.2.7
* @product highcharts
* @apioption xAxis.angle
*/
/**
* In a gauge chart, this option determines the inner radius of the
* plot band that stretches along the perimeter. It can be given as
* a percentage string, like `"100%"`, or as a pixel number, like `100`.
* By default, the inner radius is controlled by the [thickness](
* #yAxis.plotBands.thickness) option.
*
* @sample {highcharts} highcharts/xaxis/plotbands-gauge
* Gauge plot band
*
* @type {number|string}
* @since 2.3
* @product highcharts
* @apioption yAxis.plotBands.innerRadius
*/
/**
* In a gauge chart, this option determines the outer radius of the
* plot band that stretches along the perimeter. It can be given as
* a percentage string, like `"100%"`, or as a pixel number, like `100`.
*
* @sample {highcharts} highcharts/xaxis/plotbands-gauge
* Gauge plot band
*
* @type {number|string}
* @default 100%
* @since 2.3
* @product highcharts
* @apioption yAxis.plotBands.outerRadius
*/
/**
* In a gauge chart, this option sets the width of the plot band
* stretching along the perimeter. It can be given as a percentage
* string, like `"10%"`, or as a pixel number, like `10`. The default
* value 10 is the same as the default [tickLength](#yAxis.tickLength),
* thus making the plot band act as a background for the tick markers.
*
* @sample {highcharts} highcharts/xaxis/plotbands-gauge
* Gauge plot band
*
* @type {number|string}
* @default 10
* @since 2.3
* @product highcharts
* @apioption yAxis.plotBands.thickness
*/
/**
* Polar charts only. Whether the grid lines should draw as a polygon
* with straight lines between categories, or as circles. Can be either
* `circle` or `polygon`. Since v8.0.0 this option is also applicable
* for X axis (inverted polar).
*
* @sample {highcharts} highcharts/demo/polar-spider/
* Polygon grid lines
* @sample {highcharts} highcharts/xaxis/gridlineinterpolation/
* Circle and polygon on inverted polar
* @sample {highcharts} highcharts/yaxis/gridlineinterpolation/
* Circle and polygon
*
* @type {string}
* @product highcharts
* @validvalue ["circle", "polygon"]
* @apioption xAxis.gridLineInterpolation
*/
gridLineInterpolation: 'circle',
gridLineWidth: 1,
labels: {
align: 'right',
padding: 5,
x: -3,
y: -2
},
showLastLabel: false,
title: {
x: 4,
text: null,
rotation: 90
}
};
/* *
*
* Default Export
*
* */
const RadialAxisDefaults = {
/** @internal */
circular: defaultCircularOptions,
radial: defaultRadialOptions,
/** @internal */
radialGauge: defaultRadialGaugeOptions
};
export default RadialAxisDefaults;