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 * Namespace 14 * 15 * */ 16var AxisDefaults; 17(function (AxisDefaults) { 18 /* * 19 * 20 * Constants 21 * 22 * */ 23 /** 24 * The X axis or category axis. Normally this is the horizontal axis, 25 * though if the chart is inverted this is the vertical axis. In case of 26 * multiple axes, the xAxis node is an array of configuration objects. 27 * 28 * See the [Axis class](/class-reference/Highcharts.Axis) for programmatic 29 * access to the axis. 30 * 31 * @productdesc {highmaps} 32 * In Highmaps, the axis is hidden, but it is used behind the scenes to 33 * control features like zooming and panning. Zooming is in effect the same 34 * as setting the extremes of one of the exes. 35 * 36 * @type {*|Array<*>} 37 * @optionparent xAxis 38 */ 39 AxisDefaults.xAxis = { 40 /** 41 * When using multiple axis, the ticks of two or more opposite axes 42 * will automatically be aligned by adding ticks to the axis or axes 43 * with the least ticks, as if `tickAmount` were specified. 44 * 45 * This can be prevented by setting `alignTicks` to false. If the grid 46 * lines look messy, it's a good idea to hide them for the secondary 47 * axis by setting `gridLineWidth` to 0. 48 * 49 * If `startOnTick` or `endOnTick` in an Axis options are set to false, 50 * then the `alignTicks ` will be disabled for the Axis. 51 * 52 * Disabled for logarithmic axes. 53 * 54 * @product highcharts highstock gantt 55 */ 56 alignTicks: true, 57 /** 58 * Whether to allow decimals in this axis' ticks. When counting 59 * integers, like persons or hits on a web page, decimals should 60 * be avoided in the labels. By default, decimals are allowed on small 61 * scale axes. 62 * 63 * @see [minTickInterval](#xAxis.minTickInterval) 64 * 65 * @sample {highcharts|highstock} highcharts/yaxis/allowdecimals-true/ 66 * True by default 67 * @sample {highcharts|highstock} highcharts/yaxis/allowdecimals-false/ 68 * False 69 * 70 * @type {boolean|undefined} 71 * @default undefined 72 * @since 2.0 73 */ 74 allowDecimals: void 0, 75 /** 76 * When using an alternate grid color, a band is painted across the 77 * plot area between every other grid line. 78 * 79 * @sample {highcharts} highcharts/yaxis/alternategridcolor/ 80 * Alternate grid color on the Y axis 81 * @sample {highstock} stock/xaxis/alternategridcolor/ 82 * Alternate grid color on the Y axis 83 * 84 * @type {Highcharts.ColorType} 85 * @apioption xAxis.alternateGridColor 86 */ 87 /** 88 * An array defining breaks in the axis, the sections defined will be 89 * left out and all the points shifted closer to each other. 90 * 91 * @productdesc {highcharts} 92 * Requires that the broken-axis.js module is loaded. 93 * 94 * @sample {highcharts} highcharts/axisbreak/break-simple/ 95 * Simple break 96 * @sample {highcharts|highstock} highcharts/axisbreak/break-visualized/ 97 * Advanced with callback 98 * @sample {highstock} stock/demo/intraday-breaks/ 99 * Break on nights and weekends 100 * 101 * @type {Array<*>} 102 * @since 4.1.0 103 * @product highcharts highstock gantt 104 * @apioption xAxis.breaks 105 */ 106 /** 107 * A number indicating how much space should be left between the start 108 * and the end of the break. The break size is given in axis units, 109 * so for instance on a `datetime` axis, a break size of 3600000 would 110 * indicate the equivalent of an hour. 111 * 112 * @type {number} 113 * @default 0 114 * @since 4.1.0 115 * @product highcharts highstock gantt 116 * @apioption xAxis.breaks.breakSize 117 */ 118 /** 119 * The axis value where the break starts. On datetime axes, this may be 120 * a date string. 121 * 122 * @type {number|string} 123 * @since 4.1.0 124 * @product highcharts highstock gantt 125 * @apioption xAxis.breaks.from 126 */ 127 /** 128 * Defines an interval after which the break appears again. By default 129 * the breaks do not repeat. 130 * 131 * @type {number} 132 * @default 0 133 * @since 4.1.0 134 * @product highcharts highstock gantt 135 * @apioption xAxis.breaks.repeat 136 */ 137 /** 138 * The axis value where the break ends. On datetime axes, this may be 139 * a date string. 140 * 141 * @type {number|string} 142 * @since 4.1.0 143 * @product highcharts highstock gantt 144 * @apioption xAxis.breaks.to 145 */ 146 /** 147 * If categories are present for the xAxis, names are used instead of 148 * numbers for that axis. 149 * 150 * Since Highcharts 3.0, categories can also 151 * be extracted by giving each point a [name](#series.data) and setting 152 * axis [type](#xAxis.type) to `category`. However, if you have multiple 153 * series, best practice remains defining the `categories` array. 154 * 155 * Example: `categories: ['Apples', 'Bananas', 'Oranges']` 156 * 157 * @sample {highcharts} highcharts/demo/line-labels/ 158 * With 159 * @sample {highcharts} highcharts/xaxis/categories/ 160 * Without 161 * 162 * @type {Array<string>} 163 * @product highcharts gantt 164 * @apioption xAxis.categories 165 */ 166 /** 167 * The highest allowed value for automatically computed axis extremes. 168 * 169 * @see [floor](#xAxis.floor) 170 * 171 * @sample {highcharts|highstock} highcharts/yaxis/floor-ceiling/ 172 * Floor and ceiling 173 * 174 * @type {number} 175 * @since 4.0 176 * @product highcharts highstock gantt 177 * @apioption xAxis.ceiling 178 */ 179 /** 180 * A class name that opens for styling the axis by CSS, especially in 181 * Highcharts styled mode. The class name is applied to group elements 182 * for the grid, axis elements and labels. 183 * 184 * @sample {highcharts|highstock|highmaps} highcharts/css/axis/ 185 * Multiple axes with separate styling 186 * 187 * @type {string} 188 * @since 5.0.0 189 * @apioption xAxis.className 190 */ 191 /** 192 * Configure a crosshair that follows either the mouse pointer or the 193 * hovered point. 194 *
195 * In styled mode, the crosshairs are styled in the 196 * `.highcharts-crosshair`, `.highcharts-crosshair-thin` or 197 * `.highcharts-xaxis-category` classes. 198 * 199 * @productdesc {highstock} 200 * In Highcharts stock, by default, the crosshair is enabled on the 201 * X axis and disabled on the Y axis. 202 * 203 * @sample {highcharts} highcharts/xaxis/crosshair-both/ 204 * Crosshair on both axes 205 * @sample {highstock} stock/xaxis/crosshairs-xy/ 206 * Crosshair on both axes, with y axis label 207 * @sample {highmaps} highcharts/xaxis/crosshair-both/ 208 * Crosshair on both axes 209 * 210 * @declare Highcharts.AxisCrosshairOptions 211 * @type {boolean|*} 212 * @default false 213 * @since 4.1 214 * @apioption xAxis.crosshair 215 */ 216 /** 217 * The value on a perpendicular axis where this axis should cross. This 218 * is typically used on mathematical plots where the axes cross at 0. 219 * When `crossing` is set, space will not be reserved at the sides of 220 * the chart for axis labels and title, so those may be clipped. In this 221 * case it is better to place the axes without the `crossing` option. 222 * 223 * @type {number} 224 * @sample highcharts/xaxis/crossing 225 * Function plot with axes crossing at 0 226 * @since 11.0.1 227 * @apioption xAxis.crossing 228 */ 229 /** 230 * A class name for the crosshair, especially as a hook for styling. 231 * 232 * @type {string} 233 * @since 5.0.0 234 * @apioption xAxis.crosshair.className 235 */ 236 /** 237 * The color of the crosshair. Defaults to `#cccccc` for numeric and 238 * datetime axes, and `rgba(204,214,235,0.25)` for category axes, where 239 * the crosshair by default highlights the whole category. 240 * 241 * @sample {highcharts|highstock|highmaps} highcharts/xaxis/crosshair-customized/ 242 * Customized crosshairs 243 * 244 * @type {Highcharts.ColorType} 245 * @default #cccccc 246 * @since 4.1 247 * @apioption xAxis.crosshair.color 248 */ 249 /** 250 * The dash style for the crosshair. See 251 * [plotOptions.series.dashStyle](#plotOptions.series.dashStyle) 252 * for possible values. 253 * 254 * @sample {highcharts|highmaps} highcharts/xaxis/crosshair-dotted/ 255 * Dotted crosshair 256 * @sample {highstock} stock/xaxis/crosshair-dashed/ 257 * Dashed X axis crosshair 258 * 259 * @type {Highcharts.DashStyleValue} 260 * @default Solid 261 * @since 4.1 262 * @apioption xAxis.crosshair.dashStyle 263 */ 264 /** 265 * A label on the axis next to the crosshair. 266 * 267 * In styled mode, the label is styled with the 268 * `.highcharts-crosshair-label` class. 269 * 270 * @sample {highstock} stock/xaxis/crosshair-label/ 271 * Crosshair labels 272 * @sample {highstock} highcharts/css/crosshair-label/ 273 * Style mode 274 * 275 * @declare Highcharts.AxisCrosshairLabelOptions 276 * @since 2.1 277 * @product highstock 278 * @apioption xAxis.crosshair.label 279 */ 280 /** 281 * Alignment of the label compared to the axis. Defaults to `"left"` for 282 * right-side axes, `"right"` for left-side axes and `"center"` for 283 * horizontal axes. 284 * 285 * @type {Highcharts.AlignValue} 286 * @since 2.1 287 * @product highstock 288 * @apioption xAxis.crosshair.label.align 289 */ 290 /** 291 * The background color for the label. Defaults to the related series 292 * color, or `#666666` if that is not available. 293 * 294 * @type {Highcharts.ColorType} 295 * @since 2.1 296 * @product highstock 297 * @apioption xAxis.crosshair.label.backgroundColor 298 */ 299 /** 300 * The border color for the crosshair label 301 * 302 * @type {Highcharts.ColorType} 303 * @since 2.1 304 * @product highstock 305 * @apioption xAxis.crosshair.label.borderColor 306 */ 307 /** 308 * The border corner radius of the crosshair label. 309 * 310 * @type {number} 311 * @default 3 312 * @since 2.1.10 313 * @product highstock 314 * @apioption xAxis.crosshair.label.borderRadius 315 */ 316 /** 317 * The border width for the crosshair label. 318 * 319 * @type {number} 320 * @default 0 321 * @since 2.1 322 * @product highstock 323 * @apioption xAxis.crosshair.label.borderWidth 324 */ 325 /** 326 * Flag to enable crosshair's label. 327 * 328 * @sample {highstock} stock/xaxis/crosshairs-xy/ 329 * Enabled label for yAxis' crosshair 330 * 331 * @type {boolean} 332 * @default false 333 * @since 2.1 334 * @product highstock 335 * @apioption xAxis.crosshair.label.enabled 336 */ 337 /**
338 * A format string for the crosshair label. Defaults to `{value}` for 339 * numeric axes and `{value:%b %d, %Y}` for datetime axes. 340 * 341 * @type {string} 342 * @since 2.1 343 * @product highstock 344 * @apioption xAxis.crosshair.label.format 345 */ 346 /** 347 * Formatter function for the label text. 348 * 349 * @type {Highcharts.XAxisCrosshairLabelFormatterCallbackFunction} 350 * @since 2.1 351 * @product highstock 352 * @apioption xAxis.crosshair.label.formatter 353 */ 354 /** 355 * Padding inside the crosshair label. 356 * 357 * @type {number} 358 * @default 8 359 * @since 2.1 360 * @product highstock 361 * @apioption xAxis.crosshair.label.padding 362 */ 363 /** 364 * The shape to use for the label box. 365 * 366 * @type {string} 367 * @default callout 368 * @since 2.1 369 * @product highstock 370 * @apioption xAxis.crosshair.label.shape 371 */ 372 /** 373 * Text styles for the crosshair label. 374 * 375 * @type {Highcharts.CSSObject} 376 * @default {"color": "white", "fontWeight": "normal", "fontSize": "11px", "textAlign": "center"} 377 * @since 2.1 378 * @product highstock 379 * @apioption xAxis.crosshair.label.style 380 */ 381 /** 382 * Whether the crosshair should snap to the point or follow the pointer 383 * independent of points. 384 * 385 * @sample {highcharts|highstock} highcharts/xaxis/crosshair-snap-false/ 386 * True by default 387 * @sample {highmaps} maps/demo/latlon-advanced/ 388 * Snap is false 389 * 390 * @type {boolean} 391 * @default true 392 * @since 4.1 393 * @apioption xAxis.crosshair.snap 394 */ 395 /** 396 * The pixel width of the crosshair. Defaults to 1 for numeric or 397 * datetime axes, and for one category width for category axes. 398 * 399 * @sample {highcharts} highcharts/xaxis/crosshair-customized/ 400 * Customized crosshairs 401 * @sample {highstock} highcharts/xaxis/crosshair-customized/ 402 * Customized crosshairs 403 * @sample {highmaps} highcharts/xaxis/crosshair-customized/ 404 * Customized crosshairs 405 * 406 * @type {number} 407 * @default 1 408 * @since 4.1 409 * @apioption xAxis.crosshair.width 410 */ 411 /** 412 * The Z index of the crosshair. Higher Z indices allow drawing the 413 * crosshair on top of the series or behind the grid lines. 414 * 415 * @type {number} 416 * @default 2 417 * @since 4.1 418 * @apioption xAxis.crosshair.zIndex 419 */ 420 /** 421 * Whether to pan axis. If `chart.panning` is enabled, the option 422 * allows to disable panning on an individual axis. 423 */ 424 panningEnabled: true, 425 /** 426 * The Z index for the axis group. 427 * 428 * @see [axis.gridZIndex](#xAxis.gridZIndex) 429 * @see [axis.labels.zIndex](#xAxis.labels.zIndex) 430 */ 431 zIndex: 2, 432 /** 433 * Whether to zoom axis. If `chart.zoomType` is set, the option allows 434 * to disable zooming on an individual axis. 435 * 436 * @sample {highcharts} highcharts/xaxis/zoomenabled/ 437 * Zoom enabled is false 438 */ 439 zoomEnabled: true, 440 /** 441 * For a datetime axis, the scale will automatically adjust to the 442 * appropriate unit. This member gives the default string 443 * representations used for each unit. For intermediate values, 444 * different units may be used, for example the `day` unit can be used 445 * on midnight and `hour` unit be used for intermediate values on the 446 * same axis. 447 * 448 * For an overview of the string or object configuration, see 449 * [dateFormat](/class-reference/Highcharts.Time#dateFormat). 450 * 451 * Defaults to: 452 * ```js 453 * { 454 * millisecond: '%[HMSL]', 455 * second: '%[HMS]', 456 * minute: '%[HM]', 457 * hour: '%[HM]', 458 * day: '%[eb]', 459 * week: '%[eb]', 460 * month: '%[bY]', 461 * year: '%Y' 462 * } 463 * ``` 464 * 465 * @sample {highcharts} highcharts/xaxis/datetimelabelformats-object/ 466 * Object day format on X axis 467 * @sample {highcharts} highcharts/xaxis/datetimelabelformats/ 468 * String day format on X axis 469 * @sample {highstock} stock/xaxis/datetimelabelformats/ 470 * More information in x axis labels 471 * 472 * @declare Highcharts.AxisDateTimeLabelFormatsOptions 473 * @product highcharts highstock gantt 474 */ 475 dateTimeLabelFormats: { 476 /** 477 * @declare Highcharts.AxisDateTimeLabelFormatsOptionsObject 478 * @type {string|*} 479 */ 480 millisecond: { 481 /** 482 * @type {Array<string|Highcharts.DateTimeFormatOptions>} 483 * @default undefined 484 * @apioption xAxis.dateTimeLabelFormats.millisecond.list 485 */ 486 /** 487 * @type {string|Highcharts.DateTimeFormatOptions} 488 * @apioption xAxis.dateTimeLabelFormats.millisecond.main 489 */ 490 main: '%[HMSL]', 491 range: false 492 }, 493 /** 494 * @declare Highcharts.AxisDateTimeLabelFormatsOptionsObject 495 * @type {string|*} 496 */ 497 second: { 498 /** 499 * @type {Array<string|Highcharts.DateTimeFormatOptions>} 500 * @default undefined 501 * @apioption xAxis.dateTimeLabelFormats.second.list 502 */ 503 /** 504 * @type {string|Highcharts.DateTimeFormatOptions} 505 * @apioption xAxis.dateTimeLabelFormats.second.main 506 */ 507 main: '%[HMS]', 508 range: false 509 }, 510 /** 511 * @declare Highcharts.AxisDateTimeLabelFormatsOptionsObject 512 * @type {string|*} 513 */ 514 minute: { 515 /** 516 * @type {Array<string|Highcharts.DateTimeFormatOptions>} 517 * @default undefined 518 * @apioption xAxis.dateTimeLabelFormats.minute.list 519 */ 520 /** 521 * @type {string|Highcharts.DateTimeFormatOptions} 522 * @apioption xAxis.dateTimeLabelFormats.minute.main 523 */ 524 main: '%[HM]', 525 range: false 526 }, 527 /** 528 * @declare Highcharts.AxisDateTimeLabelFormatsOptionsObject 529 * @type {string|*} 530 */ 531 hour: { 532 /** 533 * @type {Array<string|Highcharts.DateTimeFormatOptions>} 534 * @default undefined 535 * @apioption xAxis.dateTimeLabelFormats.hour.list 536 */ 537 /** 538 * @type {string|Highcharts.DateTimeFormatOptions} 539 * @apioption xAxis.dateTimeLabelFormats.hour.main 540 */ 541 main: '%[HM]', 542 range: false 543 }, 544 /** 545 * @declare Highcharts.AxisDateTimeLabelFormatsOptionsObject 546 * @type {string|*} 547 */ 548 day: { 549 /** 550 * @type {Array<string|Highcharts.DateTimeFormatOptions>} 551 * @default undefined 552 * @apioption xAxis.dateTimeLabelFormats.day.list 553 */ 554 /** 555 * @type {string|Highcharts.DateTimeFormatOptions} 556 * @apioption xAxis.dateTimeLabelFormats.day.main 557 */ 558 main: '%[eb]' 559 }, 560 /** 561 * @declare Highcharts.AxisDateTimeLabelFormatsOptionsObject 562 * @type {string|*} 563 */ 564 week: { 565 /** 566 * @type {Array<string|Highcharts.DateTimeFormatOptions>} 567 * @default undefined 568 * @apioption xAxis.dateTimeLabelFormats.week.list 569 */ 570 /** 571 * @type {string|Highcharts.DateTimeFormatOptions} 572 * @apioption xAxis.dateTimeLabelFormats.week.main 573 */ 574 main: '%[eb]' 575 }, 576 /** 577 * @declare Highcharts.AxisDateTimeLabelFormatsOptionsObject 578 * @type {string|*} 579 */ 580 month: { 581 /** 582 * @type {Array<string|Highcharts.DateTimeFormatOptions>} 583 * @default undefined 584 * @apioption xAxis.dateTimeLabelFormats.month.list 585 */ 586 /** 587 * @type {string|Highcharts.DateTimeFormatOptions} 588 * @apioption xAxis.dateTimeLabelFormats.month.main 589 */ 590 main: '%[bY]' 591 }, 592 /** 593 * @declare Highcharts.AxisDateTimeLabelFormatsOptionsObject 594 * @type {string|*} 595 */ 596 year: { 597 /** 598 * @type {Array<string|Highcharts.DateTimeFormatOptions>} 599 * @default undefined 600 * @apioption xAxis.dateTimeLabelFormats.year.list 601 */ 602 /** 603 * @type {string|Highcharts.DateTimeFormatOptions} 604 * @apioption xAxis.dateTimeLabelFormats.year.main 605 */ 606 main: '%Y' 607 } 608 }, 609 /** 610 * Whether to force the axis to end on a tick. Use this option with 611 * the `maxPadding` option to control the axis end. 612 * 613 * @productdesc {highstock} 614 * In Highcharts Stock, `endOnTick` is always `false` when the navigator 615 * is enabled, to prevent jumpy scrolling. With disabled navigator 616 * enabling `endOnTick` may lead to extending the xAxis to show the last 617 * tick, therefore range selector buttons may not have an active state 618 * if the axis gets extended. 619 * 620 * @sample {highcharts} highcharts/yaxis/endontick/ 621 * True by default 622 * @sample {highcharts} highcharts/yaxis/endontick-false/ 623 * False 624 * @sample {highstock} stock/demo/basic-line/ 625 * True by default 626 * @sample {highstock} stock/xaxis/endontick/ 627 * False 628 * 629 * @since 1.2.0 630 */ 631 endOnTick: false, 632 /** 633 * Event handlers for the axis. 634 * 635 * @type {*} 636 * @apioption xAxis.events 637 */ 638 /** 639 * An event fired after the breaks have rendered. 640 * 641 * @see [breaks](#xAxis.breaks) 642 * 643 * @sample {highcharts} highcharts/axisbreak/break-event/ 644 * AfterBreak Event 645 * 646 * @type {Highcharts.AxisEventCallbackFunction} 647 * @since 4.1.0 648 * @product highcharts gantt 649 * @apioption xAxis.events.afterBreaks 650 */ 651 /** 652 * As opposed to the `setExtremes` event, this event fires after the 653 * final min and max values are computed and corrected for `minRange`. 654 * 655 * Fires when the minimum and maximum is set for the axis, either by 656 * calling the `.setExtremes()` method or by selecting an area in the 657 * chart. One parameter, `event`, is passed to the function, containing 658 * common event information. 659 * 660 * The new user set minimum and maximum values can be found by 661 * `event.min` and `event.max`. These reflect the axis minimum and 662 * maximum in axis values. The actual data extremes are found in 663 * `event.dataMin` and `event.dataMax`. 664 * 665 * @type {Highcharts.AxisSetExtremesEventCallbackFunction} 666 * @since 2.3 667 * @context Highcharts.Axis 668 * @apioption xAxis.events.afterSetExtremes 669 */ 670 /** 671 * An event fired when a break from this axis occurs on a point. 672 * 673 * @see [breaks](#xAxis.breaks) 674 * 675 * @sample {highcharts} highcharts/axisbreak/break-visualized/ 676 * Visualization of a Break 677 * 678 * @type {Highcharts.AxisPointBreakEventCallbackFunction} 679 * @since 4.1.0 680 * @product highcharts gantt 681 * @context Highcharts.Axis 682 * @apioption xAxis.events.pointBreak 683 */ 684 /** 685 * An event fired when a point falls inside a break from this axis. 686 * 687 * @type {Highcharts.AxisPointBreakEventCallbackFunction} 688 * @product highcharts highstock gantt 689 * @context Highcharts.Axis 690 * @apioption xAxis.events.pointInBreak 691 */ 692 /** 693 * An event fired when a point is outside a break after zoom. 694 * 695 * @type {Highcharts.AxisPointBreakEventCallbackFunction} 696 * @product highcharts highstock gantt 697 * @context Highcharts.Axis 698 * @apioption xAxis.events.pointBreakOut 699 */ 700 /** 701 * Fires when the minimum and maximum is set for the axis, either by 702 * calling the `.setExtremes()` method or by selecting an area in the 703 * chart. One parameter, `event`, is passed to the function, 704 * containing common event information. 705 * 706 * The new user set minimum and maximum values can be found by 707 * `event.min` and `event.max`. These reflect the axis minimum and 708 * maximum in data values. When an axis is zoomed all the way out from 709 * the "Reset zoom" button, `event.min` and `event.max` are null, and 710 * the new extremes are set based on `this.dataMin` and `this.dataMax`. 711 * 712 * @sample {highstock} stock/xaxis/events-setextremes/ 713 * Log new extremes on x axis 714 * 715 * @type {Highcharts.AxisSetExtremesEventCallbackFunction} 716 * @since 1.2.0 717 * @context Highcharts.Axis 718 * @apioption xAxis.events.setExtremes 719 */ 720 /** 721 * The lowest allowed value for automatically computed axis extremes. 722 * 723 * @see [ceiling](#yAxis.ceiling) 724 * 725 * @sample {highcharts} highcharts/yaxis/floor-ceiling/ 726 * Floor and ceiling 727 * @sample {highstock} stock/demo/lazy-loading/ 728 * Prevent negative stock price on Y axis 729 * 730 * @type {number} 731 * @since 4.0 732 * @product highcharts highstock gantt 733 * @apioption xAxis.floor 734 */ 735 /** 736 * The dash or dot style of the grid lines. For possible values, see 737 * [this demonstration](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/). 738 * 739 * @sample {highcharts} highcharts/yaxis/gridlinedashstyle/ 740 * Long dashes 741 * @sample {highstock} stock/xaxis/gridlinedashstyle/ 742 * Long dashes 743 * 744 * @type {Highcharts.DashStyleValue} 745 * @since 1.2 746 */ 747 gridLineDashStyle: 'Solid', 748 /** 749 * The Z index of the grid lines. 750 * 751 * @sample {highcharts|highstock} highcharts/xaxis/gridzindex/ 752 * A Z index of 4 renders the grid above the graph 753 * 754 * @product highcharts highstock gantt 755 * 756 * @see [axis.zIndex](#xAxis.zIndex) 757 * @see [axis.labels.zIndex](#xAxis.labels.zIndex) 758 */ 759 gridZIndex: 1, 760 /** 761 * An id for the axis. This can be used after render time to get 762 * a pointer to the axis object through `chart.get()`. 763 * 764 * @sample {highcharts} highcharts/xaxis/id/ 765 * Get the object 766 * @sample {highstock} stock/xa
766xis/id/ 767 * Get the object 768 * 769 * @type {string} 770 * @since 1.2.0 771 * @apioption xAxis.id 772 */ 773 /** 774 * The axis labels show the number or category for each tick. 775 * 776 * Since v8.0.0: Labels are animated in categorized x-axis with 777 * updating data if `tickInterval` and `step` is set to 1. 778 * 779 * @productdesc {highmaps} 780 * X and Y axis labels are by default disabled in Highmaps, but the 781 * functionality is inherited from Highcharts and used on `colorAxis`, 782 * and can be enabled on X and Y axes too. 783 */ 784 labels: { 785 /** 786 * What part of the string the given position is anchored to. 787 * If `left`, the left side of the string is at the axis position. 788 * Can be one of `"left"`, `"center"` or `"right"`. Defaults to 789 * an intelligent guess based on which side of the chart the axis 790 * is on and the rotation of the label. 791 * 792 * @see [reserveSpace](#xAxis.labels.reserveSpace) 793 * 794 * @sample {highcharts} highcharts/xaxis/labels-align-left/ 795 * Left 796 * @sample {highcharts} highcharts/xaxis/labels-align-right/ 797 * Right 798 * @sample {highcharts} highcharts/xaxis/labels-reservespace-true/ 799 * Left-aligned labels on a vertical category axis 800 * 801 * @type {Highcharts.AlignValue} 802 * @apioption xAxis.labels.align 803 */ 804 /** 805 * Whether to allow the axis labels to overlap. When false, 806 * overlapping labels are hidden. 807 * 808 * @sample {highcharts} highcharts/xaxis/labels-allowoverlap-true/ 809 * X axis labels overlap enabled 810 * 811 * @type {boolean} 812 * @default false 813 * @apioption xAxis.labels.allowOverlap 814 */ 815 /** 816 * For horizontal axes, the allowed degrees of label rotation 817 * to prevent overlapping labels. If there is enough space, 818 * labels are not rotated. As the chart gets narrower, it 819 * will start rotating the labels -45 degrees, then remove 820 * every second label and try again with rotations 0 and -45 etc. 821 * Set it to `undefined` to disable rotation, which will 822 * cause the labels to word-wrap if possible. Defaults to `[-45]`` 823 * on bottom and top axes, `undefined` on left and right axes. 824 * 825 * @sample {highcharts|highstock} highcharts/xaxis/labels-autorotation-default/ 826 * Default auto rotation of 0 or -45 827 * @sample {highcharts|highstock} highcharts/xaxis/labels-autorotation-0-90/ 828 * Custom graded auto rotation 829 * 830 * @type {Array<number>} 831 * @default undefined 832 * @since 4.1.0 833 * @product highcharts highstock gantt 834 * @apioption xAxis.labels.autoRotation 835 */ 836 /** 837 * When each category width is more than this many pixels, we don't 838 * apply auto rotation. Instead, we lay out the axis label with word 839 * wrap. A lower limit makes sense when the label contains multiple 840 * short words that don't extend the available horizontal space for 841 * each label. 842 * 843 * @sample {highcharts} highcharts/xaxis/labels-autorotationlimit/ 844 * Lower limit 845 * 846 * @since 4.1.5 847 * @product highcharts gantt 848 */ 849 autoRotationLimit: 80, 850 /** 851 * The label's pixel distance from the perimeter of the plot area. 852 * On cartesian charts, this is overridden if the `labels.y` setting 853 * is set. 854 * 855 * @sample {highcharts} highcharts/yaxis/labels-distance/ 856 * Polar chart, labels centered under the arc 857 * 858 * @type {number} 859 * @product highcharts gantt 860 */ 861 distance: 15, 862 /** 863 * Enable or disable the axis labels. 864 * 865 * @sample {highcharts} highcharts/xaxis/labels-enabled/ 866 * X axis labels disabled 867 * @sample {highstock} stock/xaxis/labels-enabled/ 868 * X axis labels disabled 869 * 870 */ 871 enabled: true, 872 /**
873 * A format string for the axis label. The context is available as 874 * format string variables. For example, you can use `{text}` to 875 * insert the default formatted text. The recommended way of adding 876 * units for the label is using `text`, for example `{text} km`. 877 * 878 * To add custom numeric or datetime formatting, use `{value}` with 879 * formatting, for example `{value:.1f}` or `{value:%Y-%m-%d}`. 880 * 881 * See 882 * [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting) 883 * for more examples of formatting. 884 * 885 * The default value is not specified due to the dynamic 886 * nature of the default implementation. 887 * 888 * @sample {highcharts|highstock} highcharts/yaxis/labels-format/ 889 * Add units to Y axis label 890 * @sample {highcharts} highcharts/xaxis/labels-format-linked/ 891 * Linked category names 892 * @sample {highcharts} highcharts/xaxis/labels-format-custom/ 893 * Custom number format 894 * 895 * @type {string} 896 * @since 3.0 897 * @apioption xAxis.labels.format 898 */ 899 /** 900 * Callback JavaScript function to format the label. The value 901 * is given by `this.value`. Additional properties for `this` are 902 * `axis`, `chart`, `isFirst`, `isLast` and `text` which holds the 903 * value of the default formatter. 904 * 905 * Defaults to a built in function returning a formatted string 906 * depending on whether the axis is `category`, `datetime`, 907 * `numeric` or other. 908 * 909 * @sample {highcharts} highcharts/xaxis/labels-formatter-linked/ 910 * Linked category names 911 * @sample {highcharts} highcharts/xaxis/labels-formatter-extended/ 912 * Modified numeric labels 913 * @sample {highstock} stock/xaxis/labels-formatter/ 914 * Added units on Y axis 915 * 916 * @type {Highcharts.AxisLabelsFormatterCallbackFunction} 917 * @apioption xAxis.labels.formatter 918 */ 919 /** 920 * The number of pixels to indent the labels per level in a treegrid 921 * axis. 922 * 923 * @sample gantt/treegrid-axis/demo 924 * Indentation 10px by default. 925 * @sample gantt/treegrid-axis/indentation-0px 926 * Indentation set to 0px. 927 * 928 * @product gantt 929 */ 930 indentation: 10, 931 /** 932 * Horizontal axis only. When `staggerLines` is not set, 933 * `maxStaggerLines` defines how many lines the axis is allowed to 934 * add to automatically avoid overlapping X labels. Set to `1` to 935 * disable overlap detection. 936 * 937 * @deprecated 938 * @type {number} 939 * @default 5 940 * @since 1.3.3 941 * @apioption xAxis.labels.maxStaggerLines 942 */ 943 /** 944 * How to handle overflowing labels on horizontal axis. If set to 945 * `"allow"`, it will not be aligned at all. By default it 946 * `"justify"` labels inside the chart area. If there is room to 947 * move it, it will be aligned to the edge, else it will be removed. 948 * 949 * @since 2.2.5 950 * @validvalue ["allow", "justify"] 951 */ 952 overflow: 'justify', 953 /** 954 * The pixel padding for axis labels, to ensure white space between 955 * them. Defaults to 4 for horizontal axes, 1 for vertical. 956 * 957 * @type {number} 958 * @default undefined 959 * @product highcharts gantt 960 * @apioption xAxis.labels.padding 961 */ 962 /** 963 * Whether to reserve space for the labels. By default, space is 964 * reserved for the labels in these cases: 965 * 966 * * On all horizontal axes. 967 * * On vertical axes if `label.align` is `right` on a left-side 968 * axis or `left` on a right-side axis. 969 * * On vertical axes if `label.align` is `center`. 970 * 971 * This can be turned off when for example the labels are rendered 972 * inside the plot area instead of outside. 973 * 974 * @see [labels.align](#xAxis.labels.align) 975 * 976 * @sample {highcharts} highcharts/xaxis/labels-reservespace/ 977 * No reserved space, labels inside plot 978 * @sample {highcharts} highcharts/xaxis/labels-reservespace-true/ 979 * Left-aligned labels on a vertical category axis 980 * 981 * @type {boolean} 982 * @since 4.1.10 983 * @product highcharts highstock gantt 984 * @apioption xAxis.labels.reserveSpace 985 */ 986 reserveSpace: void 0, 987 /** 988 * Rotation of the labels in degrees. When `undefined`, the 989 * `autoRotation` option takes precedence. 990 * 991 * @sample {highcharts} highcharts/xaxis/labels-rotation/ 992 * X axis labels rotated 90° 993 * 994 * @type {number} 995 * @default 0 996 * @apioption xAxis.labels.rotation 997 */ 998 rotation: void 0, 999 /**
1000 * Horizontal axes only. The number of lines to spread the labels 1001 * over to make room or tighter labels. 0 disables staggering. 1002 * 1003 * @sample {highcharts} highcharts/xaxis/labels-staggerlines/ 1004 * Show labels over two lines 1005 * @sample {highstock} stock/xaxis/labels-staggerlines/ 1006 * Show labels over two lines 1007 * 1008 * @since 2.1 1009 */ 1010 staggerLines: 0, 1011 /** 1012 * To show only every _n_'th label on the axis, set the step to _n_. 1013 * Setting the step to 2 shows every other label. 1014 * 1015 * By default, when 0, the step is calculated automatically to avoid 1016 * overlap. To prevent this, set it to 1\. This usually only 1017 * happens on a category axis, and is often a sign that you have 1018 * chosen the wrong axis type. 1019 * 1020 * Read more at 1021 * [Axis docs](https://www.highcharts.com/docs/chart-concepts/axes) 1022 * => What axis should I use? 1023 * 1024 * @sample {highcharts} highcharts/xaxis/labels-step/ 1025 * Showing only every other axis label on a categorized 1026 * x-axis 1027 * @sample {highcharts} highcharts/xaxis/labels-step-auto/ 1028 * Auto steps on a category axis 1029 * 1030 * @since 2.1 1031 */ 1032 step: 0, 1033 /** 1034 * Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html) 1035 * to render the labels. 1036 */ 1037 useHTML: false, 1038 /** 1039 * The x position offset of all labels relative to the tick 1040 * positions on the axis. Overrides the `labels.distance` option. 1041 * 1042 * @type {number} 1043 * @apioption xAxis.labels.x 1044 */ 1045 /** 1046 * The y position offset of all labels relative to the tick 1047 * positions on the axis. Overrides the `labels.distance` option. 1048 * 1049 * @sample {highcharts} highcharts/xaxis/labels-x/ 1050 * X axis labels placed on grid lines 1051 * 1052 * @type {number} 1053 * @apioption xAxis.labels.y 1054 */ 1055 /** 1056 * The Z index for the axis labels. 1057 * 1058 * @see [axis.zIndex](#xAxis.zIndex) 1059 * @see [axis.gridZIndex](#xAxis.gridZIndex) 1060 */ 1061 zIndex: 7, 1062 /** 1063 * CSS styles for the label. Use `lineClamp` to control wrapping of 1064 * category labels. Use `textOverflow: 'none'` to prevent ellipsis 1065 * (dots). 1066 * 1067 * In styled mode, the labels are styled with the 1068 * `.highcharts-axis-labels` class. 1069 * 1070 * @sample {highcharts} highcharts/xaxis/labels-style/ 1071 * Red X axis labels 1072 * 1073 * @type {Highcharts.CSSObject} 1074 */ 1075 style: { 1076 /** @internal */ 1077 color: "#333333" /* Palette.neutralColor80 */, 1078 /** @internal */ 1079 cursor: 'default', 1080 /** 1081 * @type {number|string} 1082 */ 1083 fontSize: '0.8em', 1084 /** @internal */ 1085 textOverflow: 'ellipsis' 1086 } 1087 }, 1088 /** 1089 * The left position as the horizontal axis. If it's a number, it is 1090 * interpreted as pixel position relative to the chart. 1091 * 1092 * Since Highcharts v5.0.13: If it's a percentage string, it is 1093 * interpreted as percentages of the plot width, offset from plot area 1094 * left. 1095 * 1096 * @sample {highcharts} highcharts/xaxis/axis-position-properties 1097 * Different axis position properties 1098 * 1099 * @type {number|string} 1100 * @product highcharts highstock 1101 * @apioption xAxis.left 1102 */ 1103 /** 1104 * The top position as the vertical axis. If it's a number, it is 1105 * interpreted as pixel position relative to the chart. 1106 * 1107 * Since Highcharts 2: If it's a percentage string, it is interpreted 1108 * as percentages of the plot height, offset from plot area top. 1109 * 1110 * @sample {highcharts} highcharts/xaxis/axis-position-properties 1111 * Different axis position properties 1112 * 1113 * @type {number|string} 1114 * @product highcharts highstock 1115 * @apioption xAxis.top 1116 */ 1117 /** 1118 * Index of another axis that this axis is linked to. When an axis is 1119 * linked to a master axis, it will take the same extremes as 1120 * the master, but as assigned by min or max or by setExtremes. 1121 * It can be used to show additional info, or to ease reading the 1122 * chart by duplicating the scales. 1123 * 1124 * @sample {highcharts} highcharts/xaxis/linkedto/ 1125 * Different string formats of the same date 1126 * @sample {highcharts} highcharts/yaxis/linkedto/ 1127 * Y values on both sides 1128 * 1129 * @type {number} 1130 * @since 2.0.2 1131 * @product highcharts highstock gantt 1132 * @apioption xAxis.linkedTo 1133 */ 1134 /** 1135 * The maximum value of the axis. If `undefined`, the max value is 1136 * automatically calculated. 1137 * 1138 * If a datetime string is passed, it is parsed into epoch time 1139 * according to the time zone given in [time.timezone](#time.timezone). 1140 * 1141 * If the [endOnTick](#yAxis.endOnTick) option is true, the `max` value 1142 * might be rounded up. 1143 * 1144 * If a [tickAmount](#yAxis.tickAmount) is set, the axis may be extended 1145 * beyond the set max in order to reach the given number of ticks. The 1146 * same may happen in a chart with multiple axes, determined by [chart. 1147 * alignTicks](#chart), where a `tickAmount` is applied internally. 1148 * 1149 * @sample {highcharts} highcharts/yaxis/max-200/ 1150 * Y axis max of 200 1151 * @sample {highcharts} highcharts/yaxis/max-logarithmic/ 1152 * Y axis max on logarithmic axis 1153 * @sample {highstock} stock/xaxis/min-max/ 1154 * Fixed min and max on X axis 1155 * 1156 * @type {number|string|null} 1157 * @apioption xAxis.max 1158 */ 1159 /** 1160 * Padding of the max value relative to the length of the axis. A 1161 * padding of 0.05 will make a 100px axis 5px longer. This is useful 1162 * when you don't want the highest data value to appear on the edge 1163 * of the plot area. When the axis' `max` option is set or a max extreme 1164 * is set using `axis.setExtremes()`, the maxPadding will be ignored. 1165 * 1166 * @productdesc {highstock} 1167 * For an [ordinal](#xAxis.ordinal) axis, `minPadding` and `maxPadding` 1168 * are ignored. Use [overscroll](#xAxis.overscroll) instead. 1169 * 1170 * @sample {highcharts} highcharts/yaxis/maxpadding/ 1171 * Max padding of 0.25 on y axis 1172 * @sample {highstock} stock/xaxis/minpadding-maxpadding/ 1173 * Greater min- and maxPadding 1174 * @sample {highmaps} maps/chart/plotbackgroundcolor-gradient/ 1175 * Add some padding 1176 * 1177 * @default {highcharts} 0.01 1178 * @default {highstock|highmaps} 0 1179 * @since 1.2.0 1180 */ 1181 maxPadding: 0.01, 1182 /** 1183 * Deprecated. Use `minRange` instead. 1184 * 1185 * @deprecated 1186 * @type {number} 1187 * @product highcharts highstock 1188 * @apioption xAxis.maxZoom 1189 */ 1190 /** 1191 * The minimum value of the axis. If `undefined`, the min value is 1192 * automatically calculated. 1193 * 1194 * If a datetime string is passed, it is parsed into epoch time 1195 * according to the time zone given in [time.timezone](#time.timezone). 1196 * 1197 * If the [startOnTick](#yAxis.startOnTick) option is true (default), 1198 * the `min` value might be rounded down. 1199 * 1200 * The automatically calculated minimum value is also affected by 1201 * [floor](#yAxis.floor), [softMin](#yAxis.softMin), 1202 * [minPadding](#yAxis.minPadding), [minRange](#yAxis.minRange) 1203 * as well as [series.threshold](#plotOptions.series.threshold) 1204 * and [series.softThreshold](#plotOptions.series.softThreshold). 1205 * 1206 * @sample {highcharts} highcharts/yaxis/min-startontick-false/
1207 * -50 with startOnTick to false 1208 * @sample {highcharts} highcharts/yaxis/min-startontick-true/ 1209 * -50 with startOnTick true by default 1210 * @sample {highstock} stock/xaxis/min-max/ 1211 * Set min and max on X axis 1212 * 1213 * @type {number|string|null} 1214 * @apioption xAxis.min 1215 */ 1216 /** 1217 * The dash or dot style of the minor grid lines. For possible values, 1218 * see [this demonstration](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/). 1219 * 1220 * @sample {highcharts} highcharts/yaxis/minorgridlinedashstyle/ 1221 * Long dashes on minor grid lines 1222 * @sample {highstock} stock/xaxis/minorgridlinedashstyle/ 1223 * Long dashes on minor grid lines 1224 * 1225 * @type {Highcharts.DashStyleValue} 1226 * @since 1.2 1227 */ 1228 minorGridLineDashStyle: 'Solid', 1229 /** 1230 * Specific tick interval in axis units for the minor ticks. On a linear 1231 * axis, if `"auto"`, the minor tick interval is calculated as a fifth 1232 * of the tickInterval. If `undefined`, minor ticks are not shown. 1233 * 1234 * On logarithmic axes, the unit is the power of the value. For example, 1235 * setting the minorTickInterval to 1 puts one tick on each of 0.1, 1, 1236 * 10, 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks 1237 * between 1 and 10, 10 and 100 etc. 1238 * 1239 * If user settings dictate minor ticks to become too dense, they don't 1240 * make sense, and will be ignored to prevent performance problems. 1241 * 1242 * @sample {highcharts} highcharts/yaxis/minortickinterval-null/ 1243 * Undefined by default 1244 * @sample {highcharts} highcharts/yaxis/minortickinterval-5/ 5 units 1245 * @sample {highcharts} highcharts/yaxis/minortickinterval-log-auto/ 1246 * "auto" 1247 * @sample {highcharts} highcharts/yaxis/minortickinterval-log/ 0.1 1248 * @sample {highstock} stock/demo/basic-line/ Null by default 1249 * @sample {highstock} stock/xaxis/minortickinterval-auto/ "auto" 1250 * 1251 * @type {number|'auto'} 1252 * @apioption xAxis.minorTickInterval 1253 */ 1254 /** 1255 * The pixel length of the minor tick marks. 1256 * 1257 * @sample {highcharts} highcharts/yaxis/minorticklength/ 1258 * 10px on Y axis 1259 * @sample {highstock} stock/xaxis/minorticks/ 1260 * 10px on Y axis 1261 */ 1262 minorTickLength: 2, 1263 /** 1264 * The position of the minor tick marks relative to the axis line. 1265 * Can be one of `inside` and `outside`. 1266 * 1267 * @sample {highcharts} highcharts/yaxis/minortickposition-outside/ 1268 * Outside by default 1269 * @sample {highcharts} highcharts/yaxis/minortickposition-inside/ 1270 * Inside 1271 * @sample {highstock} stock/xaxis/minorticks/ 1272 * Inside 1273 * 1274 * @validvalue ["inside", "outside"] 1275 */ 1276 minorTickPosition: 'outside', 1277 /** 1278 * Enable or disable minor ticks. The interval between the minor ticks 1279 * can be controlled either by the 1280 * [minorTicksPerMajor](#xAxis.minorTicksPerMajor) setting, or as an 1281 * absolute [minorTickInterval](#xAxis.minorTickInterval) value. 1282 * 1283 * On a logarithmic axis, minor ticks are laid out based on a best 1284 * guess, attempting to enter an approximate number of minor ticks 1285 * between each major tick based on 1286 * [minorTicksPerMajor](#xAxis.minorTicksPerMajor). 1287 * 1288 * Prior to v6.0.0, ticks were enabled in auto layout by setting 1289 * `minorTickInterval` to `"auto"`. 1290 * 1291 * @productdesc {highcharts} On axes using 1292 * [categories](#xAxis.categories), minor ticks are not supported. 1293 * 1294 * @sample {highcharts} highcharts/yaxis/minorticks-true/ Enabled on 1295 * linear Y axis 1296 * 1297 * @type {boolean} 1298 * @default false 1299 * @since 6.0.0 1300 * @apioption xAxis.minorTicks 1301 */ 1302 /** 1303 * The number of minor ticks per major tick. Works for `linear`, 1304 * `logarithmic` and `datetime` axes. 1305 * 1306 * @sample {highcharts} highcharts/yaxis/minortickspermajor/ 1307 * 2 minor ticks per major tick on Y axis 1308 * 1309 * @since 11.0.0 1310 * 1311 * @type {number} 1312 */ 1313 minorTicksPerMajor: 5, 1314 /** 1315 * The pixel width of the minor tick mark. 1316 * 1317 * @sample {highcharts} highcharts/yaxis/minortickwidth/ 1318 * 3px width 1319 * @sample {highstock} stock/xaxis/minorticks/ 1320 * 1px width 1321 * 1322 * @type {number} 1323 * @default 0 1324 * @apioption xAxis.minorTickWidth 1325 */ 1326 /** 1327 * Padding of the min value relative to the length of the axis. A 1328 * padding of 0.05 will make a 100px axis 5px longer. This is useful 1329 * when you don't want the lowest data value to appear on the edge 1330 * of the plot area. When the axis' `min` option is set or a min extreme 1331 * is set using `axis.setExtremes()`, the minPadding will be ignored. 1332 * 1333 * @productdesc {highstock} 1334 * For an [ordinal](#xAxis.ordinal) axis, `minPadding` and `maxPadding` 1335 * are ignored. Use [overscroll](#xAxis.overscroll) instead. 1336 * 1337 * @sample {highcharts} highcharts/yaxis/minpadding/ 1338 * Min padding of 0.2 1339 * @sample {highstock} stock/xaxis/minpadding-maxpadding/ 1340 * Greater min- and maxPadding 1341 * @sample {highmaps} maps/chart/plotbackgroundcolor-gradient/ 1342 * Add some padding 1343 * 1344 * @default {highcharts} 0.01 1345 * @default {highstock|highmaps} 0 1346 * @since 1.2.0 1347 * @product highcharts highstock gantt 1348 */ 1349 minPadding: 0.01, 1350 /** 1351 * The minimum range to display on this axis. The entire axis will not 1352 * be allowed to span over a smaller interval than this. For example, 1353 * for a datetime axis the main unit is milliseconds. If minRange is 1354 * set to 3600000, you can't zoom in more than to one hour. 1355 * 1356 * The default minRange for the x axis is five times the smallest 1357 * interval between any of the data points. 1358 * 1359 * On a logarithmic axis, the unit for the minimum range is the power. 1360 * So a minRange of 1 means that the axis can be zoomed to 10-100, 1361 * 100-1000, 1000-10000 etc. 1362 * 1363 * **Note**: The `minPadding`, `maxPadding`, `startOnTick` and 1364 * `endOnTick` settings also affect how the extremes of the axis 1365 * are computed. 1366 * 1367 * @sample {highcharts} highcharts/xaxis/minrange/ 1368 * Minimum range of 5 1369 * @sample {highstock} stock/xaxis/minrange/ 1370 * Max zoom of 6 months overrides user selections 1371 * 1372 * @type {number} 1373 * @apioption xAxis.minRange 1374 */ 1375 /** 1376 * The minimum tick interval allowed in axis values. For example on 1377 * zooming in on an axis with daily data, this can be used to prevent 1378 * the axis from showing hours. Defaults to the closest distance between 1379 * two points on the axis. 1380 * 1381 * @type {number} 1382 * @since 2.3.0 1383 * @apioption xAxis.minTickInterval 1384 */ 1385 /** 1386 * The distance in pixels from the plot area to the axis line. 1387 * A positive offset moves the axis with it's line, labels and ticks 1388 * away from the plot area. This is typically used when two or more 1389 * axes are displayed on the same side of the plot. With multiple 1390 * axes the offset is dynamically adjusted to avoid collision, this 1391 * can be overridden by setting offset explicitly. 1392 * 1393 * @sample {highcharts} highcharts/yaxis/offset/ 1394 * Y axis offset of 70 1395 * @sample {highcharts} highcharts/yaxis/offset-centered/ 1396 * Axes positioned in the center of the plot 1397 * @sample {highstock} stock/xaxis/offset/ 1398 * Y axis offset by 70 px 1399 * 1400 * @type {number} 1401 */ 1402 offset: void 0, 1403 /** 1404 * Whether to display the axis on the opposite side of the normal. The 1405 * normal is on the left side for vertical axes and bottom for 1406 * horizontal, so the opposite sides will be right and top respectively. 1407 * This is typically used with dual or multiple axes. 1408 * 1409 * @sample {highcharts} highcharts/yaxis/opposite/ 1410 * Secondary Y axis opposite 1411 * @sample {highstock} stock/xaxis/opposite/ 1412 * Y axis on left side 1413 * 1414 * @default {highcharts|highstock|highmaps} false 1415 * @default {gantt} true 1416 * @type Boolean
vendor: 11,570 bytes, lines 1416-1701
1416 1417 * @apioption xAxis.opposite 1418 */ 1419 /** 1420 * In an ordinal axis, the points are equally spaced in the chart 1421 * regardless of the actual time or x distance between them. This means 1422 * that missing data periods (e.g. nights or weekends for a stock chart) 1423 * will not take up space in the chart. 1424 * Having `ordinal: false` will show any gaps created by the `gapSize` 1425 * setting proportionate to their duration. 1426 * 1427 * In stock charts the X axis is ordinal by default, unless 1428 * the boost module is used and at least one of the series' data length 1429 * exceeds the [boostThreshold](#series.line.boostThreshold). 1430 * 1431 * For an ordinal axis, `minPadding` and `maxPadding` are ignored. Use 1432 * [overscroll](#xAxis.overscroll) instead. 1433 * 1434 * @sample {highstock} stock/xaxis/ordinal-true/ 1435 * True by default 1436 * @sample {highstock} stock/xaxis/ordinal-false/ 1437 * False 1438 * 1439 * @see [overscroll](#xAxis.overscroll) 1440 * 1441 * @type {boolean} 1442 * @default true 1443 * @since 1.1 1444 * @product highstock 1445 * @apioption xAxis.ordinal 1446 */ 1447 /** 1448 * Additional range on the right side of the xAxis. Works similar to 1449 * `xAxis.maxPadding`, but the value is set in terms of axis values, 1450 * percentage or pixels. 1451 * 1452 * If it's a number, it is interpreted as axis values, which in a 1453 * datetime axis equals milliseconds. 1454 * 1455 * If it's a percentage string, is interpreted as percentages of axis 1456 * length. An overscroll of 50% will make a 100px axis 50px longer. 1457 * 1458 * If it's a pixel string, it is interpreted as a fixed pixel value, but 1459 * limited to 90% of the axis length. 1460 * 1461 * @sample {highstock} stock/xaxis/overscroll/ One minute overscroll 1462 * with live data 1463 * @sample {highstock} stock/xaxis/overscroll-percent/ Overscroll set in 1464 * percentage 1465 * @sample {highstock} stock/xaxis/overscroll-pixel/ Overscroll set in 1466 * pixels 1467 * 1468 * @type {number | string} 1469 * @default 0 1470 * @since 6.0.0 1471 * @product highstock 1472 * @apioption xAxis.overscroll 1473 */ 1474 /** 1475 * Refers to the index in the [panes](#panes) array. Used for circular 1476 * gauges and polar charts. When the option is not set then first pane 1477 * will be used. 1478 * 1479 * @sample highcharts/demo/gauge-vu-meter 1480 * Two gauges with different center 1481 * 1482 * @type {number} 1483 * @product highcharts 1484 * @apioption xAxis.pane 1485 */ 1486 /** 1487 * The zoomed range to display when only defining one or none of `min` 1488 * or `max`. For example, to show the latest month, a range of one month 1489 * can be set. 1490 * 1491 * @sample {highstock} stock/xaxis/range/ 1492 * Setting a zoomed range when the rangeSelector is disabled 1493 * 1494 * @type {number} 1495 * @product highstock 1496 * @apioption xAxis.range 1497 */ 1498 /** 1499 * Whether to reverse the axis so that the highest number is closest 1500 * to the origin. If the chart is inverted, the x axis is reversed by 1501 * default. 1502 * 1503 * @sample {highcharts} highcharts/yaxis/reversed/ 1504 * Reversed Y axis 1505 * @sample {highstock} stock/xaxis/reversed/ 1506 * Reversed Y axis 1507 * 1508 * @type {boolean} 1509 * @default undefined 1510 * @apioption xAxis.reversed 1511 */ 1512 reversed: void 0, 1513 /** 1514 * This option determines how stacks should be ordered within a group. 1515 * For example reversed xAxis also reverses stacks, so first series 1516 * comes last in a group. To keep order like for non-reversed xAxis 1517 * enable this option. 1518 * 1519 * @sample {highcharts} highcharts/xaxis/reversedstacks/ 1520 * Reversed stacks comparison 1521 * @sample {highstock} highcharts/xaxis/reversedstacks/ 1522 * Reversed stacks comparison 1523 * 1524 * @since 6.1.1 1525 * @product highcharts highstock 1526 */ 1527 reversedStacks: false, 1528 /** 1529 * An optional scrollbar to display on the X axis in response to 1530 * limiting the minimum and maximum of the axis values. 1531 * 1532 * In styled mode, all the presentational options for the scrollbar are 1533 * replaced by the classes `.highcharts-scrollbar-thumb`, 1534 * `.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`, 1535 * `.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`. 1536 * 1537 * @sample {highstock} stock/yaxis/heatmap-scrollbars/ 1538 * Heatmap with both scrollbars 1539 * 1540 * @extends scrollbar 1541 * @since 4.2.6 1542 * @product highstock 1543 * @apioption xAxis.scrollbar 1544 */ 1545 /** 1546 * Whether to show the axis line and title when the axis has no data. 1547 * 1548 * @sample {highcharts} highcharts/yaxis/showempty/ 1549 * When clicking the legend to hide series, one axis preserves 1550 * line and title, the other doesn't 1551 * @sample {highstock} highcharts/yaxis/showempty/ 1552 * When clicking the legend to hide series, one axis preserves 1553 * line and title, the other doesn't 1554 * 1555 * @since 1.1 1556 */ 1557 showEmpty: true, 1558 /** 1559 * Whether to show the first tick label. 1560 * 1561 * @sample {highcharts} highcharts/xaxis/showfirstlabel-false/ 1562 * Set to false on X axis 1563 * @sample {highstock} stock/xaxis/showfirstlabel/ 1564 * Labels below plot lines on Y axis 1565 */ 1566 showFirstLabel: true, 1567 /** 1568 * Whether to show the last tick label. Defaults to `true` on cartesian 1569 * charts, and `false` on polar charts. 1570 * 1571 * @sample {highcharts} highcharts/xaxis/showlastlabel-true/ 1572 * Set to true on X axis 1573 * @sample {highstock} stock/xaxis/showfirstlabel/ 1574 * Labels below plot lines on Y axis 1575 * 1576 * @type {boolean} 1577 * @default undefined 1578 * @product highcharts highstock gantt 1579 */ 1580 showLastLabel: true, 1581 /** 1582 * A soft maximum for the axis. If the series data maximum is less than 1583 * this, the axis will stay at this maximum, but if the series data 1584 * maximum is higher, the axis will flex to show all data. 1585 * 1586 * @sample highcharts/yaxis/softmin-softmax/ 1587 * Soft min and max 1588 * 1589 * @type {number} 1590 * @since 5.0.1 1591 * @product highcharts highstock gantt 1592 * @apioption xAxis.softMax 1593 */ 1594 /** 1595 * A soft minimum for the axis. If the series data minimum is greater 1596 * than this, the axis will stay at this minimum, but if the series 1597 * data minimum is lower, the axis will flex to show all data. 1598 * 1599 * @sample highcharts/yaxis/softmin-softmax/ 1600 * Soft min and max 1601 * 1602 * @type {number} 1603 * @since 5.0.1 1604 * @product highcharts highstock gantt 1605 * @apioption xAxis.softMin 1606 */ 1607 /** 1608 * For datetime axes, this decides where to put the tick between weeks. 1609 * 0 = Sunday, 1 = Monday. 1610 * 1611 * @sample {highcharts} highcharts/xaxis/startofweek-monday/ 1612 * Monday by default 1613 * @sample {highcharts} highcharts/xaxis/startofweek-sunday/ 1614 * Sunday 1615 * @sample {highstock} stock/xaxis/startofweek-1 1616 * Monday by default 1617 * @sample {highstock} stock/xaxis/startofweek-0 1618 * Sunday 1619 * 1620 * @product highcharts highstock gantt 1621 */ 1622 startOfWeek: 1, 1623 /** 1624 * Whether to force the axis to start on a tick. Use this option with 1625 * the `minPadding` option to control the axis start. 1626 * 1627 * @productdesc {highstock} 1628 * In Highcharts Stock, `startOnTick` is always `false` when 1629 * the navigator is enabled, to prevent jumpy scrolling. 1630 * 1631 * @sample {highcharts} highcharts/xaxis/startontick-false/ 1632 * False by default 1633 * @sample {highcharts} highcharts/xaxis/startontick-true/ 1634 * True 1635 * 1636 * @since 1.2.0 1637 */ 1638 startOnTick: false, 1639 /** 1640 * The amount of ticks to draw on the axis. This opens up for aligning 1641 * the ticks of multiple charts or panes within a chart. This option 1642 * overrides the `tickPixelInterval` option. 1643 * 1644 * This option only has an effect on linear axes. Datetime, logarithmic 1645 * or category axes are not affected. 1646 * 1647 * @sample {highcharts} highcharts/yaxis/tickamount/ 1648 * 8 ticks on Y axis 1649 * @sample {highstock} highcharts/yaxis/tickamount/ 1650 * 8 ticks on Y axis 1651 * 1652 * @type {number} 1653 * @since 4.1.0 1654 * @product highcharts highstock gantt 1655 * @apioption xAxis.tickAmount 1656 */ 1657 /** 1658 * The interval of the tick marks in axis units. When `undefined`, the 1659 * tick interval is computed to approximately follow the 1660 * [tickPixelInterval](#xAxis.tickPixelInterval) on linear and datetime 1661 * axes. On categorized axes, a `undefined` tickInterval will default to 1662 * 1, one category. Note that datetime axes are based on milliseconds, 1663 * so for example an interval of one day is expressed as 1664 * `24 * 3600 * 1000`. 1665 * 1666 * On logarithmic axes, the tickInterval is based on powers, so a 1667 * tickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A 1668 * tickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval 1669 * of 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20, 1670 * 40 etc. 1671 * 1672 * 1673 * If the tickInterval is too dense for labels to be drawn, Highcharts 1674 * may remove ticks. 1675 * 1676 * If the chart has multiple axes, the [alignTicks](#chart.alignTicks) 1677 * option may interfere with the `tickInterval` setting. 1678 * 1679 * @see [tickPixelInterval](#xAxis.tickPixelInterval) 1680 * @see [tickPositions](#xAxis.tickPositions) 1681 * @see [tickPositioner](#xAxis.tickPositioner) 1682 * 1683 * @sample {highcharts} highcharts/xaxis/tickinterval-5/ 1684 * Tick interval of 5 on a linear axis 1685 * @sample {highstock} stock/xaxis/tickinterval/ 1686 * Tick interval of 0.01 on Y axis 1687 * 1688 * @type {number} 1689 * @apioption xAxis.tickInterval 1690 */ 1691 /** 1692 * The pixel length of the main tick marks. 1693 * 1694 * @sample {highcharts} highcharts/xaxis/ticklength/ 1695 * 20 px tick length on the X axis 1696 * @sample {highstock} stock/xaxis/ticks/ 1697 * Formatted ticks on X axis 1698 */ 1699 tickLength: 10, 1700 /** 1701 *
1701If tickInterval is `null` this option sets the approximate pixel 1702 * interval of the tick marks. Not applicable to categorized axis. 1703 * 1704 * The tick interval is also influenced by the [minTickInterval]( 1705 * #xAxis.minTickInterval) option, that, by default prevents ticks from 1706 * being denser than the data points. 1707 * 1708 * @see [tickInterval](#xAxis.tickInterval) 1709 * @see [tickPositioner](#xAxis.tickPositioner) 1710 * @see [tickPositions](#xAxis.tickPositions) 1711 * 1712 * @sample {highcharts} highcharts/xaxis/tickpixelinterval-50/ 1713 * 50 px on X axis 1714 * @sample {highstock} stock/xaxis/tickpixelinterval/ 1715 * 200 px on X axis 1716 */ 1717 tickPixelInterval: 100, 1718 /** 1719 * For categorized axes only. If `on` the tick mark is placed in the 1720 * center of the category, if `between` the tick mark is placed between 1721 * categories. The default is `between` if the `tickInterval` is 1, else 1722 * `on`. In order to render tick marks on a category axis it is necessary 1723 * to provide a [tickWidth](#xAxis.tickWidth). 1724 * 1725 * @sample {highcharts} highcharts/xaxis/tickmarkplacement-between/ 1726 * "between" by default 1727 * @sample {highcharts} highcharts/xaxis/tickmarkplacement-on/ 1728 * "on" 1729 * 1730 * @product highcharts gantt 1731 * @validvalue ["on", "between"] 1732 */ 1733 tickmarkPlacement: 'between', 1734 /** 1735 * The position of the major tick marks relative to the axis line. 1736 * Can be one of `inside` and `outside`. 1737 * 1738 * @sample {highcharts} highcharts/xaxis/tickposition-outside/ 1739 * "outside" by default 1740 * @sample {highcharts} highcharts/xaxis/tickposition-inside/ 1741 * "inside" 1742 * @sample {highstock} stock/xaxis/ticks/ 1743 * Formatted ticks on X axis 1744 * 1745 * @validvalue ["inside", "outside"] 1746 */ 1747 tickPosition: 'outside', 1748 /** 1749 * A callback function returning array defining where the ticks are 1750 * laid out on the axis. This overrides the default behaviour of 1751 * [tickPixelInterval](#xAxis.tickPixelInterval) and [tickInterval]( 1752 * #xAxis.tickInterval). The automatic tick positions are accessible 1753 * through `this.tickPositions` and can be modified by the callback. 1754 * 1755 * @see [tickPositions](#xAxis.tickPositions) 1756 * 1757 * @sample {highcharts} highcharts/xaxis/tickpositions-tickpositioner/ 1758 * Demo of tickPositions and tickPositioner 1759 * @sample {highstock} highcharts/xaxis/tickpositions-tickpositioner/ 1760 * Demo of tickPositions and tickPositioner 1761 * 1762 * @type {Highcharts.AxisTickPositionerCallbackFunction} 1763 * @apioption xAxis.tickPositioner 1764 */ 1765 /** 1766 * An array defining where the ticks are laid out on the axis. This 1767 * overrides the default behaviour of [tickPixelInterval]( 1768 * #xAxis.tickPixelInterval) and [tickInterval](#xAxis.tickInterval). 1769 * 1770 * @see [tickPositioner](#xAxis.tickPositioner) 1771 * 1772 * @sample {highcharts} highcharts/xaxis/tickpositions-tickpositioner/ 1773 * Demo of tickPositions and tickPositioner 1774 * @sample {highstock} highcharts/xaxis/tickpositions-tickpositioner/ 1775 * Demo of tickPositions and tickPositioner 1776 * 1777 * @type {Array<number>} 1778 * @apioption xAxis.tickPositions 1779 */ 1780 /** 1781 * The pixel width of the major tick marks. Defaults to 0 on category 1782 * axes, otherwise 1. 1783 * 1784 * In styled mode, the stroke width is given in the `.highcharts-tick` 1785 * class, but in order for the element to be generated on category axes, 1786 * the option must be explicitly set to 1. 1787 * 1788 * @sample {highcharts} highcharts/xaxis/tickwidth/ 1789 * 10 px width 1790 * @sample {highcharts}
1790 highcharts/css/axis-grid/ 1791 * Styled mode 1792 * @sample {highstock} stock/xaxis/ticks/ 1793 * Formatted ticks on X axis 1794 * @sample {highstock} highcharts/css/axis-grid/ 1795 * Styled mode 1796 * 1797 * @type {undefined|number} 1798 * @default {highstock} 1 1799 * @default {highmaps} 0 1800 * @apioption xAxis.tickWidth 1801 */ 1802 /** 1803 * The axis title, showing next to the axis line. 1804 * 1805 * @productdesc {highmaps} 1806 * In Highmaps, the axis is hidden by default, but adding an axis title 1807 * is still possible. X axis and Y axis titles will appear at the bottom 1808 * and left by default. 1809 */ 1810 title: { 1811 /** 1812 * Alignment of the title relative to the axis values. Possible 1813 * values are "low", "middle" or "high". 1814 * 1815 * @sample {highcharts} highcharts/xaxis/title-align-low/ 1816 * "low" 1817 * @sample {highcharts} highcharts/xaxis/title-align-center/ 1818 * "middle" by default 1819 * @sample {highcharts} highcharts/xaxis/title-align-high/ 1820 * "high" 1821 * @sample {highcharts} highcharts/yaxis/title-offset/ 1822 * Place the Y axis title on top of the axis 1823 * @sample {highstock} stock/xaxis/title-align/ 1824 * Aligned to "high" value 1825 * 1826 * @type {Highcharts.AxisTitleAlignValue} 1827 */ 1828 align: 'middle', 1829 /** 1830 * Deprecated. Set the `text` to `undefined` to disable the title. 1831 * 1832 * @deprecated 1833 * @type {boolean} 1834 * @product highcharts 1835 * @apioption xAxis.title.enabled 1836 */ 1837 /** 1838 * The pixel distance between the axis labels or line and the title. 1839 * Defaults to 0 for horizontal axes, 10 for vertical 1840 * 1841 * @sample {highcharts} highcharts/xaxis/title-margin/ 1842 * Y axis title margin of 60 1843 * 1844 * @type {number} 1845 * @apioption xAxis.title.margin 1846 */ 1847 /** 1848 * The distance of the axis title from the axis line. By default, 1849 * this distance is computed from the offset width of the labels, 1850 * the labels' distance from the axis and the title's margin. 1851 * However when the offset option is set, it overrides all this. 1852 * 1853 * @sample {highcharts} highcharts/yaxis/title-offset/ 1854 * Place the axis title on top of the axis 1855 * @sample {highstock} highcharts/yaxis/title-offset/ 1856 * Place the axis title on top of the Y axis 1857 * 1858 * @type {number} 1859 * @since 2.2.0 1860 * @apioption xAxis.title.offset 1861 */ 1862 /** 1863 * Whether to reserve space for the title when laying out the axis. 1864 * 1865 * @type {boolean} 1866 * @default true 1867 * @since 5.0.11 1868 * @product highcharts highstock gantt 1869 * @apioption xAxis.title.reserveSpace 1870 */ 1871 /** 1872 * The rotation of the text in degrees. 0 is horizontal, 270 is 1873 * vertical reading from bottom to top. Defaults to 0 for horizontal 1874 * axes, 270 for left-side axes and 90 for right-side axes. 1875 * 1876 * @sample {highcharts} highcharts/yaxis/title-offset/ 1877 * Horizontal 1878 * 1879 * @type {number} 1880 * @default undefined 1881 * @apioption xAxis.title.rotation 1882 */ 1883 /** 1884 * The actual text of the axis title. It can contain basic HTML tags 1885 * like `b`, `i` and `span` with style. 1886 * 1887 * @sample {highcharts} highcharts/xaxis/title-text/ 1888 * Custom HTML 1889 * @sample {highstock} stock/xaxis/title-text/ 1890 * Titles for both axes 1891 * 1892 * @type {string|null} 1893 * @apioption xAxis.title.text 1894 */ 1895 /** 1896 * Alignment of the text, can be `"left"`, `"right"` or `"center"`. 1897 * Default alignment depends on the 1898 * [title.align](xAxis.title.align): 1899 * 1900 * Horizontal axes: 1901 * - for `align` = `"low"`, `textAlign` is set to `left` 1902 * - for `align` = `"middle"`, `textAlign` is set to `center` 1903 * - for `align` = `"high"`, `textAlign` is set to `right` 1904 * 1905 * Vertical axes: 1906 * - for `align` = `"low"` and `opposite` = `true`, `textAlign` is 1907 * set to `right` 1908 * - for `align` = `"low"` and `opposite` = `false`, `textAlign` is 1909 * set to `left` 1910 * - for `align` = `"middle"`, `textAlign` is set to `center` 1911 * - for `align` = `"high"` and `opposite` = `true` `textAlign` is 1912 * set to `left` 1913 * - for `align` = `"high"` and `opposite` = `false` `textAlign` is 1914 * set to `right` 1915 * 1916 * @type {Highcharts.AlignValue} 1917 * @apioption xAxis.title.textAlign 1918 */ 1919 /** 1920 * Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html) 1921 * to render the axis title. 1922 * 1923 * @product highcharts highstock gantt 1924 */
1925 useHTML: false, 1926 /** 1927 * Horizontal pixel offset of the title position. 1928 * 1929 * @since 4.1.6 1930 * @product highcharts highstock gantt 1931 */ 1932 x: 0, 1933 /** 1934 * Vertical pixel offset of the title position. 1935 * 1936 * @product highcharts highstock gantt 1937 */ 1938 y: 0, 1939 /** 1940 * CSS styles for the title. If the title text is longer than the 1941 * axis length, it will wrap to multiple lines by default. This can 1942 * be customized by setting the `lineClamp` property, by setting a 1943 * specific `width` or by setting `whiteSpace: 'nowrap'`. 1944 * 1945 * In styled mode, the stroke width is given in the 1946 * `.highcharts-axis-title` class. 1947 * 1948 * @sample {highcharts} highcharts/xaxis/title-style/ 1949 * Red 1950 * @sample {highcharts} highcharts/css/axis/ 1951 * Styled mode 1952 * 1953 * @type {Highcharts.CSSObject} 1954 */ 1955 style: { 1956 /** @internal */ 1957 color: "#666666" /* Palette.neutralColor60 */, 1958 /** 1959 * @type {number|string} 1960 */ 1961 fontSize: '0.8em' 1962 } 1963 }, 1964 /** 1965 * The type of axis. Can be one of `linear`, `logarithmic`, `datetime` 1966 * or `category`. In a datetime axis, the numbers are given in 1967 * milliseconds, and tick marks are placed on appropriate values like 1968 * full hours or days. In a category axis, the 1969 * [point names](#series.line.data.name) of the chart's series are used 1970 * for categories, if not a [categories](#xAxis.categories) array is 1971 * defined. 1972 * 1973 * @sample {highcharts} highcharts/xaxis/type-linear/ 1974 * Linear 1975 * @sample {highcharts} highcharts/yaxis/type-log/ 1976 * Logarithmic 1977 * @sample {highcharts} highcharts/yaxis/type-log-minorgrid/ 1978 * Logarithmic with minor grid lines 1979 * @sample {highcharts} highcharts/xaxis/type-log-both/ 1980 * Logarithmic on two axes 1981 * @sample {highcharts} highcharts/yaxis/type-log-negative/ 1982 * Logarithmic with extension to emulate negative values 1983 * 1984 * @type {Highcharts.AxisTypeValue} 1985 * @default linear 1986 * @product highcharts gantt
1987 * @apioption xAxis.type 1988 */ 1989 /** 1990 * If there are multiple axes on the same side of the chart, the pixel 1991 * margin between the axes. Defaults to 0 on vertical axes, 15 on 1992 * horizontal axes. 1993 * 1994 * @type {number} 1995 * @since 7.0.3 1996 * @apioption xAxis.margin 1997 */ 1998 /** 1999 * Applies only when the axis `type` is `category`. When `uniqueNames` 2000 * is true, points are placed on the X axis according to their names. 2001 * If the same point name is repeated in the same or another series, 2002 * the point is placed on the same X position as other points of the 2003 * same name. When `uniqueNames` is false, the points are laid out in 2004 * increasing X positions regardless of their names, and the X axis 2005 * category will take the name of the last point in each position. 2006 * 2007 * @sample {highcharts} highcharts/xaxis/uniquenames-true/ 2008 * True by default 2009 * @sample {highcharts} highcharts/xaxis/uniquenames-false/ 2010 * False 2011 * 2012 * @since 4.2.7 2013 * @product highcharts gantt 2014 * @type {boolean} 2015 * @default true 2016 * @apioption xAxis.uniqueNames 2017 */ 2018 /** 2019 * Datetime axis only. An array determining what time intervals the 2020 * ticks are allowed to fall on. Each array item is an array where the 2021 * first value is the time unit and the second value another array of 2022 * allowed multiples. 2023 * 2024 * Defaults to: 2025 * ```js 2026 * units: [[ 2027 * 'millisecond', // unit name 2028 * [1, 2, 5, 10, 20, 25, 50, 100, 200, 500] // allowed multiples 2029 * ], [ 2030 * 'second', 2031 * [1, 2, 5, 10, 15, 30] 2032 * ], [ 2033 * 'minute', 2034 * [1, 2, 5, 10, 15, 30] 2035 * ], [ 2036 * 'hour', 2037 * [1, 2, 3, 4, 6, 8, 12] 2038 * ], [ 2039 * 'day', 2040 * [1, 2] 2041 * ], [ 2042 * 'week', 2043 * [1, 2] 2044 * ], [ 2045 * 'month', 2046 * [1, 2, 3, 4, 6] 2047 * ], [ 2048 * 'year', 2049 * null 2050 * ]] 2051 * ``` 2052 * 2053 * @sample {highcharts} highcharts/xaxis/units/ 2054 * Axis units demonstrated 2055 * 2056 * @type {Array<Array<string,(Array<number>|null)>>} 2057 * @product highcharts highstock gantt 2058 * @apioption xAxis.units 2059 */ 2060 /** 2061 * Whether axis, including axis title, line, ticks and labels, should 2062 * be visible. 2063 * 2064 * @since 4.1.9 2065 * @product highcharts highstock gantt 2066 */ 2067 visible: true, 2068 /** 2069 * Color of the minor, secondary grid lines. 2070 * 2071 * In styled mode, the stroke width is given in the 2072 * `.highcharts-minor-grid-line` class. 2073 * 2074 * @sample {highcharts} highcharts/yaxis/minorgridlinecolor/ 2075 * Bright grey lines from Y axis 2076 * @sample {highcharts|highstock} highcharts/css/axis-grid/ 2077 * Styled mode 2078 * @sample {highstock} stock/xaxis/minorgridlinecolor/ 2079 * Bright grey lines from Y axis 2080 * 2081 * @type {Highcharts.ColorType} 2082 * @default #f2f2f2 2083 */ 2084 minorGridLineColor: "#f2f2f2" /* Palette.neutralColor5 */, 2085 /** 2086 * Width of the minor, secondary grid lines. 2087 * 2088 * In styled mode, the stroke width is given in the 2089 * `.highcharts-grid-line` class. 2090 * 2091 * @sample {highcharts} highcharts/yaxis/minorgridlinewidth/ 2092 * 2px lines from Y axis 2093 * @sample {highcharts|highstock} highcharts/css/axis-grid/ 2094 * Styled mode 2095 * @sample {highstock} stock/xaxis/minorgridlinewidth/ 2096 * 2px lines from Y axis 2097 */ 2098 minorGridLineWidth: 1, 2099 /** 2100 * Color for the minor tick marks. 2101 * 2102 * @sample {highcharts} highcharts/yaxis/minortickcolor/ 2103 * Black tick marks on Y axis 2104 * @sample {highstock} stock/xaxis/minorticks/ 2105 * Black tick marks on Y axis 2106 * 2107 * @type {Highcharts.ColorType} 2108 * @default #999999 2109 */ 2110 minorTickColor: "#999999" /* Palette.neutralColor40 */, 2111 /** 2112 * The color of the line marking the axis itself. 2113 *
2114 * In styled mode, the line stroke is given in the 2115 * `.highcharts-axis-line` or `.highcharts-xaxis-line` class. 2116 * 2117 * @sample {highcharts} highcharts/yaxis/linecolor/ 2118 * A red line on Y axis 2119 * @sample {highcharts|highstock} highcharts/css/axis/ 2120 * Axes in styled mode 2121 * @sample {highstock} stock/xaxis/linecolor/ 2122 * A red line on X axis 2123 * 2124 * @type {Highcharts.ColorType} 2125 */ 2126 lineColor: "#333333" /* Palette.neutralColor80 */, 2127 /** 2128 * The width of the line marking the axis itself. 2129 * 2130 * In styled mode, the stroke width is given in the 2131 * `.highcharts-axis-line` or `.highcharts-xaxis-line` class. 2132 * 2133 * @sample {highcharts} highcharts/yaxis/linecolor/ 2134 * A 1px line on Y axis 2135 * @sample {highcharts|highstock} highcharts/css/axis/ 2136 * Axes in styled mode 2137 * @sample {highstock} stock/xaxis/linewidth/ 2138 * A 2px line on X axis 2139 * 2140 * @default {highcharts|highstock} 1 2141 * @default {highmaps} 0 2142 */ 2143 lineWidth: 1, 2144 /** 2145 * Color of the grid lines extending the ticks across the plot area. 2146 * 2147 * In styled mode, the stroke is given in the `.highcharts-grid-line` 2148 * class. 2149 * 2150 * @productdesc {highmaps} 2151 * In Highmaps, the grid lines are hidden by default. 2152 * 2153 * @sample {highcharts} highcharts/yaxis/gridlinecolor/ 2154 * Green lines 2155 * @sample {highcharts|highstock} highcharts/css/axis-grid/ 2156 * Styled mode 2157 * @sample {highstock} stock/xaxis/gridlinecolor/ 2158 * Green lines 2159 * 2160 * @type {Highcharts.ColorType} 2161 * @default #e6e6e6 2162 */ 2163 gridLineColor: "#e6e6e6" /* Palette.neutralColor10 */, 2164 /** 2165 * The width of the grid lines extending the ticks across the plot area. 2166 * Defaults to 1 on the Y axis and 0 on the X axis, except for 3d 2167 * charts. 2168 * 2169 * In styled mode, the stroke width is given in the 2170 * `.highcharts-grid-line` class. 2171 * 2172 * @sample {highcharts} highcharts/yaxis/gridlinewidth/ 2173 * 2px lines 2174 * @sample {highcharts|highstock} highcharts/css/axis-grid/ 2175 * Styled mode 2176 * @sample {highstock} stock/xaxis/gridlinewidth/ 2177 * 2px lines 2178 * 2179 * @type {number} 2180 * @apioption xAxis.gridLineWidth 2181 */ 2182 gridLineWidth: void 0, 2183 /** 2184 * The height as the vertical axis. If it's a number, it is 2185 * interpreted as pixels. 2186 * 2187 * Since Highcharts 2: If it's a percentage string, it is interpreted 2188 * as percentages of the total plot height. 2189 * 2190 * @sample {highcharts} highcharts/xaxis/axis-position-properties 2191 * Different axis position properties 2192 * 2193 * @type {number|string} 2194 * @product highcharts highstock 2195 * @apioption xAxis.height 2196 */ 2197 /** 2198 * The width as the horizontal axis. If it's a number, it is interpreted 2199 * as pixels. 2200 * 2201 * Since Highcharts v5.0.13: If it's a percentage string, it is 2202 * interpreted as percentages of the total plot width. 2203 * 2204 * @sample {highcharts} highcharts/xaxis/axis-position-properties 2205 * Different axis position properties 2206 * 2207 * @type {number|string} 2208 * @product highcharts highstock 2209 * @apioption xAxis.width 2210 */ 2211 /** 2212 * Color for the main tick marks. 2213 * 2214 * In styled mode, the stroke is given in the `.highcharts-tick` 2215 * class. 2216 * 2217 * @sample {highcharts} highcharts/xaxis/tickcolor/ 2218 * Red ticks on X axis 2219 * @sample {highcharts|highstock} highcharts/css/axis-grid/ 2220 * Styled mode 2221 * @sample {highstock} stock/xaxis/ticks/ 2222 * Formatted ticks on X axis 2223 * 2224 * @type {Highcharts.ColorType} 2225 */ 2226 tickColor: "#333333" /* Palette.neutralColor80 */
vendor: 15,262 bytes, lines 2226-2615
2226 2227 // `tickWidth: 1` 2228 }; 2229 /** 2230 * The Z axis or depth axis for 3D plots. 2231 * 2232 * See the [Axis class](/class-reference/Highcharts.Axis) for programmatic 2233 * access to the axis. 2234 * 2235 * @sample {highcharts} highcharts/3d/scatter-zaxis-categories/ 2236 * Z-Axis with Categories 2237 * @sample {highcharts} highcharts/3d/scatter-zaxis-grid/ 2238 * Z-Axis with styling 2239 * 2240 * @type {*|Array<*>} 2241 * @extends xAxis 2242 * @since 5.0.0 2243 * @product highcharts 2244 * @excluding breaks, crosshair, height, left, lineColor, lineWidth, 2245 * nameToX, showEmpty, top, width 2246 * @apioption zAxis 2247 */ 2248 /** 2249 * The Y axis or value axis. Normally this is the vertical axis, 2250 * though if the chart is inverted this is the horizontal axis. 2251 * In case of multiple axes, the yAxis node is an array of 2252 * configuration objects. 2253 * 2254 * See [the Axis object](/class-reference/Highcharts.Axis) for programmatic 2255 * access to the axis. 2256 * 2257 * @type {*|Array<*>} 2258 * @extends xAxis 2259 * @excluding currentDateIndicator,ordinal,overscroll 2260 * @optionparent yAxis 2261 */ 2262 AxisDefaults.yAxis = { 2263 /** 2264 * The type of axis. Can be one of `linear`, `logarithmic`, `datetime`, 2265 * `category` or `treegrid`. Defaults to `treegrid` for Gantt charts, 2266 * `linear` for other chart types. 2267 * 2268 * In a datetime axis, the numbers are given in milliseconds, and tick 2269 * marks are placed on appropriate values, like full hours or days. In a 2270 * category or treegrid axis, the [point names](#series.line.data.name) 2271 * of the chart's series are used for categories, if a 2272 * [categories](#xAxis.categories) array is not defined. 2273 * 2274 * @sample {highcharts} highcharts/yaxis/type-log-minorgrid/ 2275 * Logarithmic with minor grid lines 2276 * @sample {highcharts} highcharts/yaxis/type-log-negative/ 2277 * Logarithmic with extension to emulate negative values 2278 * @sample {gantt} gantt/treegrid-axis/demo 2279 * Treegrid axis 2280 * 2281 * @type {Highcharts.AxisTypeValue} 2282 * @default {highcharts} linear 2283 * @default {gantt} treegrid 2284 * @product highcharts gantt 2285 * @apioption yAxis.type 2286 */ 2287 /** 2288 * The height of the Y axis. If it's a number, it is interpreted as 2289 * pixels. 2290 * 2291 * Since Highcharts 2: If it's a percentage string, it is interpreted as 2292 * percentages of the total plot height. 2293 * 2294 * @see [yAxis.top](#yAxis.top) 2295 * 2296 * @sample {highstock} stock/demo/candlestick-and-volume/ 2297 * Percentage height panes 2298 * 2299 * @type {number|string} 2300 * @product highcharts highstock 2301 * @apioption yAxis.height 2302 */ 2303 /** 2304 * Solid gauge only. Unless [stops](#yAxis.stops) are set, the color 2305 * to represent the maximum value of the Y axis. 2306 * 2307 * @sample {highcharts} highcharts/yaxis/mincolor-maxcolor/ 2308 * Min and max colors 2309 * 2310 * @type {Highcharts.ColorType} 2311 * @default #003399 2312 * @since 4.0 2313 * @product highcharts 2314 * @apioption yAxis.maxColor 2315 */ 2316 /** 2317 * Solid gauge only. Unless [stops](#yAxis.stops) are set, the color 2318 * to represent the minimum value of the Y axis. 2319 * 2320 * @sample {highcharts} highcharts/yaxis/mincolor-maxcolor/ 2321 * Min and max color 2322 * 2323 * @type {Highcharts.ColorType} 2324 * @default #e6ebf5 2325 * @since 4.0 2326 * @product highcharts 2327 * @apioption yAxis.minColor 2328 */ 2329 /** 2330 * Whether to reverse the axis so that the highest number is closest 2331 * to the origin. 2332 * 2333 * @sample {highcharts} highcharts/yaxis/reversed/ 2334 * Reversed Y axis 2335 * @sample {highstock} stock/xaxis/reversed/ 2336 * Reversed Y axis 2337 * 2338 * @type {boolean} 2339 * @default {highcharts} false 2340 * @default {highstock} false 2341 * @default {highmaps} true 2342 * @default {gantt} true 2343 * @apioption yAxis.reversed 2344 */ 2345 /** 2346 * If `true`, the first series in a stack will be drawn on top in a 2347 * positive, non-reversed Y axis. If `false`, the first series is in 2348 * the base of the stack. 2349 * 2350 * @sample {highcharts} highcharts/yaxis/reversedstacks-false/ 2351 * Non-reversed stacks 2352 * @sample {highstock} highcharts/yaxis/reversedstacks-false/ 2353 * Non-reversed stacks 2354 * 2355 * @type {boolean} 2356 * @default true 2357 * @since 3.0.10 2358 * @product highcharts highstock 2359 * @apioption yAxis.reversedStacks 2360 */ 2361 reversedStacks: true, 2362 /** 2363 * Solid gauge series only. Color stops for the solid gauge. Use this 2364 * in cases where a linear gradient between a `minColor` and `maxColor` 2365 * is not sufficient. The stops is an array of tuples, where the first 2366 * item is a float between 0 and 1 assigning the relative position in 2367 * the gradient, and the second item is the color. 2368 * 2369 * For solid gauges, the Y axis also inherits the concept of 2370 * [data classes](https://api.highcharts.com/highmaps#colorAxis.dataClasses) 2371 * from the Highmaps color axis. 2372 * 2373 * @sample {highcharts} highcharts/demo/gauge-solid/ 2374 * Gauge with stops 2375 * 2376 * @see [minColor](#yAxis.minColor) 2377 * @see [maxColor](#yAxis.maxColor) 2378 * 2379 * @type {Array<Array<number,Highcharts.ColorType>>} 2380 * @since 4.0 2381 * @product highcharts 2382 * @apioption yAxis.stops 2383 */ 2384 /** 2385 * The pixel width of the major tick marks. 2386 * 2387 * @sample {highcharts} highcharts/xaxis/tickwidth/ 10 px width 2388 * @sample {highstock} stock/xaxis/ticks/ Formatted ticks on X axis 2389 * 2390 * @type {number} 2391 * @default 0 2392 * @product highcharts highstock gantt 2393 * @apioption yAxis.tickWidth 2394 */ 2395 /** 2396 * Whether to force the axis to end on a tick. Use this option with 2397 * the `maxPadding` option to control the axis end. 2398 * 2399 * This option is always disabled, when panning type is 2400 * either `y` or `xy`. 2401 * 2402 * @see [type](#chart.panning.type) 2403 * 2404 * 2405 * @sample {highcharts} highcharts/yaxis/endontick/ 2406 * True by default 2407 * @sample {highcharts} highcharts/yaxis/endontick-false/ 2408 * False 2409 * @sample {highstock} stock/demo/basic-line/ 2410 * True by default 2411 * @sample {highstock} stock/xaxis/endontick/ 2412 * False for Y axis 2413 * 2414 * @since 1.2.0 2415 */ 2416 endOnTick: true, 2417 /** 2418 * Padding of the max value relative to the length of the axis. A 2419 * padding of 0.05 will make a 100px axis 5px longer. This is useful 2420 * when you don't want the highest data value to appear on the edge 2421 * of the plot area. When the axis' `max` option is set or a max extreme 2422 * is set using `axis.setExtremes()`, the maxPadding will be ignored. 2423 * 2424 * Also the `softThreshold` option takes precedence over `maxPadding`, 2425 * so if the data is tangent to the threshold, `maxPadding` may not 2426 * apply unless `softThreshold` is set to false. 2427 * 2428 * @sample {highcharts} highcharts/yaxis/maxpadding-02/ 2429 * Max padding of 0.2 2430 * @sample {highstock} stock/xaxis/minpadding-maxpadding/ 2431 * Greater min- and maxPadding 2432 * 2433 * @since 1.2.0 2434 * @product highcharts highstock gantt 2435 */ 2436 maxPadding: 0.05, 2437 /** 2438 * Padding of the min value relative to the length of the axis. A 2439 * padding of 0.05 will make a 100px axis 5px longer. This is useful 2440 * when you don't want the lowest data value to appear on the edge 2441 * of the plot area. When the axis' `min` option is set or a max extreme 2442 * is set using `axis.setExtremes()`, the maxPadding will be ignored. 2443 * 2444 * Also the `softThreshold` option takes precedence over `minPadding`, 2445 * so if the data is tangent to the threshold, `minPadding` may not 2446 * apply unless `softThreshold` is set to false. 2447 * 2448 * @sample {highcharts} highcharts/yaxis/minpadding/ 2449 * Min padding of 0.2 2450 * @sample {highstock} stock/xaxis/minpadding-maxpadding/ 2451 * Greater min- and maxPadding 2452 * 2453 * @since 1.2.0 2454 * @product highcharts highstock gantt 2455 */ 2456 minPadding: 0.05, 2457 /** 2458 * @productdesc {highstock} 2459 * In Highcharts Stock 1.x, the Y axis was placed 2460 * on the left side by default. 2461 * 2462 * @sample {highcharts} highcharts/yaxis/opposite/ 2463 * Secondary Y axis opposite 2464 * @sample {highstock} stock/xaxis/opposite/ 2465 * Y axis on left side 2466 * 2467 * @type {boolean} 2468 * @default {highstock} true 2469 * @default {highcharts} false 2470 * @product highstock highcharts gantt 2471 * @apioption yAxis.opposite 2472 */ 2473 /** 2474 * @see [tickInterval](#xAxis.tickInterval) 2475 * @see [tickPositioner](#xAxis.tickPositioner) 2476 * @see [tickPositions](#xAxis.tickPositions) 2477 */ 2478 tickPixelInterval: 72, 2479 /** 2480 * Whether to show the last tick label. 2481 * 2482 * @productdesc {highcharts|gantt} 2483 * Defaults to `true` on cartesian charts, and `false` on polar charts. 2484 * 2485 * @productdesc {highstock} 2486 * Defaults to `true` for categorized yAxis and `false` for other types 2487 * of yAxis. 2488 * 2489 * @default undefined 2490 */ 2491 showLastLabel: true, 2492 /** 2493 * @extends xAxis.labels 2494 */ 2495 labels: { 2496 /** 2497 * The label's pixel distance from the perimeter of the plot area. 2498 * On cartesian charts, this is overridden if the `labels.y` setting 2499 * is set. 2500 * 2501 * On polar charts, if it's a percentage string, it is interpreted 2502 * the same as [series.radius](#plotOptions.gauge.radius), so the 2503 * label can be aligned under the gauge's shape. 2504 * 2505 * @sample {highcharts} highcharts/yaxis/labels-distance/ 2506 * Polar chart, labels centered under the arc 2507 * 2508 * @type {number|string} 2509 * @product highcharts 2510 * @apioption yAxis.labels.distance 2511 */ 2512 /** 2513 * The y position offset of all labels relative to the tick 2514 * positions on the axis. For polar and radial axis consider the use 2515 * of the [distance](#yAxis.labels.distance) option. 2516 * 2517 * @sample {highcharts} highcharts/xaxis/labels-x/ 2518 * Y axis labels placed on grid lines 2519 * 2520 * @type {number} 2521 * @default {highcharts} 3 2522 * @default {highstock} -2 2523 * @default {highmaps} 3 2524 * @apioption yAxis.labels.y 2525 */ 2526 /** 2527 * What part of the string the given position is anchored to. Can 2528 * be one of `"left"`, `"center"` or `"right"`. The exact position 2529 * also depends on the `labels.x` setting. 2530 * 2531 * Angular gauges and solid gauges defaults to `"center"`. 2532 * Solid gauges with two labels have additional option `"auto"` 2533 * for automatic horizontal and vertical alignment. 2534 * 2535 * @sample {highcharts} highcharts/yaxis/labels-align-left/ 2536 * Left 2537 * @sample {highcharts} highcharts/series-solidgauge/labels-auto-aligned/ 2538 * Solid gauge labels auto aligned 2539 * 2540 * @type {Highcharts.AlignValue} 2541 * @default {highstock} right 2542 * @apioption yAxis.labels.align 2543 */ 2544 /** 2545 * The x position offset of all labels relative to the tick 2546 * positions on the axis. Defaults to -15 for left axis, 15 for 2547 * right axis. 2548 * 2549 * @sample {highcharts} highcharts/xaxis/labels-x/ 2550 * Y axis labels placed on grid lines 2551 * 2552 * @type {number} 2553 */ 2554 x: void 0 2555 }, 2556 /** 2557 * @sample {highcharts} highcharts/yaxis/max-200/ 2558 * Y axis max of 200 2559 * @sample {highcharts} highcharts/yaxis/max-logarithmic/ 2560 * Y axis max on logarithmic axis 2561 * @sample {highstock} stock/yaxis/min-max/ 2562 * Fixed min and max on Y axis 2563 * 2564 * @apioption yAxis.max 2565 */ 2566 /** 2567 * @sample {highcharts} highcharts/yaxis/min-startontick-false/ 2568 * -50 with startOnTick to false 2569 * @sample {highcharts} highcharts/yaxis/min-startontick-true/ 2570 * -50 with startOnTick true by default 2571 * @sample {highstock} stock/yaxis/min-max/ 2572 * Fixed min and max on Y axis 2573 * 2574 * @apioption yAxis.min 2575 */ 2576 /** 2577 * An optional scrollbar to display on the Y axis in response to 2578 * limiting the minimum an maximum of the axis values. 2579 * 2580 * In styled mode, all the presentational options for the scrollbar 2581 * are replaced by the classes `.highcharts-scrollbar-thumb`, 2582 * `.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`, 2583 * `.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`. 2584 * 2585 * @sample {highstock} stock/yaxis/scrollbar/ 2586 * Scrollbar on the Y axis 2587 * 2588 * @extends scrollbar 2589 * @since 4.2.6 2590 * @product highstock 2591 * @excluding height 2592 * @apioption yAxis.scrollbar 2593 */ 2594 /** 2595 * Enable the scrollbar on the Y axis. 2596 * 2597 * @sample {highstock} stock/yaxis/scrollbar/ 2598 * Enabled on Y axis 2599 * 2600 * @type {boolean} 2601 * @default false 2602 * @since 4.2.6 2603 * @product highstock 2604 * @apioption yAxis.scrollbar.enabled 2605 */ 2606 /** 2607 * Pixel margin between the scrollbar and the axis elements. 2608 * 2609 * @type {number} 2610 * @default 10 2611 * @since 4.2.6 2612 * @product highstock 2613 * @apioption yAxis.scrollbar.margin 2614 */ 2615 /* eslint-disable
2615highcharts/doclet-apioption-last */ 2616 /** 2617 * Defines the position of the scrollbar. By default, it is positioned 2618 * on the opposite of the main axis (right side of the chart). 2619 * However, in the case of RTL languages could be set to `false` 2620 * which positions the scrollbar on the left. 2621 * 2622 * Works only for vertical axes. 2623 * This means yAxis in a non-inverted chart and xAxis in the inverted. 2624 * 2625 * @sample stock/yaxis/scrollbar-opposite/ 2626 * A scrollbar not on the opposite side 2627 * 2628 * @type {boolean} 2629 * @default true 2630 * @since 9.3.0 2631 * 2632 * @apioption yAxis.scrollbar.opposite 2633 * @apioption xAxis.scrollbar.opposite 2634 * 2635 */ 2636 /* eslint-enable highcharts/doclet-apioption-last */ 2637 /** 2638 * Whether to show the scrollbar when it is fully zoomed out at max 2639 * range. Setting it to `false` on the Y axis makes the scrollbar stay 2640 * hidden until the user zooms in, like common in browsers. 2641 * 2642 * @type {boolean} 2643 * @default true 2644 * @since 4.2.6 2645 * @product highstock 2646 * @apioption yAxis.scrollbar.showFull 2647 */ 2648 /** 2649 * The width of a vertical scrollbar or height of a horizontal 2650 * scrollbar. Defaults to 20 on touch devices. 2651 * 2652 * @type {number} 2653 * @default 14 2654 * @since 4.2.6 2655 * @product highstock 2656 * @apioption yAxis.scrollbar.size 2657 */ 2658 /** 2659 * Z index of the scrollbar elements. 2660 * 2661 * @type {number} 2662 * @default 3 2663 * @since 4.2.6 2664 * @product highstock 2665 * @apioption yAxis.scrollbar.zIndex 2666 */ 2667 /** 2668 * A soft maximum for the axis. If the series data maximum is less 2669 * than this, the axis will stay at this maximum, but if the series 2670 * data maximum is higher, the axis will flex to show all data. 2671 * 2672 * **Note**: The [series.softThreshold]( 2673 * #plotOptions.series.softThreshold) option takes precedence over this 2674 * option. 2675 * 2676 * @sample highcharts/yaxis/softmin-softmax/ 2677 * Soft min and max 2678 * 2679 * @type {number} 2680 * @since 5.0.1 2681 * @product highcharts highstock gantt 2682 * @apioption yAxis.softMax 2683 */ 2684 /** 2685 * A soft minimum for the axis. If the series data minimum is greater 2686 * than this, the axis will stay at this minimum, but if the series 2687 * data minimum is lower, the axis will flex to show all data. 2688 * 2689 * **Note**: The [series.softThreshold]( 2690 * #plotOptions.series.softThreshold) option takes precedence over this 2691 * option. 2692 * 2693 * @sample highcharts/yaxis/softmin-softmax/ 2694 * Soft min and max 2695 * 2696 * @type {number} 2697 * @since 5.0.1 2698 * @product highcharts highstock gantt 2699 * @apioption yAxis.softMin 2700 */ 2701 /** 2702 * Defines the horizontal alignment of the stack total label. Can be one 2703 * of `"left"`, `"center"` or `"right"`. The default value is calculated 2704 * at runtime and depends on orientation and whether the stack is 2705 * positive or negative. 2706 * 2707 * @sample {highcharts} highcharts/yaxis/stacklabels-align-left/ 2708 * Aligned to the left 2709 * @sample {highcharts} highcharts/yaxis/stacklabels-align-center/ 2710 * Aligned in center 2711 * @sample {highcharts} highcharts/yaxis/stacklabels-align-right/ 2712 * Aligned to the right 2713 * 2714 * @type {Highcharts.AlignValue} 2715 * @since 2.1.5 2716 * @product highcharts 2717 * @apioption yAxis.stackLabels.align 2718 */ 2719 /** 2720 * A format string for the data label. Available variables are the same 2721 * as for `formatter`. 2722 * 2723 * @type {string} 2724 * @default {total} 2725 * @since 3.0.2 2726 * @product highcharts highstock 2727 * @apioption yAxis.stackLabels.format 2728 */ 2729 /** 2730 * Rotation of the labels in degrees. 2731 * 2732 * @sample {highcharts} highcharts/yaxis/stacklabels-rotation/ 2733 * Labels rotated 45° 2734 * 2735 * @type {number} 2736 * @default 0 2737 * @since 2.1.5 2738 * @product highcharts 2739 * @apioption yAxis.stackLabels.rotation 2740 */ 2741 /** 2742 * The text alignment for the label. While `align` determines where the 2743 * texts anchor point is placed with regards to the stack, `textAlign` 2744 * determines how the text is aligned against its anchor point. Possible 2745 * values are `"left"`, `"center"` and `"right"`. The default value is 2746 * calculated at runtime and depends on orientation and whether the 2747 * stack is positive or negative. 2748 * 2749 * @sample {highcharts}
2749 highcharts/yaxis/stacklabels-textalign-left/ 2750 * Label in center position but text-aligned left 2751 * 2752 * @type {Highcharts.AlignValue} 2753 * @since 2.1.5 2754 * @product highcharts 2755 * @apioption yAxis.stackLabels.textAlign 2756 */ 2757 /** 2758 * Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html) 2759 * to render the labels. 2760 * 2761 * @type {boolean} 2762 * @default false 2763 * @since 3.0 2764 * @product highcharts highstock 2765 * @apioption yAxis.stackLabels.useHTML 2766 */ 2767 /** 2768 * Defines the vertical alignment of the stack total label. Can be one 2769 * of `"top"`, `"middle"` or `"bottom"`. The default value is calculated 2770 * at runtime and depends on orientation and whether the stack is 2771 * positive or negative. 2772 * 2773 * @sample {highcharts} highcharts/yaxis/stacklabels-verticalalign-top/ 2774 * Vertically aligned top 2775 * @sample {highcharts} highcharts/yaxis/stacklabels-verticalalign-middle/ 2776 * Vertically aligned middle 2777 * @sample {highcharts} highcharts/yaxis/stacklabels-verticalalign-bottom/ 2778 * Vertically aligned bottom 2779 * 2780 * @type {Highcharts.VerticalAlignValue} 2781 * @since 2.1.5 2782 * @product highcharts 2783 * @apioption yAxis.stackLabels.verticalAlign 2784 */ 2785 /** 2786 * The x position offset of the label relative to the left of the 2787 * stacked bar. The default value is calculated at runtime and depends 2788 * on orientation and whether the stack is positive or negative. 2789 * 2790 * @sample {highcharts} highcharts/yaxis/stacklabels-x/ 2791 * Stack total labels with x offset 2792 * 2793 * @type {number} 2794 * @since 2.1.5 2795 * @product highcharts 2796 * @apioption yAxis.stackLabels.x 2797 */ 2798 /** 2799 * The y position offset of the label relative to the tick position 2800 * on the axis. The default value is calculated at runtime and depends 2801 * on orientation and whether the stack is positive or negative. 2802 * 2803 * @sample {highcharts} highcharts/yaxis/stacklabels-y/ 2804 * Stack total labels with y offset 2805 * 2806 * @type {number} 2807 * @since 2.1.5 2808 * @product highcharts 2809 * @apioption yAxis.stackLabels.y 2810 */ 2811 /** 2812 * Whether to force the axis to start on a tick. Use this option with 2813 * the `maxPadding` option to control the axis start. 2814 * 2815 * This option is always disabled, when panning type is 2816 * either `y` or `xy`. 2817 * 2818 * @see [type](#chart.panning.type) 2819 * 2820 * @sample {highcharts} highcharts/xaxis/startontick-false/ 2821 * False by default 2822 * @sample {highcharts} highcharts/xaxis/startontick-true/ 2823 * True 2824 * @sample {highstock} stock/xaxis/endontick/ 2825 * False for Y axis 2826 * 2827 * @since 1.2.0 2828 * @product highcharts highstock gantt 2829 */ 2830 startOnTick: true, 2831 title: { 2832 /** 2833 * The pixel distance between the axis labels and the title. 2834 * Positive values are outside the axis line, negative are inside. 2835 * 2836 * @sample {highcharts} highcharts/xaxis/title-margin/ 2837 * Y axis title margin of 60 2838 * 2839 * @type {number} 2840 * @default 40 2841 * @apioption yAxis.title.margin 2842 */ 2843 /** 2844 * The actual text of the axis title. Horizontal texts can contain 2845 * HTML, but rotated texts are painted using vector techniques and 2846 * must be clean text. The Y axis title is disabled by setting the 2847 * `text` option to `undefined`. 2848 * 2849 * @sample {highcharts} highcharts/xaxis/title-text/ 2850 * Custom HTML 2851 * 2852 * @type {string|null} 2853 * @default {highcharts} Values 2854 * @default {highstock} undefined 2855 * @product highcharts highstock gantt 2856 */ 2857 text: 'Values' 2858 }, 2859 /** 2860 * The top position of the Y axis. If it's a number, it is interpreted 2861 * as pixel position relative to the chart. 2862 * 2863 * Since Highcharts 2: If it's a percentage string, it is interpreted as 2864 * percentages of the plot height, offset from plot area top. 2865 * 2866 * @see [yAxis.height](#yAxis.height) 2867 * 2868 * @sample {highstock} stock/demo/candlestick-and-volume/ 2869 * Percentage height panes 2870 * 2871 * @type {number|string} 2872 * @product highcharts highstock 2873 * @apioption yAxis.top 2874 */ 2875 /** 2876 * The stack labels show the total value for each bar in a stacked 2877 * column or bar chart. The label will be placed on top of positive 2878 * columns and below negative columns. In case of an inverted column 2879 * chart or a bar chart the label is placed to the right of positive 2880 * bars and to the left of negative bars. 2881 * 2882 * @product highcharts 2883 */ 2884 stackLabels: { 2885 /** 2886 * Enable or disable the initial animation when a series is 2887 * displayed for the `stackLabels`. The animation can also be set as 2888 * a configuration object. Please note that this option only 2889 * applies to the initial animation. 2890 * For other animations, see [chart.animation](#chart.animation) 2891 * and the animation parameter under the API methods. 2892 * The following properties are supported: 2893 * 2894 * - `defer`: The animation delay time in milliseconds. 2895 * 2896 * @sample {highcharts} highcharts/plotoptions/animation-defer/ 2897 * Animation defer settings 2898 * @type {boolean|Partial<Highcharts.AnimationOptionsObject>} 2899 * @since 8.2.0 2900 * @apioption yAxis.stackLabels.animation 2901 */ 2902 animation: {}, 2903 /** 2904 * The animation delay time in milliseconds. 2905 * Set to `0` renders stackLabel immediately. 2906 * As `undefined` inherits defer time from the [series.animation.defer](#plotOptions.series.animation.defer). 2907 * 2908 * @type {number} 2909 * @since 8.2.0 2910 * @apioption yAxis.stackLabels.animation.defer 2911 */ 2912 /** 2913 * Allow the stack labels to overlap. 2914 * 2915 * @sample {highcharts} highcharts/yaxis/stacklabels-allowoverlap-false/ 2916 * Default false 2917 * 2918 * @since 5.0.13 2919 * @product highcharts 2920 */ 2921 allowOverlap: false, 2922 /** 2923 * The background color or gradient for the stack label. 2924 * 2925 * @sample {highcharts} highcharts/yaxis/stacklabels-box/ 2926 * Stack labels box options 2927 * @type {Highcharts.ColorType} 2928 * @since 8.1.0 2929 * @apioption yAxis.stackLabels.backgroundColor 2930 */ 2931 /** 2932 * The border color for the stack label. Defaults to `undefined`. 2933 * 2934 * @sample {highcharts} highcharts/yaxis/stacklabels-box/ 2935 * Stack labels box options 2936 * @type {Highcharts.ColorType} 2937 * @since 8.1.0 2938 * @apioption yAxis.stackLabels.borderColor 2939 */ 2940 /** 2941 * The border radius in pixels for the stack label. 2942 * 2943 * @sample {highcharts} highcharts/yaxis/stacklabels-box/ 2944 * Stack labels box options 2945 * @type {number} 2946 * @default 0 2947 * @since 8.1.0 2948 * @apioption yAxis.stackLabels.borderRadius 2949 */ 2950 /** 2951 * The border width in pixels for the stack label. 2952 * 2953 * @sample {highcharts} highcharts/yaxis/stacklabels-box/ 2954 * Stack labels box options 2955 * @type {number} 2956 * @default 0 2957 * @since 8.1.0 2958 * @apioption yAxis.stackLabels.borderWidth 2959 */ 2960 /** 2961 * Enable or disable the stack total labels. 2962 * 2963 * @sample {highcharts} highcharts/yaxis/stacklabels-enabled/ 2964 * Enabled stack total labels 2965 * @sample {highcharts} highcharts/yaxis/stacklabels-enabled-waterfall/ 2966 * Enabled stack labels in waterfall chart 2967 * 2968 * @since 2.1.5 2969 * @product highcharts 2970 */ 2971 enabled: false, 2972 /** 2973 * Whether to hide stack labels that are outside the plot area. 2974 * By default, the stack label is moved 2975 * inside the plot area according to the 2976 * [overflow](/highcharts/#yAxis/stackLabels/overflow) 2977 * option. 2978 * 2979 * @type {boolean} 2980 * @since 7.1.3 2981 */ 2982 crop: true, 2983 /** 2984 * How to handle stack total labels that flow outside the plot area. 2985 * The default is set to `"justify"`, 2986 * which aligns them inside the plot area. 2987 * For columns and bars, this means it will be moved inside the bar. 2988 * To display stack labels outside the plot area,
2989 * set `crop` to `false` and `overflow` to `"allow"`. 2990 * 2991 * @sample highcharts/yaxis/stacklabels-overflow/ 2992 * Stack labels flows outside the plot area. 2993 * 2994 * @type {Highcharts.DataLabelsOverflowValue} 2995 * @since 7.1.3 2996 */ 2997 overflow: 'justify', 2998 /* eslint-disable valid-jsdoc */ 2999 /** 3000 * Callback JavaScript function to format the label. The value is 3001 * given by `this.total`. 3002 * 3003 * @sample {highcharts} highcharts/yaxis/stacklabels-formatter/ 3004 * Added units to stack total value 3005 * 3006 * @type {Highcharts.FormatterCallbackFunction<Highcharts.StackItemObject>} 3007 * @since 2.1.5 3008 * @product highcharts 3009 */ 3010 formatter: function () { 3011 const { numberFormatter } = this.axis.chart; 3012 /* eslint-enable valid-jsdoc */ 3013 return numberFormatter(this.total || 0, -1); 3014 }, 3015 /** 3016 * CSS styles for the label. 3017 * 3018 * In styled mode, the styles are set in the 3019 * `.highcharts-stack-label` class. 3020 * 3021 * @sample {highcharts} highcharts/yaxis/stacklabels-style/ 3022 * Red stack total labels 3023 * 3024 * @type {Highcharts.CSSObject} 3025 * @since 2.1.5 3026 * @product highcharts 3027 */ 3028 style: { 3029 /** @internal */ 3030 color: "#000000" /* Palette.neutralColor100 */, 3031 /** 3032 * @type {number|string} 3033 */ 3034 fontSize: '0.7em', 3035 /** @internal */ 3036 fontWeight: 'bold', 3037 /** @internal */ 3038 textOutline: '1px contrast' 3039 } 3040 }, 3041 gridLineWidth: 1, 3042 lineWidth: 0 3043 }; 3044})(AxisDefaults || (AxisDefaults = {})); 3045/* * 3046 * 3047 * Default Export 3048 * 3049 * */ 3050export default AxisDefaults;
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.