1/* * 2 * 3 * (c) 2010-2024 Torstein Honsi 4 * 5 * License: www.highcharts.com/license 6 * 7 * !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!! 8 * 9 * */ 10'use strict'; 11/* * 12 * 13 * API Options 14 * 15 * */ 16/** 17 * General options for the chart. 18 * 19 * @optionparent chart 20 */ 21const ChartDefaults = { 22 /** 23 * Default `mapData` for all series, in terms of a GeoJSON or TopoJSON 24 * object. If set to a string, it functions as an index into the 25 * `Highcharts.maps` array. 26 * 27 * For picking out individual shapes and geometries to use for each series 28 * of the map, see [series.mapData](#series.map.mapData). 29 * 30 * @sample maps/demo/geojson 31 * Loading GeoJSON data 32 * @sample maps/chart/topojson 33 * Loading TopoJSON data 34 * 35 * @type {string|Array<*>|Highcharts.GeoJSON|Highcharts.TopoJSON} 36 * @since 5.0.0 37 * @product highmaps 38 * @apioption chart.map 39 */ 40 /** 41 * Set lat/lon transformation definitions for the chart. If not defined, 42 * these are extracted from the map data. 43 * 44 * @type {*} 45 * @since 5.0.0 46 * @product highmaps 47 * @apioption chart.mapTransforms 48 */ 49 /** 50 * When using multiple axes, the ticks of two or more opposite axes 51 * will automatically be aligned by adding ticks to the axis or axes 52 * with the least ticks, as if `tickAmount` were specified. 53 * 54 * This can be prevented by setting `alignTicks` to false. If the grid 55 * lines look messy, it's a good idea to hide them for the secondary 56 * axis by setting `gridLineWidth` to 0. 57 * 58 * If `startOnTick` or `endOnTick` in the axis options are set to false, 59 * then the `alignTicks ` will be disabled for the axis. 60 * 61 * Disabled for logarithmic axes. 62 * 63 * @sample {highcharts} highcharts/chart/alignticks-true/ 64 * True by default 65 * @sample {highcharts} highcharts/chart/alignticks-false/ 66 * False 67 * @sample {highstock} stock/chart/alignticks-true/ 68 * True by default 69 * @sample {highstock} stock/chart/alignticks-false/ 70 * False 71 * 72 * @type {boolean} 73 * @default true 74 * @product highcharts highstock gantt 75 * @apioption chart.alignTicks 76 */ 77 /** 78 * When using multiple axes, align the thresholds. When this is true, other 79 * ticks will also be aligned. 80 * 81 * Note that for line series and some other series types, the `threshold` 82 * option is set to `null` by default. This will in turn cause their y-axis 83 * to not have a threshold. In order to avoid that, set the series 84 * `threshold` to 0 or another number. 85 * 86 * If `startOnTick` or `endOnTick` in the axis options are set to false, or 87 * if the axis is logarithmic, the threshold will not be aligned. 88 * 89 * @sample {highcharts} highcharts/chart/alignthresholds/ Set to true 90 * 91 * @since 10.0.0 92 * @product highcharts highstock gantt 93 * @apioption chart.alignThresholds 94 */ 95 alignThresholds: false, 96 /** 97 * Set the overall animation for all chart updating. Animation can be 98 * disabled throughout the chart by setting it to false here. It can 99 * be overridden for each individual API method as a function parameter. 100 * The only animation not affected by this option is the initial series 101 * animation, see [plotOptions.series.animation]( 102 * #plotOptions.series.animation). 103 * 104 * The animation can either be set as a boolean or a configuration 105 * object. If `true`, it will use the 'swing' jQuery easing and a 106 * duration of 500 ms. If used as a configuration object, the following 107 * properties are supported: 108 * 109 * - `defer`: The animation delay time in milliseconds. 110 * 111 * - `duration`: The duration of the animation in milliseconds. 112 * 113 * - `easing`: A string reference to an easing function set on the 114 * `Math` object. See 115 * [the easing demo](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-animation-easing/). 116 * 117 * When zooming on a series with less than 100 points, the chart redraw 118 * will be done with animation, but in case of more data points, it is 119 * necessary to set this option to ensure animation on zoom. 120 * 121 * @sample {highcharts} highcharts/chart/animation-none/ 122 * Updating with no animation 123 * @sample {highcharts} highcharts/chart/animation-duration/ 124 * With a longer duration 125 * @sample {highcharts} highcharts/chart/animation-easing/ 126 * With a jQuery UI easing 127 * @sample {highmaps} maps/chart/animation-none/ 128 * Updating with no animation 129 * @sample {highmaps} maps/chart/animation-duration/ 130 * With a longer duration 131 * 132 * @type {boolean|Partial<Highcharts.AnimationOptionsObject>} 133 * @default true 134 * @apioption chart.animation 135 */ 136 /** 137 * A CSS class name to apply to the charts container `div`, allowing 138 * unique CSS styling for each chart. 139 * 140 * @type {string} 141 * @apioption chart.className 142 */ 143 /** 144 * Event listeners for the chart. 145 * 146 * @apioption chart.events 147 */ 148 /** 149 * Fires when a series is added to the chart after load time, using the 150 * `addSeries` method. One parameter, `event`, is passed to the 151 * function, containing common event information. Through 152 * `event.options` you can access the series options that were passed to 153 * the `addSeries` method. Returning false prevents the series from 154 * being added. 155 * 156 * @sample {highcharts} highcharts/chart/events-addseries/ 157 * Alert on add series 158 * @sample {highstock} stock/chart/events-addseries/ 159 * Alert on add series 160 * 161 * @type {Highcharts.ChartAddSeriesCallbackFunction} 162 * @since 1.2.0 163 * @context Highcharts.Chart 164 * @apioption chart.events.addSeries 165 */ 166 /** 167 * Fires when clicking on the plot background. One parameter, `event`, 168 * is passed to the function, containing common event information. 169 * 170 * Information on the clicked spot can be found through `event.xAxis` 171 * and `event.yAxis`, which are arrays containing the axes of each 172 * dimension and each axis' value at the clicked spot. The primary axes 173 * are `event.xAxis[0]` and `event.yAxis[0]`. Remember the unit of a 174 * datetime axis is milliseconds since 1970-01-01 00:00:00. 175 * 176 * ```js 177 * click: function(e) { 178 * console.log( 179 * Highcharts.dateFormat('%Y-%m-%d %H:%M:%S', e.xAxis[0].value), 180 * e.yAxis[0].value 181 * ) 182 * } 183 * ``` 184 * 185 * @sample {highcharts} highcharts/chart/events-click/ 186 * Alert coordinates on click 187 * @sample {highcharts} highcharts/chart/events-container/ 188 * Alternatively, attach event to container 189 * @sample {highstock} stock/chart/events-click/ 190 * Alert coordinates on click 191 * @sample {highstock} highcharts/chart/events-container/ 192 * Alternatively, attach event to container 193 * @sample {highmaps} maps/chart/events-click/ 194 * Record coordinates on click 195 * @sample {highmaps} highcharts/chart/events-container/ 196 * Alternatively, attach event to container 197 * 198 * @type {Highcharts.ChartClickCallbackFunction} 199 * @since 1.2.0 200 * @context Highcharts.Chart 201 * @apioption chart.events.click 202 */ 203 /** 204 * Fires when the chart is finished loading. Since v4.2.2, it also waits 205 * for images to be loaded, for example from point markers. One 206 * parameter, `event`, is passed to the function, containing common 207 * event information. 208 * 209 * There is also a second parameter to the chart constructor where a 210 * callback function can be passed to be executed on chart.load. 211 * 212 * @sample {highcharts} highcharts/chart/events-load/ 213 * Alert on chart load 214 * @sample {highcharts} highcharts/chart/events-render/ 215 * Load vs Redraw vs Render 216 * @sample {highstock} stock/chart/events-load/ 217 * Alert on chart load 218 * @sample {highmaps} maps/chart/events-load/ 219 * Add series on chart load 220 * 221 * @type {Highcharts.ChartLoadCallbackFunction} 222 * @context Highcharts.Chart 223 * @apioption chart.events.load 224 */ 225 /** 226 * Fires when the chart is redrawn, either after a call to 227 * `chart.redraw()` or after an axis, series or point is modified with 228 * the `redraw` option set to `true`. One parameter, `event`, is passed 229 * to the function, containing common event information. 230 * 231 * @sample {highcharts} highcharts/chart/events-redraw/ 232 * Alert on chart redraw 233 * @sample {highcharts} highcharts/chart/events-render/ 234 * Load vs Redraw vs Render 235 * @sample {highstock} stock/chart/events-redraw/ 236 * Alert on chart redraw when adding a series or moving the 237 * zoomed range 238 * @sample {highmaps} maps/chart/events-redraw/ 239 * Set subtitle on chart redraw 240 * 241 * @type {Highcharts.ChartRedrawCallbackFunction} 242 * @since 1.2.0 243 * @context Highcharts.Chart 244 * @apioption chart.events.redraw 245 */ 246 /** 247 * Fires after initial load of the chart (directly after the `load` 248 * event), and after each redraw (directly after the `redraw` event). 249 * 250 * @sample {highcharts} highcharts/chart/events-render/ 251 * Load vs Redraw vs Render 252 * 253 * @type {Highcharts.ChartRenderCallbackFunction} 254 * @since 5.0.7 255 * @context Highcharts.Chart 256 * @apioption chart.events.render 257 */ 258 /** 259 * Fires when an area of the chart has been selected. Selection is
260 * enabled by setting the chart's zoomType. One parameter, `event`, is 261 * passed to the function, containing common event information. The 262 * default action for the selection event is to zoom the chart to the 263 * selected area. It can be prevented by calling 264 * `event.preventDefault()` or return false. 265 * 266 * Information on the selected area can be found through `event.xAxis` 267 * and `event.yAxis`, which are arrays containing the axes of each 268 * dimension and each axis' min and max values. The primary axes are 269 * `event.xAxis[0]` and `event.yAxis[0]`. Remember the unit of a 270 * datetime axis is milliseconds since 1970-01-01 00:00:00. 271 * 272 * ```js 273 * selection: function(event) { 274 * // log the min and max of the primary, datetime x-axis 275 * console.log( 276 * Highcharts.dateFormat( 277 * '%Y-%m-%d %H:%M:%S', 278 * event.xAxis[0].min 279 * ), 280 * Highcharts.dateFormat( 281 * '%Y-%m-%d %H:%M:%S', 282 * event.xAxis[0].max 283 * ) 284 * ); 285 * // log the min and max of the y axis 286 * console.log(event.yAxis[0].min, event.yAxis[0].max); 287 * } 288 * ``` 289 * 290 * @sample {highcharts} highcharts/chart/events-selection/ 291 * Report on selection and reset 292 * @sample {highcharts} highcharts/chart/events-selection-points/ 293 * Select a range of points through a drag selection 294 * @sample {highstock} stock/chart/events-selection/ 295 * Report on selection and reset 296 * @sample {highstock} highcharts/chart/events-selection-points/ 297 * Select a range of points through a drag selection 298 * (Highcharts) 299 * 300 * @type {Highcharts.ChartSelectionCallbackFunction} 301 * @apioption chart.events.selection 302 */ 303 /** 304 * The margin between the outer edge of the chart and the plot area. 305 * The numbers in the array designate top, right, bottom and left 306 * respectively. Use the options `marginTop`, `marginRight`, 307 * `marginBottom` and `marginLeft` for shorthand setting of one option. 308 * 309 * By default there is no margin. The actual space is dynamically 310 * calculated from the offset of axis labels, axis title, title, 311 * subtitle and legend in addition to the `spacingTop`, `spacingRight`, 312 * `spacingBottom` and `spacingLeft` options. 313 * 314 * @sample {highcharts} highcharts/chart/margins-zero/ 315 * Zero margins 316 * @sample {highstock} stock/chart/margin-zero/ 317 * Zero margins 318 * 319 * @type {number|Array<number>} 320 * @apioption chart.margin 321 */ 322 /** 323 * The margin between the bottom outer edge of the chart and the plot 324 * area. Use this to set a fixed pixel value for the margin as opposed 325 * to the default dynamic margin. See also `spacingBottom`. 326 * 327 * @sample {highcharts} highcharts/chart/marginbottom/ 328 * 100px bottom margin 329 * @sample {highstock} stock/chart/marginbottom/ 330 * 100px bottom margin 331 * @sample {highmaps} maps/chart/margin/ 332 * 100px margins 333 * 334 * @type {number} 335 * @since 2.0 336 * @apioption chart.marginBottom 337 */ 338 /** 339 * The margin between the left outer edge of the chart and the plot 340 * area. Use this to set a fixed pixel value for the margin as opposed 341 * to the default dynamic margin. See also `spacingLeft`. 342 * 343 * @sample {highcharts} highcharts/chart/marginleft/ 344 * 150px left margin 345 * @sample {highstock} stock/chart/marginleft/ 346 * 150px left margin 347 * @sample {highmaps} maps/chart/margin/ 348 * 100px margins 349 * 350 * @type {number} 351 * @since 2.0 352 * @apioption chart.marginLeft 353 */ 354 /** 355 * The margin between the right outer edge of the chart and the plot 356 * area. Use this to set a fixed pixel value for the margin as opposed 357 * to the default dynamic margin. See also `spacingRight`. 358 * 359 * @sample {highcharts} highcharts/chart/marginright/ 360 * 100px right margin 361 * @sample {highstock} stock/chart/marginright/ 362 * 100px right margin 363 * @sample {highmaps} maps/chart/margin/ 364 * 100px margins 365 * 366 * @type {number} 367 * @since 2.0 368 * @apioption chart.marginRight 369 */ 370 /** 371 * The margin between the top outer edge of the chart and the plot area. 372 * Use this to set a fixed pixel value for the margin as opposed to 373 * the default dynamic margin. See also `spacingTop`. 374 * 375 * @sample {highcharts} highcharts/chart/margintop/ 100px top margin 376 * @sample {highstock} stock/chart/margintop/ 377 * 100px top margin 378 * @sample {highmaps} maps/chart/margin/ 379 * 100px margins 380 * 381 * @type {number} 382 * @since 2.0 383 * @apioption chart.marginTop 384 */ 385 /** 386 * Callback function to override the default function that formats all 387 * the numbers in the chart. Returns a string with the formatted number. 388 * 389 * @sample highcharts/members/highcharts-numberformat 390 * Arabic digits in Highcharts 391 * @type {Highcharts.NumberFormatterCallbackFunction} 392 * @since 8.0.0 393 * @apioption chart.numberFormatter 394 */ 395 /** 396 * When a chart with an x and a y-axis is rendered, we first pre-render the 397 * labels of both in order to measure them. Then, if either of the axis 398 * labels take up so much space that it significantly affects the length of 399 * the other axis, we repeat the process. 400 * 401 * By default we stop at two axis layout runs, but it may be that the second 402 * run also alter the space required by either axis, for example if it 403 * causes the labels to rotate. In this situation, a subsequent redraw of 404 * the chart may cause the tick and label placement to change for apparently 405 * no reason. 406 * 407 * Use the `axisLayoutRuns` option to set the maximum allowed number of 408 * repetitions. But keep in mind that the default value of 2 is set because 409 * every run costs performance time. 410 * 411 * **Note:** Changing that option to higher than the default might decrease 412 * performance significantly, especially with bigger sets of data. 413 * 414 * @type {number} 415 * @default 2 416 * @since 11.3.0 417 * @apioption chart.axisLayoutRuns 418 */ 419 /** 420 * Allows setting a key to switch between zooming and panning. Can be 421 * one of `alt`, `ctrl`, `meta` (the command key on Mac and Windows 422 * key on Windows) or `shift`. The keys are mapped directly to the key 423 * properties of the click event argument (`event.altKey`, 424 * `event.ctrlKey`, `event.metaKey` and `event.shiftKey`). 425 * 426 * @type {string} 427 * @since 4.0.3 428 * @product highcharts gantt 429 * @validvalue ["alt", "ctrl", "meta", "shift"] 430 * @apioption chart.panKey 431 */ 432 /** 433 * Allow panning in a chart. Best used with [panKey](#chart.panKey) 434 * to combine zooming and panning. 435 * 436 * On touch devices, when the [tooltip.followTouchMove]( 437 * #tooltip.followTouchMove) option is `true` (default), panning 438 * requires two fingers. To allow panning with one finger, set 439 * `followTouchMove` to `false`. 440 * 441 * @sample {highcharts} highcharts/chart/pankey/ Zooming and panning 442 * @sample {highstock} stock/chart/panning/ Zooming and xy panning 443 */ 444 panning: { 445 /** 446 * Enable or disable chart panning. 447 * 448 * @type {boolean} 449 * @default {highcharts} false 450 * @default {highstock|highmaps} true 451 */ 452 enabled: false, 453 /** 454 * Decides in what dimensions the user can pan the chart. Can be 455 * one of `x`, `y`, or `xy`. 456 * 457 * During panning, all axes will behave as if 458 * [`startOnTick`](#yAxis.startOnTick) and 459 * [`endOnTick`](#yAxis.endOnTick) were set to `false`. After the
460 * panning action is finished, the axes will adjust to their actual 461 * settings. 462 * 463 * @sample {highcharts} highcharts/chart/panning-type 464 * Zooming and xy panning 465 * 466 * @declare Highcharts.OptionsChartPanningTypeValue 467 * @type {string} 468 * @validvalue ["x", "y", "xy"] 469 * @product highcharts highstock gantt 470 */ 471 type: 'x' 472 }, 473 /** 474 * Equivalent to [zoomType](#chart.zoomType), but for multitouch 475 * gestures only. By default, the `pinchType` is the same as the 476 * `zoomType` setting. However, pinching can be enabled separately in 477 * some cases, for example in stock charts where a mouse drag pans the 478 * chart, while pinching is enabled. When [tooltip.followTouchMove]( 479 * #tooltip.followTouchMove) is true, pinchType only applies to 480 * two-finger touches. 481 * 482 * @type {string} 483 * @default {highcharts} undefined 484 * @default {highstock} undefined 485 * @since 3.0 486 * @product highcharts highstock gantt 487 * @deprecated 488 * @validvalue ["x", "y", "xy"] 489 * @apioption chart.pinchType 490 */ 491 /** 492 * Whether to apply styled mode. When in styled mode, no presentational 493 * attributes or CSS are applied to the chart SVG. Instead, CSS rules 494 * are required to style the chart. The default style sheet is 495 * available from `https://code.highcharts.com/css/highcharts.css`. 496 * 497 * [Read more in the docs](https://www.highcharts.com/docs/chart-design-and-style/style-by-css) 498 * on what classes and variables are available. 499 * 500 * @sample highcharts/css/colors 501 * Color theming with CSS 502 * @sample highcharts/css/prefers-color-scheme 503 * Dynamic theme based on system settings 504 * @type {boolean} 505 * @default false 506 * @since 7.0 507 * @apioption chart.styledMode 508 */ 509 styledMode: false, 510 /** 511 * The corner radius of the outer chart border. 512 * 513 * @sample {highcharts} highcharts/chart/borderradius/ 514 * 20px radius 515 * @sample {highstock} stock/chart/border/ 516 * 10px radius 517 * @sample {highmaps} maps/chart/border/ 518 * Border options 519 * 520 */ 521 borderRadius: 0, 522 /** 523 * In styled mode, this sets how many colors the class names 524 * should rotate between. With ten colors, series (or points) are 525 * given class names like `highcharts-color-0`, `highcharts-color-1` 526 * [...] `highcharts-color-9`. The equivalent in non-styled mode 527 * is to set colors using the [colors](#colors) setting. 528 * 529 * @since 5.0.0 530 */ 531 colorCount: 10, 532 /** 533 * By default, (because of memory and performance reasons) the chart does 534 * not copy the data but keeps it as a reference. In some cases, this might 535 * result in mutating the original data source. In order to prevent that, 536 * set that property to false. Please note that changing that might decrease 537 * performance, especially with bigger sets of data. 538 * 539 * @type {boolean} 540 * @since 10.1.0 541 */ 542 allowMutatingData: true, 543 /** 544 * If true, the axes will scale to the remaining visible series once 545 * one series is hidden. If false, hiding and showing a series will 546 * not affect the axes or the other series. For stacks, once one series 547 * within the stack is hidden, the rest of the stack will close in 548 * around it even if the axis is not affected. 549 * 550 * @sample {highcharts} highcharts/chart/ignorehiddenseries-true/ 551 * True by default 552 * @sample {highcharts} highcharts/chart/ignorehiddenseries-false/ 553 * False 554 * @sample {highcharts} highcharts/chart/ignorehiddenseries-true-stacked/ 555 * True with stack 556 * @sample {highstock} stock/chart/ignorehiddenseries-true/ 557 * True by default 558 * @sample {highstock} stock/chart/ignorehiddenseries-false/ 559 * False 560 * 561 * @since 1.2.0 562 * @product highcharts highstock gantt 563 */ 564 ignoreHiddenSeries: true, 565 /** 566 * Whether to invert the axes so that the x axis is vertical and y axis 567 * is horizontal. When `true`, the x axis is [reversed](#xAxis.reversed) 568 * by default. 569 * 570 * @productdesc {highcharts} 571 * If a bar series is present in the chart, it will be inverted 572 * automatically. Inverting the chart doesn't have an effect if there 573 * are no cartesian series in the chart. 574 * 575 * @sample {highcharts} highcharts/chart/inverted/ 576 * Inverted line 577 * @sample {highstock} stock/navigator/inverted/ 578 * Inverted stock chart 579 * 580 * @type {boolean} 581 * @default false 582 * @product highcharts highstock gantt 583 * @apioption chart.inverted 584 */ 585 /** 586 * The distance between the outer edge of the chart and the content, 587 * like title or legend, or axis title and labels if present. The 588 * numbers in the array designate top, right, bottom and left 589 * respectively. Use the options spacingTop, spacingRight, spacingBottom 590 * and spacingLeft options for shorthand setting of one option. 591 * 592 * @type {Array<number>} 593 * @see [chart.margin](#chart.margin) 594 * @default [10, 10, 15, 10] 595 * @since 3.0.6 596 */ 597 spacing: [10, 10, 15, 10], 598 /** 599 * The button that appears after a selection zoom, allowing the user
600 * to reset zoom. This option is deprecated in favor of 601 * [zooming](#chart.zooming). 602 * 603 * @since 2.2 604 * @deprecated 10.2.1 605 */ 606 resetZoomButton: { 607 /** 608 * What frame the button placement should be related to. Can be 609 * either `plotBox` or `spacingBox`. 610 * 611 * @sample {highcharts} highcharts/chart/resetzoombutton-relativeto/ 612 * Relative to the chart 613 * @sample {highstock} highcharts/chart/resetzoombutton-relativeto/ 614 * Relative to the chart 615 * 616 * @type {Highcharts.ButtonRelativeToValue} 617 * @apioption chart.resetZoomButton.relativeTo 618 */ 619 /** 620 * A collection of attributes for the button. The object takes SVG 621 * attributes like `fill`, `stroke`, `stroke-width` or `r`, the 622 * border radius. The theme also supports `style`, a collection of 623 * CSS properties for the text. Equivalent attributes for the hover 624 * state are given in `theme.states.hover`. 625 * 626 * @sample {highcharts} highcharts/chart/resetzoombutton-theme/ 627 * Theming the button 628 * @sample {highstock} highcharts/chart/resetzoombutton-theme/ 629 * Theming the button 630 * 631 * @type {Highcharts.SVGAttributes} 632 */ 633 theme: { 634 /** 635 * The z-index of the button. 636 * 637 * @type {number} 638 * @apioption chart.resetZoomButton.theme.zIndex 639 */ 640 }, 641 /** 642 * The position of the button. 643 * 644 * @sample {highcharts} highcharts/chart/resetzoombutton-position/ 645 * Above the plot area 646 * @sample {highstock} highcharts/chart/resetzoombutton-position/ 647 * Above the plot area 648 * @sample {highmaps} highcharts/chart/resetzoombutton-position/ 649 * Above the plot area 650 * 651 * @type {Highcharts.AlignObject} 652 */ 653 position: { 654 /** 655 * The horizontal alignment of the button. 656 * 657 * @type {number} 658 * @apioption chart.resetZoomButton.position.align 659 */ 660 /** 661 * The horizontal offset of the button. 662 * 663 * @type {number} 664 * @apioption chart.resetZoomButton.position.x 665 */ 666 /** 667 * The vertical alignment of the button. 668 * 669 * @type {Highcharts.VerticalAlignValue} 670 * @apioption chart.resetZoomButton.position.verticalAlign 671 */ 672 /** 673 * The vertical offset of the button. 674 * 675 * @type {number} 676 * @apioption chart.resetZoomButton.position.y 677 */ 678 } 679 }, 680 /** 681 * The pixel width of the plot area border. 682 * 683 * @sample {highcharts} highcharts/chart/plotborderwidth/ 684 * 1px border 685 * @sample {highstock} stock/chart/plotborder/ 686 * 2px border 687 * @sample {highmaps} maps/chart/plotborder/ 688 * Plot border options 689 * 690 * @type {number} 691 * @default 0 692 * @apioption chart.plotBorderWidth 693 */ 694 /** 695 * Whether to apply a drop shadow to the plot area. Requires that
696 * plotBackgroundColor be set. The shadow can be an object configuration 697 * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`. 698 * 699 * @sample {highcharts} highcharts/chart/plotshadow/ 700 * Plot shadow 701 * @sample {highstock} stock/chart/plotshadow/ 702 * Plot shadow 703 * @sample {highmaps} maps/chart/plotborder/ 704 * Plot border options 705 * 706 * @type {boolean|Highcharts.ShadowOptionsObject} 707 * @default false 708 * @apioption chart.plotShadow 709 */ 710 /** 711 * When true, cartesian charts like line, spline, area and column are 712 * transformed into the polar coordinate system. This produces _polar 713 * charts_, also known as _radar charts_. 714 * 715 * @sample {highcharts} highcharts/demo/polar/ 716 * Polar chart 717 * @sample {highcharts} highcharts/demo/polar-wind-rose/ 718 * Wind rose, stacked polar column chart 719 * @sample {highcharts} highcharts/demo/polar-spider/ 720 * Spider web chart 721 * @sample {highcharts} highcharts/parallel-coordinates/polar/ 722 * Star plot, multivariate data in a polar chart 723 * 724 * @type {boolean} 725 * @default false 726 * @since 2.3.0 727 * @product highcharts 728 * @requires highcharts-more 729 * @apioption chart.polar 730 */ 731 /** 732 * Whether to reflow the chart to fit the width of the container div 733 * on resizing the window. 734 * 735 * @sample {highcharts} highcharts/chart/reflow-true/ 736 * True by default 737 * @sample {highcharts} highcharts/chart/reflow-false/ 738 * False 739 * @sample {highstock} stock/chart/reflow-true/ 740 * True by default 741 * @sample {highstock} stock/chart/reflow-false/ 742 * False 743 * @sample {highmaps} maps/chart/reflow-true/ 744 * True by default 745 * @sample {highmaps} maps/chart/reflow-false/ 746 * False 747 * 748 * @since 2.1 749 */ 750 reflow: true, 751 /** 752 * The HTML element where the chart will be rendered. If it is a string, 753 * the element by that id is used. The HTML element can also be passed 754 * by direct reference, or as the first argument of the chart 755 * constructor, in which case the option is not needed. 756 * 757 * @sample {highcharts} highcharts/chart/reflow-true/ 758 * String 759 * @sample {highcharts} highcharts/chart/renderto-object/ 760 * Object reference 761 * @sample {highstock} stock/chart/renderto-string/ 762 * String 763 * @sample {highstock} stock/chart/renderto-object/ 764 * Object reference 765 * 766 * @type {string|Highcharts.HTMLDOMElement} 767 * @apioption chart.renderTo 768 */ 769 /** 770 * The background color of the marker square when selecting (zooming 771 * in on) an area of the chart. 772 * 773 * @see In styled mode, the selection marker fill is set with the 774 * `.highcharts-selection-marker` class. 775 * 776 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} 777 * @default rgba(51,92,173,0.25) 778 * @since 2.1.7 779 * @apioption chart.selectionMarkerFill 780 */ 781 /** 782 * Whether to apply a drop shadow to the global series group. This causes 783 * all the series to have the same shadow. Contrary to the `series.shadow` 784 * option, this prevents items from casting shadows on each other, like for 785 * others series in a stack. The shadow can be an object configuration 786 * containing `color`, `offsetX`, `offsetY`, `opacity` and `width`. 787 * 788 * @sample highcharts/chart/seriesgroupshadow/ Shadow 789 * 790 * @type {boolean|Highcharts.ShadowOptionsObject} 791 * @default false 792 * @apioption chart.shadow 793 */ 794 /** 795 * Whether to apply a drop shadow to the outer chart area. Requires 796 * that backgroundColor be set. The shadow can be an object 797 * configuration containing `color`, `offsetX`, `offsetY`, `opacity` and 798 * `width`. 799 * 800 * @sample {highcharts} highcharts/chart/shadow/ 801 * Shadow 802 * @sample {highstock} stock/chart/shadow/ 803 * Shadow 804 * @sample {highmaps} maps/chart/border/ 805 * Chart border and shadow 806 * 807 * @type {boolean|Highcharts.ShadowOptionsObject} 808 * @default false 809 * @apioption chart.shadow 810 */ 811 /** 812 * Whether to show the axes initially. This only applies to empty charts 813 * where series are added dynamically, as axes are automatically added 814 * to cartesian series. 815 * 816 * @sample {highcharts} highcharts/chart/showaxes-false/ 817 * False by default 818 * @sample {highcharts} highcharts/chart/showaxes-true/ 819 * True 820 * 821 * @type {boolean} 822 * @since 1.2.5 823 * @product highcharts gantt 824 * @apioption chart.showAxes 825 */ 826 /** 827 * The space between the bottom edge of the chart and the content (plot 828 * area, axis title and labels, title, subtitle or legend in top 829 * position). 830 * 831 * @sample {highcharts} highcharts/chart/spacingbottom/ 832 * Spacing bottom set to 100 833 * @sample {highstock} stock/chart/spacingbottom/ 834 * Spacing bottom set to 100 835 * @sample {highmaps} maps/chart/spacing/ 836 * Spacing 100 all around 837 * 838 * @type {number} 839 * @default 15 840 * @since 2.1 841 * @apioption chart.spacingBottom 842 */ 843 /** 844 * The space between the left edge of the chart and the content (plot 845 * area, axis title and labels, title, subtitle or legend in top 846 * position). 847 * 848 * @sample {highcharts} highcharts/chart/spacingleft/ 849 * Spacing left set to 100 850 * @sample {highstock} stock/chart/spacingleft/ 851 * Spacing left set to 100 852 * @sample {highmaps} maps/chart/spacing/ 853 * Spacing 100 all around 854 * 855 * @type {number} 856 * @default 10 857 * @since 2.1 858 * @apioption chart.spacingLeft 859 */ 860 /** 861 * The space between the right edge of the chart and the content (plot 862 * area, axis title and labels, title, subtitle or legend in top 863 * position). 864 * 865 * @sample {highcharts} highcharts/chart/spacingright-100/ 866 * Spacing set to 100 867 * @sample {highcharts} highcharts/chart/spacingright-legend/ 868 * Legend in right position with default spacing 869 * @sample {highstock} stock/chart/spacingright/ 870 * Spacing set to 100 871 * @sample {highmaps} maps/chart/spacing/ 872 * Spacing 100 all around 873 * 874 * @type {number} 875 * @default 10 876 * @since 2.1 877 * @apioption chart.spacingRight 878 */ 879 /** 880 * The space between the top edge of the chart and the content (plot 881 * area, axis title and labels, title, subtitle or legend in top 882 * position). 883 * 884 * @sample {highcharts} highcharts/chart/spacingtop-100/ 885 * A top spacing of 100 886 * @sample {highcharts} highcharts/chart/spacingtop-10/ 887 * Floating chart title makes the plot area align to the default 888 * spacingTop of 10. 889 * @sample {highstock} stock/chart/spacingtop/ 890 * A top spacing of 100 891 * @sample {highmaps} maps/chart/spacing/ 892 * Spacing 100 all around 893 * 894 * @type {number} 895 * @default 10 896 * @since 2.1 897 * @apioption chart.spacingTop 898 */ 899 /** 900 * Additional CSS styles to apply inline to the container `div` and the root 901 * SVG. 902 * 903 * According to the CSS syntax documentation, it is recommended to quote 904 * font family names that contain white space, digits, or punctuation 905 * characters other than hyphens. In such cases, wrap the fontFamily 906 * name as follows: `fontFamily: '"Font name"'`. 907 * 908 * Since v11, the root font size is 1rem by default, and all child element 909 * are given a relative `em` font size by default. This allows implementers
910 * to control all the chart's font sizes by only setting the root level. 911 * 912 * @see In styled mode, general chart styles can be set with the 913 * `.highcharts-root` class. 914 * @sample {highcharts} highcharts/chart/style-serif-font/ 915 * Using a serif type font 916 * @sample {highcharts} highcharts/chart/style-special-font/ 917 * Using a font with special character in name 918 * @sample {highcharts} highcharts/members/relative-font-size/ 919 * Relative font sizes 920 * @sample {highcharts} highcharts/css/em/ 921 * Styled mode with relative font sizes 922 * @sample {highstock} stock/chart/style/ 923 * Using a serif type font 924 * @sample {highmaps} maps/chart/style-serif-font/ 925 * Using a serif type font 926 * 927 * @type {Highcharts.CSSObject} 928 * @default {"fontFamily": "-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', sans-serif", "fontSize":"1rem"} 929 * @apioption chart.style 930 */ 931 /** 932 * The default series type for the chart. Can be any of the chart types 933 * listed under [plotOptions](#plotOptions) and [series](#series) or can 934 * be a series provided by an additional module. 935 * 936 * In TypeScript this option has no effect in sense of typing and 937 * instead the `type` option must always be set in the series. 938 * 939 * @sample {highcharts} highcharts/chart/type-bar/ 940 * Bar 941 * @sample {highstock} stock/chart/type/ 942 * Areaspline 943 * @sample {highmaps} maps/chart/type-mapline/ 944 * Mapline 945 * 946 * @type {string} 947 * @default {highcharts} line 948 * @default {highstock} line 949 * @default {highmaps} map 950 * @since 2.1.0 951 * @apioption chart.type 952 */ 953 type: 'line', 954 /** 955 * Decides in what dimensions the user can zoom by dragging the mouse. 956 * Can be one of `x`, `y` or `xy`. 957 * 958 * @see [panKey](#chart.panKey) 959 * 960 * @sample {highcharts} highcharts/chart/zoomtype-none/ 961 * None by default 962 * @sample {highcharts} highcharts/chart/zoomtype-x/ 963 * X 964 * @sample {highcharts} highcharts/chart/zoomtype-y/ 965 * Y 966 * @sample {highcharts} highcharts/chart/zoomtype-xy/ 967 * Xy 968 * @sample {highcharts} highcharts/chart/zoomtype-polar/ 969 * Zoom on polar chart 970 * @sample {highstock} stock/demo/basic-line/ 971 * None by default 972 * @sample {highstock} stock/chart/zoomtype-x/ 973 * X 974 * @sample {highstock} stock/chart/zoomtype-y/ 975 * Y 976 * @sample {highstock} stock/chart/zoomtype-xy/ 977 * Xy 978 * @sample {highmaps} maps/chart/zoomtype-xy/ 979 * Map with selection zoom 980 * 981 * @type {string} 982 * @validvalue ["x", "y", "xy"] 983 * @deprecated 984 * @apioption chart.zoomType 985 */ 986 /** 987 * Enables zooming by a single touch, in combination with 988 * [chart.zoomType](#chart.zoomType). When enabled, two-finger pinch 989 * will still work as set up by [chart.pinchType](#chart.pinchType). 990 * However, `zoomBySingleTouch` will interfere with touch-dragging the 991 * chart to read the tooltip. And especially when vertical zooming is 992 * enabled, it will make it hard to scroll vertically on the page. 993 * @since 9.0.0 994 * @sample highcharts/chart/zoombysingletouch 995 * Zoom by single touch enabled, with buttons to toggle 996 * @product highcharts highstock gantt 997 * @deprecated 998 */ 999 /** 1000 * Chart zooming options. 1001 * @since 10.2.1 1002 */ 1003 zooming: { 1004 /** 1005 * Equivalent to [type](#chart.zooming.type), but for multitouch 1006 * gestures only. By default, the `pinchType` is the same as the 1007 * `type` setting. However, pinching can be enabled separately in 1008 * some cases, for example in stock charts where a mouse drag pans the 1009 * chart, while pinching is enabled. When [tooltip.followTouchMove]( 1010 * #tooltip.followTouchMove) is true, pinchType only applies to 1011 * two-finger touches. 1012 * 1013 * @type {string} 1014 * @default {highcharts} undefined 1015 * @default {highstock} x 1016 * @product highcharts highstock gantt 1017 * @validvalue ["x", "y", "xy"] 1018 * @apioption chart.zooming.pinchType 1019 */ 1020 /** 1021 * Decides in what dimensions the user can zoom by dragging the mouse. 1022 * Can be one of `x`, `y` or `xy`. 1023 * 1024 * @declare Highcharts.OptionsChartZoomingTypeValue 1025 * @type {string} 1026 * @default {highcharts} undefined 1027 * @product highcharts highstock gantt 1028 * @validvalue ["x", "y", "xy"] 1029 * @apioption chart.zooming.type 1030 */ 1031 /** 1032 * Set a key to hold when dragging to zoom the chart. This is useful to 1033 * avoid zooming while moving points. Should be set different than 1034 * [chart.panKey](#chart.panKey). 1035 * 1036 * @type {string} 1037 * @default {highcharts} undefined 1038 * @validvalue ["alt", "ctrl", "meta", "shift"] 1039 * @requires modules/draggable-points 1040 * @apioption chart.zooming.key 1041 */ 1042 /** 1043 * Enables zooming by a single touch, in combination with 1044 * [chart.zooming.type](#chart.zooming.type). When enabled, two-finger 1045 * pinch will still work as set up by [chart.zooming.pinchType] 1046 * (#chart.zooming.pinchType). However, `singleTouch` will interfere 1047 * with touch-dragging the chart to read the tooltip. And especially 1048 * when vertical zooming is enabled, it will make it hard to scroll 1049 * vertically on the page. 1050 * 1051 * @sample highcharts/chart/zoombysingletouch 1052 * Zoom by single touch enabled, with buttons to toggle 1053 * 1054 * @product highcharts highstock gantt 1055 */ 1056 singleTouch: false, 1057 /** 1058 * The button that appears after a selection zoom, allowing the user 1059 * to reset zoom. 1060 */ 1061 resetButton: { 1062 /** 1063 * What frame the button placement should be related to. Can be 1064 * either `plotBox` or `spacingBox`. 1065 * 1066 * @sample {highcharts} highcharts/chart/resetzoombutton-relativeto/ 1067 * Relative to the chart 1068 * @sample {highstock} highcharts/chart/resetzoombutton-relativeto/ 1069 * Relative to the chart 1070 * 1071 * @type {Highcharts.ButtonRelativeToValue} 1072 * @default plot 1073 * @apioption chart.zooming.resetButton.relativeTo 1074 */ 1075 /** 1076 * A collection of attributes for the button. The object takes SVG 1077 * attributes like `fill`, `stroke`, `stroke-width` or `r`, the 1078 * border radius. The theme also supports `style`, a collection of 1079 * CSS properties for the text. Equivalent attributes for the hover 1080 * state are given in `theme.states.hover`. 1081 * 1082 * @sample {highcharts} highcharts/chart/resetzoombutton-theme/ 1083 * Theming the button 1084 * @sample {highstock} highcharts/chart/resetzoombutton-theme/ 1085 * Theming the button 1086 * 1087 * @type {Highcharts.SVGAttributes} 1088 * @since 10.2.1 1089 */ 1090 theme: { 1091 /** @internal */ 1092 zIndex: 6 1093 }, 1094 /** 1095 * The position of the button. 1096 * 1097 * Note: Adjusting position values might cause overlap with chart 1098 * elements. Ensure coordinates do not obstruct other components or 1099 * data visibility. 1100 * 1101 * @sample {highcharts} highcharts/chart/resetzoombutton-position/ 1102 * Above the plot area 1103 * @sample {highstock} highcharts/chart/resetzoombutton-position/ 1104 * Above the plot area 1105 * @sample {highmaps} highcharts/chart/resetzoombutton-position/ 1106 * Above the plot area 1107 * 1108 * @type {Highcharts.AlignObject} 1109 * @since 10.2.1 1110 */ 1111 position: { 1112 /** 1113 * The horizontal alignment of the button. 1114 */ 1115 align: 'right', 1116 /** 1117 * The horizontal offset of the button. 1118 */ 1119 x: -10, 1120 /** 1121 * The vertical alignment of the button. 1122 * 1123 * @type {Highcharts.VerticalAlignValue} 1124 * @default top 1125 * @apioption chart.zooming.resetButton.position.verticalAlign 1126 */ 1127 /** 1128 * The vertical offset of the button. 1129 */ 1130 y: 10 1131 } 1132 } 1133 }, 1134 /** 1135 * An explicit width for the chart. By default (when `null`) the width 1136 * is calculated from the offset width of the containing element. 1137 * 1138 * @sample {highcharts} highcharts/chart/width/ 1139 * 800px wide 1140 * @sample {highstock} stock/chart/width/ 1141 * 800px wide 1142 * @sample {highmaps} maps/chart/size/ 1143 * Chart with explicit size 1144 * 1145 * @type {null|number|string} 1146 */ 1147 width: null, 1148 /** 1149 * An explicit height for the chart. If a _number_, the height is 1150 * given in pixels. If given a _percentage string_ (for example 1151 * `'56%'`), the height is given as the percentage of the actual chart 1152 * width. This allows for preserving the aspect ratio across responsive 1153 * sizes. 1154 * 1155 * By default (when `null`) the height is calculated from the offset 1156 * height of the containing element, or 400 pixels if the containing 1157 * element's height is 0. 1158 * 1159 * @sample {highcharts} highcharts/chart/height/ 1160 * Forced 200px height 1161 * @sample {highstock} stock/chart/height/ 1162 * 300px height 1163 * @sample {highmaps} maps/chart/size/ 1164 * Chart with explicit size 1165 * @sample highcharts/chart/height-percent/ 1166 * Highcharts with percentage height 1167 * @sample highcharts/chart/height-inherited/ 1168 * Chart with inherited height 1169 * 1170 * @type {null|number|string} 1171 */ 1172 height: null, 1173 /** 1174 * The color of the outer chart border. 1175 * 1176 * @see In styled mode, the stroke is set with the 1177 * `.highcharts-background` class. 1178 * 1179 * @sample {highcharts} highcharts/chart/bordercolor/ 1180 * Brown border 1181 * @sample {highstock} stock/chart/border/ 1182 * Brown border 1183 * @sample {highmaps} maps/chart/border/ 1184 * Border options 1185 * 1186 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} 1187 */ 1188 borderColor: "#334eff" /* Palette.highlightColor80 */, 1189 /** 1190 * The pixel width of the outer chart border. 1191 * 1192 * @see In styled mode, the stroke is set with the 1193 * `.highcharts-background` class. 1194 * 1195 * @sample {highcharts} highcharts/chart/borderwidth/ 1196 * 5px border 1197 * @sample {highstock} stock/chart/border/ 1198 * 2px border 1199 * @sample {highmaps} maps/chart/border/ 1200 * Border options 1201 * 1202 * @type {number} 1203 * @default 0 1204 * @apioption chart.borderWidth 1205 */ 1206 /** 1207 * The background color or gradient for the outer chart area. 1208 * 1209 * @see In styled mode, the background is set with the 1210 * `.highcharts-background` class. 1211 * 1212 * @sample {highcharts} highcharts/chart/backgroundcolor-color/ 1213 * Color 1214 * @sample {highcharts} highcharts/chart/backgroundcolor-gradient/ 1215 * Gradient 1216 * @sample {highstock} stock/chart/backgroundcolor-color/ 1217 * Color 1218 * @sample {highstock} stock/chart/backgroundcolor-gradient/ 1219 * Gradient 1220 * @sample {highmaps} maps/chart/backgroundcolor-color/ 1221 * Color 1222 * @sample {highmaps} maps/chart/backgroundcolor-gradient/ 1223 * Gradient 1224 * 1225 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} 1226 */ 1227 backgroundColor: "#ffffff" /* Palette.backgroundColor */, 1228 /** 1229 * The background color or gradient for the plot area. 1230 * 1231 * @see In styled mode, the plot background is set with the 1232 * `.highcharts-plot-background` class. 1233 * 1234 * @sample {highcharts} highcharts/chart/plotbackgroundcolor-color/ 1235 * Color 1236 * @sample {highcharts} highcharts/chart/plotbackgroundcolor-gradient/ 1237 * Gradient 1238 * @sample {highstock} stock/chart/plotbackgroundcolor-color/ 1239 * Color 1240 * @sample {highstock} stock/chart/plotbackgroundcolor-gradient/ 1241 * Gradient 1242 * @sample {highmaps} maps/chart/plotbackgroundcolor-color/ 1243 * Color 1244 * @sample {highmaps} maps/chart/plotbackgroundcolor-gradient/ 1245 * Gradient 1246 * 1247 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
1248 * @apioption chart.plotBackgroundColor 1249 */ 1250 /** 1251 * The URL for an image to use as the plot background. To set an image 1252 * as the background for the entire chart, set a CSS background image 1253 * to the container element. Note that for the image to be applied to 1254 * exported charts, its URL needs to be accessible by the export server. 1255 * 1256 * @see In styled mode, a plot background image can be set with the 1257 * `.highcharts-plot-background` class and a [custom pattern]( 1258 * https://www.highcharts.com/docs/chart-design-and-style/gradients-shadows-and-patterns). 1259 * 1260 * @sample {highcharts} highcharts/chart/plotbackgroundimage/ 1261 * Skies 1262 * @sample {highstock} stock/chart/plotbackgroundimage/ 1263 * Skies 1264 * 1265 * @type {string} 1266 * @apioption chart.plotBackgroundImage 1267 */ 1268 /** 1269 * The color of the inner chart or plot area border. 1270 * 1271 * @see In styled mode, a plot border stroke can be set with the 1272 * `.highcharts-plot-border` class. 1273 * 1274 * @sample {highcharts} highcharts/chart/plotbordercolor/ 1275 * Blue border 1276 * @sample {highstock} stock/chart/plotborder/ 1277 * Blue border 1278 * @sample {highmaps} maps/chart/plotborder/ 1279 * Plot border options 1280 * 1281 * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} 1282 */ 1283 plotBorderColor: "#cccccc" /* Palette.neutralColor20 */ 1284}; 1285/* * 1286 * 1287 * Default Export 1288 * 1289 * */ 1290export default ChartDefaults;
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.