{"_meta":{"branch":"master","commit":"b0b7d196ce","version":"12.6.0","date":"Mon Apr 13 2026 09:44:53 GMT+0200 (Central European Summer Time)"},"accessibility":{"doclet":{"description":"Options for configuring accessibility for the chart. Requires the\n[accessibility module](https://code.highcharts.com/modules/accessibility.js)\nto be loaded. For a description of the module and information\non its features, see\n[Highcharts Accessibility](https://www.highcharts.com/docs/accessibility/accessibility-module).","since":"5.0.0","requires":["module:modules/accessibility"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","name":"accessibility","fullname":"accessibility","line":97,"lineEnd":107,"column":4},"children":{"announceNewData":{"doclet":{"description":"Options for announcing new data to screen reader users. Useful\nfor dynamic data applications and drilldown.\n\nKeep in mind that frequent announcements will not be useful to\nusers, as they won't have time to explore the new data. For these\napplications, consider making snapshots of the data accessible, and\ndo the announcements in batches.","declare":"Highcharts.AccessibilityAnnounceNewDataOptionsObject","since":"7.1.0","type":{"names":["*"]}},"meta":{"fullname":"accessibility.announceNewData","name":"announceNewData","line":696,"lineEnd":707,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"announcementFormatter":{"doclet":{"description":"Optional formatter callback for the announcement. Receives\nup to three arguments. The first argument is always an array\nof all series that received updates. If an announcement is\nalready queued, the series that received updates for that\nannouncement are also included in this array. The second\nargument is provided if `chart.addSeries` was called, and\nthere is a new series. In that case, this argument is a\nreference to the new series. The third argument, similarly,\nis provided if `series.addPoint` was called, and there is a\nnew point. In that case, this argument is a reference to the\nnew point.\n\nThe function should return a string with the text to announce\nto the user. Return empty string to not announce anything.\nReturn `false` to use the default announcement format.","samples":[{"name":"High priority live alerts","value":"highcharts/accessibility/custom-dynamic"}],"type":{"names":["Highcharts.AccessibilityAnnouncementFormatter"]},"since":"7.1.0"},"meta":{"fullname":"accessibility.announceNewData.announcementFormatter","name":"announcementFormatter","line":709,"lineEnd":731,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Enable announcing new data to screen reader users","samples":[{"name":"Dynamic data accessible","value":"highcharts/accessibility/accessible-dynamic"}],"since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"accessibility.announceNewData.enabled","name":"enabled","line":709,"lineEnd":731,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":false},"children":{}},"interruptUser":{"doclet":{"description":"Choose whether or not the announcements should interrupt the\nscreen reader. If not enabled, the user will be notified once\nidle. It is recommended not to enable this setting unless\nthere is a specific reason to do so.","since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"accessibility.announceNewData.interruptUser","name":"interruptUser","line":748,"lineEnd":753,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":false},"children":{}},"minAnnounceInterval":{"doclet":{"description":"Minimum interval between announcements in milliseconds. If\nnew data arrives before this amount of time has passed, it is\nqueued for announcement. If another new data event happens\nwhile an announcement is queued, the queued announcement is\ndropped, and the latest announcement is queued instead. Set\nto 0 to allow all announcements, but be warned that frequent\nannouncements are disturbing to users.","since":"7.1.0","type":{"names":["number"]},"defaultvalue":5000},"meta":{"fullname":"accessibility.announceNewData.minAnnounceInterval","name":"minAnnounceInterval","line":738,"lineEnd":746,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":5000},"children":{}}}},"customComponents":{"doclet":{"description":"A hook for adding custom components to the accessibility module.\nShould be an object mapping component names to instances of classes\ninheriting from the Highcharts.AccessibilityComponent base class.\nRemember to add the component to the\n[keyboardNavigation.order](#accessibility.keyboardNavigation.order)\nfor the keyboard navigation to be usable.","samples":[{"name":"Custom accessibility component","value":"highcharts/accessibility/custom-component"}],"type":{"names":["*"]},"since":"7.1.0"},"meta":{"fullname":"accessibility.customComponents","name":"customComponents","line":477,"lineEnd":491,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"description":{"doclet":{"description":"A text description of the chart.\n\n**Note: Prefer using [linkedDescription](#accessibility.linkedDescription)\nor [caption](#caption.text) instead.**\n\nIf the Accessibility module is loaded, this option is included by\ndefault as a long description of the chart in the hidden screen\nreader information region.\n\nNote: Since Highcharts now supports captions and linked descriptions,\nit is preferred to define the description using those methods, as a\nvisible caption/description benefits all users. If the\n`accessibility.description` option is defined, the linked description\nis ignored, and the caption is hidden from screen reader users.","see":["[linkedDescription](#accessibility.linkedDescription)","[caption](#caption)","[typeDescription](#accessibility.typeDescription)"],"type":{"names":["string"]},"since":"5.0.0"},"meta":{"fullname":"accessibility.description","name":"description","line":514,"lineEnd":537,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Enable accessibility functionality for the chart. For more\ninformation on how to include these features, and why this is\nrecommended, see [Highcharts Accessibility](https://www.highcharts.com/docs/accessibility/accessibility-module).\n\nHighcharts will by default emit a warning to the console if\nthe [accessibility module](https://code.highcharts.com/modules/accessibility.js)\nis not loaded. Setting this option to `false` will override\nand silence the warning.\n\nOnce the module is loaded, setting this option to `false`\nwill disable the module for this chart.","since":"5.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"accessibility.enabled","name":"enabled","line":109,"lineEnd":123,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":true},"children":{}},"highContrastMode":{"doclet":{"description":"Controls how [highContrastTheme](#accessibility.highContrastTheme)\nis applied.\n\nThe default option is `auto`, which applies the high contrast theme\nthe user's system has a high contrast theme active.","samples":[{"name":"High contrast mode enabled","value":"highcharts/accessibility/high-contrast-mode"}],"since":"11.4.0","type":{"names":["string"]},"defaultvalue":"auto"},"meta":{"fullname":"accessibility.highContrastMode","name":"highContrastMode","line":476,"lineEnd":476,"column":91,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":"auto"},"children":{}},"highContrastTheme":{"doclet":{"description":"Theme to apply to the chart when Windows High Contrast Mode is\ndetected. By default, a high contrast theme matching the high\ncontrast system colors is used.","type":{"names":["*"]},"since":"7.1.3"},"meta":{"fullname":"accessibility.highContrastTheme","name":"highContrastTheme","line":492,"lineEnd":500,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"keyboardNavigation":{"doclet":{"description":"Options for keyboard navigation.","declare":"Highcharts.KeyboardNavigationOptionsObject","since":"5.0.0","type":{"names":["*"]}},"meta":{"fullname":"accessibility.keyboardNavigation","name":"keyboardNavigation","line":514,"lineEnd":537,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable keyboard navigation for the chart.","since":"5.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"accessibility.keyboardNavigation.enabled","name":"enabled","line":559,"lineEnd":563,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":true},"children":{}},"focusBorder":{"doclet":{"description":"Options for the focus border drawn around elements while\nnavigating through them.","samples":[{"name":"Custom focus ring","value":"highcharts/accessibility/custom-focus"}],"declare":"Highcharts.KeyboardNavigationFocusBorderOptionsObject","since":"6.0.3","type":{"names":["*"]}},"meta":{"fullname":"accessibility.keyboardNavigation.focusBorder","name":"focusBorder","line":565,"lineEnd":574,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable/disable focus border for chart.","since":"6.0.3","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"accessibility.keyboardNavigation.focusBorder.enabled","name":"enabled","line":576,"lineEnd":580,"column":16,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":true},"children":{}},"hideBrowserFocusOutline":{"doclet":{"description":"Hide the browser's default focus indicator.","since":"6.0.4","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"accessibility.keyboardNavigation.focusBorder.hideBrowserFocusOutline","name":"hideBrowserFocusOutline","line":582,"lineEnd":586,"column":16,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":true},"children":{}},"margin":{"doclet":{"description":"Focus border margin around the elements.","since":"6.0.3","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"accessibility.keyboardNavigation.focusBorder.margin","name":"margin","line":608,"lineEnd":612,"column":16,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":2},"children":{}},"style":{"doclet":{"description":"Style options for the focus border drawn around elements\nwhile navigating through them. Note that some browsers in\naddition draw their own borders for focused elements. These\nautomatic borders cannot be styled by Highcharts.\n\nIn styled mode, the border is given the\n`.highcharts-focus-border` class.","type":{"names":["Highcharts.CSSObject"]},"since":"6.0.3"},"meta":{"fullname":"accessibility.keyboardNavigation.focusBorder.style","name":"style","line":588,"lineEnd":599,"column":16,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}}}},"order":{"doclet":{"description":"Order of tab navigation in the chart. Determines which elements\nare tabbed to first. Available elements are: `series`, `zoom`,\n`rangeSelector`, `navigator`, `chartMenu`, `legend` and `container`.\nIn addition, any custom components can be added here. Adding\n`container` first in order will make the keyboard focus stop on\nthe chart container first, requiring the user to tab again to\nenter the chart.","samples":[{"name":"Custom order is set","value":"highcharts/accessibility/custom-component"}],"type":{"names":["Array.<string>"]},"since":"7.1.0"},"meta":{"fullname":"accessibility.keyboardNavigation.order","name":"order","line":615,"lineEnd":629,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"seriesNavigation":{"doclet":{"description":"Options for the keyboard navigation of data points and series.","declare":"Highcharts.KeyboardNavigationSeriesNavigationOptionsObject","since":"8.0.0","type":{"names":["*"]}},"meta":{"fullname":"accessibility.keyboardNavigation.seriesNavigation","name":"seriesNavigation","line":640,"lineEnd":645,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"mode":{"doclet":{"description":"Set the keyboard navigation mode for the chart. Can be\n\"normal\" or \"serialize\". In normal mode, left/right arrow\nkeys move between points in a series, while up/down arrow\nkeys move between series. Up/down navigation acts\nintelligently to figure out which series makes sense to move\nto from any given point.\n\nIn \"serialize\" mode, points are instead navigated as a single\nlist. Left/right behaves as in \"normal\" mode. Up/down arrow\nkeys will behave like left/right. This can be useful for\nunifying navigation behavior with/without screen readers\nenabled.","type":{"names":["\"normal\"","\"serialize\""]},"defaultvalue":"normal","since":"8.0.0"},"meta":{"fullname":"accessibility.keyboardNavigation.seriesNavigation.mode","name":"mode","line":647,"lineEnd":666,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"pointNavigationEnabledThreshold":{"doclet":{"description":"When a series contains more points than this, we no longer\nallow keyboard navigation for it.\n\nSet to `false` to disable.","type":{"names":["boolean","number"]},"since":"8.0.0","defaultvalue":false},"meta":{"fullname":"accessibility.keyboardNavigation.seriesNavigation.pointNavigationEnabledThreshold","name":"pointNavigationEnabledThreshold","line":675,"lineEnd":683,"column":16,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":false},"children":{}},"rememberPointFocus":{"doclet":{"description":"Remember which point was focused even after navigating away\nfrom the series, so that when navigating back to the series\nyou start at the last focused point.","type":{"names":["boolean"]},"since":"10.1.0","defaultvalue":false},"meta":{"fullname":"accessibility.keyboardNavigation.seriesNavigation.rememberPointFocus","name":"rememberPointFocus","line":685,"lineEnd":692,"column":16,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":false},"children":{}},"skipNullPoints":{"doclet":{"description":"Skip null points when navigating through points with the\nkeyboard. By default this is the opposite of\n[series.nullInteraction](https://api.highcharts.com/highcharts/plotOptions.series.nullInteraction).","since":"8.0.0","type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"accessibility.keyboardNavigation.seriesNavigation.skipNullPoints","name":"skipNullPoints","line":647,"lineEnd":666,"column":16,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":"undefined"},"children":{}}}},"wrapAround":{"doclet":{"description":"Whether or not to wrap around when reaching the end of arrow-key\nnavigation for an element in the chart.","since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"accessibility.keyboardNavigation.wrapAround","name":"wrapAround","line":634,"lineEnd":638,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":true},"children":{}}}},"landmarkVerbosity":{"doclet":{"description":"Amount of landmarks/regions to create for screen reader users. More\nlandmarks can make navigation with screen readers easier, but can\nbe distracting if there are lots of charts on the page. Three modes\nare available:\n - `all`: Adds regions for all series, legend, information\n     region.\n - `one`: Adds a single landmark per chart.\n - `disabled`: No landmarks are added.","since":"7.1.0","values":"[\"all\", \"one\", \"disabled\"]","type":{"names":["string"]},"defaultvalue":"all"},"meta":{"fullname":"accessibility.landmarkVerbosity","name":"landmarkVerbosity","line":422,"lineEnd":434,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":"all"},"children":{}},"linkedDescription":{"doclet":{"description":"Link the chart to an HTML element describing the contents of the\nchart.\n\nIt is always recommended to describe charts using visible text, to\nimprove SEO as well as accessibility for users with disabilities.\nThis option lets an HTML element with a description be linked to the\nchart, so that screen reader users can connect the two.\n\nBy setting this option to a string, Highcharts runs the string as an\nHTML selector query on the entire document. If there is only a single\nmatch, this element is linked to the chart. The content of the linked\nelement will be included in the chart description for screen reader\nusers.\n\nBy default, the chart looks for an adjacent sibling element with the\n`highcharts-description` class.\n\nThe feature can be disabled by setting the option to an empty string,\nor overridden by providing the\n[accessibility.description](#accessibility.description) option.\nAlternatively, the HTML element to link can be passed in directly as\nan HTML node.\n\nIf you need the description to be part of the exported image,\nconsider using the [caption](#caption) feature.\n\nIf you need the description to be hidden visually, use the\n[accessibility.description](#accessibility.description) option.","see":["[caption](#caption)","[description](#accessibility.description)","[typeDescription](#accessibility.typeDescription)"],"samples":[{"name":"Accessible line chart","value":"highcharts/accessibility/accessible-line"}],"type":{"names":["string","Highcharts.HTMLDOMElement"]},"since":"8.0.0","defaultvalue":"*[data-highcharts-chart=\"{index}\"] + .highcharts-description"},"meta":{"fullname":"accessibility.linkedDescription","name":"linkedDescription","line":436,"lineEnd":475,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":"*[data-highcharts-chart=\"{index}\"] + .highcharts-description"},"children":{}},"point":{"doclet":{"description":"Options for descriptions of individual data points.","since":"8.0.0","type":{"names":["*"]}},"meta":{"fullname":"accessibility.point","name":"point","line":297,"lineEnd":301,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"dateFormat":{"doclet":{"description":"Date format to use for points on datetime axes when describing\nthem to screen reader users.\n\nDefaults to the same format as in tooltip.\n\nFor an overview of the replacement codes, see\n[dateFormat](/class-reference/Highcharts.Time#dateFormat).","see":["[dateFormatter](#accessibility.point.dateFormatter)"],"type":{"names":["string"]},"since":"8.0.0"},"meta":{"fullname":"accessibility.point.dateFormat","name":"dateFormat","line":303,"lineEnd":317,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"dateFormatter":{"doclet":{"description":"Formatter function to determine the date/time format used with\npoints on datetime axes when describing them to screen reader\nusers. Receives one argument, `point`, referring to the point\nto describe. Should return a date format string compatible with\n[dateFormat](/class-reference/Highcharts.Time#dateFormat).","see":["[dateFormat](#accessibility.point.dateFormat)"],"type":{"names":["Highcharts.ScreenReaderFormatterCallbackFunction.<Highcharts.Point>"]},"since":"8.0.0"},"meta":{"fullname":"accessibility.point.dateFormatter","name":"dateFormatter","line":318,"lineEnd":330,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"describeNull":{"doclet":{"description":"Whether or not to describe points with the value `null` to\nassistive technology, such as screen readers.","samples":[{"name":"Accessible map with null points","value":"maps/demo/all-areas-as-null","products":["highmaps"]}],"type":{"names":["boolean"]},"since":"10.1.0","defaultvalue":true},"meta":{"fullname":"accessibility.point.describeNull","name":"describeNull","line":410,"lineEnd":419,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":true},"children":{}},"descriptionFormat":{"doclet":{"description":"A [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nto use instead of the default for point descriptions.\n\nThe context of the format string is the point instance.\n\nAs opposed to [accessibility.point.valueDescriptionFormat](#accessibility.point.valueDescriptionFormat),\nthis option replaces the whole description.","type":{"names":["string"]},"since":"11.1.0","samples":[{"name":"Description format","value":"highcharts/demo/advanced-accessible"}]},"meta":{"fullname":"accessibility.point.descriptionFormat","name":"descriptionFormat","line":355,"lineEnd":369,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"descriptionFormatter":{"doclet":{"description":"Formatter function to use instead of the default for point\ndescriptions.\n\nReceives one argument, `point`, referring to the point to\ndescribe. Should return a string with the description of the\npoint for a screen reader user. If `false` is returned, the\ndefault formatter will be used for that point.\n\nNote: Prefer using [accessibility.point.valueDescriptionFormat](#accessibility.point.valueDescriptionFormat)\ninstead if possible, as default functionality such as describing\nannotations will be preserved.","see":["[accessibility.point.valueDescriptionFormat](#accessibility.point.valueDescriptionFormat)","[point.accessibility.description](#series.line.data.accessibility.description)"],"type":{"names":["Highcharts.ScreenReaderFormatterCallbackFunction.<Highcharts.Point>"]},"since":"8.0.0"},"meta":{"fullname":"accessibility.point.descriptionFormatter","name":"descriptionFormatter","line":370,"lineEnd":389,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"valueDecimals":{"doclet":{"description":"Decimals to use for the values in the point descriptions. Uses\n[tooltip.valueDecimals](#tooltip.valueDecimals) if not defined.","type":{"names":["number"]},"since":"8.0.0"},"meta":{"fullname":"accessibility.point.valueDecimals","name":"valueDecimals","line":347,"lineEnd":354,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"valueDescriptionFormat":{"doclet":{"description":"Format to use for describing the values of data points\nto assistive technology - including screen readers.\nThe point context is available as `{point}`.\n\nOther available context variables include `{index}`, `{value}`, and `{xDescription}`.\n\nAdditionally, the series name, annotation info, and\ndescription added in `point.accessibility.description`\nis added by default if relevant. To override this, use the\n[accessibility.point.descriptionFormatter](#accessibility.point.descriptionFormatter)\noption.","see":["[point.accessibility.description](#series.line.data.accessibility.description)","[accessibility.point.descriptionFormatter](#accessibility.point.descriptionFormatter)"],"type":{"names":["string"]},"since":"8.0.1","defaultvalue":"{xDescription}{separator}{value}."},"meta":{"fullname":"accessibility.point.valueDescriptionFormat","name":"valueDescriptionFormat","line":303,"lineEnd":317,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":"{xDescription}{separator}{value}."},"children":{}},"valuePrefix":{"doclet":{"description":"Prefix to add to the values in the point descriptions. Uses\n[tooltip.valuePrefix](#tooltip.valuePrefix) if not defined.","type":{"names":["string"]},"since":"8.0.0"},"meta":{"fullname":"accessibility.point.valuePrefix","name":"valuePrefix","line":331,"lineEnd":338,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"valueSuffix":{"doclet":{"description":"Suffix to add to the values in the point descriptions. Uses\n[tooltip.valueSuffix](#tooltip.valueSuffix) if not defined.","type":{"names":["string"]},"since":"8.0.0"},"meta":{"fullname":"accessibility.point.valueSuffix","name":"valueSuffix","line":339,"lineEnd":346,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}}}},"screenReaderSection":{"doclet":{"description":"Accessibility options for the screen reader information sections\nadded before and after the chart.","since":"8.0.0","type":{"names":["*"]}},"meta":{"fullname":"accessibility.screenReaderSection","name":"screenReaderSection","line":125,"lineEnd":130,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"afterChartFormat":{"doclet":{"description":"Format for the screen reader information region after the chart.\nAnalogous to [beforeChartFormat](#accessibility.screenReaderSection.beforeChartFormat).","since":"8.0.0","type":{"names":["string"]},"defaultvalue":"{endOfChartMarker}"},"meta":{"fullname":"accessibility.screenReaderSection.afterChartFormat","name":"afterChartFormat","line":194,"lineEnd":202,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":"{endOfChartMarker}"},"children":{}},"afterChartFormatter":{"doclet":{"description":"A formatter function to create the HTML contents of the hidden\nscreen reader information region after the chart. Analogous to\n[beforeChartFormatter](#accessibility.screenReaderSection.beforeChartFormatter).","type":{"names":["Highcharts.ScreenReaderFormatterCallbackFunction.<Highcharts.Chart>"]},"since":"8.0.0"},"meta":{"fullname":"accessibility.screenReaderSection.afterChartFormatter","name":"afterChartFormatter","line":194,"lineEnd":202,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"axisRangeDateFormat":{"doclet":{"description":"Date format to use to describe range of datetime axes.\n\nFor an overview of the replacement codes, see\n[dateFormat](/class-reference/Highcharts.Time#dateFormat).","see":["[point.dateFormat](#accessibility.point.dateFormat)"],"since":"8.0.0","type":{"names":["string"]},"defaultvalue":"%Y-%m-%d %H:%M:%S"},"meta":{"fullname":"accessibility.screenReaderSection.axisRangeDateFormat","name":"axisRangeDateFormat","line":210,"lineEnd":219,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":"%Y-%m-%d %H:%M:%S"},"children":{}},"beforeChartFormat":{"doclet":{"description":"Format for the screen reader information region before the chart.\nSupported HTML tags are `<h1-6>`, `<p>`, `<div>`, `<a>`, `<ul>`,\n`<ol>`, `<li>`, and `<button>`. Attributes are not supported,\nexcept for id on `<div>`, `<a>`, and `<button>`. Id is required\non `<a>` and `<button>` in the format `<tag id=\"abcd\">`. Numbers,\nlower- and uppercase letters, \"-\" and \"#\" are valid characters in\nIDs.\n\nThe headingTagName is an auto-detected heading (h1-h6) that\ncorresponds to the heading level below the previous heading in\nthe DOM.\n\nSet to empty string to remove the region altogether.","samples":[{"name":"beforeChartFormat","value":"highcharts/accessibility/before-chart-format"}],"since":"8.0.0","type":{"names":["string"]},"defaultvalue":"<{headingTagName}>{chartTitle}</{headingTagName}><div>{typeDescription}</div><div>{chartSubtitle}</div><div>{chartLongdesc}</div><div>{playAsSoundButton}</div><div>{viewTableButton}</div><div>{xAxisDescription}</div><div>{yAxisDescription}</div><div>{annotationsTitle}{annotationsList}</div>"},"meta":{"fullname":"accessibility.screenReaderSection.beforeChartFormat","name":"beforeChartFormat","line":132,"lineEnd":142,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":"<{headingTagName}>{chartTitle}</{headingTagName}><div>{typeDescription}</div><div>{chartSubtitle}</div><div>{chartLongdesc}</div><div>{playAsSoundButton}</div><div>{viewTableButton}</div><div>{xAxisDescription}</div><div>{yAxisDescription}</div><div>{annotationsTitle}{annotationsList}</div>"},"children":{}},"beforeChartFormatter":{"doclet":{"description":"A formatter function to create the HTML contents of the hidden\nscreen reader information region before the chart. Receives one\nargument, `chart`, referring to the chart object. Should return a\nstring with the HTML content of the region. By default this\nreturns an automatic description of the chart based on\n[beforeChartFormat](#accessibility.screenReaderSection.beforeChartFormat).","type":{"names":["Highcharts.ScreenReaderFormatterCallbackFunction.<Highcharts.Chart>"]},"since":"8.0.0"},"meta":{"fullname":"accessibility.screenReaderSection.beforeChartFormatter","name":"beforeChartFormatter","line":153,"lineEnd":164,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"onPlayAsSoundClick":{"doclet":{"description":"Function to run upon clicking the \"Play as sound\" button in\nthe screen reader region.\n\nBy default Highcharts will call the `chart.sonify` function.","type":{"names":["Highcharts.ScreenReaderClickCallbackFunction"]},"since":"8.0.1"},"meta":{"fullname":"accessibility.screenReaderSection.onPlayAsSoundClick","name":"onPlayAsSoundClick","line":143,"lineEnd":152,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"onViewDataTableClick":{"doclet":{"description":"Function to run upon clicking the \"View as Data Table\" link in\nthe screen reader region.\n\nBy default Highcharts will insert and set focus to a data table\nrepresentation of the chart.","type":{"names":["Highcharts.ScreenReaderClickCallbackFunction"]},"since":"8.0.0"},"meta":{"fullname":"accessibility.screenReaderSection.onViewDataTableClick","name":"onViewDataTableClick","line":132,"lineEnd":142,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}}}},"series":{"doclet":{"description":"Accessibility options global to all data series. Individual series\ncan also have specific [accessibility options](#plotOptions.series.accessibility)\nset.","since":"8.0.0","type":{"names":["*"]}},"meta":{"fullname":"accessibility.series","name":"series","line":222,"lineEnd":228,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"describeSingleSeries":{"doclet":{"description":"Whether or not to add series descriptions to charts with a single\nseries.","since":"8.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"accessibility.series.describeSingleSeries","name":"describeSingleSeries","line":274,"lineEnd":279,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":false},"children":{}},"descriptionFormat":{"doclet":{"description":"Format to use for describing the data series group to assistive\ntechnology - including screen readers.\n\nThe series context and its subproperties are available under the\nvariable `{series}`, for example `{series.name}` for the series\nname, and `{series.points.length}` for the number of data points.\n\nThe chart context and its subproperties are available under the\nvariable `{chart}`, for example `{chart.series.length}` for the\nnumber of series in the chart.\n\n`{seriesDescription}` refers to the automatic description of the\nseries type and number of points added by Highcharts by default.\n`{authorDescription}` refers to the description added in\n[series.description](#plotOptions.series.description) if one is\npresent. `{axisDescription}` refers to the description added if\nthe chart has multiple X or Y axes.\n\nNote that if [series.descriptionFormatter](#accessibility.series.descriptionFormatter)\nis declared it will take precedence, and this option will be\noverridden.","samples":[{"name":"Accessible low-medium-high chart","value":"highcharts/accessibility/advanced-accessible"}],"type":{"names":["string"]},"since":"10.1.0","defaultvalue":"{seriesDescription}{authorDescription}{axisDescription}"},"meta":{"fullname":"accessibility.series.descriptionFormat","name":"descriptionFormat","line":230,"lineEnd":243,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":"{seriesDescription}{authorDescription}{axisDescription}"},"children":{}},"descriptionFormatter":{"doclet":{"description":"Formatter function to use instead of the default for series\ndescriptions. Receives one argument, `series`, referring to the\nseries to describe. Should return a string with the description\nof the series for a screen reader user. If `false` is returned,\nthe default formatter will be used for that series.","see":["[series.descriptionFormat](#accessibility.series.descriptionFormat)","[series.description](#plotOptions.series.description)"],"type":{"names":["Highcharts.ScreenReaderFormatterCallbackFunction.<Highcharts.Series>"]},"since":"8.0.0"},"meta":{"fullname":"accessibility.series.descriptionFormatter","name":"descriptionFormatter","line":230,"lineEnd":243,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"pointDescriptionEnabledThreshold":{"doclet":{"description":"When a series contains more points than this, we no longer expose\ninformation about individual points to screen readers.\nNote that the keyboard navigation remains functional, but points\nwon't have accessible descriptions unless handled separately.\n\nSet to `false` to disable.","samples":[{"name":"pointDescriptionEnabledThreshold","value":"highcharts/accessibility/point-description-enabled-threshold"}],"type":{"names":["boolean","number"]},"since":"8.0.0","defaultvalue":200},"meta":{"fullname":"accessibility.series.pointDescriptionEnabledThreshold","name":"pointDescriptionEnabledThreshold","line":281,"lineEnd":294,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":200},"children":{}}}},"typeDescription":{"doclet":{"description":"A text description of the chart type.\n\nIf the Accessibility module is loaded, this will be included in the\ndescription of the chart in the screen reader information region.\n\nHighcharts will by default attempt to guess the chart type, but for\nmore complex charts it is recommended to specify this property for\nclarity.","type":{"names":["string"]},"since":"5.0.0"},"meta":{"fullname":"accessibility.typeDescription","name":"typeDescription","line":538,"lineEnd":551,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}}}},"annotations":{"doclet":{"description":"A collection of annotations to add to the chart. The basic annotation allows\nadding custom labels or shapes. The items can be tied to points, axis\ncoordinates or chart pixel coordinates.\n\nGeneral options for all annotations can be set using the\n`Highcharts.setOptions` function. In this case only single objects are\nsupported, because it alters the defaults for all items. For initialization\nin the chart constructors however, arrays of annotations are supported.\n\nSee more in the [general docs](https://www.highcharts.com/docs/advanced-chart-features/annotations).","samples":[{"name":"Basic annotations","value":"highcharts/annotations/basic/"},{"name":"Annotated chart","value":"highcharts/demo/annotations/"},{"name":"Styled mode","value":"highcharts/css/annotations"},{"name":"Controllable items","value":"highcharts/annotations-advanced/controllable"},{"name":"Custom annotation, Fibonacci retracement","value":"stock/annotations/fibonacci-retracements","products":["highstock"]},{"name":"Themed crooked line annotation","value":"highcharts/annotations/shape/"}],"type":{"names":["Array.<*>"]},"since":"6.0.0","requires":["module:modules/annotations"]},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","name":"annotations","fullname":"annotations","line":12,"lineEnd":22,"column":4},"children":{"animation":{"doclet":{"description":"Enable or disable the initial animation when a series is\ndisplayed for the `annotation`. The animation can also be set\nas a configuration object. Please note that this option only\napplies to the initial animation.\nFor other animations, see [chart.animation](#chart.animation)\nand the animation parameter under the API methods.\nThe following properties are supported:\n\n- `defer`: The animation delay time in milliseconds.","samples":[{"name":"Animation defer settings","value":"highcharts/annotations/defer/","products":["highcharts"]}],"type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"since":"8.2.0"},"meta":{"fullname":"annotations.animation","name":"animation","line":73,"lineEnd":88,"column":4,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{"defer":{"doclet":{"description":"The animation delay time in milliseconds.\nSet to `0` renders annotation immediately.\nAs `undefined` inherits defer time from the [series.animation.defer](#plotOptions.series.animation.defer).","type":{"names":["number"]},"since":"8.2.0"},"meta":{"fullname":"annotations.animation.defer","name":"defer","line":100,"lineEnd":108,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}}}},"className":{"doclet":{"description":"A class name for styling by CSS.","since":"12.5.0","type":{"names":["string"]}},"meta":{"fullname":"annotations.className","name":"className","line":40,"lineEnd":46,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"controlPointOptions":{"doclet":{"description":"Options for annotation's control points. Each control point\ninherits options from controlPointOptions object.\nOptions from the controlPointOptions can be overwritten\nby options in a specific control point.","declare":"Highcharts.AnnotationControlPointOptionsObject","requires":["module:modules/annotations"],"since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"annotations.controlPointOptions","name":"controlPointOptions","line":599,"lineEnd":607,"column":4,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{"events":{"doclet":{"type":{"names":["Highcharts.Dictionary.<function()>"]}},"meta":{"fullname":"annotations.controlPointOptions.events","name":"events","line":609,"lineEnd":612,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"height":{"doclet":{"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"annotations.controlPointOptions.height","name":"height","line":626,"lineEnd":626,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":10},"children":{}},"positioner":{"doclet":{"type":{"names":["Highcharts.AnnotationControlPointPositionerFunction"]}},"meta":{"fullname":"annotations.controlPointOptions.positioner","name":"positioner","line":609,"lineEnd":612,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"style":{"doclet":{"type":{"names":["Highcharts.SVGAttributes"]}},"meta":{"fullname":"annotations.controlPointOptions.style","name":"style","line":617,"lineEnd":619,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{"cursor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"pointer"},"meta":{"fullname":"annotations.controlPointOptions.style.cursor","name":"cursor","line":621,"lineEnd":621,"column":12,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"pointer"},"children":{}},"fill":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#ffffff"},"meta":{"fullname":"annotations.controlPointOptions.style.fill","name":"fill","line":622,"lineEnd":622,"column":12,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"#ffffff"},"children":{}},"stroke":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#000000"},"meta":{"fullname":"annotations.controlPointOptions.style.stroke","name":"stroke","line":623,"lineEnd":623,"column":12,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"#000000"},"children":{}},"stroke-width":{"doclet":{"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"annotations.controlPointOptions.style.stroke-width","name":"stroke-width","line":624,"lineEnd":624,"column":12,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":2},"children":{}}}},"symbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"circle"},"meta":{"fullname":"annotations.controlPointOptions.symbol","name":"symbol","line":627,"lineEnd":627,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"circle"},"children":{}},"visible":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"annotations.controlPointOptions.visible","name":"visible","line":628,"lineEnd":628,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":false},"children":{}},"width":{"doclet":{"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"annotations.controlPointOptions.width","name":"width","line":629,"lineEnd":629,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":10},"children":{}}}},"crop":{"doclet":{"description":"Whether to hide the part of the annotation\nthat is outside the plot area.","samples":[{"name":"Crop line annotation","value":"highcharts/annotations/label-crop-overflow/"}],"type":{"names":["boolean"]},"since":"9.3.0","defaultvalue":true},"meta":{"fullname":"annotations.crop","name":"crop","line":90,"lineEnd":98,"column":4,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":true},"children":{}},"draggable":{"doclet":{"description":"Allow an annotation to be draggable by a user. Possible\nvalues are `'x'`, `'xy'`, `'y'` and `''` (disabled).","samples":[{"name":"Annotations draggable: 'xy'","value":"highcharts/annotations/draggable/"}],"type":{"names":["Highcharts.AnnotationDraggableValue"]},"since":"6.0.0","defaultvalue":"xy"},"meta":{"fullname":"annotations.draggable","name":"draggable","line":100,"lineEnd":108,"column":4,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"xy"},"children":{}},"events":{"doclet":{"description":"Events available in annotations.","requires":["module:modules/annotations"],"since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"annotations.events","name":"events","line":631,"lineEnd":637,"column":4,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{"add":{"doclet":{"description":"Event callback when annotation is added to the chart.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.Annotation>"]},"since":"7.1.0"},"meta":{"fullname":"annotations.events.add","name":"add","line":631,"lineEnd":637,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"afterUpdate":{"doclet":{"description":"Event callback when annotation is updated (e.g. drag and\ndropped or resized by control points).","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.Annotation>"]},"since":"7.1.0"},"meta":{"fullname":"annotations.events.afterUpdate","name":"afterUpdate","line":638,"lineEnd":645,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"click":{"doclet":{"description":"Fires when the annotation is clicked.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.Annotation>"]},"since":"7.1.0"},"meta":{"fullname":"annotations.events.click","name":"click","line":646,"lineEnd":652,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"drag":{"doclet":{"description":"Fires when the annotation is dragged.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.Annotation>"]},"since":"6.0.0"},"meta":{"fullname":"annotations.events.drag","name":"drag","line":653,"lineEnd":658,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"remove":{"doclet":{"description":"Event callback when annotation is removed from the chart.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.Annotation>"]},"since":"7.1.0"},"meta":{"fullname":"annotations.events.remove","name":"remove","line":659,"lineEnd":665,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}}}},"id":{"doclet":{"description":"Sets an ID for an annotation. Can be user later when\nremoving an annotation in [Chart#removeAnnotation(id)](/class-reference/Highcharts.Chart#removeAnnotation) method.","type":{"names":["number","string"]},"since":"6.0.0"},"meta":{"fullname":"annotations.id","name":"id","line":47,"lineEnd":54,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"labelOptions":{"meta":{"fullname":"annotations.labelOptions","name":"labelOptions","line":119,"lineEnd":125,"column":4,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"doclet":{"description":"Options for annotation's labels. Each label inherits options\nfrom the labelOptions object. An option from the labelOptions\ncan be overwritten by config for a specific label.","requires":["module:modules/annotations"],"since":"6.0.0","type":{"names":["*"]}},"children":{"accessibility":{"doclet":{"description":"Accessibility options for an annotation label.","declare":"Highcharts.AnnotationLabelAccessibilityOptionsObject","since":"8.0.1","requires":["module:modules/accessibility"],"type":{"names":["*"]}},"meta":{"fullname":"annotations.labelOptions.accessibility","name":"accessibility","line":857,"lineEnd":864,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"description":{"doclet":{"description":"Description of an annotation label for screen readers and other assistive\ntechnology.","type":{"names":["string"]},"since":"8.0.1"},"meta":{"fullname":"annotations.labelOptions.accessibility.description","name":"description","line":865,"lineEnd":872,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}}}},"align":{"doclet":{"description":"The alignment of the annotation's label. If right,\nthe right side of the label should be touching the point.","samples":[{"name":"Set labels position","value":"highcharts/annotations/label-position/"}],"type":{"names":["Highcharts.AlignValue"]},"since":"6.0.0","defaultvalue":"center"},"meta":{"fullname":"annotations.labelOptions.align","name":"align","line":127,"lineEnd":135,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"center"},"children":{}},"allowOverlap":{"doclet":{"description":"Whether to allow the annotation's labels to overlap.\nTo make the labels less sensitive for overlapping,\nthe can be set to 0.","samples":[{"name":"Hide overlapping labels","value":"highcharts/annotations/tooltip-like/"}],"since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"annotations.labelOptions.allowOverlap","name":"allowOverlap","line":137,"lineEnd":144,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":false},"children":{}},"backgroundColor":{"doclet":{"description":"The background color or gradient for the annotation's label.","samples":[{"name":"Set labels graphic options","value":"highcharts/annotations/label-presentation/"}],"type":{"names":["Highcharts.ColorType"]},"since":"6.0.0","defaultvalue":"rgba(0, 0, 0, 0.75)"},"meta":{"fullname":"annotations.labelOptions.backgroundColor","name":"backgroundColor","line":146,"lineEnd":153,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"rgba(0, 0, 0, 0.75)"},"children":{}},"borderColor":{"doclet":{"description":"The border color for the annotation's label.","samples":[{"name":"Set labels graphic options","value":"highcharts/annotations/label-presentation/"}],"type":{"names":["Highcharts.ColorType"]},"since":"6.0.0","defaultvalue":"#000000"},"meta":{"fullname":"annotations.labelOptions.borderColor","name":"borderColor","line":155,"lineEnd":162,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"#000000"},"children":{}},"borderRadius":{"doclet":{"description":"The border radius in pixels for the annotation's label.","samples":[{"name":"Set labels graphic options","value":"highcharts/annotations/label-presentation/"}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"annotations.labelOptions.borderRadius","name":"borderRadius","line":164,"lineEnd":169,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":3},"children":{}},"borderWidth":{"doclet":{"description":"The border width in pixels for the annotation's label.","samples":[{"name":"Set labels graphic options","value":"highcharts/annotations/label-presentation/"}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"annotations.labelOptions.borderWidth","name":"borderWidth","line":171,"lineEnd":176,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":1},"children":{}},"className":{"doclet":{"description":"A class name for styling by CSS.","samples":[{"name":"Styled mode annotations","value":"highcharts/css/annotations"}],"since":"6.0.5","type":{"names":["string"]},"defaultvalue":"highcharts-no-tooltip"},"meta":{"fullname":"annotations.labelOptions.className","name":"className","line":178,"lineEnd":185,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"highcharts-no-tooltip"},"children":{}},"crop":{"doclet":{"description":"Whether to hide the annotation's label\nthat is outside the plot area.","samples":[{"name":"Crop or justify labels","value":"highcharts/annotations/label-crop-overflow/"}],"since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"annotations.labelOptions.crop","name":"crop","line":187,"lineEnd":193,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":false},"children":{}},"distance":{"doclet":{"description":"The label's pixel distance from the point.","samples":[{"name":"Set labels position","value":"highcharts/annotations/label-position/"}],"type":{"names":["number"]},"since":"6.0.0"},"meta":{"fullname":"annotations.labelOptions.distance","name":"distance","line":195,"lineEnd":203,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"format":{"doclet":{"description":"A\n[format](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nstring for the data label.","see":["[plotOptions.series.dataLabels.format](#plotOptions.series.dataLabels.format)"],"samples":[{"name":"Set labels text","value":"highcharts/annotations/label-text/"}],"type":{"names":["string"]},"since":"6.0.0"},"meta":{"fullname":"annotations.labelOptions.format","name":"format","line":204,"lineEnd":216,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"formatter":{"doclet":{"description":"Callback JavaScript function to format the annotation's\nlabel. Note that if a `format` or `text` are defined,\nthe format or text take precedence and the formatter is\nignored. `This` refers to a point object. The callback also receives\nan argument `ctx` so that arrow-functions can access the same\ncontext (the point in this case) as normal functions can using\n`this`. Since v12.6.0, the callback receives `ctx`.","samples":[{"name":"Set labels text","value":"highcharts/annotations/label-text/"}],"type":{"names":["Highcharts.FormatterCallbackFunction.<Highcharts.Point>"]},"defaultvalue":"function () { return defined(this.y) ? this.y : 'Annotation label'; }","since":"6.0.0"},"meta":{"fullname":"annotations.labelOptions.formatter","name":"formatter","line":195,"lineEnd":203,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"includeInDataExport":{"doclet":{"description":"Whether all the labels for an annotation are visible in the exported\ndata table.","samples":[{"name":"Do not include in the data export","value":"highcharts/annotations/include-in-data-export/"}],"since":"8.2.0","requires":["module:modules/export-data"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"annotations.labelOptions.includeInDataExport","name":"includeInDataExport","line":246,"lineEnd":255,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":true},"children":{}},"overflow":{"doclet":{"description":"How to handle the annotation's label that flow outside\nthe plot area. The justify option aligns the label inside\nthe plot area.","samples":[{"name":"Crop or justify labels","value":"highcharts/annotations/label-crop-overflow/"}],"values":"[\"allow\", \"justify\"]","since":"6.0.0","type":{"names":["string"]},"defaultvalue":"justify"},"meta":{"fullname":"annotations.labelOptions.overflow","name":"overflow","line":257,"lineEnd":266,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"justify"},"children":{}},"padding":{"doclet":{"description":"When either the borderWidth or the backgroundColor is\nset, this is the padding within the box.","samples":[{"name":"Set labels graphic options","value":"highcharts/annotations/label-presentation/"}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"annotations.labelOptions.padding","name":"padding","line":268,"lineEnd":274,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":5},"children":{}},"shadow":{"doclet":{"description":"The shadow of the box. The shadow can be an object\nconfiguration containing `color`, `offsetX`, `offsetY`,\n`opacity` and `width`.","samples":[{"name":"Set labels graphic options","value":"highcharts/annotations/label-presentation/"}],"type":{"names":["boolean","Highcharts.ShadowOptionsObject"]},"since":"6.0.0","defaultvalue":false},"meta":{"fullname":"annotations.labelOptions.shadow","name":"shadow","line":276,"lineEnd":285,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":false},"children":{}},"shape":{"doclet":{"description":"The name of a symbol to use for the border around the\nlabel. Symbols are predefined functions on the Renderer\nobject.","samples":[{"name":"Available shapes for labels","value":"highcharts/annotations/shapes/"}],"since":"6.0.0","type":{"names":["string"]},"defaultvalue":"callout"},"meta":{"fullname":"annotations.labelOptions.shape","name":"shape","line":287,"lineEnd":294,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"callout"},"children":{}},"style":{"doclet":{"description":"Styles for the annotation's label.","see":["[plotOptions.series.dataLabels.style](plotOptions.series.dataLabels.style.html)"],"samples":[{"name":"Set labels graphic options","value":"highcharts/annotations/label-presentation/"}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"fontSize\": \"0.7em\", \"fontWeight\": \"normal\", \"color\": \"contrast\"}","since":"6.0.0"},"meta":{"fullname":"annotations.labelOptions.style","name":"style","line":296,"lineEnd":306,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"text":{"doclet":{"description":"Alias for the format option.","see":["[format](#annotations.labelOptions.format)"],"samples":[{"name":"Set labels text","value":"highcharts/annotations/label-text/"}],"type":{"names":["string"]},"since":"6.0.0"},"meta":{"fullname":"annotations.labelOptions.text","name":"text","line":217,"lineEnd":227,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"useHTML":{"doclet":{"description":"Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the annotation's label.","since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"annotations.labelOptions.useHTML","name":"useHTML","line":315,"lineEnd":318,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":false},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of the annotation's label.","samples":[{"name":"Set labels position","value":"highcharts/annotations/label-position/"}],"type":{"names":["Highcharts.VerticalAlignValue"]},"since":"6.0.0","defaultvalue":"bottom"},"meta":{"fullname":"annotations.labelOptions.verticalAlign","name":"verticalAlign","line":320,"lineEnd":327,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"bottom"},"children":{}},"x":{"doclet":{"description":"The x position offset of the label relative to the point.\nNote that if a `distance` is defined, the distance takes\nprecedence over `x` and `y` options.","samples":[{"name":"Set labels position","value":"highcharts/annotations/label-position/"}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.labelOptions.x","name":"x","line":329,"lineEnd":336,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"The y position offset of the label relative to the point.\nNote that if a `distance` is defined, the distance takes\nprecedence over `x` and `y` options.","samples":[{"name":"Set labels position","value":"highcharts/annotations/label-position/"}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":-16},"meta":{"fullname":"annotations.labelOptions.y","name":"y","line":338,"lineEnd":345,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":-16},"children":{}}}},"labels":{"doclet":{"description":"An array of labels for the annotation. For options that apply\nto multiple labels, they can be added to the\n[labelOptions](annotations.labelOptions.html).","type":{"names":["Array.<*>"]},"extends":"annotations.labelOptions","since":"6.0.0"},"meta":{"fullname":"annotations.labels","name":"labels","line":348,"lineEnd":356,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{"controlPoints":{"doclet":{"description":"The array of control points.","samples":[{"name":"Ellipse annotation","value":"highcharts/annotations/ellipse"}],"extends":"annotations.controlPointOptions","type":{"names":["Array.<AnnotationControlPointOptionsObject>"]},"since":"6.0.0"},"meta":{"fullname":"annotations.labels.controlPoints","name":"controlPoints","line":357,"lineEnd":366,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"point":{"doclet":{"description":"This option defines the point to which the label will be\nconnected. It can be either the point which exists in the\nseries - it is referenced by the point's id - or a new point\nwith defined x, y properties and optionally axes.","samples":[{"name":"Attach annotation to a mock point","value":"highcharts/annotations/mock-point/"},{"name":"Attach annotation to a mock point with different ways","value":"highcharts/annotations/mock-points/"}],"type":{"names":["Highcharts.AnnotationMockPointOptions"]},"requires":["module:modules/annotations"],"since":"6.0.0"},"meta":{"fullname":"annotations.labels.point","name":"point","line":367,"lineEnd":381,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}}}},"shapeOptions":{"doclet":{"description":"Options for annotation's shapes. Each shape inherits options\nfrom the shapeOptions object. An option from the shapeOptions\ncan be overwritten by config for a specific shape.","requires":["module:modules/annotations"],"since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"annotations.shapeOptions","name":"shapeOptions","line":348,"lineEnd":356,"column":4,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{"dashStyle":{"doclet":{"description":"Name of the dash style to use for the shape's stroke.","samples":[{"name":"Possible values demonstrated","value":"highcharts/plotoptions/series-dashstyle-all/","products":["highcharts"]}],"type":{"names":["Highcharts.DashStyleValue"]},"since":"6.0.0"},"meta":{"fullname":"annotations.shapeOptions.dashStyle","name":"dashStyle","line":550,"lineEnd":558,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"fill":{"doclet":{"description":"The color of the shape's fill.","samples":[{"name":"Basic shape annotation","value":"highcharts/annotations/shape/"}],"type":{"names":["Highcharts.ColorType"]},"since":"6.0.0","defaultvalue":"rgba(0, 0, 0, 0.75)"},"meta":{"fullname":"annotations.shapeOptions.fill","name":"fill","line":575,"lineEnd":582,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"rgba(0, 0, 0, 0.75)"},"children":{}},"height":{"doclet":{"description":"The height of the `rect` shape. Can be defined in pixels or yAxis\nunits, if [shapes.yAxis](#annotations.shapeOptions.yAxis) index is\ndefined.","samples":[{"name":"Basic shape annotation","value":"highcharts/annotations/shape/"}],"type":{"names":["number"]},"since":"6.0.0"},"meta":{"fullname":"annotations.shapeOptions.height","name":"height","line":513,"lineEnd":523,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"r":{"doclet":{"description":"The radius of the `circle` shape. Can be defined in pixels or yAxis\nunits, if [shapes.yAxis](#annotations.shapeOptions.yAxis) index is\ndefined.","samples":[{"name":"Basic shape annotation","value":"highcharts/annotations/shape/"}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.shapeOptions.r","name":"r","line":584,"lineEnd":591,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":0},"children":{}},"ry":{"doclet":{"description":"The radius of the `ellipse` shape in y direction. Can be defined in\npixels or yAxis units, if\n[shapes.yAxis](#annotations.shapeOptions.yAxis) index is defined.","samples":[{"name":"Ellipse annotation","value":"highcharts/annotations/ellipse/"}],"type":{"names":["number"]},"since":"6.0.0"},"meta":{"fullname":"annotations.shapeOptions.ry","name":"ry","line":461,"lineEnd":471,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"snap":{"doclet":{"description":"Defines additional snapping area around an annotation\nmaking this annotation to focus. Defined in pixels.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"annotations.shapeOptions.snap","name":"snap","line":593,"lineEnd":596,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":2},"children":{}},"src":{"doclet":{"description":"The URL for an image to use as the annotation shape.\nNote, type has to be set to `'image'`.","see":["[annotations.shapeOptions.type](#annotations.shapeOptions.type)"],"samples":[{"name":"Define a marker image url for annotations","value":"highcharts/annotations/shape-src/"}],"type":{"names":["string"]},"since":"6.0.0"},"meta":{"fullname":"annotations.shapeOptions.src","name":"src","line":538,"lineEnd":549,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"stroke":{"doclet":{"description":"The color of the shape's stroke.","samples":[{"name":"Basic shape annotation","value":"highcharts/annotations/shape/"}],"type":{"names":["Highcharts.ColorType"]},"since":"6.0.0","defaultvalue":"rgba(0, 0, 0, 0.75)"},"meta":{"fullname":"annotations.shapeOptions.stroke","name":"stroke","line":461,"lineEnd":471,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":"rgba(0, 0, 0, 0.75)"},"children":{}},"strokeWidth":{"doclet":{"description":"The pixel stroke width of the shape.","samples":[{"name":"Basic shape annotation","value":"highcharts/annotations/shape/"}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"annotations.shapeOptions.strokeWidth","name":"strokeWidth","line":568,"lineEnd":573,"column":8,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":1},"children":{}},"type":{"doclet":{"description":"The type of the shape.\nAvailable options are `circle`, `rect`, `ellipse` and `path`.","samples":[{"name":"Basic shape annotation","value":"highcharts/annotations/shape/"},{"name":"Ellipse annotation","value":"highcharts/annotations/ellipse/"}],"type":{"names":["string"]},"defaultvalue":"rect","since":"6.0.0"},"meta":{"fullname":"annotations.shapeOptions.type","name":"type","line":524,"lineEnd":537,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"width":{"doclet":{"description":"The width of the `rect` shape. Can be defined in pixels or xAxis\nunits, if [shapes.xAxis](#annotations.shapeOptions.xAxis) index is\ndefined.","samples":[{"name":"Basic shape annotation","value":"highcharts/annotations/shape/"}],"type":{"names":["number"]},"since":"6.0.0"},"meta":{"fullname":"annotations.shapeOptions.width","name":"width","line":502,"lineEnd":512,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"xAxis":{"doclet":{"description":"The xAxis index which should be used for annotation's sizes and\npoints coordinates conversion.\n\nThis option is used for `rect` shape\n[width](#annotations.shapeOptions.width), and all shapes\n[point](#annotations.shapes.point) and\n[points](#annotations.shapes.points) coordinates.","samples":[{"name":"Shapes created with axis units","value":"highcharts/annotations/shapes-axis-units/"}],"type":{"names":["number"]},"since":"6.0.0"},"meta":{"fullname":"annotations.shapeOptions.xAxis","name":"xAxis","line":472,"lineEnd":485,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"yAxis":{"doclet":{"description":"The yAxis index which should be used for annotation's sizes and\npoints coordinates conversion.\n\nThis option is used for `rect` shape\n[height](#annotations.shapeOptions.height), `circle` shape\n[radius](#annotations.shapeOptions.r), `ellipse`\n[y direction radius](#annotations.shapeOptions.ry), and all shapes\n[point](#annotations.shapes.point) and\n[points](#annotations.shapes.points) coordinates.","samples":[{"name":"Shapes created with axis units","value":"highcharts/annotations/shapes-axis-units/"}],"type":{"names":["number"]},"since":"6.0.0"},"meta":{"fullname":"annotations.shapeOptions.yAxis","name":"yAxis","line":486,"lineEnd":501,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}}}},"shapes":{"doclet":{"description":"An array of shapes for the annotation. For options that apply\nto multiple shapes, then can be added to the\n[shapeOptions](annotations.shapeOptions.html).","type":{"names":["Array.<*>"]},"extends":"annotations.shapeOptions","since":"6.0.0"},"meta":{"fullname":"annotations.shapes","name":"shapes","line":382,"lineEnd":390,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{"controlPoints":{"doclet":{"description":"The array of control points.","samples":[{"name":"Controllable image annotation","value":"highcharts/annotations-advanced/controllable-image"}],"extends":"annotations.controlPointOptions","type":{"names":["Array.<AnnotationControlPointOptionsObject>"]},"since":"6.0.0"},"meta":{"fullname":"annotations.shapes.controlPoints","name":"controlPoints","line":391,"lineEnd":400,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"markerEnd":{"doclet":{"description":"Id of the marker which will be drawn at the final vertex of\nthe path. Custom markers can be defined in defs property.","see":["[defs.markers](#defs.markers)"],"samples":[{"name":"Define a custom marker for annotations","value":"highcharts/annotations/custom-markers/"}],"type":{"names":["string"]},"since":"6.0.0"},"meta":{"fullname":"annotations.shapes.markerEnd","name":"markerEnd","line":429,"lineEnd":440,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"markerStart":{"doclet":{"description":"Id of the marker which will be drawn at the first vertex of\nthe path. Custom markers can be defined in defs property.","see":["[defs.markers](#defs.markers)"],"samples":[{"name":"Define a custom marker for annotations","value":"highcharts/annotations/custom-markers/","products":["highcharts"]}],"type":{"names":["string"]},"since":"6.0.0"},"meta":{"fullname":"annotations.shapes.markerStart","name":"markerStart","line":441,"lineEnd":452,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"point":{"doclet":{"description":"This option defines the point to which the shape will be\nconnected. It can be either the point which exists in the\nseries - it is referenced by the point's id - or a new point\nwith defined x, y properties and optionally axes.","samples":[{"name":"Attach annotation to a mock point with different ways","value":"highcharts/annotations/mock-points/"}],"type":{"names":["Highcharts.AnnotationMockPointOptions"]},"extends":"annotations.labels.point","requires":["module:modules/annotations"],"since":"6.0.0"},"meta":{"fullname":"annotations.shapes.point","name":"point","line":401,"lineEnd":414,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"points":{"doclet":{"description":"An array of points for the shape\nor a callback function that returns that shape point.\n\nThis option is available\nfor shapes which can use multiple points such as path. A\npoint can be either a point object or a point's id.","see":["[annotations.shapes.point](#annotations.shapes.point)"],"type":{"names":["Array.<Highcharts.AnnotationMockPointOptions>"]},"extends":"annotations.labels.point","since":"6.0.0"},"meta":{"fullname":"annotations.shapes.points","name":"points","line":415,"lineEnd":428,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}}}},"type":{"doclet":{"description":"For advanced annotations, this option defines the type of annotation. Can\nbe one of the keys listed under the [types option](#annotations.types).","samples":[{"name":"Crooked line annotation","value":"highcharts/annotations-advanced/crooked-line"}],"requires":["module:modules/annotations-advanced"],"products":["highstock"],"type":{"names":["string"]},"since":"6.0.0"},"meta":{"fullname":"annotations.type","name":"type","line":55,"lineEnd":65,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"typeOptions":{"doclet":{"description":"Additional options for an annotation with the type.","requires":["module:modules/annotations"],"since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"annotations.typeOptions","name":"typeOptions","line":672,"lineEnd":678,"column":4,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{"background":{"doclet":{"description":"Background shape options for the annotation.","extends":"annotations.shapeOptions","since":"6.0.0"},"meta":{"fullname":"annotations.typeOptions.background","name":"background","line":680,"lineEnd":685,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"height":{"doclet":{"description":"Height of the annotation in pixels.","type":{"names":["number"]},"since":"6.0.0"},"meta":{"fullname":"annotations.typeOptions.height","name":"height","line":686,"lineEnd":691,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"line":{"doclet":{"description":"Line options.","extends":"annotations.shapeOptions","since":"6.0.0"},"meta":{"fullname":"annotations.typeOptions.line","name":"line","line":692,"lineEnd":697,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"point":{"doclet":{"description":"A single point that the annotation is attached to. It can be either\nthe point which exists in the series - it is referenced by the\npoint's id - or a new point with defined x, y properties\nand optionally axes.","type":{"names":["string","Highcharts.AnnotationMockPointOptionsObject"]},"since":"6.0.0"},"meta":{"fullname":"annotations.typeOptions.point","name":"point","line":698,"lineEnd":706,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"points":{"doclet":{"description":"An array of points that the annotation is attached to. Each point can\nthe point which exists in the series - it is referenced by the\npoint's id - or a new point with defined x, y properties\nand optionally axes.","type":{"names":["Array.<(string|Highcharts.AnnotationMockPointOptionsObject)>"]},"since":"6.0.0"},"meta":{"fullname":"annotations.typeOptions.points","name":"points","line":707,"lineEnd":715,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"type":{"doclet":{"description":"The annotation type identifier.","type":{"names":["string"]},"since":"6.0.0"},"meta":{"fullname":"annotations.typeOptions.type","name":"type","line":716,"lineEnd":721,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"xAxis":{"doclet":{"description":"This number defines which `xAxis` the point is connected to.\nIt refers to either the axis id or the index of the axis\nin the `xAxis` array.","type":{"names":["number"]},"since":"6.0.0"},"meta":{"fullname":"annotations.typeOptions.xAxis","name":"xAxis","line":722,"lineEnd":729,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}},"yAxis":{"doclet":{"description":"This number defines which `yAxis` the point is connected to.\nIt refers to either the axis id or the index of the axis\nin the `yAxis` array.","type":{"names":["number"]},"since":"6.0.0"},"meta":{"fullname":"annotations.typeOptions.yAxis","name":"yAxis","line":730,"lineEnd":737,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js"},"children":{}}}},"types":{"doclet":{"description":"Option override for specific advanced annotation types. This collection\nis intended for general theming using `Highcharts.setOptions()`.","samples":[{"name":"Themed crooked line annotation","value":"highcharts/annotations/shape/"}],"products":["highstock"],"requires":["module:modules/annotations-advanced"],"since":"6.0.0","type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","name":"types","fullname":"annotations.types","line":12,"lineEnd":22,"column":4},"children":{"crookedLine":{"doclet":{"description":"Options for the crooked line annotation type.","samples":[{"name":"Crooked line","value":"highcharts/annotations-advanced/crooked-line/"}],"products":["highstock"],"since":"6.0.0","type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js","name":"crookedLine","fullname":"annotations.types.crookedLine","line":13,"lineEnd":21,"column":4},"children":{"controlPointOptions":{"doclet":{"exclude":["positioner","events"],"extends":"annotations.controlPointOptions"},"meta":{"fullname":"annotations.types.crookedLine.controlPointOptions","name":"controlPointOptions","line":73,"lineEnd":76,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js"},"children":{"events":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.crookedLine.controlPointOptions.events","name":"events","line":85,"lineEnd":85,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js"},"children":{}}}},"labelOptions":{"doclet":{"extends":"annotations.labelOptions"},"meta":{"fullname":"annotations.types.crookedLine.labelOptions","name":"labelOptions","line":23,"lineEnd":26,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js"},"children":{}},"typeOptions":{"doclet":{"description":"Additional options for an annotation with the type.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"annotations.types.crookedLine.typeOptions","name":"typeOptions","line":23,"lineEnd":26,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js"},"children":{"line":{"doclet":{"description":"Line options.","exclude":["height","point","points","r","type","width"],"since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"annotations.types.crookedLine.typeOptions.line","name":"line","line":43,"lineEnd":46,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js"},"children":{"fill":{"doclet":{"type":{"names":["string"]},"defaultvalue":"none"},"meta":{"fullname":"annotations.types.crookedLine.typeOptions.line.fill","name":"fill","line":70,"lineEnd":70,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js","default":"none"},"children":{}}}},"points":{"doclet":{"type":{"names":["Array.<*>"]}},"meta":{"fullname":"annotations.types.crookedLine.typeOptions.points","name":"points","line":43,"lineEnd":46,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js"},"children":{"controlPoint":{"doclet":{"type":{"names":["number"]},"exclude":["positioner","events"]},"meta":{"fullname":"annotations.types.crookedLine.typeOptions.points.controlPoint","name":"controlPoint","line":59,"lineEnd":63,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js"},"children":{}},"x":{"doclet":{"description":"The x position of the point.","type":{"names":["number"]}},"meta":{"fullname":"annotations.types.crookedLine.typeOptions.points.x","name":"x","line":47,"lineEnd":52,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js"},"children":{}},"y":{"doclet":{"description":"The y position of the point.","type":{"names":["number"]}},"meta":{"fullname":"annotations.types.crookedLine.typeOptions.points.y","name":"y","line":53,"lineEnd":58,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js"},"children":{}}}},"xAxis":{"doclet":{"description":"This number defines which xAxis the point is connected to.\nIt refers to either the axis id or the index of the axis\nin the xAxis array.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.crookedLine.typeOptions.xAxis","name":"xAxis","line":31,"lineEnd":35,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js","default":0},"children":{}},"yAxis":{"doclet":{"description":"This number defines which yAxis the point is connected to.\nIt refers to either the axis id or the index of the axis\nin the xAxis array.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.crookedLine.typeOptions.yAxis","name":"yAxis","line":37,"lineEnd":41,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/CrookedLine.js","default":0},"children":{}}}}}},"elliottWave":{"doclet":{"description":"Options for the elliott wave annotation type.","samples":[{"name":"Elliott wave","value":"highcharts/annotations-advanced/elliott-wave/"}],"extends":"annotations.types.crookedLine","products":["highstock"],"since":"6.0.0"},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","name":"elliottWave","fullname":"annotations.types.elliottWave","line":13,"lineEnd":22,"column":4},"children":{"labelOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.elliottWave.labelOptions","name":"labelOptions","line":37,"lineEnd":37,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js"},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"center"},"meta":{"fullname":"annotations.types.elliottWave.labelOptions.align","name":"align","line":38,"lineEnd":38,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","default":"center"},"children":{}},"allowOverlap":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"annotations.types.elliottWave.labelOptions.allowOverlap","name":"allowOverlap","line":39,"lineEnd":39,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","default":true},"children":{}},"backgroundColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"none"},"meta":{"fullname":"annotations.types.elliottWave.labelOptions.backgroundColor","name":"backgroundColor","line":43,"lineEnd":43,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","default":"none"},"children":{}},"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.elliottWave.labelOptions.borderWidth","name":"borderWidth","line":44,"lineEnd":44,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","default":0},"children":{}},"crop":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"annotations.types.elliottWave.labelOptions.crop","name":"crop","line":40,"lineEnd":40,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","default":true},"children":{}},"overflow":{"doclet":{"type":{"names":["string"]},"defaultvalue":"none"},"meta":{"fullname":"annotations.types.elliottWave.labelOptions.overflow","name":"overflow","line":41,"lineEnd":41,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","default":"none"},"children":{}},"style":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.elliottWave.labelOptions.style","name":"style","line":46,"lineEnd":46,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#333333"},"meta":{"fullname":"annotations.types.elliottWave.labelOptions.style.color","name":"color","line":47,"lineEnd":47,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","default":"#333333"},"children":{}}}},"type":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rect"},"meta":{"fullname":"annotations.types.elliottWave.labelOptions.type","name":"type","line":42,"lineEnd":42,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","default":"rect"},"children":{}},"y":{"doclet":{"type":{"names":["number"]},"defaultvalue":-5},"meta":{"fullname":"annotations.types.elliottWave.labelOptions.y","name":"y","line":45,"lineEnd":45,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","default":-5},"children":{}}}},"typeOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.elliottWave.typeOptions","name":"typeOptions","line":24,"lineEnd":24,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js"},"children":{"line":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.elliottWave.typeOptions.line","name":"line","line":33,"lineEnd":33,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js"},"children":{"strokeWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"annotations.types.elliottWave.typeOptions.line.strokeWidth","name":"strokeWidth","line":34,"lineEnd":34,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js","default":1},"children":{}}}},"points":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"label":{"doclet":{"extends":"annotations.types.crookedLine.labelOptions"},"meta":{"fullname":"annotations.types.elliottWave.typeOptions.points.label","name":"label","line":25,"lineEnd":28,"filename":"code/es-modules/Extensions/Annotations/Types/ElliottWave.js"},"children":{}}}}}}}},"fibonacci":{"doclet":{"description":"Options for the fibonacci annotation type.","samples":[{"name":"Fibonacci","value":"highcharts/annotations-advanced/fibonacci/"}],"extends":"annotations.types.crookedLine","products":["highstock"],"since":"6.0.0"},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","name":"fibonacci","fullname":"annotations.types.fibonacci","line":14,"lineEnd":23,"column":4},"children":{"labelOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.fibonacci.labelOptions","name":"labelOptions","line":80,"lineEnd":80,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js"},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"right"},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.align","name":"align","line":82,"lineEnd":82,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":"right"},"children":{}},"allowOverlap":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.allowOverlap","name":"allowOverlap","line":81,"lineEnd":81,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":true},"children":{}},"backgroundColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"none"},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.backgroundColor","name":"backgroundColor","line":83,"lineEnd":83,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":"none"},"children":{}},"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.borderWidth","name":"borderWidth","line":84,"lineEnd":84,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":0},"children":{}},"crop":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.crop","name":"crop","line":85,"lineEnd":85,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":false},"children":{}},"overflow":{"doclet":{"type":{"names":["string"]},"defaultvalue":"none"},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.overflow","name":"overflow","line":86,"lineEnd":86,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":"none"},"children":{}},"shape":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rect"},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.shape","name":"shape","line":87,"lineEnd":87,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":"rect"},"children":{}},"style":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.style","name":"style","line":88,"lineEnd":88,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#333333"},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.style.color","name":"color","line":89,"lineEnd":89,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":"#333333"},"children":{}}}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"middle"},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.verticalAlign","name":"verticalAlign","line":91,"lineEnd":91,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":"middle"},"children":{}},"y":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.fibonacci.labelOptions.y","name":"y","line":92,"lineEnd":92,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":0},"children":{}}}},"typeOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.fibonacci.typeOptions","name":"typeOptions","line":25,"lineEnd":25,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js"},"children":{"backgroundColors":{"doclet":{"description":"An array of background colors:\nDefaults to:\n```\n[\n'rgba(130, 170, 255, 0.4)',\n'rgba(139, 191, 216, 0.4)',\n'rgba(150, 216, 192, 0.4)',\n'rgba(156, 229, 161, 0.4)',\n'rgba(162, 241, 130, 0.4)',\n'rgba(169, 255, 101, 0.4)'\n]\n```"},"meta":{"fullname":"annotations.types.fibonacci.typeOptions.backgroundColors","name":"backgroundColors","line":41,"lineEnd":54,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js"},"children":{}},"height":{"doclet":{"description":"The height of the fibonacci in terms of yAxis.","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"annotations.types.fibonacci.typeOptions.height","name":"height","line":37,"lineEnd":39,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":2},"children":{}},"labels":{"doclet":{"description":"An array with options for the labels.","type":{"names":["Array.<*>"]},"extends":"annotations.types.crookedLine.labelOptions"},"meta":{"fullname":"annotations.types.fibonacci.typeOptions.labels","name":"labels","line":71,"lineEnd":77,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js"},"children":{}},"lineColor":{"doclet":{"description":"The color of line.","type":{"names":["string"]},"defaultvalue":"#999999"},"meta":{"fullname":"annotations.types.fibonacci.typeOptions.lineColor","name":"lineColor","line":63,"lineEnd":65,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js","default":"#999999"},"children":{}},"lineColors":{"doclet":{"description":"An array of colors for the lines."},"meta":{"fullname":"annotations.types.fibonacci.typeOptions.lineColors","name":"lineColors","line":67,"lineEnd":69,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js"},"children":{}},"reversed":{"doclet":{"description":"Whether the annotation levels should be reversed. By default\nthey start from 0 and go to 1.","samples":[{"name":"Fibonacci annotation reversed","value":"highcharts/annotations-advanced/fibonacci-reversed/"}],"type":{"names":["boolean"]}},"meta":{"fullname":"annotations.types.fibonacci.typeOptions.reversed","name":"reversed","line":26,"lineEnd":35,"filename":"code/es-modules/Extensions/Annotations/Types/Fibonacci.js"},"children":{}}}}}},"fibonacciTimeZones":{"doclet":{"description":"Options for the fibonacci time zones annotation type.","samples":[{"name":"Fibonacci Time Zones","value":"highcharts/annotations-advanced/fibonacci-time-zones/"}],"extends":"annotations.types.crookedLine","since":"9.3.0","products":["highstock"]},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/FibonacciTimeZones.js","name":"fibonacciTimeZones","fullname":"annotations.types.fibonacciTimeZones","line":22,"lineEnd":32,"column":4},"children":{"typeOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.fibonacciTimeZones.typeOptions","name":"typeOptions","line":34,"lineEnd":34,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/FibonacciTimeZones.js"},"children":{"controlPointOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.fibonacciTimeZones.typeOptions.controlPointOptions","name":"controlPointOptions","line":63,"lineEnd":63,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/FibonacciTimeZones.js"},"children":{"events":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.fibonacciTimeZones.typeOptions.controlPointOptions.events","name":"events","line":76,"lineEnd":76,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/FibonacciTimeZones.js"},"children":{}}}},"line":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.fibonacciTimeZones.typeOptions.line","name":"line","line":35,"lineEnd":40,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/FibonacciTimeZones.js"},"children":{"fill":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"annotations.types.fibonacciTimeZones.typeOptions.line.fill","name":"fill","line":60,"lineEnd":60,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/FibonacciTimeZones.js","default":"undefined"},"children":{}},"stroke":{"doclet":{"description":"The color of the lines.","type":{"names":["string"]},"since":"9.3.0"},"meta":{"fullname":"annotations.types.fibonacciTimeZones.typeOptions.line.stroke","name":"stroke","line":43,"lineEnd":49,"filename":"code/es-modules/Extensions/Annotations/Types/FibonacciTimeZones.js"},"children":{}},"strokeWidth":{"doclet":{"description":"The width of the lines.","type":{"names":["number"]},"since":"9.3.0","defaultvalue":"1"},"meta":{"fullname":"annotations.types.fibonacciTimeZones.typeOptions.line.strokeWidth","name":"strokeWidth","line":51,"lineEnd":58,"filename":"code/es-modules/Extensions/Annotations/Types/FibonacciTimeZones.js"},"children":{}}}},"points":{"doclet":{"exclude":["y"],"since":"9.3.0","products":["highstock"]},"meta":{"fullname":"annotations.types.fibonacciTimeZones.typeOptions.points","name":"points","line":35,"lineEnd":40,"filename":"code/es-modules/Extensions/Annotations/Types/FibonacciTimeZones.js"},"children":{}}}}}},"infinityLine":{"doclet":{"description":"Options for the infinity line annotation type.","samples":[{"name":"Infinity line","value":"highcharts/annotations-advanced/infinity-line/"}],"extends":"annotations.types.crookedLine","products":["highstock"],"since":"6.0.0"},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/InfinityLine.js","name":"infinityLine","fullname":"annotations.types.infinityLine","line":13,"lineEnd":22,"column":4},"children":{}},"measure":{"doclet":{"description":"Options for the measure annotation type.","extends":"annotations.types.crookedLine","exclude":["labels","labelOptions","shapes","shapeOptions"],"samples":[{"name":"Measure","value":"highcharts/annotations-advanced/measure/"}],"products":["highstock"],"since":"6.0.0"},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","name":"measure","fullname":"annotations.types.measure","line":12,"lineEnd":21,"column":4},"children":{"controlPointOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.measure.controlPointOptions","name":"controlPointOptions","line":194,"lineEnd":194,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js"},"children":{"events":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.measure.controlPointOptions.events","name":"events","line":226,"lineEnd":226,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js"},"children":{}}}},"typeOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.measure.typeOptions","name":"typeOptions","line":23,"lineEnd":23,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js"},"children":{"background":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.measure.typeOptions.background","name":"background","line":41,"lineEnd":41,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js"},"children":{"fill":{"doclet":{"description":"The color of the rectangle.","type":{"names":["string"]},"defaultvalue":"rgba(130, 170, 255, 0.4)"},"meta":{"fullname":"annotations.types.measure.typeOptions.background.fill","name":"fill","line":42,"lineEnd":44,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":"rgba(130, 170, 255, 0.4)"},"children":{}},"stroke":{"doclet":{"description":"The color of border.","type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"annotations.types.measure.typeOptions.background.stroke","name":"stroke","line":50,"lineEnd":52,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":"undefined"},"children":{}},"strokeWidth":{"doclet":{"description":"The width of border.","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.measure.typeOptions.background.strokeWidth","name":"strokeWidth","line":46,"lineEnd":48,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":0},"children":{}}}},"crosshairX":{"doclet":{"description":"Configure a crosshair that is horizontally placed in middle of\nrectangle.","type":{"names":["*"]}},"meta":{"fullname":"annotations.types.measure.typeOptions.crosshairX","name":"crosshairX","line":55,"lineEnd":59,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js"},"children":{"dashStyle":{"doclet":{"description":"The dash or dot style of the crosshair's line. For possible\nvalues, see\n[this demonstration](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/).","type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Dash"},"meta":{"fullname":"annotations.types.measure.typeOptions.crosshairX.dashStyle","name":"dashStyle","line":70,"lineEnd":77,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":"Dash"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the horizontal crosshair.","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"annotations.types.measure.typeOptions.crosshairX.enabled","name":"enabled","line":61,"lineEnd":64,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":true},"children":{}},"markerEnd":{"doclet":{"description":"The marker-end defines the arrowhead that will be drawn\nat the final vertex of the given crosshair's path.","type":{"names":["string"]},"defaultvalue":"arrow"},"meta":{"fullname":"annotations.types.measure.typeOptions.crosshairX.markerEnd","name":"markerEnd","line":79,"lineEnd":85,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":"arrow"},"children":{}},"zIndex":{"doclet":{"description":"The Z index of the crosshair in annotation.","type":{"names":["number"]},"defaultvalue":6},"meta":{"fullname":"annotations.types.measure.typeOptions.crosshairX.zIndex","name":"zIndex","line":66,"lineEnd":68,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":6},"children":{}}}},"crosshairY":{"doclet":{"description":"Configure a crosshair that is vertically placed in middle of\nrectangle.","type":{"names":["*"]}},"meta":{"fullname":"annotations.types.measure.typeOptions.crosshairY","name":"crosshairY","line":88,"lineEnd":91,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js"},"children":{"dashStyle":{"doclet":{"description":"The dash or dot style of the crosshair's line. For possible\nvalues, see\n[this demonstration](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/).","type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Dash"},"meta":{"fullname":"annotations.types.measure.typeOptions.crosshairY.dashStyle","name":"dashStyle","line":102,"lineEnd":111,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the vertical crosshair.","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"annotations.types.measure.typeOptions.crosshairY.enabled","name":"enabled","line":93,"lineEnd":96,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":true},"children":{}},"markerEnd":{"doclet":{"description":"The marker-end defines the arrowhead that will be drawn\nat the final vertex of the given crosshair's path.","type":{"names":["\"none\"","\"arrow\""]},"defaultvalue":"arrow"},"meta":{"fullname":"annotations.types.measure.typeOptions.crosshairY.markerEnd","name":"markerEnd","line":113,"lineEnd":121,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":"arrow"},"children":{}},"zIndex":{"doclet":{"description":"The Z index of the crosshair in annotation.","type":{"names":["number"]},"defaultvalue":6},"meta":{"fullname":"annotations.types.measure.typeOptions.crosshairY.zIndex","name":"zIndex","line":98,"lineEnd":100,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":6},"children":{}}}},"label":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.measure.typeOptions.label","name":"label","line":124,"lineEnd":124,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js"},"children":{"enabled":{"doclet":{"description":"Enable or disable the label text (min, max, average,\nbins values).\n\nDefaults to true.","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"annotations.types.measure.typeOptions.label.enabled","name":"enabled","line":125,"lineEnd":130,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":true},"children":{}},"formatter":{"doclet":{"description":"Formatter function for the label text.\n\nAvailable data are:\n\n<table>\n\n<tbody>\n\n<tr>\n\n<td>`this.min`</td>\n\n<td>The minimum value of the points in the selected\nrange.</td>\n\n</tr>\n\n<tr>\n\n<td>`this.max`</td>\n\n<td>The maximum value of the points in the selected\nrange.</td>\n\n</tr>\n\n<tr>\n\n<td>`this.average`</td>\n\n<td>The average value of the points in the selected\nrange.</td>\n\n</tr>\n\n<tr>\n\n<td>`this.bins`</td>\n\n<td>The amount of the points in the selected range.</td>\n\n</tr>\n\n</table>","type":{"names":["function"]},"defaultvalue":"undefined"},"meta":{"fullname":"annotations.types.measure.typeOptions.label.formatter","name":"formatter","line":142,"lineEnd":190,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":"undefined"},"children":{}},"style":{"doclet":{"description":"CSS styles for the measure label.","type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"color\": \"#666666\", \"fontSize\": \"11px\"}"},"meta":{"fullname":"annotations.types.measure.typeOptions.label.style","name":"style","line":132,"lineEnd":137,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#333333"},"meta":{"fullname":"annotations.types.measure.typeOptions.label.style.color","name":"color","line":140,"lineEnd":140,"column":20,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":"#333333"},"children":{}},"fontSize":{"doclet":{"type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"annotations.types.measure.typeOptions.label.style.fontSize","name":"fontSize","line":139,"lineEnd":139,"column":20,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":"0.7em"},"children":{}}}}}},"selectType":{"doclet":{"description":"Decides in what dimensions the user can resize by dragging the\nmouse. Can be one of x, y or xy.","type":{"names":["string"]},"defaultvalue":"xy"},"meta":{"fullname":"annotations.types.measure.typeOptions.selectType","name":"selectType","line":24,"lineEnd":27,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":"xy"},"children":{}},"xAxis":{"doclet":{"description":"This number defines which xAxis the point is connected to.\nIt refers to either the axis id or the index of the axis\nin the xAxis array.","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.measure.typeOptions.xAxis","name":"xAxis","line":29,"lineEnd":33,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":0},"children":{}},"yAxis":{"doclet":{"description":"This number defines which yAxis the point is connected to.\nIt refers to either the axis id or the index of the axis\nin the yAxis array.","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.measure.typeOptions.yAxis","name":"yAxis","line":35,"lineEnd":39,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Measure.js","default":0},"children":{}}}}}},"pitchfork":{"doclet":{"description":"Options for the pitchfork annotation type.","samples":[{"name":"Pitchfork","value":"highcharts/annotations-advanced/pitchfork/"}],"extends":"annotations.types.infinityLine","products":["highstock"],"since":"6.0.0"},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/Pitchfork.js","name":"pitchfork","fullname":"annotations.types.pitchfork","line":14,"lineEnd":23,"column":4},"children":{"typeOptions":{"doclet":{"exclude":["line"],"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.pitchfork.typeOptions","name":"typeOptions","line":25,"lineEnd":27,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/Pitchfork.js"},"children":{"innerBackground":{"doclet":{"description":"Inner background options.","extends":"annotations.shapeOptions","exclude":["height","r","type","width"]},"meta":{"fullname":"annotations.types.pitchfork.typeOptions.innerBackground","name":"innerBackground","line":29,"lineEnd":34,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Pitchfork.js"},"children":{"fill":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rgba(130, 170, 255, 0.4)"},"meta":{"fullname":"annotations.types.pitchfork.typeOptions.innerBackground.fill","name":"fill","line":36,"lineEnd":36,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Pitchfork.js","default":"rgba(130, 170, 255, 0.4)"},"children":{}},"strokeWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.pitchfork.typeOptions.innerBackground.strokeWidth","name":"strokeWidth","line":37,"lineEnd":37,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Pitchfork.js","default":0},"children":{}}}},"outerBackground":{"doclet":{"description":"Outer background options.","extends":"annotations.shapeOptions","exclude":["height","r","type","width"]},"meta":{"fullname":"annotations.types.pitchfork.typeOptions.outerBackground","name":"outerBackground","line":39,"lineEnd":44,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Pitchfork.js"},"children":{"fill":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rgba(156, 229, 161, 0.4)"},"meta":{"fullname":"annotations.types.pitchfork.typeOptions.outerBackground.fill","name":"fill","line":46,"lineEnd":46,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Pitchfork.js","default":"rgba(156, 229, 161, 0.4)"},"children":{}},"strokeWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.pitchfork.typeOptions.outerBackground.strokeWidth","name":"strokeWidth","line":47,"lineEnd":47,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Pitchfork.js","default":0},"children":{}}}}}}}},"timeCycles":{"doclet":{"description":"Options for the time cycles annotation type.","samples":[{"name":"Time Cycles annotation","value":"highcharts/annotations-advanced/time-cycles/"}],"extends":"annotations.types.crookedLine","products":["highstock"],"exclude":["labelOptions"],"since":"6.0.0"},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/TimeCycles.js","name":"timeCycles","fullname":"annotations.types.timeCycles","line":16,"lineEnd":26,"column":4},"children":{"typeOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.timeCycles.typeOptions","name":"typeOptions","line":28,"lineEnd":28,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/TimeCycles.js"},"children":{"points":{"doclet":{"exclude":["y"],"products":["highstock"]},"meta":{"fullname":"annotations.types.timeCycles.typeOptions.points","name":"points","line":29,"lineEnd":33,"filename":"code/es-modules/Extensions/Annotations/Types/TimeCycles.js"},"children":{}}}}}},"tunnel":{"doclet":{"description":"Options for the tunnel annotation type.","extends":"annotations.types.crookedLine","samples":[{"name":"Tunnel","value":"highcharts/annotations-advanced/tunnel/"}],"products":["highstock"],"since":"6.0.0"},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js","name":"tunnel","fullname":"annotations.types.tunnel","line":15,"lineEnd":23,"column":4},"children":{"controlPointOptions":{"doclet":{"extends":"annotations.types.crookedLine.controlPointOptions","exclude":["positioner","events"]},"meta":{"fullname":"annotations.types.tunnel.controlPointOptions","name":"controlPointOptions","line":72,"lineEnd":75,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js"},"children":{"events":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.tunnel.controlPointOptions.events","name":"events","line":77,"lineEnd":77,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js"},"children":{}}}},"typeOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.tunnel.typeOptions","name":"typeOptions","line":25,"lineEnd":25,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js"},"children":{"background":{"doclet":{"description":"Background options.","type":{"names":["Object"]},"exclude":["height","point","points","r","type","width","markerEnd","markerStart"]},"meta":{"fullname":"annotations.types.tunnel.typeOptions.background","name":"background","line":26,"lineEnd":32,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js"},"children":{"fill":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rgba(130, 170, 255, 0.4)"},"meta":{"fullname":"annotations.types.tunnel.typeOptions.background.fill","name":"fill","line":34,"lineEnd":34,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js","default":"rgba(130, 170, 255, 0.4)"},"children":{}},"strokeWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.tunnel.typeOptions.background.strokeWidth","name":"strokeWidth","line":35,"lineEnd":35,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js","default":0},"children":{}}}},"height":{"doclet":{"description":"The height of the annotation in terms of yAxis.","type":{"names":["number"]},"defaultvalue":-2},"meta":{"fullname":"annotations.types.tunnel.typeOptions.height","name":"height","line":40,"lineEnd":42,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js","default":-2},"children":{}},"heightControlPoint":{"doclet":{"description":"Options for the control point which controls\nthe annotation's height.","extends":"annotations.types.crookedLine.controlPointOptions","exclude":["positioner","events"]},"meta":{"fullname":"annotations.types.tunnel.typeOptions.heightControlPoint","name":"heightControlPoint","line":44,"lineEnd":50,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js"},"children":{"events":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.tunnel.typeOptions.heightControlPoint.events","name":"events","line":60,"lineEnd":60,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js"},"children":{}}}},"line":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.tunnel.typeOptions.line","name":"line","line":37,"lineEnd":37,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js"},"children":{"strokeWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"annotations.types.tunnel.typeOptions.line.strokeWidth","name":"strokeWidth","line":38,"lineEnd":38,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/Tunnel.js","default":1},"children":{}}}}}}}},"verticalLine":{"doclet":{"description":"Options for the vertical line annotation type.","samples":[{"name":"Vertical line","value":"highcharts/annotations-advanced/vertical-line/"}],"extends":"annotations.types.crookedLine","exclude":["labels","shapes","controlPointOptions"],"products":["highstock"],"since":"6.0.0"},"meta":{"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","name":"verticalLine","fullname":"annotations.types.verticalLine","line":12,"lineEnd":22,"column":4},"children":{"labelOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.verticalLine.labelOptions","name":"labelOptions","line":58,"lineEnd":58,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js"},"children":{"style":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.verticalLine.labelOptions.style","name":"style","line":59,"lineEnd":59,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#333333"},"meta":{"fullname":"annotations.types.verticalLine.labelOptions.style.color","name":"color","line":60,"lineEnd":60,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":"#333333"},"children":{}},"fontSize":{"doclet":{"type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"annotations.types.verticalLine.labelOptions.style.fontSize","name":"fontSize","line":61,"lineEnd":61,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":"0.7em"},"children":{}}}}}},"typeOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"annotations.types.verticalLine.typeOptions","name":"typeOptions","line":24,"lineEnd":24,"column":8,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js"},"children":{"connector":{"doclet":{"description":"Connector options.","extends":"annotations.shapeOptions","exclude":["height","r","type","width"]},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.connector","name":"connector","line":47,"lineEnd":52,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js"},"children":{"markerEnd":{"doclet":{"type":{"names":["string"]},"defaultvalue":"arrow"},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.connector.markerEnd","name":"markerEnd","line":55,"lineEnd":55,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":"arrow"},"children":{}},"strokeWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.connector.strokeWidth","name":"strokeWidth","line":54,"lineEnd":54,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":1},"children":{}}}},"label":{"doclet":{"description":"Label options.","extends":"annotations.types.crookedLine.labelOptions"},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.label","name":"label","line":29,"lineEnd":33,"column":12,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js"},"children":{"allowOverlap":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.label.allowOverlap","name":"allowOverlap","line":39,"lineEnd":39,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":true},"children":{}},"backgroundColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"none"},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.label.backgroundColor","name":"backgroundColor","line":40,"lineEnd":40,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":"none"},"children":{}},"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.label.borderWidth","name":"borderWidth","line":41,"lineEnd":41,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":0},"children":{}},"crop":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.label.crop","name":"crop","line":42,"lineEnd":42,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":true},"children":{}},"offset":{"doclet":{"type":{"names":["number"]},"defaultvalue":-40},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.label.offset","name":"offset","line":35,"lineEnd":35,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":-40},"children":{}},"overflow":{"doclet":{"type":{"names":["string"]},"defaultvalue":"none"},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.label.overflow","name":"overflow","line":43,"lineEnd":43,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":"none"},"children":{}},"shape":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rect"},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.label.shape","name":"shape","line":44,"lineEnd":44,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":"rect"},"children":{}},"text":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{y:.2f}"},"meta":{"fullname":"annotations.types.verticalLine.typeOptions.label.text","name":"text","line":45,"lineEnd":45,"column":16,"filename":"code/es-modules/Extensions/Annotations/Types/VerticalLine.js","default":"{y:.2f}"},"children":{}}}}}}}}}},"visible":{"doclet":{"description":"Whether the annotation is visible.","samples":[{"name":"Set annotation visibility","value":"highcharts/annotations/visible/"}],"since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"annotations.visible","name":"visible","line":40,"lineEnd":46,"column":4,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":true},"children":{}},"zIndex":{"doclet":{"description":"The Z index of the annotation.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":6},"meta":{"fullname":"annotations.zIndex","name":"zIndex","line":749,"lineEnd":751,"column":4,"filename":"code/es-modules/Extensions/Annotations/AnnotationDefaults.js","default":6},"children":{}}}},"boost":{"doclet":{"description":"Options for the Boost module. The Boost module allows certain series types\nto be rendered by WebGL instead of the default SVG. This allows hundreds of\nthousands of data points to be rendered in milliseconds. In addition to the\nWebGL rendering it saves time by skipping processing and inspection of the\ndata wherever possible. This introduces some limitations to what features are\navailable in boost mode. See [the docs](https://www.highcharts.com/docs/advanced-chart-features/boost-module) for\ndetails.\n\nIn addition to the global `boost` option, each series has a\n[boostThreshold](#plotOptions.series.boostThreshold) that defines when the\nboost should kick in.\n\nRequires the `modules/boost.js` module.","samples":[{"name":"Stock chart","value":"highcharts/boost/line-series-heavy-stock","products":["highstock"]},{"name":"Dynamic stock chart","value":"highcharts/boost/line-series-heavy-dynamic","products":["highstock"]},{"name":"Line chart","value":"highcharts/boost/line"},{"name":"Line chart with hundreds of series","value":"highcharts/boost/line-series-heavy"},{"name":"Scatter chart","value":"highcharts/boost/scatter"},{"name":"Scatter chart with colored points","value":"highcharts/boost/scatter-pointcolor"},{"name":"Scatter chart with colorByPoint","value":"highcharts/boost/scatter-colorbypoint"},{"name":"Area chart","value":"highcharts/boost/area"},{"name":"Area range chart","value":"highcharts/boost/arearange"},{"name":"Column chart","value":"highcharts/boost/column"},{"name":"Column range chart","value":"highcharts/boost/columnrange"},{"name":"Bubble chart","value":"highcharts/boost/bubble"},{"name":"Heat map","value":"highcharts/boost/heatmap"},{"name":"Tree map","value":"highcharts/boost/treemap"}],"products":["highcharts","highstock"],"requires":["module:modules/boost"],"type":{"names":["*"]}},"meta":{"fullname":"boost","name":"boost","line":134,"lineEnd":182,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{"allowForce":{"doclet":{"description":"The chart will be boosted, if one of the series crosses its threshold and all\nthe series in the chart can be boosted.","type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"boost.allowForce","name":"allowForce","line":183,"lineEnd":190,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"chunkSize":{"doclet":{"description":"The number of points processed per frame when building the k-d tree for\nboosted series. Lower values improve responsiveness but increase the time it\ntakes to build the tree.","type":{"names":["number"]},"defaultvalue":"3000"},"meta":{"fullname":"boost.chunkSize","name":"chunkSize","line":271,"lineEnd":279,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"debug":{"doclet":{"description":"Debugging options for boost.\nUseful for benchmarking, and general timing.","type":{"names":["*"]}},"meta":{"fullname":"boost.debug","name":"debug","line":198,"lineEnd":203,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{"showSkipSummary":{"doclet":{"description":"Show the number of points skipped through culling.\n\nWhen set to true, the number of points skipped in series processing\nis outputted. Points are skipped if they are closer than 1 pixel from\neach other.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"boost.debug.showSkipSummary","name":"showSkipSummary","line":247,"lineEnd":257,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"timeBufferCopy":{"doclet":{"description":"Time the WebGL to SVG buffer copy\n\nAfter rendering, the result is copied to an image which is injected\ninto the SVG.\n\nIf this property is set to true, the time it takes for the buffer copy\nto complete is outputted.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"boost.debug.timeBufferCopy","name":"timeBufferCopy","line":258,"lineEnd":270,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"timeKDTree":{"doclet":{"description":"Time the building of the k-d tree.\n\nThis outputs the time spent building the k-d tree used for\nmarkers etc.\n\nNote that the k-d tree is built async, and runs post-rendering.\nFollowing, it does not affect the performance of the rendering itself.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"boost.debug.timeKDTree","name":"timeKDTree","line":234,"lineEnd":246,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"timeRendering":{"doclet":{"description":"Time the series rendering.\n\nThis outputs the time spent on actual rendering in the console when\nset to true.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"boost.debug.timeRendering","name":"timeRendering","line":204,"lineEnd":213,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"timeSeriesProcessing":{"doclet":{"description":"Time the series processing.\n\nThis outputs the time spent on transforming the series data to\nvertex buffers when set to true.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"boost.debug.timeSeriesProcessing","name":"timeSeriesProcessing","line":214,"lineEnd":223,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"timeSetup":{"doclet":{"description":"Time the WebGL setup.\n\nThis outputs the time spent on setting up the WebGL context,\ncreating shaders, and textures.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"boost.debug.timeSetup","name":"timeSetup","line":224,"lineEnd":233,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}}}},"enabled":{"doclet":{"description":"Enable or disable boost on a chart.","type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"boost.enabled","name":"enabled","line":191,"lineEnd":197,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"pixelRatio":{"doclet":{"description":"The pixel ratio for the WebGL content. If 0, the `window.devicePixelRatio` is\nused. This ensures sharp graphics on high DPI displays like Apple's Retina,\nas well as when a page is zoomed.\n\nThe default is left at 1 for now, as this is a new feature that has the\npotential to break existing setups. Over time, when it has been battle\ntested, the intention is to set it to 0 by default.\n\nAnother use case for this option is to set it to 2 in order to make exported\nand upscaled charts render sharp.\n\nOne limitation when using the `pixelRatio` is that the line width of graphs\nis scaled down. Since the Boost module currently can only render 1px line\nwidths, it is scaled down to a thin 0.5 pixels on a Retina display.","samples":[{"name":"Enable the `devicePixelRatio`","value":"highcharts/boost/line-devicepixelratio"},{"name":"Sharper graphics in export","value":"highcharts/boost/line-export-pixelratio"}],"type":{"names":["number"]},"since":"10.0.0","defaultvalue":"1"},"meta":{"fullname":"boost.pixelRatio","name":"pixelRatio","line":280,"lineEnd":305,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"seriesThreshold":{"doclet":{"description":"Set the series threshold for when the boost should kick in globally.\n\nSetting to e.g. 20 will cause the whole chart to enter boost mode\nif there are 20 or more series active. When the chart is in boost mode,\nevery series in it will be rendered to a common canvas. This offers\na significant speed improvement in charts with a very high\namount of series.","type":{"names":["number"]},"defaultvalue":"50"},"meta":{"fullname":"boost.seriesThreshold","name":"seriesThreshold","line":306,"lineEnd":318,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"useGPUTranslations":{"doclet":{"description":"Enable or disable GPU translations. GPU translations are faster than doing\nthe translation in JavaScript.\n\nThis option may cause rendering issues with certain datasets.\nNamely, if your dataset has large numbers with small increments (such as\ntimestamps), it won't work correctly. This is due to floating point\nprecision.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"boost.useGPUTranslations","name":"useGPUTranslations","line":319,"lineEnd":331,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"usePreallocated":{"doclet":{"description":"Enable or disable pre-allocation of vertex buffers.\n\nEnabling this will make it so that the binary data arrays required for\nstoring the series data will be allocated prior to transforming the data\nto a WebGL-compatible format.\n\nThis saves a copy operation on the order of O(n) and so is significantly more\nperformant. However, this is currently an experimental option, and may cause\nvisual artifacts with some datasets.\n\nAs such, care should be taken when using this setting to make sure that\nit doesn't cause any rendering glitches with the given use-case.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"boost.usePreallocated","name":"usePreallocated","line":332,"lineEnd":349,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}}}},"caption":{"doclet":{"description":"The chart's caption, which will render below the chart and will be part\nof exported charts. The caption can be updated after chart initialization\nthrough the `Chart.update` or `Chart.caption.update` methods.","samples":[{"name":"A chart with a caption","value":"highcharts/caption/text/"}],"since":"7.2.0","type":{"names":["*"]}},"meta":{"fullname":"caption","name":"caption","line":803,"lineEnd":811,"column":4,"filename":"code/es-modules/Core/Defaults.js"},"children":{"align":{"doclet":{"description":"The horizontal alignment of the caption. Can be one of \"left\",\n \"center\" and \"right\".","type":{"names":["Highcharts.AlignValue"]},"since":"7.2.0","defaultvalue":"left"},"meta":{"fullname":"caption.align","name":"align","line":875,"lineEnd":880,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"left"},"children":{}},"floating":{"doclet":{"description":"When the caption is floating, the plot area will not move to make\nspace for it.","type":{"names":["boolean"]},"defaultvalue":"false","since":"7.2.0"},"meta":{"fullname":"caption.floating","name":"floating","line":813,"lineEnd":820,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"margin":{"doclet":{"description":"The margin between the caption and the plot area.","since":"7.2.0","type":{"names":["number"]},"defaultvalue":15},"meta":{"fullname":"caption.margin","name":"margin","line":813,"lineEnd":820,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":15},"children":{}},"style":{"doclet":{"description":"CSS styles for the caption.\n\nIn styled mode, the caption style is given in the\n`.highcharts-caption` class.","samples":[{"name":"Styled mode","value":"highcharts/css/titles/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"color\": \"#666666\"}","since":"7.2.0"},"meta":{"fullname":"caption.style","name":"style","line":825,"lineEnd":833,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#666666"},"meta":{"fullname":"caption.style.color","name":"color","line":862,"lineEnd":862,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"#666666"},"children":{}},"fontSize":{"doclet":{"type":{"names":["number","string"]},"defaultvalue":"0.8em"},"meta":{"fullname":"caption.style.fontSize","name":"fontSize","line":863,"lineEnd":865,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"0.8em"},"children":{}}}},"text":{"doclet":{"description":"The caption text of the chart.","samples":[{"name":"Custom caption","value":"highcharts/caption/text/","products":["highcharts"]}],"since":"7.2.0","type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"caption.text","name":"text","line":868,"lineEnd":873,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":""},"children":{}},"useHTML":{"doclet":{"description":"Whether to\n[use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the text.","type":{"names":["boolean"]},"defaultvalue":"false","since":"7.2.0"},"meta":{"fullname":"caption.useHTML","name":"useHTML","line":825,"lineEnd":833,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of the caption. Can be one of `\"top\"`,\n`\"middle\"` and `\"bottom\"`. When middle, the caption behaves as\nfloating.","type":{"names":["Highcharts.VerticalAlignValue"]},"since":"7.2.0","defaultvalue":"bottom"},"meta":{"fullname":"caption.verticalAlign","name":"verticalAlign","line":882,"lineEnd":888,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"bottom"},"children":{}},"x":{"doclet":{"description":"The x position of the caption relative to the alignment within\n`chart.spacingLeft` and `chart.spacingRight`.","type":{"names":["number"]},"defaultvalue":"0","since":"7.2.0"},"meta":{"fullname":"caption.x","name":"x","line":834,"lineEnd":841,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"y":{"doclet":{"description":"The y position of the caption relative to the alignment within\n`chart.spacingTop` and `chart.spacingBottom`.","type":{"names":["number"]},"since":"7.2.0"},"meta":{"fullname":"caption.y","name":"y","line":842,"lineEnd":848,"filename":"code/es-modules/Core/Defaults.js"},"children":{}}}},"chart":{"doclet":{"description":"General options for the chart.","type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js","name":"chart","fullname":"chart","line":14,"lineEnd":18,"column":0},"children":{"alignThresholds":{"doclet":{"description":"When using multiple axes, align the thresholds. When this is true, other\nticks will also be aligned.\n\nNote that for line series and some other series types, the `threshold`\noption is set to `null` by default. This will in turn cause their y-axis\nto not have a threshold. In order to avoid that, set the series\n`threshold` to 0 or another number.\n\nIf `startOnTick` or `endOnTick` in the axis options are set to false, or\nif the axis is logarithmic, the threshold will not be aligned.","samples":[{"name":"Set to true","value":"highcharts/chart/alignthresholds/","products":["highcharts"]}],"since":"10.0.0","products":["highcharts","highstock","gantt"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"chart.alignThresholds","name":"alignThresholds","line":23,"lineEnd":40,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":false},"children":{}},"alignTicks":{"doclet":{"description":"When using multiple axes, the ticks of two or more opposite axes\nwill automatically be aligned by adding ticks to the axis or axes\nwith the least ticks, as if `tickAmount` were specified.\n\nThis can be prevented by setting `alignTicks` to false. If the grid\nlines look messy, it's a good idea to hide them for the secondary\naxis by setting `gridLineWidth` to 0.\n\nIf `startOnTick` or `endOnTick` in the axis options are set to false,\nthen the `alignTicks ` will be disabled for the axis.\n\nDisabled for logarithmic axes.","samples":[{"name":"True by default","value":"highcharts/chart/alignticks-true/","products":["highcharts"]},{"name":"False","value":"highcharts/chart/alignticks-false/","products":["highcharts"]},{"name":"True by default","value":"stock/chart/alignticks-true/","products":["highstock"]},{"name":"False","value":"stock/chart/alignticks-false/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"true","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"chart.alignTicks","name":"alignTicks","line":50,"lineEnd":77,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"allowMutatingData":{"doclet":{"description":"By default, (because of memory and performance reasons) the chart does\nnot copy the data but keeps it as a reference. In some cases, this might\nresult in mutating the original data source. In order to prevent that,\nset that property to false. Please note that changing that might decrease\nperformance, especially with bigger sets of data.","type":{"names":["boolean"]},"since":"10.1.0","defaultvalue":true},"meta":{"fullname":"chart.allowMutatingData","name":"allowMutatingData","line":544,"lineEnd":553,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":true},"children":{}},"animation":{"doclet":{"description":"Set the overall animation for all chart updating. Animation can be\ndisabled throughout the chart by setting it to false here. It can\nbe overridden for each individual API method as a function parameter.\nThe only animation not affected by this option is the initial series\nanimation, see [plotOptions.series.animation](#plotOptions.series.animation).\n\nThe animation can either be set as a boolean or a configuration\nobject. If `true`, it will use the 'swing' jQuery easing and a\nduration of 500 ms. If used as a configuration object, the following\nproperties are supported:\n\n- `defer`: The animation delay time in milliseconds.\n\n- `duration`: The duration of the animation in milliseconds.\n\n- `easing`: A string reference to an easing function set on the\n  `Math` object. See\n  [the easing demo](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-animation-easing/).\n\nWhen zooming on a series with less than 100 points, the chart redraw\nwill be done with animation, but in case of more data points, it is\nnecessary to set this option to ensure animation on zoom.","samples":[{"name":"Updating with no animation","value":"highcharts/chart/animation-none/","products":["highcharts"]},{"name":"With a longer duration","value":"highcharts/chart/animation-duration/","products":["highcharts"]},{"name":"With a jQuery UI easing","value":"highcharts/chart/animation-easing/","products":["highcharts"]},{"name":"Updating with no animation","value":"maps/chart/animation-none/","products":["highmaps"]},{"name":"With a longer duration","value":"maps/chart/animation-duration/","products":["highmaps"]}],"type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"defaultvalue":"true"},"meta":{"fullname":"chart.animation","name":"animation","line":97,"lineEnd":136,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"axisLayoutRuns":{"doclet":{"description":"When a chart with an x and a y-axis is rendered, we first pre-render the\nlabels of both in order to measure them. Then, if either of the axis\nlabels take up so much space that it significantly affects the length of\nthe other axis, we repeat the process.\n\nBy default we stop at two axis layout runs, but it may be that the second\nrun also alter the space required by either axis, for example if it\ncauses the labels to rotate. In this situation, a subsequent redraw of\nthe chart may cause the tick and label placement to change for apparently\nno reason.\n\nUse the `axisLayoutRuns` option to set the maximum allowed number of\nrepetitions. But keep in mind that the default value of 2 is set because\nevery run costs performance time.\n\n**Note:** Changing that option to higher than the default might decrease\nperformance significantly, especially with bigger sets of data.","type":{"names":["number"]},"defaultvalue":"2","since":"11.3.0"},"meta":{"fullname":"chart.axisLayoutRuns","name":"axisLayoutRuns","line":399,"lineEnd":422,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"backgroundColor":{"doclet":{"description":"The background color or gradient for the outer chart area.","see":["In styled mode, the background is set with the\n     `.highcharts-background` class."],"samples":[{"name":"Color","value":"highcharts/chart/backgroundcolor-color/","products":["highcharts"]},{"name":"Gradient","value":"highcharts/chart/backgroundcolor-gradient/","products":["highcharts"]},{"name":"Color","value":"stock/chart/backgroundcolor-color/","products":["highstock"]},{"name":"Gradient","value":"stock/chart/backgroundcolor-gradient/","products":["highstock"]},{"name":"Color","value":"maps/chart/backgroundcolor-color/","products":["highmaps"]},{"name":"Gradient","value":"maps/chart/backgroundcolor-gradient/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#ffffff"},"meta":{"fullname":"chart.backgroundColor","name":"backgroundColor","line":1209,"lineEnd":1225,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":"#ffffff"},"children":{}},"borderColor":{"doclet":{"description":"The color of the outer chart border.","see":["In styled mode, the stroke is set with the\n     `.highcharts-background` class."],"samples":[{"name":"Brown border","value":"highcharts/chart/bordercolor/","products":["highcharts"]},{"name":"Brown border","value":"stock/chart/border/","products":["highstock"]},{"name":"Border options","value":"maps/chart/border/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#334eff"},"meta":{"fullname":"chart.borderColor","name":"borderColor","line":1193,"lineEnd":1207,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":"#334eff"},"children":{}},"borderRadius":{"doclet":{"description":"The corner radius of the outer chart border.","samples":[{"name":"20px radius","value":"highcharts/chart/borderradius/","products":["highcharts"]},{"name":"10px radius","value":"stock/chart/border/","products":["highstock"]},{"name":"Border options","value":"maps/chart/border/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"chart.borderRadius","name":"borderRadius","line":522,"lineEnd":532,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":0},"children":{}},"borderWidth":{"doclet":{"description":"The pixel width of the outer chart border.","see":["In styled mode, the stroke is set with the\n     `.highcharts-background` class."],"samples":[{"name":"5px border","value":"highcharts/chart/borderwidth/","products":["highcharts"]},{"name":"2px border","value":"stock/chart/border/","products":["highstock"]},{"name":"Border options","value":"maps/chart/border/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"chart.borderWidth","name":"borderWidth","line":1209,"lineEnd":1225,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"className":{"doclet":{"description":"A CSS class name to apply to the charts container `div`, allowing\nunique CSS styling for each chart.","type":{"names":["string"]}},"meta":{"fullname":"chart.className","name":"className","line":137,"lineEnd":143,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"colorCount":{"doclet":{"description":"In styled mode, this sets how many colors the class names\nshould rotate between. With ten colors, series (or points) are\ngiven class names like `highcharts-color-0`, `highcharts-color-1`\n[...] `highcharts-color-9`. The equivalent in non-styled mode\nis to set colors using the [colors](#colors) setting.","since":"5.0.0","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"chart.colorCount","name":"colorCount","line":534,"lineEnd":542,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":10},"children":{}},"displayErrors":{"doclet":{"description":"Whether to display errors on the chart. When `false`, the errors will\nbe shown only in the console.","samples":[{"name":"Show errors on chart","value":"highcharts/chart/display-errors/"}],"since":"7.0.0","requires":["module:modules/debugger"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"chart.displayErrors","name":"displayErrors","line":28,"lineEnd":37,"column":8,"filename":"code/es-modules/Extensions/Debugger/Debugger.js","default":true},"children":{}},"events":{"doclet":{"description":"Event listeners for the chart.","type":{"names":["*"]}},"meta":{"fullname":"chart.events","name":"events","line":144,"lineEnd":148,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{"addSeries":{"doclet":{"description":"Fires when a series is added to the chart after load time, using the\n`addSeries` method. One parameter, `event`, is passed to the\nfunction, containing common event information. Through\n`event.options` you can access the series options that were passed to\nthe `addSeries` method. Returning false prevents the series from\nbeing added.","samples":[{"name":"Alert on add series","value":"highcharts/chart/events-addseries/","products":["highcharts"]},{"name":"Alert on add series","value":"stock/chart/events-addseries/","products":["highstock"]}],"type":{"names":["Highcharts.ChartAddSeriesCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Chart"},"meta":{"fullname":"chart.events.addSeries","name":"addSeries","line":149,"lineEnd":166,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"afterPrint":{"doclet":{"description":"Fires after a chart is printed through the context menu item or the\n`Chart.print` method.","samples":[{"name":"Rescale the chart to print","value":"highcharts/chart/events-beforeprint-afterprint/"}],"type":{"names":["Highcharts.ExportingAfterPrintCallbackFunction"]},"since":"4.1.0","context":"Highcharts.Chart","requires":["module:modules/exporting"]},"meta":{"fullname":"chart.events.afterPrint","name":"afterPrint","line":2020,"lineEnd":2032,"filename":"code/es-modules/Extensions/Exporting/Exporting.js"},"children":{}},"beforePrint":{"doclet":{"description":"Fires before a chart is printed through the context menu item or\nthe `Chart.print` method.","samples":[{"name":"Rescale the chart to print","value":"highcharts/chart/events-beforeprint-afterprint/"}],"type":{"names":["Highcharts.ExportingBeforePrintCallbackFunction"]},"since":"4.1.0","context":"Highcharts.Chart","requires":["module:modules/exporting"]},"meta":{"fullname":"chart.events.beforePrint","name":"beforePrint","line":2033,"lineEnd":2045,"filename":"code/es-modules/Extensions/Exporting/Exporting.js"},"children":{}},"click":{"doclet":{"description":"Fires when clicking on the plot background. One parameter, `event`,\nis passed to the function, containing common event information.\n\nInformation on the clicked spot can be found through `event.xAxis`\nand `event.yAxis`, which are arrays containing the axes of each\ndimension and each axis' value at the clicked spot. The primary axes\nare `event.xAxis[0]` and `event.yAxis[0]`. Remember the unit of a\ndatetime axis is milliseconds since 1970-01-01 00:00:00.\n\n```js\nclick: function(e) {\n    console.log(\n        Highcharts.dateFormat('%Y-%m-%d %H:%M:%S', e.xAxis[0].value),\n        e.yAxis[0].value\n    )\n}\n```","samples":[{"name":"Alert coordinates on click","value":"highcharts/chart/events-click/","products":["highcharts"]},{"name":"Alternatively, attach event to container","value":"highcharts/chart/events-container/","products":["highcharts"]},{"name":"Alert coordinates on click","value":"stock/chart/events-click/","products":["highstock"]},{"name":"Alternatively, attach event to container","value":"highcharts/chart/events-container/","products":["highstock"]},{"name":"Record coordinates on click","value":"maps/chart/events-click/","products":["highmaps"]},{"name":"Alternatively, attach event to container","value":"highcharts/chart/events-container/","products":["highmaps"]}],"type":{"names":["Highcharts.ChartClickCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Chart"},"meta":{"fullname":"chart.events.click","name":"click","line":167,"lineEnd":203,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"drilldown":{"doclet":{"description":"Fires when a drilldown point is clicked, before the new series is added. This\nevent is also utilized for async drilldown, where the seriesOptions are not\nadded by option, but rather loaded async. Note that when clicking a category\nlabel to trigger multiple series drilldown, one `drilldown` event is\ntriggered per point in the category.\n\nEvent arguments:\n\n- `category`: If a category label was clicked, which index.\n\n- `originalEvent`: The original browser event (usually click) that triggered\n  the drilldown.\n\n- `point`: The originating point.\n\n- `points`: If a category label was clicked, this array holds all points\n  corresponding to the category.\n\n- `seriesOptions`: Options for the new series.","samples":[{"name":"Async drilldown","value":"highcharts/drilldown/async/","products":["highcharts"]}],"type":{"names":["Highcharts.DrilldownCallbackFunction"]},"since":"3.0.8","products":["highcharts","highmaps"],"context":"Highcharts.Chart","requires":["module:modules/drilldown"]},"meta":{"fullname":"chart.events.drilldown","name":"drilldown","line":244,"lineEnd":274,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"drillup":{"doclet":{"description":"Fires when drilling up from a drilldown series.","type":{"names":["Highcharts.DrillupCallbackFunction"]},"since":"3.0.8","products":["highcharts","highmaps"],"context":"Highcharts.Chart","requires":["module:modules/drilldown"]},"meta":{"fullname":"chart.events.drillup","name":"drillup","line":275,"lineEnd":284,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"drillupall":{"doclet":{"description":"In a chart with multiple drilldown series, this event fires after all the\nseries have been drilled up.","type":{"names":["Highcharts.DrillupAllCallbackFunction"]},"since":"4.2.4","products":["highcharts","highmaps"],"context":"Highcharts.Chart","requires":["module:modules/drilldown"]},"meta":{"fullname":"chart.events.drillupall","name":"drillupall","line":285,"lineEnd":295,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"exportData":{"doclet":{"description":"Callback that fires while exporting data. This allows the modification of\ndata rows before processed into the final format.","type":{"names":["Highcharts.ExportDataCallbackFunction"]},"since":"7.2.0","context":"Highcharts.Chart","requires":["module:modules/exporting","module:modules/export-data"]},"meta":{"fullname":"chart.events.exportData","name":"exportData","line":311,"lineEnd":321,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js"},"children":{}},"fullscreenClose":{"doclet":{"description":"Fires when a fullscreen is closed through the context menu item,\nor a fullscreen is closed on the `Escape` button click,\nor the `Chart.fullscreen.close` method.","samples":[{"name":"Title size change on fullscreen open","value":"highcharts/chart/events-fullscreen"}],"type":{"names":["Highcharts.FullScreenfullscreenCloseCallbackFunction"]},"since":"10.1.0","context":"Highcharts.Chart","requires":["module:modules/full-screen"]},"meta":{"fullname":"chart.events.fullscreenClose","name":"fullscreenClose","line":312,"lineEnd":325,"filename":"code/es-modules/Extensions/Exporting/Fullscreen.js"},"children":{}},"fullscreenOpen":{"doclet":{"description":"Fires when a fullscreen is opened through the context menu item,\nor the `Chart.fullscreen.open` method.","samples":[{"name":"Title size change on fullscreen open","value":"highcharts/chart/events-fullscreen"}],"type":{"names":["Highcharts.FullScreenfullscreenOpenCallbackFunction"]},"since":"10.1.0","context":"Highcharts.Chart","requires":["module:modules/full-screen"]},"meta":{"fullname":"chart.events.fullscreenOpen","name":"fullscreenOpen","line":326,"lineEnd":338,"filename":"code/es-modules/Extensions/Exporting/Fullscreen.js"},"children":{}},"load":{"doclet":{"description":"Fires when the chart is finished loading. Since v4.2.2, it also waits\nfor images to be loaded, for example from point markers. One\nparameter, `event`, is passed to the function, containing common\nevent information.\n\nThere is also a second parameter to the chart constructor where a\ncallback function can be passed to be executed on chart.load.","samples":[{"name":"Alert on chart load","value":"highcharts/chart/events-load/","products":["highcharts"]},{"name":"Load vs Redraw vs Render","value":"highcharts/chart/events-render/","products":["highcharts"]},{"name":"Alert on chart load","value":"stock/chart/events-load/","products":["highstock"]},{"name":"Add series on chart load","value":"maps/chart/events-load/","products":["highmaps"]}],"type":{"names":["Highcharts.ChartLoadCallbackFunction"]},"context":"Highcharts.Chart"},"meta":{"fullname":"chart.events.load","name":"load","line":204,"lineEnd":225,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"redraw":{"doclet":{"description":"Fires when the chart is redrawn, either after a call to\n`chart.redraw()` or after an axis, series or point is modified with\nthe `redraw` option set to `true`. One parameter, `event`, is passed\nto the function, containing common event information.","samples":[{"name":"Alert on chart redraw","value":"highcharts/chart/events-redraw/","products":["highcharts"]},{"name":"Load vs Redraw vs Render","value":"highcharts/chart/events-render/","products":["highcharts"]},{"name":"Alert on chart redraw when adding a series or moving the zoomed range","value":"stock/chart/events-redraw/","products":["highstock"]},{"name":"Set subtitle on chart redraw","value":"maps/chart/events-redraw/","products":["highmaps"]}],"type":{"names":["Highcharts.ChartRedrawCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Chart"},"meta":{"fullname":"chart.events.redraw","name":"redraw","line":226,"lineEnd":246,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"render":{"doclet":{"description":"Fires after initial load of the chart (directly after the `load`\nevent), and after each redraw (directly after the `redraw` event).","samples":[{"name":"Load vs Redraw vs Render","value":"highcharts/chart/events-render/","products":["highcharts"]}],"type":{"names":["Highcharts.ChartRenderCallbackFunction"]},"since":"5.0.7","context":"Highcharts.Chart"},"meta":{"fullname":"chart.events.render","name":"render","line":247,"lineEnd":258,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"selection":{"doclet":{"description":"Fires when an area of the chart has been selected. Selection is\nenabled by setting the chart's zoomType. One parameter, `event`, is\npassed to the function, containing common event information. The\ndefault action for the selection event is to zoom the chart to the\nselected area. It can be prevented by calling\n`event.preventDefault()` or return false.\n\nInformation on the selected area can be found through `event.xAxis`\nand `event.yAxis`, which are arrays containing the axes of each\ndimension and each axis' min and max values. The primary axes are\n`event.xAxis[0]` and `event.yAxis[0]`. Remember the unit of a\ndatetime axis is milliseconds since 1970-01-01 00:00:00.\n\n```js\nselection: function(event) {\n    // log the min and max of the primary, datetime x-axis\n    console.log(\n        Highcharts.dateFormat(\n            '%Y-%m-%d %H:%M:%S',\n            event.xAxis[0].min\n        ),\n        Highcharts.dateFormat(\n            '%Y-%m-%d %H:%M:%S',\n            event.xAxis[0].max\n        )\n    );\n    // log the min and max of the y axis\n    console.log(event.yAxis[0].min, event.yAxis[0].max);\n}\n```","samples":[{"name":"Report on selection and reset","value":"highcharts/chart/events-selection/","products":["highcharts"]},{"name":"Select a range of points through a drag selection","value":"highcharts/chart/events-selection-points/","products":["highcharts"]},{"name":"Report on selection and reset","value":"stock/chart/events-selection/","products":["highstock"]},{"name":"Select a range of points through a drag selection (Highcharts)","value":"highcharts/chart/events-selection-points/","products":["highstock"]}],"type":{"names":["Highcharts.ChartSelectionCallbackFunction"]}},"meta":{"fullname":"chart.events.selection","name":"selection","line":259,"lineEnd":303,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}}}},"height":{"doclet":{"description":"An explicit height for the chart. If a _number_, the height is\ngiven in pixels. If given a _percentage string_ (for example\n`'56%'`), the height is given as the percentage of the actual chart\nwidth. This allows for preserving the aspect ratio across responsive\nsizes.\n\nBy default (when `null`) the height is calculated from the offset\nheight of the containing element, or 400 pixels if the containing\nelement's height is 0.","samples":[{"name":"Forced 200px height","value":"highcharts/chart/height/","products":["highcharts"]},{"name":"300px height","value":"stock/chart/height/","products":["highstock"]},{"name":"Chart with explicit size","value":"maps/chart/size/","products":["highmaps"]},{"name":"Highcharts with percentage height","value":"highcharts/chart/height-percent/"},{"name":"Chart with inherited height","value":"highcharts/chart/height-inherited/"}],"type":{"names":["null","number","string"]},"defaultvalue":null},"meta":{"fullname":"chart.height","name":"height","line":1168,"lineEnd":1191,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":null},"children":{}},"ignoreHiddenSeries":{"doclet":{"description":"If true, the axes will scale to the remaining visible series once\none series is hidden. If false, hiding and showing a series will\nnot affect the axes or the other series. For stacks, once one series\nwithin the stack is hidden, the rest of the stack will close in\naround it even if the axis is not affected.","samples":[{"name":"True by default","value":"highcharts/chart/ignorehiddenseries-true/","products":["highcharts"]},{"name":"False","value":"highcharts/chart/ignorehiddenseries-false/","products":["highcharts"]},{"name":"True with stack","value":"highcharts/chart/ignorehiddenseries-true-stacked/","products":["highcharts"]},{"name":"True by default","value":"stock/chart/ignorehiddenseries-true/","products":["highstock"]},{"name":"False","value":"stock/chart/ignorehiddenseries-false/","products":["highstock"]}],"since":"1.2.0","products":["highcharts","highstock","gantt"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"chart.ignoreHiddenSeries","name":"ignoreHiddenSeries","line":555,"lineEnd":575,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":true},"children":{}},"inverted":{"doclet":{"description":"Whether to invert the axes so that the x axis is vertical and y axis\nis horizontal. When `true`, the x axis is [reversed](#xAxis.reversed)\nby default.","productdesc":[{"value":"If a bar series is present in the chart, it will be inverted\nautomatically. Inverting the chart doesn't have an effect if there\nare no cartesian series in the chart.","products":["highcharts"]}],"samples":[{"name":"Inverted line","value":"highcharts/chart/inverted/","products":["highcharts"]},{"name":"Inverted stock chart","value":"stock/navigator/inverted/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"chart.inverted","name":"inverted","line":577,"lineEnd":596,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"map":{"doclet":{"description":"Default `mapData` for all series, in terms of a GeoJSON or TopoJSON\nobject. If set to a string, it functions as an index into the\n`Highcharts.maps` array.\n\nFor picking out individual shapes and geometries to use for each series\nof the map, see [series.mapData](#series.map.mapData).","samples":[{"name":"Loading GeoJSON data","value":"maps/demo/geojson"},{"name":"Loading TopoJSON data","value":"maps/chart/topojson"}],"type":{"names":["string","Array.<*>","Highcharts.GeoJSON","Highcharts.TopoJSON"]},"since":"5.0.0","products":["highmaps"]},"meta":{"fullname":"chart.map","name":"map","line":23,"lineEnd":40,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"mapTransforms":{"doclet":{"description":"Set lat/lon transformation definitions for the chart. If not defined,\nthese are extracted from the map data.","type":{"names":["*"]},"since":"5.0.0","products":["highmaps"]},"meta":{"fullname":"chart.mapTransforms","name":"mapTransforms","line":41,"lineEnd":49,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"margin":{"doclet":{"description":"The margin between the outer edge of the chart and the plot area.\nThe numbers in the array designate top, right, bottom and left\nrespectively. Use the options `marginTop`, `marginRight`,\n`marginBottom` and `marginLeft` for shorthand setting of one option.\n\nBy default there is no margin. The actual space is dynamically\ncalculated from the offset of axis labels, axis title, title,\nsubtitle and legend in addition to the `spacingTop`, `spacingRight`,\n`spacingBottom` and `spacingLeft` options.","samples":[{"name":"Zero margins","value":"highcharts/chart/margins-zero/","products":["highcharts"]},{"name":"Zero margins","value":"stock/chart/margin-zero/","products":["highstock"]}],"type":{"names":["number","Array.<number>"]}},"meta":{"fullname":"chart.margin","name":"margin","line":304,"lineEnd":322,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"marginBottom":{"doclet":{"description":"The margin between the bottom outer edge of the chart and the plot\narea. Use this to set a fixed pixel value for the margin as opposed\nto the default dynamic margin. See also `spacingBottom`.","samples":[{"name":"100px bottom margin","value":"highcharts/chart/marginbottom/","products":["highcharts"]},{"name":"100px bottom margin","value":"stock/chart/marginbottom/","products":["highstock"]},{"name":"100px margins","value":"maps/chart/margin/","products":["highmaps"]}],"type":{"names":["number"]},"since":"2.0.0"},"meta":{"fullname":"chart.marginBottom","name":"marginBottom","line":323,"lineEnd":338,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"marginLeft":{"doclet":{"description":"The margin between the left outer edge of the chart and the plot\narea. Use this to set a fixed pixel value for the margin as opposed\nto the default dynamic margin. See also `spacingLeft`.","samples":[{"name":"150px left margin","value":"highcharts/chart/marginleft/","products":["highcharts"]},{"name":"150px left margin","value":"stock/chart/marginleft/","products":["highstock"]},{"name":"100px margins","value":"maps/chart/margin/","products":["highmaps"]}],"type":{"names":["number"]},"since":"2.0.0"},"meta":{"fullname":"chart.marginLeft","name":"marginLeft","line":339,"lineEnd":354,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"marginRight":{"doclet":{"description":"The margin between the right outer edge of the chart and the plot\narea. Use this to set a fixed pixel value for the margin as opposed\nto the default dynamic margin. See also `spacingRight`.","samples":[{"name":"100px right margin","value":"highcharts/chart/marginright/","products":["highcharts"]},{"name":"100px right margin","value":"stock/chart/marginright/","products":["highstock"]},{"name":"100px margins","value":"maps/chart/margin/","products":["highmaps"]}],"type":{"names":["number"]},"since":"2.0.0"},"meta":{"fullname":"chart.marginRight","name":"marginRight","line":355,"lineEnd":370,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"marginTop":{"doclet":{"description":"The margin between the top outer edge of the chart and the plot area.\nUse this to set a fixed pixel value for the margin as opposed to\nthe default dynamic margin. See also `spacingTop`.","samples":[{"name":"100px top margin","value":"highcharts/chart/margintop/","products":["highcharts"]},{"name":"100px top margin","value":"stock/chart/margintop/","products":["highstock"]},{"name":"100px margins","value":"maps/chart/margin/","products":["highmaps"]}],"type":{"names":["number"]},"since":"2.0.0"},"meta":{"fullname":"chart.marginTop","name":"marginTop","line":371,"lineEnd":385,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"numberFormatter":{"doclet":{"description":"Callback function to override the default function that formats all\nthe numbers in the chart. Returns a string with the formatted number.\nSince v12.6.0, the callback also receives `ctx` as the last argument,\nso that arrow functions can access the same context as regular\nfunctions using `this`.","samples":[{"name":"Arabic digits in Highcharts","value":"highcharts/members/highcharts-numberformat"}],"type":{"names":["Highcharts.NumberFormatterCallbackFunction"]},"since":"8.0.0"},"meta":{"fullname":"chart.numberFormatter","name":"numberFormatter","line":386,"lineEnd":398,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"options3d":{"doclet":{"description":"Options to render charts in 3 dimensions. This feature requires\n`highcharts-3d.js`, found in the download package or online at\n[code.highcharts.com/highcharts-3d.js](https://code.highcharts.com/highcharts-3d.js).","since":"4.0.0","products":["highcharts"],"requires":["module:highcharts-3d"],"type":{"names":["*"]}},"meta":{"fullname":"chart.options3d","name":"options3d","line":44,"lineEnd":52,"column":12,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{"alpha":{"doclet":{"description":"One of the two rotation angles for the chart.","since":"4.0.0","products":["highcharts"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"chart.options3d.alpha","name":"alpha","line":61,"lineEnd":66,"column":16,"filename":"code/es-modules/Core/Chart/Chart3D.js","default":0},"children":{}},"axisLabelPosition":{"doclet":{"description":"Set it to `\"auto\"` to automatically move the labels to the\nbest edge.","type":{"names":["\"auto\"","null"]},"since":"5.0.12","products":["highcharts"],"defaultvalue":null},"meta":{"fullname":"chart.options3d.axisLabelPosition","name":"axisLabelPosition","line":100,"lineEnd":107,"column":16,"filename":"code/es-modules/Core/Chart/Chart3D.js","default":null},"children":{}},"beta":{"doclet":{"description":"One of the two rotation angles for the chart.","since":"4.0.0","products":["highcharts"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"chart.options3d.beta","name":"beta","line":68,"lineEnd":73,"column":16,"filename":"code/es-modules/Core/Chart/Chart3D.js","default":0},"children":{}},"depth":{"doclet":{"description":"The total depth of the chart.","since":"4.0.0","products":["highcharts"],"type":{"names":["number"]},"defaultvalue":100},"meta":{"fullname":"chart.options3d.depth","name":"depth","line":75,"lineEnd":80,"column":16,"filename":"code/es-modules/Core/Chart/Chart3D.js","default":100},"children":{}},"enabled":{"doclet":{"description":"Whether to render the chart using the 3D functionality.","since":"4.0.0","products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"chart.options3d.enabled","name":"enabled","line":54,"lineEnd":59,"column":16,"filename":"code/es-modules/Core/Chart/Chart3D.js","default":false},"children":{}},"fitToPlot":{"doclet":{"description":"Whether the 3d box should automatically adjust to the chart\nplot area.","since":"4.2.4","products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"chart.options3d.fitToPlot","name":"fitToPlot","line":82,"lineEnd":88,"column":16,"filename":"code/es-modules/Core/Chart/Chart3D.js","default":true},"children":{}},"frame":{"doclet":{"description":"Provides the option to draw a frame around the charts by\ndefining a bottom, front and back panel.","since":"4.0.0","products":["highcharts"],"requires":["module:highcharts-3d"],"type":{"names":["*"]}},"meta":{"fullname":"chart.options3d.frame","name":"frame","line":109,"lineEnd":116,"column":16,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{"back":{"doclet":{"description":"The back side of the frame around a 3D chart.","extends":"chart.options3d.frame.bottom","since":"4.0.0"},"meta":{"fullname":"chart.options3d.frame.back","name":"back","line":188,"lineEnd":192,"column":20,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{}},"bottom":{"doclet":{"description":"The bottom of the frame around a 3D chart.","since":"4.0.0","type":{"names":["*"]}},"meta":{"fullname":"chart.options3d.frame.bottom","name":"bottom","line":126,"lineEnd":132,"column":20,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{"color":{"doclet":{"description":"The color of the panel.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"transparent","since":"4.0.0","products":["highcharts"]},"meta":{"fullname":"chart.options3d.frame.bottom.color","name":"color","line":133,"lineEnd":141,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{}},"size":{"doclet":{"description":"The thickness of the panel.","type":{"names":["number"]},"defaultvalue":"1","since":"4.0.0","products":["highcharts"]},"meta":{"fullname":"chart.options3d.frame.bottom.size","name":"size","line":142,"lineEnd":150,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{}},"visible":{"doclet":{"description":"Whether to display the frame. Possible values are `true`,\n`false`, `\"auto\"` to display only the frames behind the\ndata, and `\"default\"` to display faces behind the data\nbased on the axis layout, ignoring the point of view.","samples":[{"name":"Auto frames","value":"highcharts/3d/scatter-frame/","products":["highcharts"]}],"type":{"names":["boolean","\"default\"","\"auto\""]},"defaultvalue":"default","since":"5.0.12","products":["highcharts"]},"meta":{"fullname":"chart.options3d.frame.bottom.visible","name":"visible","line":151,"lineEnd":165,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{}}}},"front":{"doclet":{"description":"The front of the frame around a 3D chart.","extends":"chart.options3d.frame.bottom","since":"4.0.0"},"meta":{"fullname":"chart.options3d.frame.front","name":"front","line":194,"lineEnd":198,"column":20,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{}},"left":{"doclet":{"description":"The left side of the frame around a 3D chart.","extends":"chart.options3d.frame.bottom","since":"4.0.0"},"meta":{"fullname":"chart.options3d.frame.left","name":"left","line":176,"lineEnd":180,"column":20,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{}},"right":{"doclet":{"description":"The right of the frame around a 3D chart.","extends":"chart.options3d.frame.bottom","since":"4.0.0"},"meta":{"fullname":"chart.options3d.frame.right","name":"right","line":182,"lineEnd":186,"column":20,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{}},"side":{"doclet":{"description":"Note: As of v5.0.12, `frame.left` or `frame.right` should be used instead.\n\nThe side for the frame around a 3D chart.","deprecated":true,"since":"4.0.0","products":["highcharts"],"requires":["module:highcharts-3d"],"type":{"names":["*"]}},"meta":{"fullname":"chart.options3d.frame.side","name":"side","line":1641,"lineEnd":1651,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{"color":{"doclet":{"description":"The color of the panel.","deprecated":true,"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"transparent","since":"4.0.0","products":["highcharts"]},"meta":{"fullname":"chart.options3d.frame.side.color","name":"color","line":1652,"lineEnd":1661,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{}},"size":{"doclet":{"description":"The thickness of the panel.","deprecated":true,"type":{"names":["number"]},"defaultvalue":"1","since":"4.0.0","products":["highcharts"]},"meta":{"fullname":"chart.options3d.frame.side.size","name":"size","line":1662,"lineEnd":1671,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{}}}},"size":{"doclet":{"description":"General pixel thickness for the frame faces.","since":"4.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"chart.options3d.frame.size","name":"size","line":122,"lineEnd":124,"column":20,"filename":"code/es-modules/Core/Chart/Chart3D.js","default":1},"children":{}},"top":{"doclet":{"description":"The top of the frame around a 3D chart.","extends":"chart.options3d.frame.bottom","since":"4.0.0"},"meta":{"fullname":"chart.options3d.frame.top","name":"top","line":170,"lineEnd":174,"column":20,"filename":"code/es-modules/Core/Chart/Chart3D.js"},"children":{}},"visible":{"doclet":{"description":"Whether the frames are visible.","since":"4.0.0","type":{"names":["string"]},"defaultvalue":"default"},"meta":{"fullname":"chart.options3d.frame.visible","name":"visible","line":118,"lineEnd":120,"column":20,"filename":"code/es-modules/Core/Chart/Chart3D.js","default":"default"},"children":{}}}},"viewDistance":{"doclet":{"description":"Defines the distance the viewer is standing in front of the\nchart, this setting is important to calculate the perspective\neffect in column and scatter charts. It is not used for 3D\npie charts.","since":"4.0.0","products":["highcharts"],"type":{"names":["number"]},"defaultvalue":25},"meta":{"fullname":"chart.options3d.viewDistance","name":"viewDistance","line":90,"lineEnd":98,"column":16,"filename":"code/es-modules/Core/Chart/Chart3D.js","default":25},"children":{}}}},"panKey":{"doclet":{"description":"Allows setting a key to switch between zooming and panning. Can be\none of `alt`, `ctrl`, `meta` (the command key on Mac and Windows\nkey on Windows) or `shift`. The keys are mapped directly to the key\nproperties of the click event argument (`event.altKey`,\n`event.ctrlKey`, `event.metaKey` and `event.shiftKey`).","type":{"names":["\"alt\"","\"ctrl\"","\"meta\"","\"shift\""]},"since":"4.0.3","products":["highcharts","gantt"]},"meta":{"fullname":"chart.panKey","name":"panKey","line":423,"lineEnd":435,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"panning":{"doclet":{"description":"Allow panning in a chart. Best used with [panKey](#chart.panKey)\nto combine zooming and panning.\n\nOn touch devices, when the [tooltip.followTouchMove](#tooltip.followTouchMove) option is `true` (default), panning\nrequires two fingers. To allow panning with one finger, set\n`followTouchMove` to `false`.\n\n**Note:** If both zooming and panning are enabled without keys, zooming\nwill take precedence by default. To prioritize panning, either set\n[chart.zooming.key](#chart.zooming.key) or panKey.","samples":[{"name":"Zooming and panning","value":"highcharts/chart/pankey/","products":["highcharts"]},{"name":"Zooming and xy panning","value":"stock/chart/panning/","products":["highstock"]}],"type":{"names":["*"]}},"meta":{"fullname":"chart.panning","name":"panning","line":97,"lineEnd":136,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable or disable chart panning.","type":{"names":["boolean"]},"defaultByProduct":{"highcharts":false,"highstock":true,"highmaps":true},"defaultvalue":false},"meta":{"fullname":"chart.panning.enabled","name":"enabled","line":453,"lineEnd":459,"column":8,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":false},"children":{}},"type":{"doclet":{"description":"Decides in what dimensions the user can pan the chart. Can be\none of `x`, `y`, or `xy`.\n\nDuring panning, all axes will behave as if\n[`startOnTick`](#yAxis.startOnTick) and\n[`endOnTick`](#yAxis.endOnTick) were set to `false`. After the\npanning action is finished, the axes will adjust to their actual\nsettings.\n\n**Note:** For non-cartesian series, the only supported panning type\nis `xy`, as zooming in a single direction is not applicable due to\nthe radial nature of the coordinate system.","samples":[{"name":"Zooming and xy panning","value":"highcharts/chart/panning-type","products":["highcharts"]}],"declare":"Highcharts.OptionsChartPanningTypeValue","type":{"names":["\"x\"","\"y\"","\"xy\""]},"products":["highcharts","highstock","gantt"],"defaultvalue":"x"},"meta":{"fullname":"chart.panning.type","name":"type","line":461,"lineEnd":482,"column":8,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":"x"},"children":{}}}},"parallelAxes":{"doclet":{"description":"Common options for all yAxes rendered in a parallel coordinates plot.\nThis feature requires `modules/parallel-coordinates.js`.\n\nThe default options are:\n```js\nparallelAxes: {\n   lineWidth: 1,       // classic mode only\n   gridLineWidth: 0,  // classic mode only\n   title: {\n       text: '',\n       reserveSpace: false\n   },\n   labels: {\n       x: 0,\n       y: 0,\n       align: 'center',\n       reserveSpace: false\n   },\n   offset: 0\n}\n```","samples":[{"name":"Set the same tickAmount for all yAxes","value":"highcharts/parallel-coordinates/parallelaxes/","products":["highcharts"]}],"extends":"yAxis","since":"6.0.0","products":["highcharts"],"exclude":["alternateGridColor","breaks","id","gridLineColor","gridLineDashStyle","gridLineWidth","minorGridLineColor","minorGridLineDashStyle","minorGridLineWidth","plotBands","plotLines","angle","gridLineInterpolation","maxColor","maxZoom","minColor","scrollbar","stackLabels","stops",""],"requires":["module:modules/parallel-coordinates"]},"meta":{"fullname":"chart.parallelAxes","name":"parallelAxes","line":39,"lineEnd":74,"column":4,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js"},"children":{"labels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"chart.parallelAxes.labels","name":"labels","line":87,"lineEnd":87,"column":8,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js"},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"center"},"meta":{"fullname":"chart.parallelAxes.labels.align","name":"align","line":90,"lineEnd":90,"column":12,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js","default":"center"},"children":{}},"reserveSpace":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"chart.parallelAxes.labels.reserveSpace","name":"reserveSpace","line":91,"lineEnd":91,"column":12,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js","default":false},"children":{}},"x":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"chart.parallelAxes.labels.x","name":"x","line":88,"lineEnd":88,"column":12,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js","default":0},"children":{}},"y":{"doclet":{"type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"chart.parallelAxes.labels.y","name":"y","line":89,"lineEnd":89,"column":12,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js","default":4},"children":{}}}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"chart.parallelAxes.lineWidth","name":"lineWidth","line":76,"lineEnd":76,"column":8,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js","default":1},"children":{}},"offset":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"chart.parallelAxes.offset","name":"offset","line":93,"lineEnd":93,"column":8,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js","default":0},"children":{}},"title":{"doclet":{"description":"Visually the parallel coordinates titles are done through\n[xAxis.categories](#xAxis.categories). All options for `xAxis.labels`\napplies to parallel coordinates titles. For example, to style\ncategories, use [xAxis.labels.style](#xAxis.labels.style).","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"chart.parallelAxes.title","name":"title","line":77,"lineEnd":82,"column":8,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js"},"children":{"reserveSpace":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"chart.parallelAxes.title.reserveSpace","name":"reserveSpace","line":85,"lineEnd":85,"column":12,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js","default":false},"children":{}},"text":{"doclet":{"type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"chart.parallelAxes.title.text","name":"text","line":84,"lineEnd":84,"column":12,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js","default":""},"children":{}}}}}},"parallelCoordinates":{"doclet":{"description":"Flag to render charts as a parallel coordinates plot. In a parallel\ncoordinates plot (||-coords) by default all required yAxes are generated\nand the legend is disabled. This feature requires\n`modules/parallel-coordinates.js`.","samples":[{"name":"Parallel coordinates demo","value":"/highcharts/demo/parallel-coordinates/","products":["highcharts"]},{"name":"Star plot, multivariate data in a polar chart","value":"highcharts/parallel-coordinates/polar/","products":["highcharts"]}],"since":"6.0.0","products":["highcharts"],"requires":["module:modules/parallel-coordinates"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"chart.parallelCoordinates","name":"parallelCoordinates","line":23,"lineEnd":37,"column":4,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js","default":false},"children":{}},"pinchType":{"doclet":{"description":"Equivalent to [zoomType](#chart.zoomType), but for multitouch\ngestures only. By default, the `pinchType` is the same as the\n`zoomType` setting. However, pinching can be enabled separately in\nsome cases, for example in stock charts where a mouse drag pans the\nchart, while pinching is enabled. When [tooltip.followTouchMove](#tooltip.followTouchMove) is true, pinchType only applies to\ntwo-finger touches.","type":{"names":["\"x\"","\"y\"","\"xy\""]},"defaultByProduct":{"highcharts":"undefined","highstock":"undefined"},"since":"3.0.0","products":["highcharts","highstock","gantt"],"deprecated":true},"meta":{"fullname":"chart.pinchType","name":"pinchType","line":485,"lineEnd":502,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"plotBackgroundColor":{"doclet":{"description":"The background color or gradient for the plot area.","see":["In styled mode, the plot background is set with the\n     `.highcharts-plot-background` class."],"samples":[{"name":"Color","value":"highcharts/chart/plotbackgroundcolor-color/","products":["highcharts"]},{"name":"Gradient","value":"highcharts/chart/plotbackgroundcolor-gradient/","products":["highcharts"]},{"name":"Color","value":"stock/chart/plotbackgroundcolor-color/","products":["highstock"]},{"name":"Gradient","value":"stock/chart/plotbackgroundcolor-gradient/","products":["highstock"]},{"name":"Color","value":"maps/chart/plotbackgroundcolor-color/","products":["highmaps"]},{"name":"Gradient","value":"maps/chart/plotbackgroundcolor-gradient/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"chart.plotBackgroundColor","name":"plotBackgroundColor","line":1248,"lineEnd":1269,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"plotBackgroundImage":{"doclet":{"description":"The URL for an image to use as the plot background. To set an image\nas the background for the entire chart, set a CSS background image\nto the container element. Note that for the image to be applied to\nexported charts, its URL needs to be accessible by the export server.","see":["In styled mode, a plot background image can be set with the\n     `.highcharts-plot-background` class and a [custom pattern](\n     https://www.highcharts.com/docs/chart-design-and-style/gradients-shadows-and-patterns)."],"samples":[{"name":"Skies","value":"highcharts/chart/plotbackgroundimage/","products":["highcharts"]},{"name":"Skies","value":"stock/chart/plotbackgroundimage/","products":["highstock"]}],"type":{"names":["string"]}},"meta":{"fullname":"chart.plotBackgroundImage","name":"plotBackgroundImage","line":1270,"lineEnd":1287,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"plotBorderColor":{"doclet":{"description":"The color of the inner chart or plot area border.","see":["In styled mode, a plot border stroke can be set with the\n     `.highcharts-plot-border` class."],"samples":[{"name":"Blue border","value":"highcharts/chart/plotbordercolor/","products":["highcharts"]},{"name":"Blue border","value":"stock/chart/plotborder/","products":["highstock"]},{"name":"Plot border options","value":"maps/chart/plotborder/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"chart.plotBorderColor","name":"plotBorderColor","line":1248,"lineEnd":1269,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":"#cccccc"},"children":{}},"plotBorderWidth":{"doclet":{"description":"The pixel width of the plot area border.","samples":[{"name":"1px border","value":"highcharts/chart/plotborderwidth/","products":["highcharts"]},{"name":"2px border","value":"stock/chart/plotborder/","products":["highstock"]},{"name":"Plot border options","value":"maps/chart/plotborder/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"chart.plotBorderWidth","name":"plotBorderWidth","line":692,"lineEnd":705,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"plotShadow":{"doclet":{"description":"Whether to apply a drop shadow to the plot area. Requires that\nplotBackgroundColor be set. The shadow can be an object configuration\ncontaining `color`, `offsetX`, `offsetY`, `opacity` and `width`.","samples":[{"name":"Plot shadow","value":"highcharts/chart/plotshadow/","products":["highcharts"]},{"name":"Plot shadow","value":"stock/chart/plotshadow/","products":["highstock"]},{"name":"Plot border options","value":"maps/chart/plotborder/","products":["highmaps"]}],"type":{"names":["boolean","Highcharts.ShadowOptionsObject"]},"defaultvalue":"false"},"meta":{"fullname":"chart.plotShadow","name":"plotShadow","line":706,"lineEnd":721,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"polar":{"doclet":{"description":"When true, cartesian charts like line, spline, area and column are\ntransformed into the polar coordinate system. This produces _polar\ncharts_, also known as _radar charts_.","samples":[{"name":"Polar chart","value":"highcharts/demo/polar/","products":["highcharts"]},{"name":"Wind rose, stacked polar column chart","value":"highcharts/demo/polar-wind-rose/","products":["highcharts"]},{"name":"Spider web chart","value":"highcharts/demo/polar-spider/","products":["highcharts"]},{"name":"Star plot, multivariate data in a polar chart","value":"highcharts/parallel-coordinates/polar/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"fullname":"chart.polar","name":"polar","line":722,"lineEnd":742,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"proj4":{"doclet":{"description":"Allows to manually load the proj4 library from Highcharts options\ninstead of the `window`.\nIn case of loading the library from a `script` tag,\nthis option is not needed, it will be loaded from there by default.","type":{"names":["function"]},"products":["highmaps"]},"meta":{"fullname":"chart.proj4","name":"proj4","line":89,"lineEnd":98,"filename":"code/es-modules/Maps/GeoJSONComposition.js"},"children":{}},"reflow":{"doclet":{"description":"Whether to reflow the chart to fit the width of the container div\non resizing the window.","samples":[{"name":"True by default","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"False","value":"highcharts/chart/reflow-false/","products":["highcharts"]},{"name":"True by default","value":"stock/chart/reflow-true/","products":["highstock"]},{"name":"False","value":"stock/chart/reflow-false/","products":["highstock"]},{"name":"True by default","value":"maps/chart/reflow-true/","products":["highmaps"]},{"name":"False","value":"maps/chart/reflow-false/","products":["highmaps"]}],"since":"2.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"chart.reflow","name":"reflow","line":692,"lineEnd":705,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":true},"children":{}},"renderTo":{"doclet":{"description":"The HTML element where the chart will be rendered. If it is a string,\nthe element by that id is used. The HTML element can also be passed\nby direct reference, or as the first argument of the chart\nconstructor, in which case the option is not needed.","samples":[{"name":"String","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Object reference","value":"highcharts/chart/renderto-object/","products":["highcharts"]},{"name":"String","value":"stock/chart/renderto-string/","products":["highstock"]},{"name":"Object reference","value":"stock/chart/renderto-object/","products":["highstock"]}],"type":{"names":["string","Highcharts.HTMLDOMElement"]}},"meta":{"fullname":"chart.renderTo","name":"renderTo","line":763,"lineEnd":780,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"resetZoomButton":{"doclet":{"description":"The button that appears after a selection zoom, allowing the user\nto reset zoom. This option is deprecated in favor of\n[zooming](#chart.zooming).","since":"2.2.0","deprecated":"10.2.1","type":{"names":["*"]}},"meta":{"fullname":"chart.resetZoomButton","name":"resetZoomButton","line":610,"lineEnd":617,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{"position":{"doclet":{"description":"The position of the button.","samples":[{"name":"Above the plot area","value":"highcharts/chart/resetzoombutton-position/","products":["highcharts"]},{"name":"Above the plot area","value":"highcharts/chart/resetzoombutton-position/","products":["highstock"]},{"name":"Above the plot area","value":"highcharts/chart/resetzoombutton-position/","products":["highmaps"]}],"type":{"names":["Highcharts.AlignObject"]},"since":"2.2.0","deprecated":"10.2.1"},"meta":{"fullname":"chart.resetZoomButton.position","name":"position","line":653,"lineEnd":664,"column":8,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{"align":{"doclet":{"description":"The horizontal alignment of the button.","type":{"names":["number"]},"since":"2.2.0","deprecated":"10.2.1"},"meta":{"fullname":"chart.resetZoomButton.position.align","name":"align","line":666,"lineEnd":671,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of the button.","type":{"names":["Highcharts.VerticalAlignValue"]},"since":"2.2.0","deprecated":"10.2.1"},"meta":{"fullname":"chart.resetZoomButton.position.verticalAlign","name":"verticalAlign","line":678,"lineEnd":683,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"x":{"doclet":{"description":"The horizontal offset of the button.","type":{"names":["number"]},"since":"2.2.0","deprecated":"10.2.1"},"meta":{"fullname":"chart.resetZoomButton.position.x","name":"x","line":672,"lineEnd":677,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"y":{"doclet":{"description":"The vertical offset of the button.","type":{"names":["number"]},"since":"2.2.0","deprecated":"10.2.1"},"meta":{"fullname":"chart.resetZoomButton.position.y","name":"y","line":684,"lineEnd":689,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}}}},"relativeTo":{"doclet":{"description":"What frame the button placement should be related to. Can be\neither `plotBox` or `spacingBox`.","samples":[{"name":"Relative to the chart","value":"highcharts/chart/resetzoombutton-relativeto/","products":["highcharts"]},{"name":"Relative to the chart","value":"highcharts/chart/resetzoombutton-relativeto/","products":["highstock"]}],"type":{"names":["Highcharts.ButtonRelativeToValue"]},"since":"2.2.0","deprecated":"10.2.1"},"meta":{"fullname":"chart.resetZoomButton.relativeTo","name":"relativeTo","line":619,"lineEnd":630,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"theme":{"doclet":{"description":"A collection of attributes for the button. The object takes SVG\nattributes like `fill`, `stroke`, `stroke-width` or `r`, the\nborder radius. The theme also supports `style`, a collection of\nCSS properties for the text. Equivalent attributes for the hover\nstate are given in `theme.states.hover`.","samples":[{"name":"Theming the button","value":"highcharts/chart/resetzoombutton-theme/","products":["highcharts"]},{"name":"Theming the button","value":"highcharts/chart/resetzoombutton-theme/","products":["highstock"]}],"type":{"names":["Highcharts.SVGAttributes"]},"since":"2.2.0","deprecated":"10.2.1"},"meta":{"fullname":"chart.resetZoomButton.theme","name":"theme","line":619,"lineEnd":630,"column":8,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{"zIndex":{"doclet":{"description":"The z-index of the button.","type":{"names":["number"]},"since":"2.2.0","deprecated":"10.2.1"},"meta":{"fullname":"chart.resetZoomButton.theme.zIndex","name":"zIndex","line":646,"lineEnd":651,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}}}}}},"scrollablePlotArea":{"doclet":{"description":"Options for a scrollable plot area. This feature provides a minimum size for\nthe plot area of the chart. If the size gets smaller than this, typically\non mobile devices, a native browser scrollbar is presented. This scrollbar\nprovides smooth scrolling for the contents of the plot area, whereas the\ntitle, legend and unaffected axes are fixed.\n\nSince v7.1.2, a scrollable plot area can be defined for either horizontal or\nvertical scrolling, depending on whether the `minWidth` or `minHeight`\noption is set.","samples":[{"name":"Scrollable plot area","value":"highcharts/chart/scrollable-plotarea"},{"name":"Vertically scrollable plot area","value":"highcharts/chart/scrollable-plotarea-vertical"},{"name":"Gantt chart with vertically scrollable plot area","value":"gantt/chart/scrollable-plotarea-vertical","products":["gantt"]}],"since":"6.1.0","products":["highcharts","gantt"],"type":{"names":["*"]}},"meta":{"fullname":"chart.scrollablePlotArea","name":"scrollablePlotArea","line":318,"lineEnd":339,"filename":"code/es-modules/Extensions/ScrollablePlotArea.js"},"children":{"minHeight":{"doclet":{"description":"The minimum height for the plot area. If it gets smaller than this, the plot\narea will become scrollable.","type":{"names":["number"]},"since":"7.1.2"},"meta":{"fullname":"chart.scrollablePlotArea.minHeight","name":"minHeight","line":340,"lineEnd":347,"filename":"code/es-modules/Extensions/ScrollablePlotArea.js"},"children":{}},"minWidth":{"doclet":{"description":"The minimum width for the plot area. If it gets smaller than this, the plot\narea will become scrollable.","type":{"names":["number"]},"since":"6.1.0"},"meta":{"fullname":"chart.scrollablePlotArea.minWidth","name":"minWidth","line":348,"lineEnd":355,"filename":"code/es-modules/Extensions/ScrollablePlotArea.js"},"children":{}},"opacity":{"doclet":{"description":"The opacity of mask applied on one of the sides of the plot\narea.","samples":[{"name":"Disabled opacity for the mask","value":"highcharts/chart/scrollable-plotarea-opacity","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0.85","since":"7.1.1"},"meta":{"fullname":"chart.scrollablePlotArea.opacity","name":"opacity","line":373,"lineEnd":384,"filename":"code/es-modules/Extensions/ScrollablePlotArea.js"},"children":{}},"scrollPositionX":{"doclet":{"description":"The initial scrolling position of the scrollable plot area. Ranges from 0 to\n1, where 0 aligns the plot area to the left and 1 aligns it to the right.\nTypically we would use 1 if the chart has right aligned Y axes.","type":{"names":["number"]},"since":"6.1.0"},"meta":{"fullname":"chart.scrollablePlotArea.scrollPositionX","name":"scrollPositionX","line":356,"lineEnd":364,"filename":"code/es-modules/Extensions/ScrollablePlotArea.js"},"children":{}},"scrollPositionY":{"doclet":{"description":"The initial scrolling position of the scrollable plot area. Ranges from 0 to\n1, where 0 aligns the plot area to the top and 1 aligns it to the bottom.","type":{"names":["number"]},"since":"7.1.2"},"meta":{"fullname":"chart.scrollablePlotArea.scrollPositionY","name":"scrollPositionY","line":365,"lineEnd":372,"filename":"code/es-modules/Extensions/ScrollablePlotArea.js"},"children":{}}}},"selectionMarkerFill":{"doclet":{"description":"The background color of the marker square when selecting (zooming\nin on) an area of the chart.","see":["In styled mode, the selection marker fill is set with the\n     `.highcharts-selection-marker` class."],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"rgba(51,92,173,0.25)","since":"2.1.7"},"meta":{"fullname":"chart.selectionMarkerFill","name":"selectionMarkerFill","line":781,"lineEnd":792,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"seriesGroupShadow":{"doclet":{"description":"Whether to apply a drop shadow to the global series group. This causes\nall the series to have the same shadow. Contrary to the `series.shadow`\noption, this prevents items from casting shadows on each other, like for\nothers series in a stack. The shadow can be an object configuration\ncontaining `color`, `offsetX`, `offsetY`, `opacity` and `width`.","samples":[{"name":"Shadow","value":"highcharts/chart/seriesgroupshadow/"}],"type":{"names":["boolean","Highcharts.ShadowOptionsObject"]},"defaultvalue":"false"},"meta":{"fullname":"chart.seriesGroupShadow","name":"seriesGroupShadow","line":793,"lineEnd":806,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"shadow":{"doclet":{"description":"Whether to apply a drop shadow to the outer chart area. Requires\nthat backgroundColor be set. The shadow can be an object\nconfiguration containing `color`, `offsetX`, `offsetY`, `opacity` and\n`width`.","samples":[{"name":"Shadow","value":"highcharts/chart/shadow/","products":["highcharts"]},{"name":"Shadow","value":"stock/chart/shadow/","products":["highstock"]},{"name":"Chart border and shadow","value":"maps/chart/border/","products":["highmaps"]}],"type":{"names":["boolean","Highcharts.ShadowOptionsObject"]},"defaultvalue":"false"},"meta":{"fullname":"chart.shadow","name":"shadow","line":807,"lineEnd":823,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"showAxes":{"doclet":{"description":"Whether to show the axes initially. This only applies to empty charts\nwhere series are added dynamically, as axes are automatically added\nto cartesian series.","samples":[{"name":"False by default","value":"highcharts/chart/showaxes-false/","products":["highcharts"]},{"name":"True","value":"highcharts/chart/showaxes-true/","products":["highcharts"]}],"type":{"names":["boolean"]},"since":"1.2.5","products":["highcharts","gantt"]},"meta":{"fullname":"chart.showAxes","name":"showAxes","line":824,"lineEnd":838,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"spacing":{"doclet":{"description":"The distance between the outer edge of the chart and the content,\nlike title or legend, or axis title and labels if present. The\nnumbers in the array designate top, right, bottom and left\nrespectively. Use the options spacingTop, spacingRight, spacingBottom\nand spacingLeft options for shorthand setting of one option.","type":{"names":["Array.<number>"]},"see":["[chart.margin](#chart.margin)"],"defaultvalue":"[10, 10, 15, 10]","since":"3.0.6"},"meta":{"fullname":"chart.spacing","name":"spacing","line":577,"lineEnd":596,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"spacingBottom":{"doclet":{"description":"The space between the bottom edge of the chart and the content (plot\narea, axis title and labels, title, subtitle or legend in top\nposition).","samples":[{"name":"Spacing bottom set to 100","value":"highcharts/chart/spacingbottom/","products":["highcharts"]},{"name":"Spacing bottom set to 100","value":"stock/chart/spacingbottom/","products":["highstock"]},{"name":"Spacing 100 all around","value":"maps/chart/spacing/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"15","since":"2.1.0"},"meta":{"fullname":"chart.spacingBottom","name":"spacingBottom","line":839,"lineEnd":855,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"spacingLeft":{"doclet":{"description":"The space between the left edge of the chart and the content (plot\narea, axis title and labels, title, subtitle or legend in top\nposition).","samples":[{"name":"Spacing left set to 100","value":"highcharts/chart/spacingleft/","products":["highcharts"]},{"name":"Spacing left set to 100","value":"stock/chart/spacingleft/","products":["highstock"]},{"name":"Spacing 100 all around","value":"maps/chart/spacing/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"10","since":"2.1.0"},"meta":{"fullname":"chart.spacingLeft","name":"spacingLeft","line":856,"lineEnd":872,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"spacingRight":{"doclet":{"description":"The space between the right edge of the chart and the content (plot\narea, axis title and labels, title, subtitle or legend in top\nposition).","samples":[{"name":"Spacing set to 100","value":"highcharts/chart/spacingright-100/","products":["highcharts"]},{"name":"Legend in right position with default spacing","value":"highcharts/chart/spacingright-legend/","products":["highcharts"]},{"name":"Spacing set to 100","value":"stock/chart/spacingright/","products":["highstock"]},{"name":"Spacing 100 all around","value":"maps/chart/spacing/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"10","since":"2.1.0"},"meta":{"fullname":"chart.spacingRight","name":"spacingRight","line":873,"lineEnd":891,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"spacingTop":{"doclet":{"description":"The space between the top edge of the chart and the content (plot\narea, axis title and labels, title, subtitle or legend in top\nposition).","samples":[{"name":"A top spacing of 100","value":"highcharts/chart/spacingtop-100/","products":["highcharts"]},{"name":"Floating chart title makes the plot area align to the default spacingTop of 10.","value":"highcharts/chart/spacingtop-10/","products":["highcharts"]},{"name":"A top spacing of 100","value":"stock/chart/spacingtop/","products":["highstock"]},{"name":"Spacing 100 all around","value":"maps/chart/spacing/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"10","since":"2.1.0"},"meta":{"fullname":"chart.spacingTop","name":"spacingTop","line":892,"lineEnd":911,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"style":{"doclet":{"description":"Additional CSS styles to apply inline to the container `div` and the root\nSVG.\n\nAccording to the CSS syntax documentation, it is recommended to quote\nfont family names that contain white space, digits, or punctuation\ncharacters other than hyphens. In such cases, wrap the fontFamily\nname as follows: `fontFamily: '\"Font name\"'`.\n\nSince v11, the root font size is 1rem by default, and all child element\nare given a relative `em` font size by default. This allows implementers\nto control all the chart's font sizes by only setting the root level.","see":["In styled mode, general chart styles can be set with the\n        `.highcharts-root` class."],"samples":[{"name":"Using a serif type font","value":"highcharts/chart/style-serif-font/","products":["highcharts"]},{"name":"Using a font with special character in name","value":"highcharts/chart/style-special-font/","products":["highcharts"]},{"name":"Relative font sizes","value":"highcharts/members/relative-font-size/","products":["highcharts"]},{"name":"Styled mode with relative font sizes","value":"highcharts/css/em/","products":["highcharts"]},{"name":"Using a serif type font","value":"stock/chart/style/","products":["highstock"]},{"name":"Using a serif type font","value":"maps/chart/style-serif-font/","products":["highmaps"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"fontFamily\": \"-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', sans-serif\", \"fontSize\":\"1rem\"}"},"meta":{"fullname":"chart.style","name":"style","line":912,"lineEnd":943,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"styledMode":{"doclet":{"description":"Whether to apply styled mode. When in styled mode, no presentational\nattributes or CSS are applied to the chart SVG. Instead, CSS rules\nare required to style the chart. The default style sheet is\navailable from `https://code.highcharts.com/css/highcharts.css`.\n\n[Read more in the docs](https://www.highcharts.com/docs/chart-design-and-style/style-by-css)\non what classes and variables are available.","samples":[{"name":"Color theming with CSS","value":"highcharts/css/colors"},{"name":"Dynamic theme based on system settings","value":"highcharts/css/prefers-color-scheme"}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"7.0.0"},"meta":{"fullname":"chart.styledMode","name":"styledMode","line":503,"lineEnd":520,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"type":{"doclet":{"description":"The default series type for the chart. Can be any of the chart types\nlisted under [plotOptions](#plotOptions) and [series](#series) or can\nbe a series provided by an additional module.\n\nIn TypeScript this option has no effect in sense of typing and\ninstead the `type` option must always be set in the series.","samples":[{"name":"Bar","value":"highcharts/chart/type-bar/","products":["highcharts"]},{"name":"Areaspline","value":"stock/chart/type/","products":["highstock"]},{"name":"Mapline","value":"maps/chart/type-mapline/","products":["highmaps"]}],"type":{"names":["string"]},"defaultByProduct":{"highcharts":"line","highstock":"line","highmaps":"map"},"since":"2.1.0"},"meta":{"fullname":"chart.type","name":"type","line":944,"lineEnd":965,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"width":{"doclet":{"description":"An explicit width for the chart. By default (when `null`) the width\nis calculated from the offset width of the containing element.","samples":[{"name":"800px wide","value":"highcharts/chart/width/","products":["highcharts"]},{"name":"800px wide","value":"stock/chart/width/","products":["highstock"]},{"name":"Chart with explicit size","value":"maps/chart/size/","products":["highmaps"]}],"type":{"names":["null","number","string"]},"defaultvalue":null},"meta":{"fullname":"chart.width","name":"width","line":1154,"lineEnd":1166,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":null},"children":{}},"zoomKey":{"doclet":{"description":"Set a key to hold when dragging to zoom the chart. This is useful to\navoid zooming while moving points. Should be set different than\n[chart.panKey](#chart.panKey).","type":{"names":["\"alt\"","\"ctrl\"","\"meta\"","\"shift\""]},"since":"6.2.0","deprecated":true,"requires":["module:modules/draggable-points"]},"meta":{"fullname":"chart.zoomKey","name":"zoomKey","line":162,"lineEnd":173,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"zoomType":{"doclet":{"description":"Decides in what dimensions the user can zoom by dragging the mouse.\nCan be one of `x`, `y` or `xy`.","see":["[panKey](#chart.panKey)"],"samples":[{"name":"None by default","value":"highcharts/chart/zoomtype-none/","products":["highcharts"]},{"name":"X","value":"highcharts/chart/zoomtype-x/","products":["highcharts"]},{"name":"Y","value":"highcharts/chart/zoomtype-y/","products":["highcharts"]},{"name":"Xy","value":"highcharts/chart/zoomtype-xy/","products":["highcharts"]},{"name":"Zoom on polar chart","value":"highcharts/chart/zoomtype-polar/","products":["highcharts"]},{"name":"None by default","value":"stock/demo/basic-line/","products":["highstock"]},{"name":"X","value":"stock/chart/zoomtype-x/","products":["highstock"]},{"name":"Y","value":"stock/chart/zoomtype-y/","products":["highstock"]},{"name":"Xy","value":"stock/chart/zoomtype-xy/","products":["highstock"]},{"name":"Map with selection zoom","value":"maps/chart/zoomtype-xy/","products":["highmaps"]}],"type":{"names":["\"x\"","\"y\"","\"xy\""]},"deprecated":true},"meta":{"fullname":"chart.zoomType","name":"zoomType","line":967,"lineEnd":998,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"zooming":{"doclet":{"description":"Chart zooming options.","since":"10.2.1","samples":[{"name":"Zooming in sankey series","value":"highcharts/plotoptions/sankey-node-color"},{"name":"Zooming in treegraph series","value":"highcharts/series-treegraph/link-types"}],"type":{"names":["*"]}},"meta":{"fullname":"chart.zooming","name":"zooming","line":967,"lineEnd":998,"column":4,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{"key":{"doclet":{"description":"Set a key to hold when dragging to zoom the chart. This is useful to\navoid zooming while moving points. Should be set different than\n[chart.panKey](#chart.panKey).\n\n**Note:** If both zooming and panning are enabled without keys,\nzooming will take precedence by default. To prioritize panning,\neither set zooming key or [chart.panKey](#chart.panKey).","type":{"names":["\"alt\"","\"ctrl\"","\"meta\"","\"shift\""]},"defaultByProduct":{"highcharts":"undefined"},"requires":["module:modules/draggable-points"],"since":"10.2.1"},"meta":{"fullname":"chart.zooming.key","name":"key","line":1053,"lineEnd":1067,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"mouseWheel":{"doclet":{"description":"The mouse wheel zoom is a feature included in Highcharts Stock, but is also\navailable for Highcharts Core as a module. Zooming with the mouse wheel is\nenabled by default in Highcharts Stock. In Highcharts Core it is enabled if\n[chart.zooming.type](chart.zooming.type) is set. It can be disabled by\nsetting this option to `false`.","type":{"names":["boolean","object"]},"since":"11.1.0","requires":["module:modules/mouse-wheel-zoom"],"samples":[{"name":"Enable or disable","value":"highcharts/mouse-wheel-zoom/enabled","products":["highcharts"]},{"name":"Enable or disable","value":"stock/mouse-wheel-zoom/enabled","products":["highstock"]}]},"meta":{"fullname":"chart.zooming.mouseWheel","name":"mouseWheel","line":129,"lineEnd":144,"filename":"code/es-modules/Extensions/MouseWheelZoom/MouseWheelZoom.js"},"children":{"enabled":{"doclet":{"description":"Zooming with the mouse wheel can be disabled by setting this option to\n`false`.","type":{"names":["boolean"]},"defaultvalue":"true","since":"11.1.0","requires":["module:modules/mouse-wheel-zoom"]},"meta":{"fullname":"chart.zooming.mouseWheel.enabled","name":"enabled","line":145,"lineEnd":154,"filename":"code/es-modules/Extensions/MouseWheelZoom/MouseWheelZoom.js"},"children":{}},"sensitivity":{"doclet":{"description":"Adjust the sensitivity of the zoom. Sensitivity of mouse wheel or trackpad\nscrolling. `1` is no sensitivity, while with `2`, one mouse wheel delta will\nzoom in `50%`.","type":{"names":["number"]},"defaultvalue":"1.1","since":"11.1.0","requires":["module:modules/mouse-wheel-zoom"],"samples":[{"name":"Change mouse wheel zoom sensitivity","value":"highcharts/mouse-wheel-zoom/sensitivity","products":["highcharts"]},{"name":"Change mouse wheel zoom sensitivity","value":"stock/mouse-wheel-zoom/sensitivity","products":["highstock"]}]},"meta":{"fullname":"chart.zooming.mouseWheel.sensitivity","name":"sensitivity","line":155,"lineEnd":169,"filename":"code/es-modules/Extensions/MouseWheelZoom/MouseWheelZoom.js"},"children":{}},"showResetButton":{"doclet":{"description":"Whether to enable the reset zoom button when zooming with the mouse wheel.","type":{"names":["boolean"]},"defaultvalue":"false","requires":["module:modules/mouse-wheel-zoom"],"samples":[{"name":"Enable reset zoom button for mouse wheel zooming","value":"highcharts/mouse-wheel-zoom/reset-zoom-button","products":["highcharts"]},{"name":"Enable reset zoom button for mouse wheel zooming","value":"stock/mouse-wheel-zoom/reset-zoom-button","products":["highstock"]}],"since":"11.1.0"},"meta":{"fullname":"chart.zooming.mouseWheel.showResetButton","name":"showResetButton","line":190,"lineEnd":202,"filename":"code/es-modules/Extensions/MouseWheelZoom/MouseWheelZoom.js"},"children":{}},"type":{"doclet":{"description":"Decides in what dimensions the user can zoom scrolling the wheel. Can be one\nof `x`, `y` or `xy`. In Highcharts Core, if not specified here, it will\ninherit the type from [chart.zooming.type](chart.zooming.type). In Highcharts\nStock, it defaults to `x`.\n\nNote that particularly with mouse wheel in the y direction, the zoom is\naffected by the default [yAxis.startOnTick](#yAxis.startOnTick) and\n[endOnTick]((#yAxis.endOnTick)) settings. In order to respect these settings,\nthe zoom level will adjust after the user has stopped zooming. To prevent\nthis, consider setting `startOnTick` and `endOnTick` to `false`.","type":{"names":["\"x\"","\"y\"","\"xy\""]},"defaultByProduct":{"highcharts":"undefined","highstock":"x"},"since":"11.1.0","requires":["module:modules/mouse-wheel-zoom"]},"meta":{"fullname":"chart.zooming.mouseWheel.type","name":"type","line":170,"lineEnd":189,"filename":"code/es-modules/Extensions/MouseWheelZoom/MouseWheelZoom.js"},"children":{}}}},"pinchType":{"doclet":{"description":"Equivalent to [type](#chart.zooming.type), but for multitouch\ngestures only. By default, the `pinchType` is the same as the\n`type` setting. However, pinching can be enabled separately in\nsome cases, for example in stock charts where a mouse drag pans the\nchart, while pinching is enabled. When [tooltip.followTouchMove](#tooltip.followTouchMove) is true, pinchType only applies to\ntwo-finger touches.","type":{"names":["\"x\"","\"y\"","\"xy\""]},"defaultByProduct":{"highcharts":"undefined","highstock":"x"},"products":["highcharts","highstock","gantt"],"since":"10.2.1"},"meta":{"fullname":"chart.zooming.pinchType","name":"pinchType","line":1022,"lineEnd":1037,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"resetButton":{"doclet":{"description":"The button that appears after a selection zoom, allowing the user\nto reset zoom.","since":"10.2.1","type":{"names":["*"]}},"meta":{"fullname":"chart.zooming.resetButton","name":"resetButton","line":1083,"lineEnd":1086,"column":8,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{"position":{"doclet":{"description":"The position of the button.\n\nNote: Adjusting position values might cause overlap with chart\nelements. Ensure coordinates do not obstruct other components or\ndata visibility.","samples":[{"name":"Above the plot area","value":"highcharts/chart/resetzoombutton-position/","products":["highcharts"]},{"name":"Above the plot area","value":"highcharts/chart/resetzoombutton-position/","products":["highstock"]},{"name":"Above the plot area","value":"highcharts/chart/resetzoombutton-position/","products":["highmaps"]}],"type":{"names":["Highcharts.AlignObject"]},"since":"10.2.1"},"meta":{"fullname":"chart.zooming.resetButton.position","name":"position","line":1120,"lineEnd":1136,"column":12,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{"verticalAlign":{"doclet":{"description":"The vertical alignment of the button.","type":{"names":["Highcharts.VerticalAlignValue"]},"defaultvalue":"top","since":"10.2.1"},"meta":{"fullname":"chart.zooming.resetButton.position.verticalAlign","name":"verticalAlign","line":1142,"lineEnd":1148,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}}}},"relativeTo":{"doclet":{"description":"What frame the button placement should be related to. Can be\neither `plotBox` or `spacingBox`.","samples":[{"name":"Relative to the chart","value":"highcharts/chart/resetzoombutton-relativeto/","products":["highcharts"]},{"name":"Relative to the chart","value":"highcharts/chart/resetzoombutton-relativeto/","products":["highstock"]}],"type":{"names":["Highcharts.ButtonRelativeToValue"]},"defaultvalue":"plot","since":"10.2.1"},"meta":{"fullname":"chart.zooming.resetButton.relativeTo","name":"relativeTo","line":1088,"lineEnd":1100,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}},"theme":{"doclet":{"description":"A collection of attributes for the button. The object takes SVG\nattributes like `fill`, `stroke`, `stroke-width` or `r`, the\nborder radius. The theme also supports `style`, a collection of\nCSS properties for the text. Equivalent attributes for the hover\nstate are given in `theme.states.hover`.","samples":[{"name":"Theming the button","value":"highcharts/chart/resetzoombutton-theme/","products":["highcharts"]},{"name":"Theming the button","value":"highcharts/chart/resetzoombutton-theme/","products":["highstock"]}],"type":{"names":["Highcharts.SVGAttributes"]},"since":"10.2.1"},"meta":{"fullname":"chart.zooming.resetButton.theme","name":"theme","line":1088,"lineEnd":1100,"column":12,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}}}},"singleTouch":{"doclet":{"description":"Enables zooming by a single touch, in combination with\n[chart.zooming.type](#chart.zooming.type). When enabled, two-finger\npinch will still work as set up by [chart.zooming.pinchType]\n(#chart.zooming.pinchType). However, `singleTouch` will interfere\nwith touch-dragging the chart to read the tooltip. And especially\nwhen vertical zooming is enabled, it will make it hard to scroll\nvertically on the page.","samples":[{"name":"Zoom by single touch enabled, with buttons to toggle","value":"highcharts/chart/zoombysingletouch"}],"products":["highcharts","highstock","gantt"],"since":"10.2.1","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"chart.zooming.singleTouch","name":"singleTouch","line":1022,"lineEnd":1037,"column":8,"filename":"code/es-modules/Core/Chart/ChartDefaults.js","default":false},"children":{}},"type":{"doclet":{"description":"Decides in what dimensions the user can zoom by dragging the mouse.\nCan be one of `x`, `y` or `xy`.\n\n**Note:** For non-cartesian series, the only supported zooming type\nis `xy`, as zooming in a single direction is not applicable due to\nthe radial nature of the coordinate system.","declare":"Highcharts.OptionsChartZoomingTypeValue","type":{"names":["\"x\"","\"y\"","\"xy\""]},"defaultByProduct":{"highcharts":"undefined"},"products":["highcharts","highstock","gantt"],"since":"10.2.1"},"meta":{"fullname":"chart.zooming.type","name":"type","line":1038,"lineEnd":1052,"filename":"code/es-modules/Core/Chart/ChartDefaults.js"},"children":{}}}}}},"colorAxis":{"doclet":{"description":"A color axis for series. Visually, the color\naxis will appear as a gradient or as separate items inside the\nlegend, depending on whether the axis is scalar or based on data\nclasses.\n\nFor supported color formats, see the\n[docs article about colors](https://www.highcharts.com/docs/chart-design-and-style/colors).\n\nA scalar color axis is represented by a gradient. The colors either\nrange between the [minColor](#colorAxis.minColor) and the\n[maxColor](#colorAxis.maxColor), or for more fine grained control the\ncolors can be defined in [stops](#colorAxis.stops). Often times, the\ncolor axis needs to be adjusted to get the right color spread for the\ndata. In addition to stops, consider using a logarithmic\n[axis type](#colorAxis.type), or setting [min](#colorAxis.min) and\n[max](#colorAxis.max) to avoid the colors being determined by\noutliers.\n\nWhen [dataClasses](#colorAxis.dataClasses) are used, the ranges are\nsubdivided into separate classes like categories based on their\nvalues. This can be used for ranges between two values, but also for\na true category. However, when your data is categorized, it may be as\nconvenient to add each category to a separate series.\n\nColor axis does not work with: `sankey`, `sunburst`, `dependencywheel`,\n`networkgraph`, `venn`, `gauge` and `solidgauge` series\ntypes.\n\nSince v7.2.0 `colorAxis` can also be an array of options objects.\n\nSee [the Axis object](/class-reference/Highcharts.Axis) for\nprogrammatic access to the axis.","samples":[{"name":"Column chart with color axis","value":"highcharts/coloraxis/custom-color-key","products":["highcharts"]},{"name":"Horizontal layout","value":"highcharts/coloraxis/horizontal-layout","products":["highcharts"]},{"name":"With data classes","value":"maps/coloraxis/dataclasscolor","products":["highmaps"]},{"name":"Min color and max color","value":"maps/coloraxis/mincolor-maxcolor","products":["highmaps"]}],"extends":"xAxis","exclude":["alignTicks","allowDecimals","alternateGridColor","breaks","categories","crosshair","dateTimeLabelFormats","left","lineWidth","linkedTo","maxZoom","minRange","minTickInterval","offset","opposite","pane","plotBands","plotLines","reversedStacks","scrollbar","showEmpty","top","zoomEnabled"],"products":["highcharts","highstock","highmaps"],"type":{"names":["*","Array.<*>"]}},"meta":{"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","name":"colorAxis","fullname":"colorAxis","line":12,"lineEnd":16,"column":0},"children":{"allowDecimals":{"doclet":{"description":"Whether to allow decimals on the color axis.","type":{"names":["boolean"]},"defaultvalue":"true","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.allowDecimals","name":"allowDecimals","line":71,"lineEnd":77,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"dataClassColor":{"doclet":{"description":"Determines how to set each data class' color if no individual\ncolor is set. The default value, `tween`, computes intermediate\ncolors between `minColor` and `maxColor`. The other possible\nvalue, `category`, pulls colors from the global or chart specific\n[colors](#colors) array.","samples":[{"name":"Category colors","value":"maps/coloraxis/dataclasscolor/","products":["highmaps"]}],"type":{"names":["\"tween\"","\"category\""]},"defaultvalue":"tween","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.dataClassColor","name":"dataClassColor","line":78,"lineEnd":93,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"dataClasses":{"doclet":{"description":"An array of data classes or ranges for the choropleth map. If\nnone given, the color axis is scalar and values are distributed\nas a gradient between the minimum and maximum colors.","samples":[{"name":"Multiple ranges","value":"maps/demo/data-class-ranges/","products":["highmaps"]},{"name":"Two ranges","value":"maps/demo/data-class-two-ranges/","products":["highmaps"]}],"type":{"names":["Array.<*>"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.dataClasses","name":"dataClasses","line":94,"lineEnd":108,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{"color":{"doclet":{"description":"The color of each data class. If not set, the color is pulled\nfrom the global or chart-specific [colors](#colors) array. In\nstyled mode, this option is ignored. Instead, use colors defined\nin CSS.","samples":[{"name":"Explicit colors","value":"maps/demo/data-class-two-ranges/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.dataClasses.color","name":"color","line":109,"lineEnd":121,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"from":{"doclet":{"description":"The start of the value range that the data class represents,\nrelating to the point value.\n\nThe range of each `dataClass` is closed in both ends, but can be\noverridden by the next `dataClass`.","type":{"names":["number"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.dataClasses.from","name":"from","line":122,"lineEnd":132,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"name":{"doclet":{"description":"The name of the data class as it appears in the legend.\nIf no name is given, it is automatically created based on the\n`from` and `to` values. For full programmatic control,\n[legend.labelFormatter](#legend.labelFormatter) can be used.\nIn the formatter, `this.from` and `this.to` can be accessed.","samples":[{"name":"Named data classes","value":"maps/coloraxis/dataclasses-name/","products":["highmaps"]},{"name":"Formatted data classes","value":"maps/coloraxis/dataclasses-labelformatter/","products":["highmaps"]}],"type":{"names":["string"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.dataClasses.name","name":"name","line":133,"lineEnd":149,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"to":{"doclet":{"description":"The end of the value range that the data class represents,\nrelating to the point value.\n\nThe range of each `dataClass` is closed in both ends, but can be\noverridden by the next `dataClass`.","type":{"names":["number"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.dataClasses.to","name":"to","line":150,"lineEnd":160,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}}}},"endOnTick":{"doclet":{"description":"Whether to force the axis to end on a tick. Use this option with\nthe [maxPadding](#colorAxis.maxPadding) option to control the\naxis end.","products":["highcharts","highstock","highmaps"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"colorAxis.endOnTick","name":"endOnTick","line":258,"lineEnd":264,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":true},"children":{}},"events":{"doclet":{"products":["highcharts","highstock","highmaps"],"exclude":["afterBreaks","pointBreak","pointInBreak"],"type":{"names":["*"]}},"meta":{"fullname":"colorAxis.events","name":"events","line":419,"lineEnd":423,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{"legendItemClick":{"doclet":{"description":"Fires when the legend item belonging to the colorAxis is clicked.\nOne parameter, `event`, is passed to the function.\n\n**Note:** This option is deprecated in favor of\n[legend.events.itemClick](#legend.events.itemClick).","deprecated":"11.4.4","type":{"names":["function"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.events.legendItemClick","name":"legendItemClick","line":424,"lineEnd":435,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}}}},"gridLineColor":{"doclet":{"description":"Color of the grid lines extending from the axis across the\ngradient.","samples":[{"name":"Grid lines demonstrated","value":"maps/coloraxis/gridlines/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock","highmaps"],"defaultvalue":"#ffffff"},"meta":{"fullname":"colorAxis.gridLineColor","name":"gridLineColor","line":214,"lineEnd":223,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":"#ffffff"},"children":{}},"gridLineWidth":{"doclet":{"description":"The width of the grid lines extending from the axis across the\ngradient of a scalar color axis.","samples":[{"name":"Grid lines demonstrated","value":"maps/coloraxis/gridlines/","products":["highmaps"]}],"products":["highcharts","highstock","highmaps"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"colorAxis.gridLineWidth","name":"gridLineWidth","line":225,"lineEnd":233,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":1},"children":{}},"height":{"doclet":{"description":"The height of the color axis. If it's a number, it is interpreted as\npixels.\n\nIf it's a percentage string, it is interpreted as percentages of the\ntotal plot height.","samples":[{"name":"Percentage width and pixel height for color axis","value":"highcharts/coloraxis/width-and-height"}],"type":{"names":["number","string"]},"since":"11.3.0","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.height","name":"height","line":451,"lineEnd":465,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"labels":{"doclet":{"description":"The axis labels show the number for each tick.\n\nFor more live examples on label options, see [xAxis.labels in the\nHighcharts API.](/highcharts#xAxis.labels)","extends":"xAxis.labels","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.labels","name":"labels","line":301,"lineEnd":309,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{"distance":{"doclet":{"type":{"names":["number"]},"defaultvalue":8},"meta":{"fullname":"colorAxis.labels.distance","name":"distance","line":311,"lineEnd":311,"column":8,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":8},"children":{}},"overflow":{"doclet":{"description":"How to handle overflowing labels on horizontal color axis. If set\nto `\"allow\"`, it will not be aligned at all. By default it\n`\"justify\"` labels inside the chart area. If there is room to\nmove it, it will be aligned to the edge, else it will be removed.","values":"[\"allow\", \"justify\"]","products":["highcharts","highstock","highmaps"],"type":{"names":["string"]},"defaultvalue":"justify"},"meta":{"fullname":"colorAxis.labels.overflow","name":"overflow","line":312,"lineEnd":320,"column":8,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":"justify"},"children":{}},"rotation":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"colorAxis.labels.rotation","name":"rotation","line":322,"lineEnd":322,"column":8,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":0},"children":{}}}},"layout":{"doclet":{"description":"The layout of the color axis. Can be `'horizontal'` or `'vertical'`.\nIf none given, the color axis has the same layout as the legend.","samples":[{"name":"Horizontal color axis layout with vertical legend","value":"highcharts/coloraxis/horizontal-layout/"}],"type":{"names":["string","undefined"]},"since":"7.2.0","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.layout","name":"layout","line":161,"lineEnd":172,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"marker":{"doclet":{"description":"The triangular marker on a scalar color axis that points to the\nvalue of the hovered area. To disable the marker, set\n`marker: null`.","samples":[{"name":"Black marker","value":"maps/coloraxis/marker/","products":["highmaps"]}],"declare":"Highcharts.PointMarkerOptionsObject","products":["highcharts","highstock","highmaps"],"type":{"names":["*"]}},"meta":{"fullname":"colorAxis.marker","name":"marker","line":268,"lineEnd":278,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{"animation":{"doclet":{"description":"Animation for the marker as it moves between values. Set to\n`false` to disable animation. Defaults to `{ duration: 50 }`.","type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.marker.animation","name":"animation","line":280,"lineEnd":286,"column":8,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"color":{"doclet":{"description":"The color of the marker.","type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock","highmaps"],"defaultvalue":"#999999"},"meta":{"fullname":"colorAxis.marker.color","name":"color","line":293,"lineEnd":298,"column":8,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":"#999999"},"children":{}}}},"max":{"doclet":{"description":"The maximum value of the axis in terms of map point values. If\n`null`, the max value is automatically calculated. If the\n`endOnTick` option is true, the max value might be rounded up.","samples":[{"name":"Explicit min and max to reduce the effect of outliers","value":"maps/coloraxis/gridlines/","products":["highmaps"]}],"type":{"names":["number"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.max","name":"max","line":182,"lineEnd":193,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"maxColor":{"doclet":{"description":"The color to represent the maximum of the color axis. Unless\n[dataClasses](#colorAxis.dataClasses) or\n[stops](#colorAxis.stops) are set, the gradient ends at this\nvalue.\n\nIf dataClasses are set, the color is based on minColor and\nmaxColor unless a color is set for each data class, or the\n[dataClassColor](#colorAxis.dataClassColor) is set.","samples":[{"name":"Min and max colors on scalar (gradient) axis","value":"maps/coloraxis/mincolor-maxcolor/","products":["highmaps"]},{"name":"On data classes","value":"maps/coloraxis/mincolor-maxcolor-dataclasses/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock","highmaps"],"defaultvalue":"#0022ff"},"meta":{"fullname":"colorAxis.maxColor","name":"maxColor","line":343,"lineEnd":360,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":"#0022ff"},"children":{}},"maxPadding":{"doclet":{"description":"Padding of the max value relative to the length of the axis. A\npadding of 0.05 will make a 100px axis 5px longer.","products":["highcharts","highstock","highmaps"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"colorAxis.maxPadding","name":"maxPadding","line":182,"lineEnd":193,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":0},"children":{}},"min":{"doclet":{"description":"The minimum value of the axis in terms of map point values. If\n`null`, the min value is automatically calculated. If the\n`startOnTick` option is true, the min value might be rounded\ndown.","samples":[{"name":"Explicit min and max to reduce the effect of outliers","value":"maps/coloraxis/gridlines/","products":["highmaps"]}],"type":{"names":["number"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.min","name":"min","line":194,"lineEnd":206,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"minColor":{"doclet":{"description":"The color to represent the minimum of the color axis. Unless\n[dataClasses](#colorAxis.dataClasses) or\n[stops](#colorAxis.stops) are set, the gradient starts at this\nvalue.\n\nIf dataClasses are set, the color is based on minColor and\nmaxColor unless a color is set for each data class, or the\n[dataClassColor](#colorAxis.dataClassColor) is set.","samples":[{"name":"Min and max colors on scalar (gradient) axis","value":"maps/coloraxis/mincolor-maxcolor/","products":["highmaps"]},{"name":"On data classes","value":"maps/coloraxis/mincolor-maxcolor-dataclasses/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock","highmaps"],"defaultvalue":"#e6e9ff"},"meta":{"fullname":"colorAxis.minColor","name":"minColor","line":324,"lineEnd":341,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":"#e6e9ff"},"children":{}},"minPadding":{"doclet":{"description":"Padding of the min value relative to the length of the axis. A\npadding of 0.05 will make a 100px axis 5px longer.","products":["highcharts","highstock","highmaps"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"colorAxis.minPadding","name":"minPadding","line":175,"lineEnd":180,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":0},"children":{}},"reversed":{"doclet":{"description":"Whether to reverse the axis so that the highest number is closest\nto the origin. Defaults to `false`.","type":{"names":["boolean"]},"defaultvalue":"false","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.reversed","name":"reversed","line":410,"lineEnd":418,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"showInLegend":{"doclet":{"description":"Whether to display the colorAxis in the legend.","samples":[{"name":"Hidden color axis with 3d chart","value":"highcharts/coloraxis/hidden-coloraxis-with-3d-chart/"}],"see":["[heatmap.showInLegend](#series.heatmap.showInLegend)"],"since":"4.2.7","products":["highcharts","highstock","highmaps"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"colorAxis.showInLegend","name":"showInLegend","line":397,"lineEnd":409,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":true},"children":{}},"startOnTick":{"doclet":{"description":"Whether to force the axis to start on a tick. Use this option\nwith the `maxPadding` option to control the axis start.","products":["highcharts","highstock","highmaps"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"colorAxis.startOnTick","name":"startOnTick","line":251,"lineEnd":256,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":true},"children":{}},"stops":{"doclet":{"description":"Color stops for the gradient of a scalar color axis. Use this in\ncases where a linear gradient between a `minColor` and `maxColor`\nis not sufficient. The stops is an array of tuples, where the\nfirst item is a float between 0 and 1 assigning the relative\nposition in the gradient, and the second item is the color.","samples":[{"name":"Color axis stops","value":"highcharts/coloraxis/coloraxis-stops/"},{"name":"Color axis stops with custom colorKey","value":"highcharts/coloraxis/color-key-with-stops/"},{"name":"Heatmap with three color stops","value":"maps/demo/heatmap/","products":["highmaps"]}],"type":{"names":["Array.<Array.<number, Highcharts.ColorString>>"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.stops","name":"stops","line":362,"lineEnd":379,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"tickInterval":{"doclet":{"description":"The interval of the tick marks in axis units. When `null`, the\ntick interval is computed to approximately follow the\n`tickPixelInterval`.","type":{"names":["number"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.tickInterval","name":"tickInterval","line":235,"lineEnd":243,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"tickLength":{"doclet":{"description":"The pixel length of the main tick marks on the color axis.","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"colorAxis.tickLength","name":"tickLength","line":362,"lineEnd":379,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":5},"children":{}},"tickPixelInterval":{"doclet":{"description":"If [tickInterval](#colorAxis.tickInterval) is `null` this option\nsets the approximate pixel interval of the tick marks.","products":["highcharts","highstock","highmaps"],"type":{"names":["number"]},"defaultvalue":72},"meta":{"fullname":"colorAxis.tickPixelInterval","name":"tickPixelInterval","line":235,"lineEnd":243,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":72},"children":{}},"title":{"doclet":{"description":"The color axis title. Displayed alongside the color axis. When the\nlegend is vertical the title is rotated accordingly.","samples":[{"name":"Color axis with title","value":"highcharts/coloraxis/coloraxis-title/"}],"type":{"names":["Highcharts.AxisTitleOptions"]},"products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.title","name":"title","line":384,"lineEnd":393,"column":4,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{"margin":{"doclet":{"type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"colorAxis.title.margin","name":"margin","line":395,"lineEnd":395,"column":8,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js","default":5},"children":{}}}},"type":{"doclet":{"description":"The type of interpolation to use for the color axis. Can be\n`linear` or `logarithmic`.","samples":[{"name":"Logarithmic color axis with extension to emulate negative values","value":"highcharts/coloraxis/logarithmic-with-emulate-negative-values/"}],"type":{"names":["Highcharts.ColorAxisTypeValue"]},"defaultvalue":"linear","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.type","name":"type","line":397,"lineEnd":409,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}},"width":{"doclet":{"description":"The width of the color axis. If it's a number, it is interpreted as\npixels.\n\nIf it's a percentage string, it is interpreted as percentages of the\ntotal plot width.","samples":[{"name":"Percentage width and pixel height for color axis","value":"highcharts/coloraxis/width-and-height"}],"type":{"names":["number","string"]},"since":"11.3.0","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"colorAxis.width","name":"width","line":436,"lineEnd":450,"filename":"code/es-modules/Core/Axis/Color/ColorAxisDefaults.js"},"children":{}}}},"colors":{"doclet":{"description":"An array containing the default colors for the chart's series. When\nall colors are used, new colors are pulled from the start again.\n\nDefault colors can also be set on a series or series.type basis,\nsee [column.colors](#plotOptions.column.colors),\n[pie.colors](#plotOptions.pie.colors).\n\nIn styled mode, the colors option doesn't exist. Instead, colors\nare defined in CSS and applied either through series or point class\nnames, or through the [chart.colorCount](#chart.colorCount) option.","samples":[{"name":"Assign a global color theme","value":"highcharts/chart/colors/","products":["highcharts"]},{"name":"Latest release styled like version 10","value":"highcharts/members/theme-v10/"}],"type":{"names":["Array.<Highcharts.ColorType>"]},"defaultvalue":"[\n    \"#2caffe\",\n    \"#544fc5\",\n    \"#00e272\",\n    \"#fe6a35\",\n    \"#6b8abc\",\n    \"#d568fb\",\n    \"#2ee0ca\",\n    \"#fa4b42\",\n    \"#feb56a\",\n    \"#91e8e1\"\n]"},"meta":{"fullname":"colors","name":"colors","line":33,"lineEnd":63,"column":4,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"connectors":{"doclet":{"description":"The Pathfinder module allows you to define connections between any two\npoints, represented as lines - optionally with markers for the start\nand/or end points. Multiple algorithms are available for calculating how\nthe connecting lines are drawn.\n\nConnector functionality requires Highcharts Gantt to be loaded. In Gantt\ncharts, the connectors are used to draw dependencies between tasks.","see":["[dependency](series.gantt.data.dependency)"],"samples":[{"name":"Pathfinder connections","value":"gantt/pathfinder/demo"}],"declare":"Highcharts.ConnectorsOptions","products":["gantt"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","name":"connectors","fullname":"connectors","line":24,"lineEnd":41,"column":4},"children":{"algorithmMargin":{"doclet":{"description":"Set the default pathfinder margin to use, in pixels. Some Pathfinder\nalgorithms attempt to avoid obstacles, such as other points in the\nchart. These algorithms use this margin to determine how close lines\ncan be to an obstacle. The default is to compute this automatically\nfrom the size of the obstacles in the chart.\n\nTo draw connecting lines close to existing points, set this to a low\nnumber. For more space around existing points, set this number\nhigher.","samples":[{"name":"Small algorithmMargin","value":"gantt/pathfinder/algorithm-margin"}],"type":{"names":["number"]},"since":"6.2.0"},"meta":{"fullname":"connectors.algorithmMargin","name":"algorithmMargin","line":67,"lineEnd":84,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}},"dashStyle":{"doclet":{"description":"Set the default dash style for this chart's connecting lines.","type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"6.2.0"},"meta":{"fullname":"connectors.dashStyle","name":"dashStyle","line":51,"lineEnd":58,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Enable connectors for this chart. Requires Highcharts Gantt.","type":{"names":["boolean"]},"defaultvalue":"true","since":"6.2.0"},"meta":{"fullname":"connectors.enabled","name":"enabled","line":43,"lineEnd":50,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}},"endMarker":{"doclet":{"description":"Marker options specific to the end markers for this chart's\nPathfinder connectors. Overrides the generic marker options.","declare":"Highcharts.ConnectorsEndMarkerOptions","extends":"connectors.marker","since":"6.2.0"},"meta":{"fullname":"connectors.endMarker","name":"endMarker","line":221,"lineEnd":228,"column":8,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{"symbol":{"doclet":{"description":"Set the symbol of the connector end markers.","since":"6.2.0","type":{"names":["string"]},"defaultvalue":"arrow-filled"},"meta":{"fullname":"connectors.endMarker.symbol","name":"symbol","line":230,"lineEnd":232,"column":12,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","default":"arrow-filled"},"children":{}}}},"lineColor":{"doclet":{"description":"Set the default color for this chart's Pathfinder connecting lines.\nDefaults to the color of the point being connected.","type":{"names":["Highcharts.ColorString"]},"since":"6.2.0"},"meta":{"fullname":"connectors.lineColor","name":"lineColor","line":59,"lineEnd":66,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}},"lineWidth":{"doclet":{"description":"Set the default pixel width for this chart's Pathfinder connecting\nlines.","since":"6.2.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"connectors.lineWidth","name":"lineWidth","line":123,"lineEnd":128,"column":8,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","default":1},"children":{}},"marker":{"doclet":{"description":"Marker options for this chart's Pathfinder connectors. Note that\nthis option is overridden by the `startMarker` and `endMarker`\noptions.","declare":"Highcharts.ConnectorsMarkerOptions","since":"6.2.0","type":{"names":["*"]}},"meta":{"fullname":"connectors.marker","name":"marker","line":130,"lineEnd":137,"column":8,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{"align":{"doclet":{"description":"Horizontal alignment of the markers relative to the points.","type":{"names":["Highcharts.AlignValue"]},"since":"6.2.0","defaultvalue":"center"},"meta":{"fullname":"connectors.marker.align","name":"align","line":186,"lineEnd":190,"column":12,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","default":"center"},"children":{}},"color":{"doclet":{"description":"Set the color of the connector markers. By default this is the\nsame as the connector color.","type":{"names":["Highcharts.ColorType"]},"since":"6.2.0"},"meta":{"fullname":"connectors.marker.color","name":"color","line":166,"lineEnd":173,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Enable markers for the connectors.","since":"6.2.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"connectors.marker.enabled","name":"enabled","line":139,"lineEnd":149,"column":12,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","default":false},"children":{}},"height":{"doclet":{"description":"Set the height of the connector markers. If not supplied, this\nis inferred from the marker radius.","type":{"names":["number"]},"since":"6.2.0"},"meta":{"fullname":"connectors.marker.height","name":"height","line":158,"lineEnd":165,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}},"inside":{"doclet":{"description":"Whether or not to draw the markers inside the points.","since":"6.2.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"connectors.marker.inside","name":"inside","line":198,"lineEnd":200,"column":12,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","default":false},"children":{}},"lineColor":{"doclet":{"description":"Set the line/border color of the connector markers. By default\nthis is the same as the marker color.","type":{"names":["Highcharts.ColorString"]},"since":"6.2.0"},"meta":{"fullname":"connectors.marker.lineColor","name":"lineColor","line":174,"lineEnd":181,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}},"lineWidth":{"doclet":{"description":"Set the line/border width of the pathfinder markers.","since":"6.2.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"connectors.marker.lineWidth","name":"lineWidth","line":202,"lineEnd":204,"column":12,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","default":1},"children":{}},"radius":{"doclet":{"description":"Set the radius of the connector markers. The default is\nautomatically computed based on the algorithmMargin setting.\n\nSetting marker.width and marker.height will override this\nsetting.","type":{"names":["number"]},"since":"6.2.0"},"meta":{"fullname":"connectors.marker.radius","name":"radius","line":139,"lineEnd":149,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"Vertical alignment of the markers relative to the points.","type":{"names":["Highcharts.VerticalAlignValue"]},"since":"6.2.0","defaultvalue":"middle"},"meta":{"fullname":"connectors.marker.verticalAlign","name":"verticalAlign","line":192,"lineEnd":196,"column":12,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","default":"middle"},"children":{}},"width":{"doclet":{"description":"Set the width of the connector markers. If not supplied, this\nis inferred from the marker radius.","type":{"names":["number"]},"since":"6.2.0"},"meta":{"fullname":"connectors.marker.width","name":"width","line":150,"lineEnd":157,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}}}},"radius":{"doclet":{"description":"The corner radius for the connector line.","since":"11.2.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"connectors.radius","name":"radius","line":117,"lineEnd":121,"column":8,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","default":0},"children":{}},"startMarker":{"doclet":{"description":"Marker options specific to the start markers for this chart's\nPathfinder connectors. Overrides the generic marker options.","declare":"Highcharts.ConnectorsStartMarkerOptions","extends":"connectors.marker","since":"6.2.0"},"meta":{"fullname":"connectors.startMarker","name":"startMarker","line":207,"lineEnd":214,"column":8,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{"symbol":{"doclet":{"description":"Set the symbol of the connector start markers.","since":"6.2.0","type":{"names":["string"]},"defaultvalue":"diamond"},"meta":{"fullname":"connectors.startMarker.symbol","name":"symbol","line":216,"lineEnd":218,"column":12,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","default":"diamond"},"children":{}}}},"type":{"doclet":{"description":"Set the default pathfinder algorithm to use for this chart. It is\npossible to define your own algorithms by adding them to the\nHighcharts.Pathfinder.prototype.algorithms object before the chart\nhas been created.\n\nThe default algorithms are as follows:\n\n`straight`:      Draws a straight line between the connecting\n                 points. Does not avoid other points when drawing.\n\n`simpleConnect`: Finds a path between the points using right angles\n                 only. Takes only starting/ending points into\n                 account, and will not avoid other points.\n\n`fastAvoid`:     Finds a path between the points using right angles\n                 only. Will attempt to avoid other points, but its\n                 focus is performance over accuracy. Works well with\n                 less dense datasets.\n\nDefault value: `straight` is used as default for most series types,\nwhile `simpleConnect` is used as default for Gantt series, to show\ndependencies between points.","samples":[{"name":"Different types used","value":"gantt/pathfinder/demo"}],"type":{"names":["Highcharts.PathfinderTypeValue"]},"defaultvalue":"undefined","since":"6.2.0"},"meta":{"fullname":"connectors.type","name":"type","line":43,"lineEnd":50,"column":8,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js","default":"straight"},"children":{}}}},"credits":{"doclet":{"description":"Highcharts by default puts a credits label in the lower right corner\nof the chart. This can be changed using these options.","type":{"names":["*"]}},"meta":{"fullname":"credits","name":"credits","line":2657,"lineEnd":2660,"column":4,"filename":"code/es-modules/Core/Defaults.js"},"children":{"enabled":{"doclet":{"description":"Whether to show the credits text.","samples":[{"name":"Credits disabled","value":"highcharts/credits/enabled-false/","products":["highcharts"]},{"name":"Credits disabled","value":"stock/credits/enabled/","products":["highstock"]},{"name":"Credits disabled","value":"maps/credits/enabled-false/","products":["highmaps"]}],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"credits.enabled","name":"enabled","line":2662,"lineEnd":2675,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":true},"children":{}},"href":{"doclet":{"description":"The URL for the credits label.","samples":[{"name":"Custom URL and text","value":"highcharts/credits/href/","products":["highcharts"]},{"name":"Custom URL and text","value":"maps/credits/customized/","products":["highmaps"]}],"type":{"names":["string"]},"defaultvalue":"https://www.highcharts.com?credits"},"meta":{"fullname":"credits.href","name":"href","line":2701,"lineEnd":2708,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"https://www.highcharts.com?credits"},"children":{}},"mapText":{"doclet":{"description":"Credits for map source to be concatenated with conventional credit\ntext. By default this is a format string that collects copyright\ninformation from the map if available.","see":["[mapTextFull](#credits.mapTextFull)","[text](#credits.text)"],"type":{"names":["string"]},"defaultvalue":"\\u00a9 <a href=\"{geojson.copyrightUrl}\">{geojson.copyrightShort}</a>","since":"4.2.2","products":["highmaps"]},"meta":{"fullname":"credits.mapText","name":"mapText","line":2662,"lineEnd":2675,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"mapTextFull":{"doclet":{"description":"Detailed credits for map source to be displayed on hover of credits\ntext. By default this is a format string that collects copyright\ninformation from the map if available.","see":["[mapText](#credits.mapText)","[text](#credits.text)"],"type":{"names":["string"]},"defaultvalue":"{geojson.copyright}","since":"4.2.2","products":["highmaps"]},"meta":{"fullname":"credits.mapTextFull","name":"mapTextFull","line":2676,"lineEnd":2689,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"position":{"doclet":{"description":"Position configuration for the credits label.","samples":[{"name":"Left aligned","value":"highcharts/credits/position-left/","products":["highcharts"]},{"name":"Left aligned","value":"highcharts/credits/position-left/","products":["highcharts"]},{"name":"Left aligned","value":"maps/credits/customized/","products":["highmaps"]},{"name":"Left aligned","value":"maps/credits/customized/","products":["highmaps"]}],"type":{"names":["Highcharts.AlignObject"]},"since":"2.1.0"},"meta":{"fullname":"credits.position","name":"position","line":2710,"lineEnd":2724,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"style":{"doclet":{"description":"CSS styles for the credits label.","see":["In styled mode, credits styles can be set with the\n     `.highcharts-credits` class."],"type":{"names":["Highcharts.CSSObject"]}},"meta":{"fullname":"credits.style","name":"style","line":2735,"lineEnd":2742,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{"fontSize":{"doclet":{"type":{"names":["number","string"]},"defaultvalue":"0.6em"},"meta":{"fullname":"credits.style.fontSize","name":"fontSize","line":2748,"lineEnd":2750,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"0.6em"},"children":{}}}},"text":{"doclet":{"description":"The text for the credits label.","productdesc":[{"value":"If a map is loaded as GeoJSON, the text defaults to\n`Highcharts @ {map-credits}`. Otherwise, it defaults to\n`Highcharts.com`.","products":["highmaps"]}],"samples":[{"name":"Custom URL and text","value":"highcharts/credits/href/","products":["highcharts"]},{"name":"Custom URL and text","value":"maps/credits/customized/","products":["highmaps"]}],"type":{"names":["string"]},"defaultvalue":"Highcharts.com"},"meta":{"fullname":"credits.text","name":"text","line":2753,"lineEnd":2765,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"Highcharts.com"},"children":{}}}},"data":{"doclet":{"description":"The Data module provides a simplified interface for adding data to\na chart from sources like CVS, HTML tables or grid views. See also\nthe [tutorial article on the Data module](https://www.highcharts.com/docs/working-with-data/data-module).\n\nIt requires the `modules/data.js` file to be loaded.\n\nPlease note that the default way of adding data in Highcharts, without\nthe need of a module, is through the [series._type_.data](#series.line.data)\noption.","samples":[{"name":"HTML table","value":"highcharts/demo/column-parsed/","products":["highcharts"]},{"name":"CSV","value":"highcharts/data/csv/","products":["highcharts"]}],"since":"4.0.0","requires":["module:modules/data"],"type":{"names":["*"]}},"meta":{"fullname":"data","name":"data","line":1719,"lineEnd":1739,"filename":"code/es-modules/Extensions/Data.js"},"children":{"beforeParse":{"doclet":{"description":"A callback function to modify the CSV before parsing it. Return the modified\nstring.","samples":[{"name":"Modify CSV before parse","value":"highcharts/demo/line-csv/","products":["highcharts"]}],"type":{"names":["Highcharts.DataBeforeParseCallbackFunction"]},"since":"6.1.0"},"meta":{"fullname":"data.beforeParse","name":"beforeParse","line":1740,"lineEnd":1750,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"columnTypes":{"doclet":{"description":"An array option that specifies the data type for each column in the series\nloaded within the data module.\n\nPossible values: `\"string\"`, `\"number\"`, `\"float\"`, `\"date\"`.","samples":[{"name":"X-axis categories based on CSV data","value":"highcharts/data/column-types/","products":["highcharts","highstock"]},{"name":"Map chart created with fips from CSV","value":"highcharts/data/column-types-map/","products":["highmaps"]}],"type":{"names":["Array.<('string'|'number'|'float'|'date')>"]},"since":"11.3.0","values":"[\"string\", \"number\", \"float\", \"date\"]"},"meta":{"fullname":"data.columnTypes","name":"columnTypes","line":1767,"lineEnd":1782,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"columns":{"doclet":{"description":"A two-dimensional array representing the input data on tabular form.\nThis input can be used when the data is already parsed, for example\nfrom a grid view component. Each cell can be a string or number.\nIf not switchRowsAndColumns is set, the columns are interpreted as\nseries.","see":["[data.rows](#data.rows)"],"samples":[{"name":"Columns","value":"highcharts/data/columns/","products":["highcharts"]}],"type":{"names":["Array.<Array.<Highcharts.DataValueType>>"]},"since":"4.0.0"},"meta":{"fullname":"data.columns","name":"columns","line":1751,"lineEnd":1766,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"columnsURL":{"doclet":{"description":"A URL to a remote JSON dataset, structured as a column array.\nWill be fetched when the chart is created using Ajax.","samples":[{"name":"Columns with live polling","value":"highcharts/demo/livedata-columns"}],"type":{"names":["string"]},"since":"4.0.0"},"meta":{"fullname":"data.columnsURL","name":"columnsURL","line":2090,"lineEnd":2099,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"complete":{"doclet":{"description":"The callback that is evaluated when the data is finished loading,\noptionally from an external source, and parsed. The first argument\npassed is a finished chart options object, containing the series.\nThese options can be extended with additional options and passed\ndirectly to the chart constructor.","see":["[data.parsed](#data.parsed)"],"samples":[{"name":"Modify data on complete","value":"highcharts/data/complete/","products":["highcharts"]}],"type":{"names":["Highcharts.DataCompleteCallbackFunction"]},"since":"4.0.0"},"meta":{"fullname":"data.complete","name":"complete","line":1783,"lineEnd":1798,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"csv":{"doclet":{"description":"A comma delimited string to be parsed. Related options are [startRow](#data.startRow), [endRow](#data.endRow), [startColumn](#data.startColumn)\nand [endColumn](#data.endColumn) to delimit what part of the table\nis used. The [lineDelimiter](#data.lineDelimiter) and [itemDelimiter](#data.itemDelimiter) options define the CSV delimiter formats.\n\nThe built-in CSV parser doesn't support all flavours of CSV, so in\nsome cases it may be necessary to use an external CSV parser. See\n[this example](https://jsfiddle.net/highcharts/u59176h4/) of parsing\nCSV through the MIT licensed [Papa Parse](http://papaparse.com/)\nlibrary.","samples":[{"name":"Data from CSV","value":"highcharts/data/csv/","products":["highcharts"]}],"type":{"names":["string"]},"since":"4.0.0"},"meta":{"fullname":"data.csv","name":"csv","line":1799,"lineEnd":1818,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"csvURL":{"doclet":{"description":"An URL to a remote CSV dataset. Will be fetched when the chart is created\nusing Ajax.","samples":[{"name":"Categorized bar chart with CSV and live polling","value":"highcharts/demo/livedata-columns"},{"name":"Time based line chart with CSV and live polling","value":"highcharts/data/livedata-csv"}],"type":{"names":["string"]},"since":"4.0.0"},"meta":{"fullname":"data.csvURL","name":"csvURL","line":2068,"lineEnd":2079,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"dataRefreshRate":{"doclet":{"description":"Sets the refresh rate for data polling when importing remote dataset by\nsetting [data.csvURL](data.csvURL), [data.rowsURL](data.rowsURL),\n[data.columnsURL](data.columnsURL), or\n[data.googleSpreadsheetKey](data.googleSpreadsheetKey).\n\nNote that polling must be enabled by setting\n[data.enablePolling](data.enablePolling) to true.\n\nThe value is the number of seconds between pollings.\nIt cannot be set to less than 1 second.","samples":[{"name":"Live data with user set refresh rate","value":"highcharts/demo/live-data"}],"defaultvalue":"1","type":{"names":["number"]},"since":"4.0.0"},"meta":{"fullname":"data.dataRefreshRate","name":"dataRefreshRate","line":2100,"lineEnd":2118,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"dateFormat":{"doclet":{"description":"Which of the predefined date formats in Date.prototype.dateFormats\nto use to parse date values. Defaults to a best guess based on what\nformat gives valid and ordered dates. Valid options include: `YYYY/mm/dd`,\n`dd/mm/YYYY`, `mm/dd/YYYY`, `dd/mm/YY`, `mm/dd/YY`.","see":["[data.parseDate](#data.parseDate)"],"samples":[{"name":"Best guess date format","value":"highcharts/data/dateformat-auto/","products":["highcharts"]}],"type":{"names":["\"YYYY/mm/dd\"","\"dd/mm/YYYY\"","\"mm/dd/YYYY\"","\"dd/mm/YYYY\"","\"dd/mm/YY\"","\"mm/dd/YY\""]},"since":"4.0.0"},"meta":{"fullname":"data.dateFormat","name":"dateFormat","line":1819,"lineEnd":1835,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"decimalPoint":{"doclet":{"description":"The decimal point used for parsing numbers in the CSV.\n\nIf both this and data.delimiter is set to `undefined`, the parser will\nattempt to deduce the decimal point automatically.","samples":[{"name":"Comma as decimal point","value":"highcharts/data/delimiters/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":".","since":"4.1.0"},"meta":{"fullname":"data.decimalPoint","name":"decimalPoint","line":1836,"lineEnd":1849,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"enablePolling":{"doclet":{"description":"Enables automatic refetching of remote datasets every _n_ seconds (defined by\nsetting [data.dataRefreshRate](data.dataRefreshRate)).\n\nOnly works when either [data.csvURL](data.csvURL),\n[data.rowsURL](data.rowsURL), [data.columnsURL](data.columnsURL), or\n[data.googleSpreadsheetKey](data.googleSpreadsheetKey).","samples":[{"name":"Live data","value":"highcharts/demo/live-data"},{"name":"Categorized bar chart with CSV and live polling","value":"highcharts/demo/livedata-columns"}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"4.0.0"},"meta":{"fullname":"data.enablePolling","name":"enablePolling","line":2119,"lineEnd":2135,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"endColumn":{"doclet":{"description":"In tabular input data, the last column (indexed by 0) to use. Defaults\nto the last column containing data.","samples":[{"name":"Limited data","value":"highcharts/data/start-end/","products":["highcharts"]}],"type":{"names":["number"]},"since":"4.0.0"},"meta":{"fullname":"data.endColumn","name":"endColumn","line":1850,"lineEnd":1860,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"endRow":{"doclet":{"description":"In tabular input data, the last row (indexed by 0) to use. Defaults\nto the last row containing data.","samples":[{"name":"Limited data","value":"highcharts/data/start-end/","products":["highcharts"]}],"type":{"names":["number"]},"since":"4.0.4"},"meta":{"fullname":"data.endRow","name":"endRow","line":1861,"lineEnd":1871,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"firstRowAsNames":{"doclet":{"description":"Whether to use the first row in the data set as series names.","samples":[{"name":"Don't get series names from the CSV","value":"highcharts/data/start-end/","products":["highcharts"]},{"name":"Don't get series names from the CSV","value":"highcharts/data/start-end/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"4.1.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"data.firstRowAsNames","name":"firstRowAsNames","line":1872,"lineEnd":1885,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"googleAPIKey":{"doclet":{"description":"The Google Spreadsheet API key required for access generated at [API Services\n/ Credentials](https://console.cloud.google.com/apis/credentials). See a\ncomprehensive tutorial for setting up the key at the\n[Hands-On Data Visualization](https://handsondataviz.org/google-sheets-api-key.html)\nbook website.","samples":[{"name":"Load a Google Spreadsheet","value":"highcharts/data/google-spreadsheet/","products":["highcharts"]}],"type":{"names":["string"]},"since":"9.2.2"},"meta":{"fullname":"data.googleAPIKey","name":"googleAPIKey","line":1886,"lineEnd":1899,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"googleSpreadsheetKey":{"doclet":{"description":"The key or `spreadsheetId` value for a Google Spreadsheet to load. See\n[developers.google.com](https://developers.google.com/sheets/api/guides/concepts)\nfor how to find the `spreadsheetId`.\n\nIn order for Google Sheets to load, a valid [googleAPIKey](#data.googleAPIKey)\nmust also be given.","samples":[{"name":"Load a Google Spreadsheet","value":"highcharts/data/google-spreadsheet/","products":["highcharts"]}],"type":{"names":["string"]},"since":"4.0.0"},"meta":{"fullname":"data.googleSpreadsheetKey","name":"googleSpreadsheetKey","line":1900,"lineEnd":1914,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"googleSpreadsheetRange":{"doclet":{"description":"The Google Spreadsheet `range` to use in combination with\n[googleSpreadsheetKey](#data.googleSpreadsheetKey). See\n[developers.google.com](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/get)\nfor details.\n\nIf given, it takes precedence over `startColumn`, `endColumn`, `startRow` and\n`endRow`.\n\n```js\ngoogleSpreadsheetRange: 'Fruit Consumption' // Load a named worksheet\ngoogleSpreadsheetRange: 'A:Z' // Load columns A to Z\n```","samples":[{"name":"Load a Google Spreadsheet","value":"highcharts/data/google-spreadsheet/","products":["highcharts"]}],"type":{"names":["string","undefined"]},"since":"9.2.2"},"meta":{"fullname":"data.googleSpreadsheetRange","name":"googleSpreadsheetRange","line":1915,"lineEnd":1935,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"googleSpreadsheetWorksheet":{"doclet":{"description":"No longer works since v9.2.2, that uses Google Sheets API v4. Instead, use\nthe [googleSpreadsheetRange](#data.googleSpreadsheetRange) option to load a\nspecific sheet.","deprecated":true,"type":{"names":["string"]},"since":"4.0.0"},"meta":{"fullname":"data.googleSpreadsheetWorksheet","name":"googleSpreadsheetWorksheet","line":1936,"lineEnd":1945,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"itemDelimiter":{"doclet":{"description":"Item or cell delimiter for parsing CSV. Defaults to the tab character\n`\\t` if a tab character is found in the CSV string, if not it defaults\nto `,`.\n\nIf this is set to false or undefined, the parser will attempt to deduce\nthe delimiter automatically.","samples":[{"name":"Delimiters","value":"highcharts/data/delimiters/","products":["highcharts"]}],"type":{"names":["string"]},"since":"4.0.0"},"meta":{"fullname":"data.itemDelimiter","name":"itemDelimiter","line":1946,"lineEnd":1960,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"lineDelimiter":{"doclet":{"description":"Line delimiter for parsing CSV.","samples":[{"name":"Delimiters","value":"highcharts/data/delimiters/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"\\n","since":"4.0.0"},"meta":{"fullname":"data.lineDelimiter","name":"lineDelimiter","line":1961,"lineEnd":1971,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"parseDate":{"doclet":{"description":"A callback function to parse string representations of dates into\nJavaScript timestamps. Should return an integer timestamp on success.","see":["[dateFormat](#data.dateFormat)"],"type":{"names":["Highcharts.DataParseDateCallbackFunction"]},"since":"4.0.0"},"meta":{"fullname":"data.parseDate","name":"parseDate","line":1987,"lineEnd":1996,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"parsed":{"doclet":{"description":"A callback function to access the parsed columns, the two-dimensional\ninput data array directly, before they are interpreted into series\ndata and categories. Return `false` to stop completion, or call\n`this.complete()` to continue async.","see":["[data.complete](#data.complete)"],"samples":[{"name":"Modify data after parse","value":"highcharts/data/parsed/","products":["highcharts"]}],"type":{"names":["Highcharts.DataParsedCallbackFunction"]},"since":"4.0.0"},"meta":{"fullname":"data.parsed","name":"parsed","line":1972,"lineEnd":1986,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"rows":{"doclet":{"description":"The same as the columns input option, but defining rows instead of\ncolumns.","see":["[data.columns](#data.columns)"],"samples":[{"name":"Data in rows","value":"highcharts/data/rows/","products":["highcharts"]}],"type":{"names":["Array.<Array.<Highcharts.DataValueType>>"]},"since":"4.0.0"},"meta":{"fullname":"data.rows","name":"rows","line":1997,"lineEnd":2009,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"rowsURL":{"doclet":{"description":"A URL to a remote JSON dataset, structured as a row array.\nWill be fetched when the chart is created using Ajax.","samples":[{"name":"Rows with live polling","value":"highcharts/data/livedata-rows"}],"type":{"names":["string"]},"since":"4.0.0"},"meta":{"fullname":"data.rowsURL","name":"rowsURL","line":2080,"lineEnd":2089,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"seriesMapping":{"doclet":{"description":"An array containing dictionaries for each series. A dictionary exists of\nPoint property names as the key and the CSV column index as the value.","samples":[{"name":"Label from data set","value":"highcharts/data/seriesmapping-label/","products":["highcharts"]}],"type":{"names":["Array.<Highcharts.Dictionary.<number>>"]},"since":"4.0.4"},"meta":{"fullname":"data.seriesMapping","name":"seriesMapping","line":2010,"lineEnd":2020,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"startColumn":{"doclet":{"description":"In tabular input data, the first column (indexed by 0) to use.","samples":[{"name":"Limited data","value":"highcharts/data/start-end/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"4.0.0"},"meta":{"fullname":"data.startColumn","name":"startColumn","line":2021,"lineEnd":2031,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"startRow":{"doclet":{"description":"In tabular input data, the first row (indexed by 0) to use.","samples":[{"name":"Limited data","value":"highcharts/data/start-end/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"4.0.0"},"meta":{"fullname":"data.startRow","name":"startRow","line":2032,"lineEnd":2042,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"switchRowsAndColumns":{"doclet":{"description":"Switch rows and columns of the input data, so that `this.columns`\neffectively becomes the rows of the data set, and the rows are interpreted\nas series.","samples":[{"name":"Switch rows and columns","value":"highcharts/data/switchrowsandcolumns/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"4.0.0"},"meta":{"fullname":"data.switchRowsAndColumns","name":"switchRowsAndColumns","line":2043,"lineEnd":2055,"filename":"code/es-modules/Extensions/Data.js"},"children":{}},"table":{"doclet":{"description":"An HTML table or the id of such to be parsed as input data. Related\noptions are `startRow`, `endRow`, `startColumn` and `endColumn` to\ndelimit what part of the table is used.","samples":[{"name":"Parsed table","value":"highcharts/demo/column-parsed/","products":["highcharts"]}],"type":{"names":["string","global.HTMLElement"]},"since":"4.0.0"},"meta":{"fullname":"data.table","name":"table","line":2056,"lineEnd":2067,"filename":"code/es-modules/Extensions/Data.js"},"children":{}}}},"defs":{"doclet":{"description":"Options for configuring markers for annotations.\n\nAn example of the arrow marker:\n<pre>\n{\n  arrow: {\n    id: 'arrow',\n    tagName: 'marker',\n    refY: 5,\n    refX: 5,\n    markerWidth: 10,\n    markerHeight: 10,\n    children: [{\n      tagName: 'path',\n      attrs: {\n        d: 'M 0 0 L 10 5 L 0 10 Z',\n        'stroke-width': 0\n      }\n    }]\n  }\n}\n</pre>","type":{"names":["Highcharts.Dictionary.<Highcharts.ASTNode>"]},"since":"6.0.0","samples":[{"name":"Define a custom marker for annotations","value":"highcharts/annotations/custom-markers/"},{"name":"Define markers in a styled mode","value":"highcharts/css/annotations-markers/"}]},"meta":{"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","name":"defs","fullname":"defs","line":6,"lineEnd":39,"column":0},"children":{"arrow":{"doclet":{"type":{"names":["Highcharts.ASTNode"]}},"meta":{"fullname":"defs.arrow","name":"arrow","line":41,"lineEnd":43,"column":4,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js"},"children":{"attributes":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"defs.arrow.attributes","name":"attributes","line":46,"lineEnd":46,"column":8,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js"},"children":{"id":{"doclet":{"type":{"names":["string"]},"defaultvalue":"arrow"},"meta":{"fullname":"defs.arrow.attributes.id","name":"id","line":47,"lineEnd":47,"column":12,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":"arrow"},"children":{}},"markerHeight":{"doclet":{"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"defs.arrow.attributes.markerHeight","name":"markerHeight","line":51,"lineEnd":51,"column":12,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":10},"children":{}},"markerWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"defs.arrow.attributes.markerWidth","name":"markerWidth","line":50,"lineEnd":50,"column":12,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":10},"children":{}},"refX":{"doclet":{"type":{"names":["number"]},"defaultvalue":9},"meta":{"fullname":"defs.arrow.attributes.refX","name":"refX","line":49,"lineEnd":49,"column":12,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":9},"children":{}},"refY":{"doclet":{"type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"defs.arrow.attributes.refY","name":"refY","line":48,"lineEnd":48,"column":12,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":5},"children":{}}}},"children":{"doclet":{"type":{"names":["Array.<Highcharts.DefsOptions>"]}},"meta":{"fullname":"defs.arrow.children","name":"children","line":53,"lineEnd":55,"column":8,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js"},"children":{}},"tagName":{"doclet":{"type":{"names":["string"]},"defaultvalue":"marker"},"meta":{"fullname":"defs.arrow.tagName","name":"tagName","line":45,"lineEnd":45,"column":8,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":"marker"},"children":{}}}},"reverse-arrow":{"doclet":{"type":{"names":["Highcharts.ASTNode"]}},"meta":{"fullname":"defs.reverse-arrow","name":"reverse-arrow","line":64,"lineEnd":66,"column":4,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js"},"children":{"attributes":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"defs.reverse-arrow.attributes","name":"attributes","line":69,"lineEnd":69,"column":8,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js"},"children":{"id":{"doclet":{"type":{"names":["string"]},"defaultvalue":"reverse-arrow"},"meta":{"fullname":"defs.reverse-arrow.attributes.id","name":"id","line":70,"lineEnd":70,"column":12,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":"reverse-arrow"},"children":{}},"markerHeight":{"doclet":{"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"defs.reverse-arrow.attributes.markerHeight","name":"markerHeight","line":74,"lineEnd":74,"column":12,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":10},"children":{}},"markerWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"defs.reverse-arrow.attributes.markerWidth","name":"markerWidth","line":73,"lineEnd":73,"column":12,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":10},"children":{}},"refX":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"defs.reverse-arrow.attributes.refX","name":"refX","line":72,"lineEnd":72,"column":12,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":1},"children":{}},"refY":{"doclet":{"type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"defs.reverse-arrow.attributes.refY","name":"refY","line":71,"lineEnd":71,"column":12,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":5},"children":{}}}},"tagName":{"doclet":{"type":{"names":["string"]},"defaultvalue":"marker"},"meta":{"fullname":"defs.reverse-arrow.tagName","name":"tagName","line":68,"lineEnd":68,"column":8,"filename":"code/es-modules/Extensions/Annotations/Controllables/ControllableDefaults.js","default":"marker"},"children":{}}}}}},"drilldown":{"doclet":{"description":"Options for drill down, the concept of inspecting increasingly high\nresolution data through clicking on chart items like columns or pie slices.","samples":[{"name":"Organization chart drilldown","value":"highcharts/series-organization/drilldown","products":["highcharts"]}],"products":["highcharts","highmaps"],"requires":["module:modules/drilldown"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js","name":"drilldown","fullname":"drilldown","line":13,"lineEnd":17,"column":0},"children":{"activeAxisLabelStyle":{"doclet":{"description":"Additional styles to apply to the X axis label for a point that\nhas drilldown data. By default it is underlined and blue to invite\nto interaction.\n\nIn styled mode, active label styles can be set with the\n`.highcharts-drilldown-axis-label` class.","samples":[{"name":"Label styles","value":"highcharts/drilldown/labels/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{ \"cursor\": \"pointer\", \"color\": \"#003399\", \"fontWeight\": \"bold\", \"textDecoration\": \"underline\" }","since":"3.0.8","products":["highcharts","highmaps"]},"meta":{"fullname":"drilldown.activeAxisLabelStyle","name":"activeAxisLabelStyle","line":31,"lineEnd":44,"column":4,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"activeDataLabelStyle":{"doclet":{"description":"Additional styles to apply to the data label of a point that has\ndrilldown data. By default it is underlined and blue to invite to\ninteraction.\n\nIn styled mode, active data label styles can be applied with the\n`.highcharts-drilldown-data-label` class.","samples":[{"name":"Label styles","value":"highcharts/drilldown/labels/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{ \"cursor\": \"pointer\", \"color\": \"#003399\", \"fontWeight\": \"bold\", \"textDecoration\": \"underline\" }","since":"3.0.8","products":["highcharts","highmaps"]},"meta":{"fullname":"drilldown.activeDataLabelStyle","name":"activeDataLabelStyle","line":91,"lineEnd":106,"column":4,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#0022ff"},"meta":{"fullname":"drilldown.activeDataLabelStyle.color","name":"color","line":109,"lineEnd":109,"column":8,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js","default":"#0022ff"},"children":{}},"cursor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"pointer"},"meta":{"fullname":"drilldown.activeDataLabelStyle.cursor","name":"cursor","line":108,"lineEnd":108,"column":8,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js","default":"pointer"},"children":{}},"fontWeight":{"doclet":{"type":{"names":["string"]},"defaultvalue":"bold"},"meta":{"fullname":"drilldown.activeDataLabelStyle.fontWeight","name":"fontWeight","line":110,"lineEnd":110,"column":8,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js","default":"bold"},"children":{}},"textDecoration":{"doclet":{"type":{"names":["string"]},"defaultvalue":"underline"},"meta":{"fullname":"drilldown.activeDataLabelStyle.textDecoration","name":"textDecoration","line":111,"lineEnd":111,"column":8,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js","default":"underline"},"children":{}}}},"allowPointDrilldown":{"doclet":{"description":"When this option is false, clicking a single point will drill down\nall points in the same category, equivalent to clicking the X axis\nlabel.","samples":[{"name":"Don't allow point drilldown","value":"highcharts/drilldown/allowpointdrilldown-false/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"4.1.7","products":["highcharts"]},"meta":{"fullname":"drilldown.allowPointDrilldown","name":"allowPointDrilldown","line":31,"lineEnd":44,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"animation":{"doclet":{"description":"Set the animation for all drilldown animations. Animation of a drilldown\noccurs when drilling between a column point and a column series, or a pie\nslice and a full pie series. Drilldown can still be used between series\nand points of different types, but animation will not occur.\n\nThe animation can either be set as a boolean or a configuration object.\nIf `true`, it will use a duration of 500 ms. If used as a configuration\nobject, the following properties are supported:\n\n- `duration`: The duration of the animation in milliseconds.\n\n- `easing`: A string reference to an easing function set on the `Math`\n  object. See [the easing\n  demo](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-animation-easing/).","type":{"names":["boolean","Highcharts.AnimationOptionsObject"]},"since":"3.0.8","products":["highcharts","highmaps"]},"meta":{"fullname":"drilldown.animation","name":"animation","line":113,"lineEnd":132,"column":4,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"breadcrumbs":{"doclet":{"description":"Options for the breadcrumbs, the navigation at the top leading the way\nup through the drilldown levels.","since":"10.0.0","products":["highcharts","highmaps"],"extends":"navigation.breadcrumbs"},"meta":{"fullname":"drilldown.breadcrumbs","name":"breadcrumbs","line":45,"lineEnd":53,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"drillUpButton":{"doclet":{"description":"Drill up button is deprecated since Highcharts v9.3.2. Use\n[drilldown.breadcrumbs](#drilldown.breadcrumbs) instead.\n\nOptions for the drill up button that appears when drilling down on a\nseries. The text for the button is defined in\n[lang.drillUpText](#lang.drillUpText).","samples":[{"name":"Breadcrumbs set up like a legacy button","value":"highcharts/breadcrumbs/single-button"},{"name":"Drill up button","value":"highcharts/drilldown/drillupbutton/","products":["highcharts"]},{"name":"Drill up button","value":"highcharts/drilldown/drillupbutton/","products":["highmaps"]}],"since":"3.0.8","products":["highcharts","highmaps"],"deprecated":"9.3.2","type":{"names":["*"]}},"meta":{"fullname":"drilldown.drillUpButton","name":"drillUpButton","line":137,"lineEnd":154,"column":4,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{"position":{"doclet":{"description":"Positioning options for the button within the `relativeTo` box.\nAvailable properties are `x`, `y`, `align` and `verticalAlign`.","type":{"names":["Highcharts.AlignObject"]},"since":"3.0.8","deprecated":"9.3.2","products":["highcharts","highmaps"]},"meta":{"fullname":"drilldown.drillUpButton.position","name":"position","line":156,"lineEnd":166,"column":8,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{"align":{"doclet":{"description":"Horizontal alignment.","type":{"names":["Highcharts.AlignValue"]},"deprecated":"9.3.2","since":"3.0.8","defaultvalue":"right"},"meta":{"fullname":"drilldown.drillUpButton.position.align","name":"align","line":198,"lineEnd":206,"column":12,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js","default":"right"},"children":{}},"verticalAlign":{"doclet":{"description":"Vertical alignment of the button.","type":{"names":["Highcharts.VerticalAlignValue"]},"deprecated":"9.3.2","defaultvalue":"top","products":["highcharts","highmaps"],"since":"3.0.8"},"meta":{"fullname":"drilldown.drillUpButton.position.verticalAlign","name":"verticalAlign","line":198,"lineEnd":206,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"x":{"doclet":{"description":"The X offset of the button.","deprecated":"9.3.2","since":"3.0.8","type":{"names":["number"]},"defaultvalue":-10},"meta":{"fullname":"drilldown.drillUpButton.position.x","name":"x","line":214,"lineEnd":218,"column":12,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js","default":-10},"children":{}},"y":{"doclet":{"description":"The Y offset of the button.","deprecated":"9.3.2","since":"3.0.8","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"drilldown.drillUpButton.position.y","name":"y","line":220,"lineEnd":224,"column":12,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js","default":10},"children":{}}}},"relativeTo":{"doclet":{"description":"What box to align the button to. Can be either `plotBox` or\n`spacingBox`.","type":{"names":["Highcharts.ButtonRelativeToValue"]},"defaultvalue":"plotBox","since":"3.0.8","deprecated":"9.3.2","products":["highcharts","highmaps"]},"meta":{"fullname":"drilldown.drillUpButton.relativeTo","name":"relativeTo","line":156,"lineEnd":166,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"theme":{"doclet":{"description":"A collection of attributes for the button. The object takes SVG\nattributes like `fill`, `stroke`, `stroke-width` or `r`, the border\nradius. The theme also supports `style`, a collection of CSS\nproperties for the text. Equivalent attributes for the hover state\nare given in `theme.states.hover`.\n\nIn styled mode, drill-up button styles can be applied with the\n`.highcharts-drillup-button` class.","samples":[{"name":"Button theming","value":"highcharts/drilldown/drillupbutton/","products":["highcharts"]},{"name":"Button theming","value":"highcharts/drilldown/drillupbutton/","products":["highmaps"]}],"type":{"names":["Object"]},"since":"3.0.8","deprecated":"9.3.2","products":["highcharts","highmaps"]},"meta":{"fullname":"drilldown.drillUpButton.theme","name":"theme","line":167,"lineEnd":187,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}}}},"mapZooming":{"doclet":{"description":"Enable or disable zooming into a region of clicked map point you want to\ndrill into. If mapZooming is set to false the drilldown/drillup\nanimations only fade in/fade out without zooming to a specific map point.","samples":[{"name":"Map drilldown without async maps loading","value":"maps/demo/map-drilldown-preloaded/"}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"11.0.0","products":["highmaps"]},"meta":{"fullname":"drilldown.mapZooming","name":"mapZooming","line":228,"lineEnd":241,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"series":{"doclet":{"description":"An array of series configurations for the drill down. Each series\nconfiguration uses the same syntax as the [series](#series) option set.\nThese drilldown series are hidden by default. The drilldown series is\nlinked to the parent series' point by its `id`.","type":{"names":["Array.<Highcharts.SeriesOptionsType>"]},"since":"3.0.8","products":["highcharts","highmaps"]},"meta":{"fullname":"drilldown.series","name":"series","line":54,"lineEnd":64,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}}}},"exporting":{"doclet":{"description":"Options for the exporting module. For an overview on the matter, see\n[the docs](https://www.highcharts.com/docs/export-module/export-module-overview) and\nread our [Fair Usage Policy](https://www.highcharts.com/docs/export-module/privacy-disclaimer-export).","requires":["module:modules/exporting"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/OfflineExporting/OfflineExportingDefaults.js","name":"exporting","fullname":"exporting","line":12,"lineEnd":16,"column":0},"children":{"accessibility":{"doclet":{"description":"Accessibility options for the exporting menu. Requires the\nAccessibility module.","since":"7.1.0","requires":["module:modules/accessibility"],"type":{"names":["*"]}},"meta":{"fullname":"exporting.accessibility","name":"accessibility","line":946,"lineEnd":952,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable accessibility support for the export menu.","since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"exporting.accessibility.enabled","name":"enabled","line":954,"lineEnd":958,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":true},"children":{}}}},"allowHTML":{"doclet":{"description":"Experimental setting to allow HTML inside the chart (added through\nthe `useHTML` options), directly in the exported image. This allows\nyou to preserve complicated HTML structures like tables or bi-directional\ntext in exported charts.\n\nDisclaimer: The HTML is rendered in a `foreignObject` tag in the\ngenerated SVG. The official export server is based on PhantomJS,\nwhich supports this, but other SVG clients, like Batik, does not\nsupport it. This also applies to downloaded SVG that you want to\nopen in a desktop client.","type":{"names":["boolean"]},"defaultvalue":"false","since":"4.1.8"},"meta":{"fullname":"exporting.allowHTML","name":"allowHTML","line":29,"lineEnd":45,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"allowTableSorting":{"doclet":{"description":"Allows the end user to sort the data table by clicking on column headers.","since":"10.3.3","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"exporting.allowTableSorting","name":"allowTableSorting","line":29,"lineEnd":45,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":true},"children":{}},"applyStyleSheets":{"doclet":{"description":"Allow exporting a chart retaining any user-applied CSS.\n\nNote that this is is default behavior in [styledMode](#chart.styledMode).","see":["[styledMode](#chart.styledMode)"],"samples":[{"name":"Export with custom stylesheet","value":"highcharts/exporting/apply-stylesheets/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"12.0.0"},"meta":{"fullname":"exporting.applyStyleSheets","name":"applyStyleSheets","line":53,"lineEnd":67,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"buttons":{"doclet":{"description":"Options for the export related buttons, print and export. In addition\nto the default buttons listed here, custom buttons can be added.\nSee [navigation.buttonOptions](#navigation.buttonOptions) for general\noptions.","type":{"names":["Highcharts.Dictionary.<*>"]},"requires":["module:modules/exporting"]},"meta":{"fullname":"exporting.buttons","name":"buttons","line":343,"lineEnd":351,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"contextButton":{"doclet":{"description":"Options for the export button.\n\nIn styled mode, export button styles can be applied with the\n`.highcharts-contextbutton` class.","declare":"Highcharts.ExportingButtonsOptionsObject","extends":"navigation.buttonOptions","requires":["module:modules/exporting"]},"meta":{"fullname":"exporting.buttons.contextButton","name":"contextButton","line":353,"lineEnd":362,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"className":{"doclet":{"description":"The class name of the context button.","type":{"names":["string"]},"defaultvalue":"highcharts-contextbutton"},"meta":{"fullname":"exporting.buttons.contextButton.className","name":"className","line":364,"lineEnd":374,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"highcharts-contextbutton"},"children":{}},"menuClassName":{"doclet":{"description":"The class name of the menu appearing from the button.","type":{"names":["string"]},"defaultvalue":"highcharts-contextmenu"},"meta":{"fullname":"exporting.buttons.contextButton.menuClassName","name":"menuClassName","line":388,"lineEnd":390,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"highcharts-contextmenu"},"children":{}},"menuItems":{"doclet":{"description":"A collection of strings pointing to config options for the menu\nitems. The config options are defined in the\n`menuItemDefinitions` option.\n\nBy default, there is the \"View in full screen\" and \"Print\" menu\nitems, plus one menu item for each of the available export types.","samples":[{"name":"Menu item definitions","value":"highcharts/exporting/menuitemdefinitions/"},{"name":"Adding a custom menu item for WebP export","value":"highcharts/exporting/menuitemdefinitions-webp/"}],"type":{"names":["Array.<string>"]},"defaultvalue":"[\"viewFullscreen\", \"printChart\", \"separator\", \"downloadPNG\", \"downloadJPEG\", \"downloadSVG\"]","since":"2.0.0"},"meta":{"fullname":"exporting.buttons.contextButton.menuItems","name":"menuItems","line":417,"lineEnd":433,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"onclick":{"doclet":{"description":"A click handler callback to use on the button directly instead of\nthe popup menu.","samples":[{"name":"Skip the menu and export the chart directly","value":"highcharts/exporting/buttons-contextbutton-onclick/"}],"type":{"names":["function"]},"since":"2.0.0"},"meta":{"fullname":"exporting.buttons.contextButton.onclick","name":"onclick","line":364,"lineEnd":374,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"symbol":{"doclet":{"description":"The symbol for the button. Points to a definition function in\nthe `Highcharts.Renderer.symbols` collection. The default\n`menu` function is part of the exporting module. Possible\nvalues are \"circle\", \"square\", \"diamond\", \"triangle\",\n\"triangle-down\", \"menu\", \"menuball\" or custom shape.","samples":[{"name":"Use a circle for symbol","value":"highcharts/exporting/buttons-contextbutton-symbol/"},{"name":"Custom shape as symbol","value":"highcharts/exporting/buttons-contextbutton-symbol-custom/"}],"type":{"names":["Highcharts.SymbolKeyValue","\"menu\"","\"menuball\"","string"]},"since":"2.0.0","defaultvalue":"menu"},"meta":{"fullname":"exporting.buttons.contextButton.symbol","name":"symbol","line":392,"lineEnd":406,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"menu"},"children":{}},"titleKey":{"doclet":{"description":"The key to a [lang](#lang) option setting that is used for the\nbutton's title tooltip. When the key is `contextButtonTitle`, it\nrefers to [lang.contextButtonTitle](#lang.contextButtonTitle)\nthat defaults to \"Chart context menu\".","since":"6.1.4","type":{"names":["string"]},"defaultvalue":"contextButtonTitle"},"meta":{"fullname":"exporting.buttons.contextButton.titleKey","name":"titleKey","line":408,"lineEnd":415,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"contextButtonTitle"},"children":{}},"x":{"doclet":{"description":"The horizontal position of the button relative to the `align`\noption.","type":{"names":["number"]},"defaultvalue":"-10","since":"2.0.0"},"meta":{"fullname":"exporting.buttons.contextButton.x","name":"x","line":375,"lineEnd":383,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}}}}}},"chartOptions":{"doclet":{"description":"Additional chart options to be merged into the chart before exporting to\nan image format. This does not apply to printing the chart via the export\nmenu.\n\nFor example, a common use case is to add data labels to improve\nreadability of the exported chart, or to add a printer-friendly color\nscheme to exported PDFs.","samples":[{"name":"Added data labels","value":"highcharts/exporting/chartoptions-data-labels/","products":["highcharts"]},{"name":"Added data labels","value":"highcharts/exporting/chartoptions-data-labels/","products":["highstock"]}],"type":{"names":["Highcharts.Options"]}},"meta":{"fullname":"exporting.chartOptions","name":"chartOptions","line":68,"lineEnd":84,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"csv":{"doclet":{"description":"Options for exporting data to CSV or Excel, or displaying the data\nin a HTML table or a JavaScript structure.\n\nThis module adds data export options to the export menu and provides\nfunctions like `Exporting.getCSV`, `Exporting.getTable`,\n`Exporting.getDataRows` and `Exporting.viewData`.\n\nThe XLS converter is limited and only creates a HTML string that is\npassed for download, which works but creates a warning before\nopening. The workaround for this is to use a third party XLSX\nconverter, as demonstrated in the sample below.","samples":[{"name":"Categorized data","value":"highcharts/export-data/categorized/"},{"name":"Highcharts Stock time axis","value":"highcharts/export-data/stock-timeaxis/"},{"name":"Using a third party XLSX converter","value":"highcharts/export-data/xlsx/"}],"since":"6.0.0","requires":["module:modules/export-data"],"type":{"names":["*"]}},"meta":{"fullname":"exporting.csv","name":"csv","line":24,"lineEnd":35,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js"},"children":{"annotations":{"doclet":{"description":"Options for annotations in the export-data table.","since":"8.2.0","requires":["module:modules/export-data","module:modules/annotations"],"type":{"names":["*"]}},"meta":{"fullname":"exporting.csv.annotations","name":"annotations","line":58,"lineEnd":64,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js"},"children":{"itemDelimiter":{"doclet":{"description":"The way to mark the separator for annotations\ncombined in one export-data table cell.","since":"8.2.0","requires":["module:modules/annotations"],"type":{"names":["string"]},"defaultvalue":"; "},"meta":{"fullname":"exporting.csv.annotations.itemDelimiter","name":"itemDelimiter","line":66,"lineEnd":72,"column":12,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"; "},"children":{}},"join":{"doclet":{"description":"When several labels are assigned to a specific point,\nthey will be displayed in one field in the table.","samples":[{"name":"Concatenate point annotations with itemDelimiter set.","value":"highcharts/export-data/join-annotations/"}],"since":"8.2.0","requires":["module:modules/annotations"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"exporting.csv.annotations.join","name":"join","line":74,"lineEnd":83,"column":12,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":false},"children":{}}}},"columnHeaderFormatter":{"doclet":{"description":"Formatter callback for the column headers. Parameters are:\n- `item` - The series or axis object)\n- `key` -  The point key, for example y or z\n- `keyLength` - The amount of value keys for this item, for\n  example a range series has the keys `low` and `high` so the\n  key length is 2.\n\nIf [useMultiLevelHeaders](#exporting.useMultiLevelHeaders) is\ntrue, columnHeaderFormatter by default returns an object with\ncolumnTitle and topLevelColumnTitle for each key. Columns with\nthe same topLevelColumnTitle have their titles merged into a\nsingle cell with colspan for table/Excel export.\n\nIf `useMultiLevelHeaders` is false, or for CSV export, it returns\nthe series name, followed by the key if there is more than one\nkey.\n\nFor the axis it returns the axis title or \"Category\" or\n\"DateTime\" by default.\n\nReturn `false` to use Highcharts' proposed header.","samples":[{"name":"Multiple table headers","value":"highcharts/export-data/multilevel-table"}],"type":{"names":["function","null"]},"since":"6.0.0","defaultvalue":null},"meta":{"fullname":"exporting.csv.columnHeaderFormatter","name":"columnHeaderFormatter","line":86,"lineEnd":113,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":null},"children":{}},"dateFormat":{"doclet":{"description":"Which date format to use for exported dates on a datetime X axis.\nSee `Highcharts.dateFormat`.","since":"6.0.0","type":{"names":["string"]},"defaultvalue":"%Y-%m-%d %H:%M:%S"},"meta":{"fullname":"exporting.csv.dateFormat","name":"dateFormat","line":115,"lineEnd":118,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"%Y-%m-%d %H:%M:%S"},"children":{}},"decimalPoint":{"doclet":{"description":"Which decimal point to use for exported CSV. Defaults to the same\nas the browser locale, typically `.` (English) or `,` (German,\nFrench etc).","type":{"names":["string","null"]},"since":"6.0.4","defaultvalue":null},"meta":{"fullname":"exporting.csv.decimalPoint","name":"decimalPoint","line":120,"lineEnd":127,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":null},"children":{}},"itemDelimiter":{"doclet":{"description":"The item delimiter in the exported data. Use `;` for direct\nexporting to Excel. Defaults to a best guess based on the browser\nlocale. If the locale _decimal point_ is `,`, the `itemDelimiter`\ndefaults to `;`, otherwise the `itemDelimiter` defaults to `,`.","type":{"names":["string","null"]},"since":"6.0.0","defaultvalue":null},"meta":{"fullname":"exporting.csv.itemDelimiter","name":"itemDelimiter","line":129,"lineEnd":136,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":null},"children":{}},"lineDelimiter":{"doclet":{"description":"The line delimiter in the exported data, defaults to a newline.","since":"6.0.0","type":{"names":["string"]},"defaultvalue":"\n"},"meta":{"fullname":"exporting.csv.lineDelimiter","name":"lineDelimiter","line":138,"lineEnd":140,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"\n"},"children":{}}}},"enabled":{"doclet":{"description":"Whether to enable the exporting module. Disabling the module will\nhide the context button, but API methods will still be available.","samples":[{"name":"Exporting module is loaded but disabled","value":"highcharts/exporting/enabled-false/","products":["highcharts"]},{"name":"Exporting module is loaded but disabled","value":"highcharts/exporting/enabled-false/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"2.0.0"},"meta":{"fullname":"exporting.enabled","name":"enabled","line":85,"lineEnd":98,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"error":{"doclet":{"description":"Function to call if the offline-exporting module fails to export\na chart on the client side, and [fallbackToExportServer](#exporting.fallbackToExportServer) is disabled. If left undefined, an\nexception is thrown instead. Receives two parameters, the exporting\noptions, and the error from the module.","see":["[fallbackToExportServer](#exporting.fallbackToExportServer)"],"type":{"names":["Highcharts.ExportingErrorCallbackFunction"]},"since":"5.0.0","requires":["module:modules/exporting","module:modules/offline-exporting"]},"meta":{"fullname":"exporting.error","name":"error","line":99,"lineEnd":113,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"fallbackToExportServer":{"doclet":{"description":"Whether or not to fall back to the export server if the offline-exporting\nmodule is unable to export the chart on the client side. This happens for\ncertain browsers, and certain features (e.g.\n[allowHTML](#exporting.allowHTML)), depending on the image type exporting\nto. For very complex charts, it is possible that export can fail in\nbrowsers that don't support Blob objects, due to data URL length limits.\nIt is recommended to define the [exporting.error](#exporting.error)\nhandler if disabling fallback, in order to notify users in case export\nfails.","type":{"names":["boolean"]},"defaultvalue":"true","since":"4.1.8","requires":["module:modules/exporting","module:modules/offline-exporting"]},"meta":{"fullname":"exporting.fallbackToExportServer","name":"fallbackToExportServer","line":114,"lineEnd":131,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"fetchOptions":{"doclet":{"description":"Options for the fetch request used when sending the SVG to the export\nserver.\n\nSee [MDN](https://developer.mozilla.org/en-US/docs/Web/API/fetch)\nfor more information","type":{"names":["Object"]},"since":"11.3.0"},"meta":{"fullname":"exporting.fetchOptions","name":"fetchOptions","line":161,"lineEnd":171,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"filename":{"doclet":{"description":"The filename, without extension, to use for the exported chart.","samples":[{"name":"Custom file name","value":"highcharts/exporting/filename/","products":["highcharts"]},{"name":"Custom file name","value":"highcharts/exporting/filename/","products":["highstock"]}],"type":{"names":["string"]},"defaultvalue":"chart","since":"2.0.0"},"meta":{"fullname":"exporting.filename","name":"filename","line":132,"lineEnd":144,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"formAttributes":{"doclet":{"description":"Highcharts v11.2.0 and older. An object containing additional key value\ndata for the POST form that sends the SVG to the export server. For\nexample, a `target` can be set to make sure the generated image is\nreceived in another frame, or a custom `enctype` or `encoding` can be\nset.\n\nWith Highcharts v11.3.0, the `fetch` API replaced the old HTML form. To\nmodify the request, now use [fetchOptions](#exporting.fetchOptions)\ninstead.","deprecated":true,"type":{"names":["Highcharts.HTMLAttributes"]},"since":"3.0.8"},"meta":{"fullname":"exporting.formAttributes","name":"formAttributes","line":145,"lineEnd":160,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"libURL":{"doclet":{"description":"Path where Highcharts will look for export module dependencies to\nload on demand if they don't already exist on `window`. Should currently\npoint to location of [CanVG](https://github.com/canvg/canvg) library,\n[jsPDF](https://github.com/parallax/jsPDF) and\n[svg2pdf.js](https://github.com/yWorks/svg2pdf.js), required for client\nside export in certain browsers.\n\nNote: Highcharts cannot take responsibility for the security of any\nexternal libraries (including [optional dependencies](https://www.highcharts.com/docs/getting-started/optional-dependencies))\nloaded through `exporting.libURL`. These libraries are not licensed or\nwarrantied under the Highcharts license.","type":{"names":["string"]},"defaultByProduct":{},"since":"5.0.0"},"meta":{"fullname":"exporting.libURL","name":"libURL","line":172,"lineEnd":189,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"local":{"doclet":{"description":"Whether the chart should be exported using the browser's built-in\ncapabilities, allowing offline exports without requiring access to the\nHighcharts export server, or sent directly to the export server for\nprocessing and downloading.\n\nThis option is different from `exporting.fallbackToExportServer`, which\ncontrols whether the export server should be used as a fallback only if\nthe local export fails. In contrast, `exporting.local` explicitly defines\nwhich export method to use.","see":["[fallbackToExportServer](#exporting.fallbackToExportServer)"],"type":{"names":["boolean"]},"defaultvalue":"true","since":"12.3.0","requires":["module:modules/exporting"]},"meta":{"fullname":"exporting.local","name":"local","line":191,"lineEnd":209,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"menuItemDefinitions":{"doclet":{"description":"An object consisting of definitions for the menu items in the context\nmenu. Each key value pair has a `key` that is referenced in the\n[menuItems](#exporting.buttons.contextButton.menuItems) setting,\nand a `value`, which is an object with the following properties:\n\n- **onclick:** The click handler for the menu item\n\n- **text:** The text for the menu item\n\n- **textKey:** If internationalization is required, the key to a language\n  string\n\nCustom text for the \"exitFullScreen\" can be set only in lang options\n(it is not a separate button).","samples":[{"name":"Menu item definitions","value":"highcharts/exporting/menuitemdefinitions/"},{"name":"Adding a custom menu item for WebP export","value":"highcharts/exporting/menuitemdefinitions-webp/"}],"type":{"names":["Highcharts.Dictionary.<Highcharts.ExportingMenuObject>"]},"since":"5.0.13"},"meta":{"fullname":"exporting.menuItemDefinitions","name":"menuItemDefinitions","line":444,"lineEnd":467,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"downloadCSV":{"doclet":{"requires":["module:modules/export-data"],"type":{"names":["*"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadCSV","name":"downloadCSV","line":144,"lineEnd":146,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js"},"children":{"textKey":{"doclet":{"see":["[lang.downloadCSV](#lang.downloadCSV)"],"defaultvalue":"downloadCSV","type":{"names":["string"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadCSV.textKey","name":"textKey","line":148,"lineEnd":151,"column":12,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"downloadCSV"},"children":{}}}},"downloadJPEG":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadJPEG","name":"downloadJPEG","line":502,"lineEnd":502,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"textKey":{"doclet":{"see":["[lang.downloadJPEG](#lang.downloadJPEG)"],"defaultvalue":"downloadJPEG","type":{"names":["string"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadJPEG.textKey","name":"textKey","line":503,"lineEnd":506,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"downloadJPEG"},"children":{}}}},"downloadPDF":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadPDF","name":"downloadPDF","line":514,"lineEnd":514,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"textKey":{"doclet":{"see":["[lang.downloadPDF](#lang.downloadPDF)"],"defaultvalue":"downloadPDF","type":{"names":["string"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadPDF.textKey","name":"textKey","line":515,"lineEnd":518,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"downloadPDF"},"children":{}}}},"downloadPNG":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadPNG","name":"downloadPNG","line":492,"lineEnd":492,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"textKey":{"doclet":{"see":["[lang.downloadPNG](#lang.downloadPNG)"],"defaultvalue":"downloadPNG","type":{"names":["string"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadPNG.textKey","name":"textKey","line":493,"lineEnd":496,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"downloadPNG"},"children":{}}}},"downloadSVG":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadSVG","name":"downloadSVG","line":526,"lineEnd":526,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"textKey":{"doclet":{"see":["[lang.downloadSVG](#lang.downloadSVG)"],"defaultvalue":"downloadSVG","type":{"names":["string"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadSVG.textKey","name":"textKey","line":527,"lineEnd":530,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"downloadSVG"},"children":{}}}},"downloadXLS":{"doclet":{"requires":["module:modules/export-data"],"type":{"names":["*"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadXLS","name":"downloadXLS","line":157,"lineEnd":159,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js"},"children":{"textKey":{"doclet":{"see":["[lang.downloadXLS](#lang.downloadXLS)"],"defaultvalue":"downloadXLS","type":{"names":["string"]}},"meta":{"fullname":"exporting.menuItemDefinitions.downloadXLS.textKey","name":"textKey","line":161,"lineEnd":164,"column":12,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"downloadXLS"},"children":{}}}},"printChart":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"exporting.menuItemDefinitions.printChart","name":"printChart","line":479,"lineEnd":479,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"textKey":{"doclet":{"see":["[lang.printChart](#lang.printChart)"],"defaultvalue":"printChart","type":{"names":["string"]}},"meta":{"fullname":"exporting.menuItemDefinitions.printChart.textKey","name":"textKey","line":480,"lineEnd":483,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"printChart"},"children":{}}}},"separator":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"exporting.menuItemDefinitions.separator","name":"separator","line":489,"lineEnd":489,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"separator":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"exporting.menuItemDefinitions.separator.separator","name":"separator","line":490,"lineEnd":490,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":true},"children":{}}}},"viewData":{"doclet":{"requires":["module:modules/export-data"],"type":{"names":["*"]}},"meta":{"fullname":"exporting.menuItemDefinitions.viewData","name":"viewData","line":170,"lineEnd":172,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js"},"children":{"textKey":{"doclet":{"see":["[lang.viewData](#lang.viewData)"],"defaultvalue":"viewData","type":{"names":["string"]}},"meta":{"fullname":"exporting.menuItemDefinitions.viewData.textKey","name":"textKey","line":174,"lineEnd":177,"column":12,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"viewData"},"children":{}}}},"viewFullscreen":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"exporting.menuItemDefinitions.viewFullscreen","name":"viewFullscreen","line":469,"lineEnd":469,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"textKey":{"doclet":{"see":["[lang.viewFullscreen](#lang.viewFullscreen)"],"defaultvalue":"viewFullscreen","type":{"names":["string"]}},"meta":{"fullname":"exporting.menuItemDefinitions.viewFullscreen.textKey","name":"textKey","line":470,"lineEnd":473,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"viewFullscreen"},"children":{}}}}}},"pdfFont":{"doclet":{"description":"Settings for a custom font for the exported PDF, when using the\n`offline-exporting` module. This is used for languages containing\nnon-ASCII characters, like Chinese, Russian, Japanese etc.\n\nAs described in the [jsPDF\ndocs](https://github.com/parallax/jsPDF#use-of-unicode-characters--utf-8),\nthe 14 standard fonts in PDF are limited to the ASCII-codepage.\nTherefore, in order to support other text in the exported PDF, one or\nmore TTF font files have to be passed on to the exporting module.\n\nSee more in [the\ndocs](https://www.highcharts.com/docs/export-module/client-side-export).","samples":[{"name":"Download PDF in a language containing non-Latin characters.","value":"highcharts/exporting/offline-download-pdffont/","products":["highcharts"]}],"since":"10.0.0","requires":["module:modules/offline-exporting"],"type":{"names":["*"]}},"meta":{"fullname":"exporting.pdfFont","name":"pdfFont","line":266,"lineEnd":285,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"bold":{"doclet":{"description":"The TTF font file for bold text.","type":{"names":["string","undefined"]},"since":"10.0.0","defaultvalue":"undefined"},"meta":{"fullname":"exporting.pdfFont.bold","name":"bold","line":295,"lineEnd":299,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"undefined"},"children":{}},"bolditalic":{"doclet":{"description":"The TTF font file for bold and italic text.","type":{"names":["string","undefined"]},"since":"10.0.0","defaultvalue":"undefined"},"meta":{"fullname":"exporting.pdfFont.bolditalic","name":"bolditalic","line":301,"lineEnd":305,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"undefined"},"children":{}},"italic":{"doclet":{"description":"The TTF font file for italic text.","type":{"names":["string","undefined"]},"since":"10.0.0","defaultvalue":"undefined"},"meta":{"fullname":"exporting.pdfFont.italic","name":"italic","line":307,"lineEnd":311,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"undefined"},"children":{}},"normal":{"doclet":{"description":"The TTF font file for normal `font-style`. If font variations like\n`bold` or `italic` are not defined, the `normal` font will be used\nfor those too.","type":{"names":["string","undefined"]},"since":"10.0.0","defaultvalue":"undefined"},"meta":{"fullname":"exporting.pdfFont.normal","name":"normal","line":287,"lineEnd":293,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"undefined"},"children":{}}}},"printMaxWidth":{"doclet":{"description":"When printing the chart from the menu item in the burger menu, if\nthe on-screen chart exceeds this width, it is resized. After printing\nor cancelled, it is restored. The default width makes the chart\nfit into typical paper format. Note that this does not affect the\nchart when printing the web page as a whole.","since":"4.2.5","type":{"names":["number"]},"defaultvalue":780},"meta":{"fullname":"exporting.printMaxWidth","name":"printMaxWidth","line":314,"lineEnd":322,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":780},"children":{}},"scale":{"doclet":{"description":"Defines the scale or zoom factor for the exported image compared\nto the on-screen display. While for instance a 600px wide chart\nmay look good on a website, it will look bad in print. The default\nscale of 2 makes this chart export to a 1200px PNG or JPG.","see":["[chart.width](#chart.width)","[exporting.sourceWidth](#exporting.sourceWidth)"],"samples":[{"name":"Scale demonstrated","value":"highcharts/exporting/scale/","products":["highcharts"]},{"name":"Scale demonstrated","value":"highcharts/exporting/scale/","products":["highstock"]},{"name":"Scale demonstrated","value":"maps/exporting/scale/","products":["highmaps"]}],"since":"3.0.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"exporting.scale","name":"scale","line":324,"lineEnd":341,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":2},"children":{}},"showExportInProgress":{"doclet":{"description":"Display a message when export is in progress. Uses\n[Chart.showLoading()](/class-reference/Highcharts.Chart#showLoading).\n\nThe message can be altered by changing\n[lang.exportInProgress](#lang.exportInProgress).","since":"11.3.0","requires":["module:modules/export-data"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"exporting.showExportInProgress","name":"showExportInProgress","line":184,"lineEnd":193,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":true},"children":{}},"showTable":{"doclet":{"description":"Show a HTML table below the chart with the chart's current data.","samples":[{"name":"Show the table","value":"highcharts/export-data/showtable/"},{"name":"Experiment with putting the table inside the subtitle to allow exporting it.","value":"highcharts/studies/exporting-table-html"}],"since":"6.0.0","requires":["module:modules/export-data"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"exporting.showTable","name":"showTable","line":195,"lineEnd":206,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":false},"children":{}},"sourceHeight":{"doclet":{"description":"Analogous to [sourceWidth](#exporting.sourceWidth).","type":{"names":["number"]},"since":"3.0.0"},"meta":{"fullname":"exporting.sourceHeight","name":"sourceHeight","line":211,"lineEnd":217,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"sourceWidth":{"doclet":{"description":"The width of the original chart when exported, unless an explicit\n[chart.width](#chart.width) is set, or a pixel width is set on the\ncontainer. The width exported raster image is then multiplied by\n[scale](#exporting.scale).","samples":[{"name":"Source size demo","value":"highcharts/exporting/sourcewidth/","products":["highcharts"]},{"name":"Source size demo","value":"highcharts/exporting/sourcewidth/","products":["highstock"]},{"name":"Source size demo","value":"maps/exporting/sourcewidth/","products":["highmaps"]}],"type":{"names":["number"]},"since":"3.0.0"},"meta":{"fullname":"exporting.sourceWidth","name":"sourceWidth","line":218,"lineEnd":234,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"tableCaption":{"doclet":{"description":"Caption for the data table. Same as chart title by default. Set to\n`false` to disable.","samples":[{"name":"Multiple table headers","value":"highcharts/export-data/multilevel-table"}],"type":{"names":["boolean","string"]},"since":"6.0.4","requires":["module:modules/export-data"]},"meta":{"fullname":"exporting.tableCaption","name":"tableCaption","line":24,"lineEnd":35,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js"},"children":{}},"type":{"doclet":{"description":"Default MIME type for exporting if `chart.exportChart()` is called\nwithout specifying a `type` option. Possible values are `image/png`,\n `image/jpeg`, `application/pdf` and `image/svg+xml`.","type":{"names":["Highcharts.ExportingMimeTypeValue"]},"since":"2.0.0","defaultvalue":"image/png"},"meta":{"fullname":"exporting.type","name":"type","line":211,"lineEnd":217,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"image/png"},"children":{}},"url":{"doclet":{"description":"The URL for the server module converting the SVG string to an image\nformat. By default this points to Highcharts free web service.","since":"2.0.0"},"meta":{"fullname":"exporting.url","name":"url","line":259,"lineEnd":264,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"useMultiLevelHeaders":{"doclet":{"description":"Use multi level headers in data table. If [csv.columnHeaderFormatter](#exporting.csv.columnHeaderFormatter) is defined, it has to return\nobjects in order for multi level headers to work.","samples":[{"name":"Multiple table headers","value":"highcharts/export-data/multilevel-table"}],"since":"6.0.4","requires":["module:modules/export-data"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"exporting.useMultiLevelHeaders","name":"useMultiLevelHeaders","line":208,"lineEnd":218,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":true},"children":{}},"useRowspanHeaders":{"doclet":{"description":"If using multi level table headers, use rowspans for headers that\nhave only one level.","samples":[{"name":"Multiple table headers","value":"highcharts/export-data/multilevel-table"}],"since":"6.0.4","requires":["module:modules/export-data"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"exporting.useRowspanHeaders","name":"useRowspanHeaders","line":220,"lineEnd":229,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":true},"children":{}},"width":{"doclet":{"description":"The pixel width of charts exported to PNG or JPG. As of Highcharts\n3.0, the default pixel width is a function of the [chart.width](#chart.width) or [exporting.sourceWidth](#exporting.sourceWidth) and the\n[exporting.scale](#exporting.scale).","samples":[{"name":"Export to 200px wide images","value":"highcharts/exporting/width/","products":["highcharts"]},{"name":"Export to 200px wide images","value":"highcharts/exporting/width/","products":["highstock"]}],"type":{"names":["number"]},"since":"2.0.0"},"meta":{"fullname":"exporting.width","name":"width","line":235,"lineEnd":249,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}}}},"global":{"doclet":{"description":"Global options that don't apply to each chart. These options must be set\nusing the `Highcharts.setOptions` method.\n\n```js\nHighcharts.setOptions({\n    global: {\n        buttonTheme: {\n            fill: '#d0d0d0'\n        }\n    }\n});\n```","type":{"names":["*"]}},"meta":{"fullname":"global","name":"global","line":278,"lineEnd":291,"column":4,"filename":"code/es-modules/Core/Defaults.js"},"children":{"buttonTheme":{"doclet":{"description":"General theme for buttons. This applies to the zoom button, exporting\ncontext menu, map navigation, range selector buttons and custom\nbuttons generated using the `SVGRenderer.button` function. However,\neach of these may be overridden with more specific options.","samples":[{"name":"General button theme","value":"highcharts/global/buttontheme"}],"since":"11.4.2","type":{"names":["*"]}},"meta":{"fullname":"global.buttonTheme","name":"buttonTheme","line":293,"lineEnd":302,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{"fill":{"doclet":{"description":"The fill color for buttons","since":"11.4.2","type":{"names":["string"]},"defaultvalue":"#f7f7f7"},"meta":{"fullname":"global.buttonTheme.fill","name":"fill","line":304,"lineEnd":306,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"#f7f7f7"},"children":{}},"padding":{"doclet":{"description":"The padding of buttons","since":"11.4.2","type":{"names":["number"]},"defaultvalue":8},"meta":{"fullname":"global.buttonTheme.padding","name":"padding","line":308,"lineEnd":310,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":8},"children":{}},"r":{"doclet":{"description":"The border radius for buttons","since":"11.4.2","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"global.buttonTheme.r","name":"r","line":312,"lineEnd":314,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":2},"children":{}},"states":{"doclet":{"description":"State overrides for the buttons","since":"11.4.2","type":{"names":["*"]}},"meta":{"fullname":"global.buttonTheme.states","name":"states","line":333,"lineEnd":335,"column":12,"filename":"code/es-modules/Core/Defaults.js"},"children":{"disabled":{"doclet":{"description":"Disabled state overrides for the buttons are applied in\naddition to the normal state options","since":"11.4.2","type":{"names":["*"]}},"meta":{"fullname":"global.buttonTheme.states.disabled","name":"disabled","line":355,"lineEnd":358,"column":16,"filename":"code/es-modules/Core/Defaults.js"},"children":{"style":{"doclet":{"description":"Disabled state CSS style overrides for the buttons' text","since":"11.4.2","type":{"names":["*"]}},"meta":{"fullname":"global.buttonTheme.states.disabled.style","name":"style","line":360,"lineEnd":362,"column":20,"filename":"code/es-modules/Core/Defaults.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"global.buttonTheme.states.disabled.style.color","name":"color","line":364,"lineEnd":364,"column":24,"filename":"code/es-modules/Core/Defaults.js","default":"#cccccc"},"children":{}}}}}},"hover":{"doclet":{"description":"Hover state overrides for the buttons are applied in addition\nto the normal state options","since":"11.4.2","type":{"names":["*"]}},"meta":{"fullname":"global.buttonTheme.states.hover","name":"hover","line":337,"lineEnd":340,"column":16,"filename":"code/es-modules/Core/Defaults.js"},"children":{"fill":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#e6e6e6"},"meta":{"fullname":"global.buttonTheme.states.hover.fill","name":"fill","line":342,"lineEnd":342,"column":20,"filename":"code/es-modules/Core/Defaults.js","default":"#e6e6e6"},"children":{}}}},"select":{"doclet":{"description":"Select state overrides for the buttons are applied in\naddition to the normal state options","since":"11.4.2","type":{"names":["*"]}},"meta":{"fullname":"global.buttonTheme.states.select","name":"select","line":344,"lineEnd":347,"column":16,"filename":"code/es-modules/Core/Defaults.js"},"children":{"fill":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#e6e9ff"},"meta":{"fullname":"global.buttonTheme.states.select.fill","name":"fill","line":349,"lineEnd":349,"column":20,"filename":"code/es-modules/Core/Defaults.js","default":"#e6e9ff"},"children":{}},"style":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"global.buttonTheme.states.select.style","name":"style","line":350,"lineEnd":350,"column":20,"filename":"code/es-modules/Core/Defaults.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#000000"},"meta":{"fullname":"global.buttonTheme.states.select.style.color","name":"color","line":351,"lineEnd":351,"column":24,"filename":"code/es-modules/Core/Defaults.js","default":"#000000"},"children":{}},"fontWeight":{"doclet":{"type":{"names":["string"]},"defaultvalue":"bold"},"meta":{"fullname":"global.buttonTheme.states.select.style.fontWeight","name":"fontWeight","line":352,"lineEnd":352,"column":24,"filename":"code/es-modules/Core/Defaults.js","default":"bold"},"children":{}}}}}}}},"stroke":{"doclet":{"description":"The stroke color for buttons","since":"11.4.2","type":{"names":["string"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"global.buttonTheme.stroke","name":"stroke","line":316,"lineEnd":318,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"#cccccc"},"children":{}},"stroke-width":{"doclet":{"description":"The stroke width for buttons","since":"11.4.2","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"global.buttonTheme.stroke-width","name":"stroke-width","line":320,"lineEnd":322,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":1},"children":{}},"style":{"doclet":{"description":"CSS styling for the buttons' text","since":"11.4.2","type":{"names":["*"]}},"meta":{"fullname":"global.buttonTheme.style","name":"style","line":324,"lineEnd":326,"column":12,"filename":"code/es-modules/Core/Defaults.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#333333"},"meta":{"fullname":"global.buttonTheme.style.color","name":"color","line":328,"lineEnd":328,"column":16,"filename":"code/es-modules/Core/Defaults.js","default":"#333333"},"children":{}},"cursor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"pointer"},"meta":{"fullname":"global.buttonTheme.style.cursor","name":"cursor","line":329,"lineEnd":329,"column":16,"filename":"code/es-modules/Core/Defaults.js","default":"pointer"},"children":{}},"fontSize":{"doclet":{"type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"global.buttonTheme.style.fontSize","name":"fontSize","line":330,"lineEnd":330,"column":16,"filename":"code/es-modules/Core/Defaults.js","default":"0.8em"},"children":{}},"fontWeight":{"doclet":{"type":{"names":["string"]},"defaultvalue":"normal"},"meta":{"fullname":"global.buttonTheme.style.fontWeight","name":"fontWeight","line":331,"lineEnd":331,"column":16,"filename":"code/es-modules/Core/Defaults.js","default":"normal"},"children":{}}}}}}}},"lang":{"doclet":{"description":"An object containing language-related strings and settings. A typical setup\nuses `Highcharts.setOptions` to make the options apply to all charts in the\nsame page.\n\n```js\nHighcharts.setOptions({\n    lang: {\n        locale: 'fr'\n    }\n});\n```","type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","name":"lang","fullname":"lang","line":14,"lineEnd":18,"column":0},"children":{"accessibility":{"doclet":{"description":"Configure the accessibility strings in the chart. Requires the\n[accessibility module](https://code.highcharts.com/modules/accessibility.js)\nto be loaded. For a description of the module and information on its\nfeatures, see\n[Highcharts Accessibility](https://www.highcharts.com/docs/chart-concepts/accessibility).\n\nThe lang options use [Format Strings](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#format-strings)\nwith variables that are replaced at run time. These variables should be\nused when available, to avoid duplicating text that is defined elsewhere.\n\nFor more dynamic control over the accessibility functionality, see\n[accessibility.point.descriptionFormatter](#accessibility.point.descriptionFormatter),\n[accessibility.series.descriptionFormatter](#accessibility.series.descriptionFormatter),\nand\n[accessibility.screenReaderSection.beforeChartFormatter](#accessibility.screenReaderSection.beforeChartFormatter).","since":"6.0.6","type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","name":"accessibility","fullname":"lang.accessibility","line":20,"lineEnd":39,"column":4},"children":{"announceNewData":{"doclet":{"description":"Default announcement for new data in charts. If addPoint or\naddSeries is used, and only one series/point is added, the\n`newPointAnnounce` and `newSeriesAnnounce` strings are used.\nThe `...Single` versions will be used if there is only one chart\non the page, and the `...Multiple` versions will be used if there\nare multiple charts on the page. For all other new data events,\nthe `newDataAnnounce` string will be used.","since":"7.1.0","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.announceNewData","name":"announceNewData","line":229,"lineEnd":239,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"newDataAnnounce":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Updated data for chart {chartTitle}"},"meta":{"fullname":"lang.accessibility.announceNewData.newDataAnnounce","name":"newDataAnnounce","line":241,"lineEnd":241,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Updated data for chart {chartTitle}"},"children":{}},"newPointAnnounceMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"New data point in chart {chartTitle}: {pointDesc}"},"meta":{"fullname":"lang.accessibility.announceNewData.newPointAnnounceMultiple","name":"newPointAnnounceMultiple","line":245,"lineEnd":245,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"New data point in chart {chartTitle}: {pointDesc}"},"children":{}},"newPointAnnounceSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"New data point: {pointDesc}"},"meta":{"fullname":"lang.accessibility.announceNewData.newPointAnnounceSingle","name":"newPointAnnounceSingle","line":243,"lineEnd":243,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"New data point: {pointDesc}"},"children":{}},"newSeriesAnnounceMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"New data series in chart {chartTitle}: {seriesDesc}"},"meta":{"fullname":"lang.accessibility.announceNewData.newSeriesAnnounceMultiple","name":"newSeriesAnnounceMultiple","line":244,"lineEnd":244,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"New data series in chart {chartTitle}: {seriesDesc}"},"children":{}},"newSeriesAnnounceSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"New data series: {seriesDesc}"},"meta":{"fullname":"lang.accessibility.announceNewData.newSeriesAnnounceSingle","name":"newSeriesAnnounceSingle","line":242,"lineEnd":242,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"New data series: {seriesDesc}"},"children":{}}}},"axis":{"doclet":{"description":"Axis description format strings.","since":"6.0.6","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.axis","name":"axis","line":322,"lineEnd":322,"column":11,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"defaultAxisNames":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.axis.defaultAxisNames","name":"defaultAxisNames","line":340,"lineEnd":340,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"categories":{"doclet":{"type":{"names":["string"]},"defaultvalue":"categories"},"meta":{"fullname":"lang.accessibility.axis.defaultAxisNames.categories","name":"categories","line":341,"lineEnd":341,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"categories"},"children":{}},"time":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Time"},"meta":{"fullname":"lang.accessibility.axis.defaultAxisNames.time","name":"time","line":342,"lineEnd":342,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Time"},"children":{}},"values":{"doclet":{"type":{"names":["string"]},"defaultvalue":"values"},"meta":{"fullname":"lang.accessibility.axis.defaultAxisNames.values","name":"values","line":343,"lineEnd":343,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"values"},"children":{}}}},"rangeCategories":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Data range: {numCategories} categories."},"meta":{"fullname":"lang.accessibility.axis.rangeCategories","name":"rangeCategories","line":339,"lineEnd":339,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Data range: {numCategories} categories."},"children":{}},"rangeFromTo":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Data ranges from {rangeFrom} to {rangeTo}."},"meta":{"fullname":"lang.accessibility.axis.rangeFromTo","name":"rangeFromTo","line":338,"lineEnd":338,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Data ranges from {rangeFrom} to {rangeTo}."},"children":{}},"timeRangeDays":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Data range: {range} days."},"meta":{"fullname":"lang.accessibility.axis.timeRangeDays","name":"timeRangeDays","line":334,"lineEnd":334,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Data range: {range} days."},"children":{}},"timeRangeHours":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Data range: {range} hours."},"meta":{"fullname":"lang.accessibility.axis.timeRangeHours","name":"timeRangeHours","line":335,"lineEnd":335,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Data range: {range} hours."},"children":{}},"timeRangeMinutes":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Data range: {range} minutes."},"meta":{"fullname":"lang.accessibility.axis.timeRangeMinutes","name":"timeRangeMinutes","line":336,"lineEnd":336,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Data range: {range} minutes."},"children":{}},"timeRangeSeconds":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Data range: {range} seconds."},"meta":{"fullname":"lang.accessibility.axis.timeRangeSeconds","name":"timeRangeSeconds","line":337,"lineEnd":337,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Data range: {range} seconds."},"children":{}},"xAxisDescriptionPlural":{"doclet":{"type":{"names":["string"]},"defaultvalue":"The chart has {numAxes} X axes displaying {#each names}{#unless @first},{/unless}{#if @last} and{/if} {this}{/each}."},"meta":{"fullname":"lang.accessibility.axis.xAxisDescriptionPlural","name":"xAxisDescriptionPlural","line":331,"lineEnd":331,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"The chart has {numAxes} X axes displaying {#each names}{#unless @first},{/unless}{#if @last} and{/if} {this}{/each}."},"children":{}},"xAxisDescriptionSingular":{"doclet":{"type":{"names":["string"]},"defaultvalue":"The chart has 1 X axis displaying {names[0]}. {ranges[0]}"},"meta":{"fullname":"lang.accessibility.axis.xAxisDescriptionSingular","name":"xAxisDescriptionSingular","line":329,"lineEnd":329,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"The chart has 1 X axis displaying {names[0]}. {ranges[0]}"},"children":{}},"yAxisDescriptionPlural":{"doclet":{"type":{"names":["string"]},"defaultvalue":"The chart has {numAxes} Y axes displaying {#each names}{#unless @first},{/unless}{#if @last} and{/if} {this}{/each}."},"meta":{"fullname":"lang.accessibility.axis.yAxisDescriptionPlural","name":"yAxisDescriptionPlural","line":333,"lineEnd":333,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"The chart has {numAxes} Y axes displaying {#each names}{#unless @first},{/unless}{#if @last} and{/if} {this}{/each}."},"children":{}},"yAxisDescriptionSingular":{"doclet":{"type":{"names":["string"]},"defaultvalue":"The chart has 1 Y axis displaying {names[0]}. {ranges[0]}"},"meta":{"fullname":"lang.accessibility.axis.yAxisDescriptionSingular","name":"yAxisDescriptionSingular","line":332,"lineEnd":332,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"The chart has 1 Y axis displaying {names[0]}. {ranges[0]}"},"children":{}}}},"chartContainerLabel":{"doclet":{"description":"Accessible label for the chart container HTML element.\n`{title}` refers to the chart title.","since":"6.0.6","type":{"names":["string"]},"defaultvalue":"{title}. Highcharts interactive chart."},"meta":{"fullname":"lang.accessibility.chartContainerLabel","name":"chartContainerLabel","line":51,"lineEnd":54,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{title}. Highcharts interactive chart."},"children":{}},"chartTypes":{"doclet":{"description":"Chart type description strings. This is added to the chart\ninformation region.\n\nIf there is only a single series type used in the chart, we use\nthe format string for the series type, or default if missing.\nThere is one format string for cases where there is only a single\nseries in the chart, and one for multiple series of the same\ntype.","since":"6.0.6","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.chartTypes","name":"chartTypes","line":277,"lineEnd":288,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"barMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Bar chart with {numSeries} data series."},"meta":{"fullname":"lang.accessibility.chartTypes.barMultiple","name":"barMultiple","line":309,"lineEnd":309,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Bar chart with {numSeries} data series."},"children":{}},"barSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Bar chart with {numPoints} {#eq numPoints 1}bar{else}bars{/eq}."},"meta":{"fullname":"lang.accessibility.chartTypes.barSingle","name":"barSingle","line":307,"lineEnd":307,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Bar chart with {numPoints} {#eq numPoints 1}bar{else}bars{/eq}."},"children":{}},"boxplotMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Boxplot with {numSeries} data series."},"meta":{"fullname":"lang.accessibility.chartTypes.boxplotMultiple","name":"boxplotMultiple","line":318,"lineEnd":318,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Boxplot with {numSeries} data series."},"children":{}},"boxplotSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Boxplot with {numPoints} {#eq numPoints 1}box{else}boxes{/eq}."},"meta":{"fullname":"lang.accessibility.chartTypes.boxplotSingle","name":"boxplotSingle","line":316,"lineEnd":316,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Boxplot with {numPoints} {#eq numPoints 1}box{else}boxes{/eq}."},"children":{}},"bubbleMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Bubble chart with {numSeries} data series."},"meta":{"fullname":"lang.accessibility.chartTypes.bubbleMultiple","name":"bubbleMultiple","line":321,"lineEnd":321,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Bubble chart with {numSeries} data series."},"children":{}},"bubbleSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Bubble chart with {numPoints} {#eq numPoints 1}bubbles{else}bubble{/eq}."},"meta":{"fullname":"lang.accessibility.chartTypes.bubbleSingle","name":"bubbleSingle","line":319,"lineEnd":319,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Bubble chart with {numPoints} {#eq numPoints 1}bubbles{else}bubble{/eq}."},"children":{}},"columnMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Bar chart with {numSeries} data series."},"meta":{"fullname":"lang.accessibility.chartTypes.columnMultiple","name":"columnMultiple","line":306,"lineEnd":306,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Bar chart with {numSeries} data series."},"children":{}},"columnSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Bar chart with {numPoints} {#eq numPoints 1}bar{else}bars{/eq}."},"meta":{"fullname":"lang.accessibility.chartTypes.columnSingle","name":"columnSingle","line":304,"lineEnd":304,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Bar chart with {numPoints} {#eq numPoints 1}bar{else}bars{/eq}."},"children":{}},"combinationChart":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Combination chart with {numSeries} data series."},"meta":{"fullname":"lang.accessibility.chartTypes.combinationChart","name":"combinationChart","line":294,"lineEnd":294,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Combination chart with {numSeries} data series."},"children":{}},"defaultMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Chart with {numSeries} data series."},"meta":{"fullname":"lang.accessibility.chartTypes.defaultMultiple","name":"defaultMultiple","line":297,"lineEnd":297,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Chart with {numSeries} data series."},"children":{}},"defaultSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Chart with {numPoints} data {#eq numPoints 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.chartTypes.defaultSingle","name":"defaultSingle","line":295,"lineEnd":295,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Chart with {numPoints} data {#eq numPoints 1}point{else}points{/eq}."},"children":{}},"emptyChart":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Empty chart"},"meta":{"fullname":"lang.accessibility.chartTypes.emptyChart","name":"emptyChart","line":290,"lineEnd":290,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Empty chart"},"children":{}},"lineMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Line chart with {numSeries} lines."},"meta":{"fullname":"lang.accessibility.chartTypes.lineMultiple","name":"lineMultiple","line":303,"lineEnd":303,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Line chart with {numSeries} lines."},"children":{}},"lineSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Line chart with {numPoints} data {#eq numPoints 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.chartTypes.lineSingle","name":"lineSingle","line":301,"lineEnd":301,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Line chart with {numPoints} data {#eq numPoints 1}point{else}points{/eq}."},"children":{}},"mapTypeDescription":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Map of {mapTitle} with {numSeries} data series."},"meta":{"fullname":"lang.accessibility.chartTypes.mapTypeDescription","name":"mapTypeDescription","line":292,"lineEnd":292,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Map of {mapTitle} with {numSeries} data series."},"children":{}},"pieMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Pie chart with {numSeries} pies."},"meta":{"fullname":"lang.accessibility.chartTypes.pieMultiple","name":"pieMultiple","line":312,"lineEnd":312,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Pie chart with {numSeries} pies."},"children":{}},"pieSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Pie chart with {numPoints} {#eq numPoints 1}slice{else}slices{/eq}."},"meta":{"fullname":"lang.accessibility.chartTypes.pieSingle","name":"pieSingle","line":310,"lineEnd":310,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Pie chart with {numPoints} {#eq numPoints 1}slice{else}slices{/eq}."},"children":{}},"scatterMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Scatter chart with {numSeries} data series."},"meta":{"fullname":"lang.accessibility.chartTypes.scatterMultiple","name":"scatterMultiple","line":315,"lineEnd":315,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Scatter chart with {numSeries} data series."},"children":{}},"scatterSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Scatter chart with {numPoints} {#eq numPoints 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.chartTypes.scatterSingle","name":"scatterSingle","line":313,"lineEnd":313,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Scatter chart with {numPoints} {#eq numPoints 1}point{else}points{/eq}."},"children":{}},"splineMultiple":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Line chart with {numSeries} lines."},"meta":{"fullname":"lang.accessibility.chartTypes.splineMultiple","name":"splineMultiple","line":300,"lineEnd":300,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Line chart with {numSeries} lines."},"children":{}},"splineSingle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Line chart with {numPoints} data {#eq numPoints 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.chartTypes.splineSingle","name":"splineSingle","line":298,"lineEnd":298,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Line chart with {numPoints} data {#eq numPoints 1}point{else}points{/eq}."},"children":{}},"unknownMap":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Map of unspecified region with {numSeries} data series."},"meta":{"fullname":"lang.accessibility.chartTypes.unknownMap","name":"unknownMap","line":293,"lineEnd":293,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Map of unspecified region with {numSeries} data series."},"children":{}}}},"credits":{"doclet":{"description":"Accessible label for the chart credits.\n`{creditsStr}` refers to the visual text in the credits.","since":"6.0.6","type":{"names":["string"]},"defaultvalue":"Chart credits: {creditsStr}"},"meta":{"fullname":"lang.accessibility.credits","name":"credits","line":66,"lineEnd":69,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Chart credits: {creditsStr}"},"children":{}},"defaultChartTitle":{"doclet":{"description":"Default title of the chart for assistive technology, for charts\nwithout a chart title.","since":"6.0.6","type":{"names":["string"]},"defaultvalue":"Chart"},"meta":{"fullname":"lang.accessibility.defaultChartTitle","name":"defaultChartTitle","line":41,"lineEnd":45,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Chart"},"children":{}},"drillUpButton":{"doclet":{"description":"Accessible label for the drill-up button.\n`{buttonText}` refers to the visual text on the button.","since":"6.0.6","type":{"names":["string"]},"defaultvalue":"{buttonText}"},"meta":{"fullname":"lang.accessibility.drillUpButton","name":"drillUpButton","line":61,"lineEnd":64,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{buttonText}"},"children":{}},"exporting":{"doclet":{"description":"Exporting menu format strings for accessibility module.","since":"6.0.6","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.exporting","name":"exporting","line":345,"lineEnd":345,"column":11,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"chartMenuLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Chart menu"},"meta":{"fullname":"lang.accessibility.exporting.chartMenuLabel","name":"chartMenuLabel","line":352,"lineEnd":352,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Chart menu"},"children":{}},"menuButtonLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"View chart menu, {chartTitle}"},"meta":{"fullname":"lang.accessibility.exporting.menuButtonLabel","name":"menuButtonLabel","line":353,"lineEnd":353,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"View chart menu, {chartTitle}"},"children":{}}}},"graphicContainerLabel":{"doclet":{"description":"Set a label on the container wrapping the SVG.","see":["[chartContainerLabel](#lang.accessibility.chartContainerLabel)"],"since":"8.0.0","type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"lang.accessibility.graphicContainerLabel","name":"graphicContainerLabel","line":91,"lineEnd":97,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":""},"children":{}},"legend":{"doclet":{"description":"Language options for accessibility of the legend.","since":"8.0.0","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.legend","name":"legend","line":138,"lineEnd":142,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"legendItem":{"doclet":{"description":"Accessible label for individual legend items. `{itemName}` refers\nto the visual text in the legend for that item.","since":"8.0.0","type":{"names":["string"]},"defaultvalue":"Show {itemName}"},"meta":{"fullname":"lang.accessibility.legend.legendItem","name":"legendItem","line":155,"lineEnd":158,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Show {itemName}"},"children":{}},"legendLabel":{"doclet":{"description":"Accessible label for the legend, for charts where there is a\nlegend title defined. `{legendTitle}` refers to the visual text\nin the legend title.","since":"8.0.0","type":{"names":["string"]},"defaultvalue":"Chart legend: {legendTitle}"},"meta":{"fullname":"lang.accessibility.legend.legendLabel","name":"legendLabel","line":149,"lineEnd":153,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Chart legend: {legendTitle}"},"children":{}},"legendLabelNoTitle":{"doclet":{"description":"Accessible label for the legend, for charts where there is no\nlegend title defined.","since":"8.0.0","type":{"names":["string"]},"defaultvalue":"Toggle series visibility, {chartTitle}"},"meta":{"fullname":"lang.accessibility.legend.legendLabelNoTitle","name":"legendLabelNoTitle","line":144,"lineEnd":147,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Toggle series visibility, {chartTitle}"},"children":{}}}},"navigator":{"doclet":{"description":"Navigator language options for accessibility.","since":"11.2.0","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.navigator","name":"navigator","line":182,"lineEnd":186,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"changeAnnouncement":{"doclet":{"description":"Announcement for assistive technology when navigator values\nare changed.\n\nReceives `axisRangeDescription` and `chart` as context.\n`axisRangeDescription` corresponds to the range description\ndefined in [lang.accessibility.axis](#lang.accessibility.axis)","since":"11.2.0","type":{"names":["string"]},"defaultvalue":"{axisRangeDescription}"},"meta":{"fullname":"lang.accessibility.navigator.changeAnnouncement","name":"changeAnnouncement","line":201,"lineEnd":208,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{axisRangeDescription}"},"children":{}},"groupLabel":{"doclet":{"description":"Label for the navigator region.\n\nReceives `chart` as context.","since":"11.2.0","type":{"names":["string"]},"defaultvalue":"Axis zoom"},"meta":{"fullname":"lang.accessibility.navigator.groupLabel","name":"groupLabel","line":195,"lineEnd":199,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Axis zoom"},"children":{}},"handleLabel":{"doclet":{"description":"Label for the navigator handles.\n\nReceives `handleIx` and `chart` as context.\n`handleIx` refers to the index of the navigator handle.","since":"11.2.0","type":{"names":["string"]},"defaultvalue":"{#eq handleIx 0}Start, percent{else}End, percent{/eq}"},"meta":{"fullname":"lang.accessibility.navigator.handleLabel","name":"handleLabel","line":188,"lineEnd":193,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{#eq handleIx 0}Start, percent{else}End, percent{/eq}"},"children":{}}}},"rangeSelector":{"doclet":{"description":"Range selector language options for accessibility.","since":"8.0.0","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.rangeSelector","name":"rangeSelector","line":171,"lineEnd":175,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"clickButtonAnnouncement":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Viewing {axisRangeDescription}"},"meta":{"fullname":"lang.accessibility.rangeSelector.clickButtonAnnouncement","name":"clickButtonAnnouncement","line":180,"lineEnd":180,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Viewing {axisRangeDescription}"},"children":{}},"dropdownLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{rangeTitle}"},"meta":{"fullname":"lang.accessibility.rangeSelector.dropdownLabel","name":"dropdownLabel","line":177,"lineEnd":177,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{rangeTitle}"},"children":{}},"maxInputLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Select end date."},"meta":{"fullname":"lang.accessibility.rangeSelector.maxInputLabel","name":"maxInputLabel","line":179,"lineEnd":179,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Select end date."},"children":{}},"minInputLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Select start date."},"meta":{"fullname":"lang.accessibility.rangeSelector.minInputLabel","name":"minInputLabel","line":178,"lineEnd":178,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Select start date."},"children":{}}}},"resetZoomButton":{"doclet":{"deprecated":"10.2.1","type":{"names":["string"]}},"meta":{"fullname":"lang.accessibility.resetZoomButton","name":"resetZoomButton","line":41,"lineEnd":45,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{}},"screenReaderSection":{"doclet":{"description":"Language options for the screen reader information sections added\nbefore and after the charts.","since":"8.0.0","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.screenReaderSection","name":"screenReaderSection","line":99,"lineEnd":104,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"afterRegionLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"lang.accessibility.screenReaderSection.afterRegionLabel","name":"afterRegionLabel","line":107,"lineEnd":107,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":""},"children":{}},"annotations":{"doclet":{"description":"Language options for annotation descriptions.","since":"8.0.1","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.screenReaderSection.annotations","name":"annotations","line":108,"lineEnd":112,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"descriptionMultiplePoints":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{annotationText}. Related to {annotationPoint}{#each additionalAnnotationPoints}, also related to {this}{/each}"},"meta":{"fullname":"lang.accessibility.screenReaderSection.annotations.descriptionMultiplePoints","name":"descriptionMultiplePoints","line":116,"lineEnd":116,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{annotationText}. Related to {annotationPoint}{#each additionalAnnotationPoints}, also related to {this}{/each}"},"children":{}},"descriptionNoPoints":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{annotationText}"},"meta":{"fullname":"lang.accessibility.screenReaderSection.annotations.descriptionNoPoints","name":"descriptionNoPoints","line":120,"lineEnd":120,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{annotationText}"},"children":{}},"descriptionSinglePoint":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{annotationText}. Related to {annotationPoint}"},"meta":{"fullname":"lang.accessibility.screenReaderSection.annotations.descriptionSinglePoint","name":"descriptionSinglePoint","line":115,"lineEnd":115,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{annotationText}. Related to {annotationPoint}"},"children":{}},"heading":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Chart annotations summary"},"meta":{"fullname":"lang.accessibility.screenReaderSection.annotations.heading","name":"heading","line":114,"lineEnd":114,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Chart annotations summary"},"children":{}}}},"beforeRegionLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"lang.accessibility.screenReaderSection.beforeRegionLabel","name":"beforeRegionLabel","line":106,"lineEnd":106,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":""},"children":{}},"endOfChartMarker":{"doclet":{"description":"Label for the end of the chart. Announced by screen readers.","since":"8.0.0","type":{"names":["string"]},"defaultvalue":"End of interactive chart."},"meta":{"fullname":"lang.accessibility.screenReaderSection.endOfChartMarker","name":"endOfChartMarker","line":122,"lineEnd":126,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"End of interactive chart."},"children":{}}}},"series":{"doclet":{"description":"Lang configuration for different series types. For more dynamic\ncontrol over the series element descriptions, see\n[accessibility.seriesDescriptionFormatter](#accessibility.seriesDescriptionFormatter).","since":"6.0.6","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.series","name":"series","line":355,"lineEnd":361,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"description":{"doclet":{"description":"User supplied description text. This is added in the point\ncomment description by default if present.\n\n`{description}` refers to the value given in\n[point.accessibility.description](#series.line.data.accessibility.description).","since":"6.0.6","type":{"names":["string"]},"defaultvalue":"{description}"},"meta":{"fullname":"lang.accessibility.series.description","name":"description","line":408,"lineEnd":408,"column":15,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{description}"},"children":{}},"nullPointValue":{"doclet":{"description":"Description for the value of null points.","since":"8.0.0","type":{"names":["string"]},"defaultvalue":"No value"},"meta":{"fullname":"lang.accessibility.series.nullPointValue","name":"nullPointValue","line":433,"lineEnd":437,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"No value"},"children":{}},"pointAnnotationsDescription":{"doclet":{"description":"Description for annotations on a point, as it is made available\nto assistive technology.","since":"8.0.1","type":{"names":["string"]},"defaultvalue":"{#each annotations}Annotation: {this}{/each}"},"meta":{"fullname":"lang.accessibility.series.pointAnnotationsDescription","name":"pointAnnotationsDescription","line":439,"lineEnd":444,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{#each annotations}Annotation: {this}{/each}"},"children":{}},"summary":{"doclet":{"description":"Lang configuration for the series main summary. Each series\ntype has two modes:\n\n1. This series type is the only series type used in the\n   chart\n\n2. This is a combination chart with multiple series types\n\nIf a definition does not exist for the specific series type\nand mode, the 'default' lang definitions are used.\n\nChart and its subproperties can be accessed with the `{chart}` variable.\nThe series and its subproperties can be accessed with the `{series}` variable.\n\nThe series index (starting from 1) can be accessed with the `{seriesNumber}` variable.","since":"6.0.6","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.series.summary","name":"summary","line":363,"lineEnd":381,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"bar":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, bar series {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}bar{else}bars{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.bar","name":"bar","line":392,"lineEnd":392,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, bar series {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}bar{else}bars{/eq}."},"children":{}},"barCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}. Bar series with {series.points.length} {#eq series.points.length 1}bar{else}bars{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.barCombination","name":"barCombination","line":393,"lineEnd":393,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}. Bar series with {series.points.length} {#eq series.points.length 1}bar{else}bars{/eq}."},"children":{}},"boxplot":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, boxplot {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}box{else}boxes{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.boxplot","name":"boxplot","line":398,"lineEnd":398,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, boxplot {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}box{else}boxes{/eq}."},"children":{}},"boxplotCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}. Boxplot with {series.points.length} {#eq series.points.length 1}box{else}boxes{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.boxplotCombination","name":"boxplotCombination","line":399,"lineEnd":399,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}. Boxplot with {series.points.length} {#eq series.points.length 1}box{else}boxes{/eq}."},"children":{}},"bubble":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, bubble series {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}bubble{else}bubbles{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.bubble","name":"bubble","line":400,"lineEnd":400,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, bubble series {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}bubble{else}bubbles{/eq}."},"children":{}},"bubbleCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}. Bubble series with {series.points.length} {#eq series.points.length 1}bubble{else}bubbles{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.bubbleCombination","name":"bubbleCombination","line":401,"lineEnd":401,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}. Bubble series with {series.points.length} {#eq series.points.length 1}bubble{else}bubbles{/eq}."},"children":{}},"column":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, bar series {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}bar{else}bars{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.column","name":"column","line":390,"lineEnd":390,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, bar series {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}bar{else}bars{/eq}."},"children":{}},"columnCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}. Bar series with {series.points.length} {#eq series.points.length 1}bar{else}bars{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.columnCombination","name":"columnCombination","line":391,"lineEnd":391,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}. Bar series with {series.points.length} {#eq series.points.length 1}bar{else}bars{/eq}."},"children":{}},"default":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length} with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.default","name":"default","line":383,"lineEnd":383,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length} with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"children":{}},"defaultCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length} with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.defaultCombination","name":"defaultCombination","line":385,"lineEnd":385,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length} with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"children":{}},"line":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, line {seriesNumber} of {chart.series.length} with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.line","name":"line","line":386,"lineEnd":386,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, line {seriesNumber} of {chart.series.length} with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"children":{}},"lineCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}. Line with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.lineCombination","name":"lineCombination","line":387,"lineEnd":387,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}. Line with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"children":{}},"map":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, map {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}area{else}areas{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.map","name":"map","line":402,"lineEnd":402,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, map {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}area{else}areas{/eq}."},"children":{}},"mapCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}. Map with {series.points.length} {#eq series.points.length 1}area{else}areas{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.mapCombination","name":"mapCombination","line":403,"lineEnd":403,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}. Map with {series.points.length} {#eq series.points.length 1}area{else}areas{/eq}."},"children":{}},"mapbubble":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, bubble series {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}bubble{else}bubbles{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.mapbubble","name":"mapbubble","line":406,"lineEnd":406,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, bubble series {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}bubble{else}bubbles{/eq}."},"children":{}},"mapbubbleCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}. Bubble series with {series.points.length} {#eq series.points.length 1}bubble{else}bubbles{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.mapbubbleCombination","name":"mapbubbleCombination","line":407,"lineEnd":407,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}. Bubble series with {series.points.length} {#eq series.points.length 1}bubble{else}bubbles{/eq}."},"children":{}},"mapline":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, line {seriesNumber} of {chart.series.length} with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.mapline","name":"mapline","line":404,"lineEnd":404,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, line {seriesNumber} of {chart.series.length} with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"children":{}},"maplineCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}. Line with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.maplineCombination","name":"maplineCombination","line":405,"lineEnd":405,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}. Line with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"children":{}},"pie":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, pie {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}slice{else}slices{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.pie","name":"pie","line":394,"lineEnd":394,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, pie {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}slice{else}slices{/eq}."},"children":{}},"pieCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}. Pie with {series.points.length} {#eq series.points.length 1}slice{else}slices{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.pieCombination","name":"pieCombination","line":395,"lineEnd":395,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}. Pie with {series.points.length} {#eq series.points.length 1}slice{else}slices{/eq}."},"children":{}},"scatter":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, scatter plot {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.scatter","name":"scatter","line":396,"lineEnd":396,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, scatter plot {seriesNumber} of {chart.series.length} with {series.points.length} {#eq series.points.length 1}point{else}points{/eq}."},"children":{}},"scatterCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}, scatter plot with {series.points.length} {#eq series.points.length 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.scatterCombination","name":"scatterCombination","line":397,"lineEnd":397,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}, scatter plot with {series.points.length} {#eq series.points.length 1}point{else}points{/eq}."},"children":{}},"spline":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, line {seriesNumber} of {chart.series.length} with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.spline","name":"spline","line":388,"lineEnd":388,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, line {seriesNumber} of {chart.series.length} with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"children":{}},"splineCombination":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{series.name}, series {seriesNumber} of {chart.series.length}. Line with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"meta":{"fullname":"lang.accessibility.series.summary.splineCombination","name":"splineCombination","line":389,"lineEnd":389,"column":16,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"{series.name}, series {seriesNumber} of {chart.series.length}. Line with {series.points.length} data {#eq series.points.length 1}point{else}points{/eq}."},"children":{}}}},"xAxisDescription":{"doclet":{"description":"X-axis description for series if there are multiple xAxes in\nthe chart.","since":"6.0.6","type":{"names":["string"]},"defaultvalue":"X axis, {name}"},"meta":{"fullname":"lang.accessibility.series.xAxisDescription","name":"xAxisDescription","line":419,"lineEnd":424,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"X axis, {name}"},"children":{}},"yAxisDescription":{"doclet":{"description":"Y-axis description for series if there are multiple yAxes in\nthe chart.","since":"6.0.6","type":{"names":["string"]},"defaultvalue":"Y axis, {name}"},"meta":{"fullname":"lang.accessibility.series.yAxisDescription","name":"yAxisDescription","line":426,"lineEnd":431,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Y axis, {name}"},"children":{}}}},"seriesTypeDescriptions":{"doclet":{"description":"Descriptions of lesser known series types. The relevant\ndescription is added to the screen reader information region\nwhen these series types are used.","since":"6.0.6","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.seriesTypeDescriptions","name":"seriesTypeDescriptions","line":247,"lineEnd":253,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"arearange":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Arearange charts are line charts displaying a range between a lower and higher value for each point."},"meta":{"fullname":"lang.accessibility.seriesTypeDescriptions.arearange","name":"arearange","line":259,"lineEnd":259,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Arearange charts are line charts displaying a range between a lower and higher value for each point."},"children":{}},"areasplinerange":{"doclet":{"type":{"names":["string"]},"defaultvalue":"These charts are line charts displaying a range between a lower and higher value for each point."},"meta":{"fullname":"lang.accessibility.seriesTypeDescriptions.areasplinerange","name":"areasplinerange","line":261,"lineEnd":261,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"These charts are line charts displaying a range between a lower and higher value for each point."},"children":{}},"boxplot":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Box plot charts are typically used to display groups of statistical data. Each data point in the chart can have up to 5 values: minimum, lower quartile, median, upper quartile, and maximum."},"meta":{"fullname":"lang.accessibility.seriesTypeDescriptions.boxplot","name":"boxplot","line":255,"lineEnd":255,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Box plot charts are typically used to display groups of statistical data. Each data point in the chart can have up to 5 values: minimum, lower quartile, median, upper quartile, and maximum."},"children":{}},"bubble":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Bubble charts are scatter charts where each data point also has a size value."},"meta":{"fullname":"lang.accessibility.seriesTypeDescriptions.bubble","name":"bubble","line":263,"lineEnd":263,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Bubble charts are scatter charts where each data point also has a size value."},"children":{}},"columnrange":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Columnrange charts are column charts displaying a range between a lower and higher value for each point."},"meta":{"fullname":"lang.accessibility.seriesTypeDescriptions.columnrange","name":"columnrange","line":265,"lineEnd":265,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Columnrange charts are column charts displaying a range between a lower and higher value for each point."},"children":{}},"errorbar":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Errorbar series are used to display the variability of the data."},"meta":{"fullname":"lang.accessibility.seriesTypeDescriptions.errorbar","name":"errorbar","line":268,"lineEnd":268,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Errorbar series are used to display the variability of the data."},"children":{}},"funnel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Funnel charts are used to display reduction of data in stages."},"meta":{"fullname":"lang.accessibility.seriesTypeDescriptions.funnel","name":"funnel","line":270,"lineEnd":270,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Funnel charts are used to display reduction of data in stages."},"children":{}},"pyramid":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Pyramid charts consist of a single pyramid with item heights corresponding to each point value."},"meta":{"fullname":"lang.accessibility.seriesTypeDescriptions.pyramid","name":"pyramid","line":272,"lineEnd":272,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Pyramid charts consist of a single pyramid with item heights corresponding to each point value."},"children":{}},"waterfall":{"doclet":{"type":{"names":["string"]},"defaultvalue":"A waterfall chart is a column chart where each column contributes towards a total end value."},"meta":{"fullname":"lang.accessibility.seriesTypeDescriptions.waterfall","name":"waterfall","line":274,"lineEnd":274,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"A waterfall chart is a column chart where each column contributes towards a total end value."},"children":{}}}},"sonification":{"doclet":{"description":"Language options for sonification.","since":"8.0.1","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.sonification","name":"sonification","line":129,"lineEnd":133,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"playAsSoundButtonText":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Play as sound, {chartTitle}"},"meta":{"fullname":"lang.accessibility.sonification.playAsSoundButtonText","name":"playAsSoundButtonText","line":135,"lineEnd":135,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Play as sound, {chartTitle}"},"children":{}},"playAsSoundClickAnnouncement":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Play"},"meta":{"fullname":"lang.accessibility.sonification.playAsSoundClickAnnouncement","name":"playAsSoundClickAnnouncement","line":136,"lineEnd":136,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Play"},"children":{}}}},"stockTools":{"doclet":{"description":"Stock tools language options for accessibility.","since":"6.0.6","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.stockTools","name":"stockTools","line":211,"lineEnd":215,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"arrowLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Toggle submenu"},"meta":{"fullname":"lang.accessibility.stockTools.arrowLabel","name":"arrowLabel","line":218,"lineEnd":218,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Toggle submenu"},"children":{}},"groupLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Stock chart tools"},"meta":{"fullname":"lang.accessibility.stockTools.groupLabel","name":"groupLabel","line":217,"lineEnd":217,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Stock chart tools"},"children":{}}}},"svgContainerLabel":{"doclet":{"description":"Accessible label for the chart SVG element.\n`{chartTitle}` refers to the chart title.","since":"6.0.6","type":{"names":["string"]},"defaultvalue":"Interactive chart"},"meta":{"fullname":"lang.accessibility.svgContainerLabel","name":"svgContainerLabel","line":56,"lineEnd":59,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Interactive chart"},"children":{}},"svgContainerTitle":{"doclet":{"description":"Title element text for the chart SVG element. Leave this\nempty to disable adding the title element. Browsers will display\nthis content when hovering over elements in the chart. Assistive\ntechnology may use this element to label the chart.","since":"6.0.8","type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"lang.accessibility.svgContainerTitle","name":"svgContainerTitle","line":82,"lineEnd":89,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":""},"children":{}},"table":{"doclet":{"description":"Accessibility language options for the data table.","since":"8.0.0","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.table","name":"table","line":220,"lineEnd":224,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"tableSummary":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Table representation of chart."},"meta":{"fullname":"lang.accessibility.table.tableSummary","name":"tableSummary","line":227,"lineEnd":227,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Table representation of chart."},"children":{}},"viewAsDataTableButtonText":{"doclet":{"type":{"names":["string"]},"defaultvalue":"View as data table, {chartTitle}"},"meta":{"fullname":"lang.accessibility.table.viewAsDataTableButtonText","name":"viewAsDataTableButtonText","line":226,"lineEnd":226,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"View as data table, {chartTitle}"},"children":{}}}},"thousandsSep":{"doclet":{"description":"Thousands separator to use when formatting numbers for screen\nreaders. Note that many screen readers will not handle space as a\nthousands separator, and will consider \"11 700\" as two numbers.\n\nSet to `null` to use the separator defined in\n[lang.thousandsSep](lang.thousandsSep).","since":"7.1.0","type":{"names":["string"]},"defaultvalue":","},"meta":{"fullname":"lang.accessibility.thousandsSep","name":"thousandsSep","line":71,"lineEnd":80,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":","},"children":{}},"zoom":{"doclet":{"description":"Chart and map zoom accessibility language options.","since":"8.0.0","type":{"names":["*"]}},"meta":{"fullname":"lang.accessibility.zoom","name":"zoom","line":161,"lineEnd":165,"column":8,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js"},"children":{"mapZoomIn":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Zoom chart"},"meta":{"fullname":"lang.accessibility.zoom.mapZoomIn","name":"mapZoomIn","line":167,"lineEnd":167,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Zoom chart"},"children":{}},"mapZoomOut":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Zoom out chart"},"meta":{"fullname":"lang.accessibility.zoom.mapZoomOut","name":"mapZoomOut","line":168,"lineEnd":168,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Zoom out chart"},"children":{}},"resetZoomButton":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Reset zoom"},"meta":{"fullname":"lang.accessibility.zoom.resetZoomButton","name":"resetZoomButton","line":169,"lineEnd":169,"column":12,"filename":"code/es-modules/Accessibility/Options/LangDefaults.js","default":"Reset zoom"},"children":{}}}}}},"chartTitle":{"doclet":{"description":"The default chart title.","since":"12.2.0","type":{"names":["string"]},"defaultvalue":"Chart title"},"meta":{"fullname":"lang.chartTitle","name":"chartTitle","line":99,"lineEnd":103,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"Chart title"},"children":{}},"contextButtonTitle":{"doclet":{"description":"Exporting module menu. The tooltip title for the context menu holding\nprint and export menu items.","since":"3.0.0","requires":["module:modules/exporting"],"type":{"names":["string"]},"defaultvalue":"Chart context menu"},"meta":{"fullname":"lang.contextButtonTitle","name":"contextButtonTitle","line":596,"lineEnd":602,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"Chart context menu"},"children":{}},"decimalPoint":{"doclet":{"description":"The default decimal point used in the `Highcharts.numberFormat`\nmethod unless otherwise specified in the function arguments. Defaults\nto the locale decimal point as determined by `lang.locale`.","type":{"names":["string"]},"defaultvalue":"undefined","since":"1.2.2"},"meta":{"fullname":"lang.decimalPoint","name":"decimalPoint","line":205,"lineEnd":214,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"downloadCSV":{"doclet":{"description":"The text for the menu item.","since":"6.0.0","requires":["module:modules/export-data"],"type":{"names":["string"]},"defaultvalue":"Download CSV"},"meta":{"fullname":"lang.downloadCSV","name":"downloadCSV","line":238,"lineEnd":243,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"Download CSV"},"children":{}},"downloadJPEG":{"doclet":{"description":"Exporting module only. The text for the JPEG download menu item.","since":"2.0.0","requires":["module:modules/exporting"],"type":{"names":["string"]},"defaultvalue":"Download JPEG image"},"meta":{"fullname":"lang.downloadJPEG","name":"downloadJPEG","line":575,"lineEnd":580,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"Download JPEG image"},"children":{}},"downloadMIDI":{"doclet":{"description":"The text for the MIDI download menu item in the export menu.","requires":["module:modules/sonification"],"since":"11.0.0"},"meta":{"fullname":"lang.downloadMIDI","name":"downloadMIDI","line":911,"lineEnd":917,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"downloadPDF":{"doclet":{"description":"Exporting module only. The text for the PDF download menu item.","since":"2.0.0","requires":["module:modules/exporting"],"type":{"names":["string"]},"defaultvalue":"Download PDF document"},"meta":{"fullname":"lang.downloadPDF","name":"downloadPDF","line":582,"lineEnd":587,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"Download PDF document"},"children":{}},"downloadPNG":{"doclet":{"description":"Exporting module only. The text for the PNG download menu item.","since":"2.0.0","requires":["module:modules/exporting"],"type":{"names":["string"]},"defaultvalue":"Download PNG image"},"meta":{"fullname":"lang.downloadPNG","name":"downloadPNG","line":568,"lineEnd":573,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"Download PNG image"},"children":{}},"downloadSVG":{"doclet":{"description":"Exporting module only. The text for the SVG download menu item.","since":"2.0.0","requires":["module:modules/exporting"],"type":{"names":["string"]},"defaultvalue":"Download SVG vector image"},"meta":{"fullname":"lang.downloadSVG","name":"downloadSVG","line":589,"lineEnd":594,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"Download SVG vector image"},"children":{}},"downloadXLS":{"doclet":{"description":"The text for the menu item.","since":"6.0.0","requires":["module:modules/export-data"],"type":{"names":["string"]},"defaultvalue":"Download XLS"},"meta":{"fullname":"lang.downloadXLS","name":"downloadXLS","line":245,"lineEnd":250,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"Download XLS"},"children":{}},"drillUpText":{"doclet":{"description":"Drill up button is deprecated since Highcharts v9.3.2. Use\n[drilldown.breadcrumbs](#drilldown.breadcrumbs) instead.\n\nThe text for the button that appears when drilling down, linking back\nto the parent series. The parent series' name is inserted for\n`{series.name}`.","deprecated":"9.3.2","since":"3.0.8","products":["highcharts","highmaps"],"requires":["module:modules/drilldown"]},"meta":{"fullname":"lang.drillUpText","name":"drillUpText","line":309,"lineEnd":322,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"exitFullscreen":{"doclet":{"description":"Exporting module only. The text for the menu item to exit the chart\nfrom full screen.","since":"8.0.1","requires":["module:modules/exporting"],"type":{"names":["string"]},"defaultvalue":"Exit from full screen"},"meta":{"fullname":"lang.exitFullscreen","name":"exitFullscreen","line":553,"lineEnd":559,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"Exit from full screen"},"children":{}},"exportData":{"doclet":{"description":"The text for exported table.","since":"8.1.0","requires":["module:modules/export-data"],"type":{"names":["*"]}},"meta":{"fullname":"lang.exportData","name":"exportData","line":252,"lineEnd":257,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js"},"children":{"annotationHeader":{"doclet":{"description":"The annotation column title.","since":"8.1.0","type":{"names":["string"]},"defaultvalue":"Annotations"},"meta":{"fullname":"lang.exportData.annotationHeader","name":"annotationHeader","line":259,"lineEnd":261,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"Annotations"},"children":{}},"categoryDatetimeHeader":{"doclet":{"description":"The category column title when axis type set to \"datetime\".","since":"8.1.0","type":{"names":["string"]},"defaultvalue":"DateTime"},"meta":{"fullname":"lang.exportData.categoryDatetimeHeader","name":"categoryDatetimeHeader","line":267,"lineEnd":269,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"DateTime"},"children":{}},"categoryHeader":{"doclet":{"description":"The category column title.","since":"8.1.0","type":{"names":["string"]},"defaultvalue":"Category"},"meta":{"fullname":"lang.exportData.categoryHeader","name":"categoryHeader","line":263,"lineEnd":265,"column":8,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"Category"},"children":{}}}},"exportInProgress":{"doclet":{"description":"Text to show when export is in progress.","since":"11.3.0","requires":["module:modules/export-data"],"type":{"names":["string"]},"defaultvalue":"Exporting..."},"meta":{"fullname":"lang.exportInProgress","name":"exportInProgress","line":286,"lineEnd":291,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"Exporting..."},"children":{}},"hideData":{"doclet":{"description":"The text for the menu item.","since":"8.2.0","requires":["module:modules/export-data"],"type":{"names":["string"]},"defaultvalue":"Hide data table"},"meta":{"fullname":"lang.hideData","name":"hideData","line":279,"lineEnd":284,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"Hide data table"},"children":{}},"invalidDate":{"doclet":{"description":"What to show in a date field for invalid dates. Defaults to an empty\nstring.","type":{"names":["string"]},"since":"4.1.8","products":["highcharts","highstock"]},"meta":{"fullname":"lang.invalidDate","name":"invalidDate","line":178,"lineEnd":186,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"loading":{"doclet":{"description":"The loading text that appears when the chart is set into the loading\nstate following a call to `chart.showLoading`.","type":{"names":["string"]},"defaultvalue":"Loading..."},"meta":{"fullname":"lang.loading","name":"loading","line":127,"lineEnd":130,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"Loading..."},"children":{}},"locale":{"doclet":{"description":"The browser locale to use for date and number formatting. The actual\nlocale used for each chart is determined in three steps:\n1. If this `lang.locale` option is specified, it is used.\n2. Else, look for the closest ancestor HTML element with a `lang`\n   attribute, typically the `<html>` element.\n3. If no 'lang' attribute is found, use the default browser locale.\n\nUse `en-GB`, British English, for approximate consistency with\nHighcharts v < 12.","samples":[{"name":"Set the locale using the `lang.locale` option","value":"highcharts/lang/locale/"},{"name":"Pick up the locale from the HTML `lang` attribute","value":"highcharts/lang/locale-attribute/"},{"name":"Arabic locale with digits and dates *","value":"highcharts/members/highcharts-numberformat"}],"since":"12.0.0","type":{"names":["string","Array.<string>"]},"defaultvalue":"undefined"},"meta":{"fullname":"lang.locale","name":"locale","line":105,"lineEnd":125,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"undefined"},"children":{}},"mainBreadcrumb":{"doclet":{"description":"The text for the main breadcrumb.","since":"10.0.0","products":["highcharts","highmaps"],"type":{"names":["string"]},"defaultvalue":"Main"},"meta":{"fullname":"lang.mainBreadcrumb","name":"mainBreadcrumb","line":22,"lineEnd":27,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":"Main"},"children":{}},"months":{"doclet":{"description":"An array containing the months names. Corresponds to the `%B` format\nin `Highcharts.dateFormat()`. Defaults to 'undefined',\nmeaning the default month names are used according to the\n`lang.locale` or browser settings.","type":{"names":["Array.<string>"]},"defaultvalue":"undefined"},"meta":{"fullname":"lang.months","name":"months","line":132,"lineEnd":139,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"undefined"},"children":{}},"navigation":{"doclet":{"description":"Configure the Popup strings in the chart. Requires the\n`annotations.js` or `annotations-advanced.src.js` module to be\nloaded.","since":"7.0.0","products":["highcharts","highstock"],"type":{"names":["*"]}},"meta":{"fullname":"lang.navigation","name":"navigation","line":98,"lineEnd":98,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"popup":{"doclet":{"description":"Translations for all field names used in popup.","products":["highcharts","highstock"],"since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"lang.navigation.popup","name":"popup","line":99,"lineEnd":99,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"addButton":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Add"},"meta":{"fullname":"lang.navigation.popup.addButton","name":"addButton","line":132,"lineEnd":132,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Add"},"children":{}},"algorithm":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Algorithm"},"meta":{"fullname":"lang.navigation.popup.algorithm","name":"algorithm","line":164,"lineEnd":164,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Algorithm"},"children":{}},"arrowInfinityLine":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Arrow line"},"meta":{"fullname":"lang.navigation.popup.arrowInfinityLine","name":"arrowInfinityLine","line":110,"lineEnd":110,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Arrow line"},"children":{}},"arrowRay":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Arrow ray"},"meta":{"fullname":"lang.navigation.popup.arrowRay","name":"arrowRay","line":108,"lineEnd":108,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Arrow ray"},"children":{}},"arrowSegment":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Arrow segment"},"meta":{"fullname":"lang.navigation.popup.arrowSegment","name":"arrowSegment","line":106,"lineEnd":106,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Arrow segment"},"children":{}},"average":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Average"},"meta":{"fullname":"lang.navigation.popup.average","name":"average","line":179,"lineEnd":179,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Average"},"children":{}},"background":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Background"},"meta":{"fullname":"lang.navigation.popup.background","name":"background","line":146,"lineEnd":146,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Background"},"children":{}},"backgroundColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Background color"},"meta":{"fullname":"lang.navigation.popup.backgroundColor","name":"backgroundColor","line":54,"lineEnd":54,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Background color"},"children":{}},"backgroundColors":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Background colors"},"meta":{"fullname":"lang.navigation.popup.backgroundColors","name":"backgroundColors","line":55,"lineEnd":55,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Background colors"},"children":{}},"borderColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Border color"},"meta":{"fullname":"lang.navigation.popup.borderColor","name":"borderColor","line":56,"lineEnd":56,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Border color"},"children":{}},"borderRadius":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Border radius"},"meta":{"fullname":"lang.navigation.popup.borderRadius","name":"borderRadius","line":57,"lineEnd":57,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Border radius"},"children":{}},"borderWidth":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Border width"},"meta":{"fullname":"lang.navigation.popup.borderWidth","name":"borderWidth","line":58,"lineEnd":58,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Border width"},"children":{}},"bottomBand":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Bottom band"},"meta":{"fullname":"lang.navigation.popup.bottomBand","name":"bottomBand","line":166,"lineEnd":166,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Bottom band"},"children":{}},"circle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Circle"},"meta":{"fullname":"lang.navigation.popup.circle","name":"circle","line":100,"lineEnd":100,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Circle"},"children":{}},"clearFilter":{"doclet":{"type":{"names":["string"]},"defaultvalue":"✕ clear filter"},"meta":{"fullname":"lang.navigation.popup.clearFilter","name":"clearFilter","line":151,"lineEnd":151,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"✕ clear filter"},"children":{}},"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Color"},"meta":{"fullname":"lang.navigation.popup.color","name":"color","line":62,"lineEnd":62,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Color"},"children":{}},"connector":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Connector"},"meta":{"fullname":"lang.navigation.popup.connector","name":"connector","line":139,"lineEnd":139,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Connector"},"children":{}},"crooked3":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Crooked 3 line"},"meta":{"fullname":"lang.navigation.popup.crooked3","name":"crooked3","line":113,"lineEnd":113,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Crooked 3 line"},"children":{}},"crooked5":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Crooked 5 line"},"meta":{"fullname":"lang.navigation.popup.crooked5","name":"crooked5","line":114,"lineEnd":114,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Crooked 5 line"},"children":{}},"crosshairX":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Crosshair X"},"meta":{"fullname":"lang.navigation.popup.crosshairX","name":"crosshairX","line":143,"lineEnd":143,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Crosshair X"},"children":{}},"crosshairY":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Crosshair Y"},"meta":{"fullname":"lang.navigation.popup.crosshairY","name":"crosshairY","line":144,"lineEnd":144,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Crosshair Y"},"children":{}},"decimals":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Decimals"},"meta":{"fullname":"lang.navigation.popup.decimals","name":"decimals","line":163,"lineEnd":163,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Decimals"},"children":{}},"deviation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Deviation"},"meta":{"fullname":"lang.navigation.popup.deviation","name":"deviation","line":174,"lineEnd":174,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Deviation"},"children":{}},"editButton":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Edit"},"meta":{"fullname":"lang.navigation.popup.editButton","name":"editButton","line":135,"lineEnd":135,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Edit"},"children":{}},"elliott3":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Elliott 3 line"},"meta":{"fullname":"lang.navigation.popup.elliott3","name":"elliott3","line":115,"lineEnd":115,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Elliott 3 line"},"children":{}},"elliott5":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Elliott 5 line"},"meta":{"fullname":"lang.navigation.popup.elliott5","name":"elliott5","line":116,"lineEnd":116,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Elliott 5 line"},"children":{}},"ellipse":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Ellipse"},"meta":{"fullname":"lang.navigation.popup.ellipse","name":"ellipse","line":102,"lineEnd":102,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Ellipse"},"children":{}},"factor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Factor"},"meta":{"fullname":"lang.navigation.popup.factor","name":"factor","line":176,"lineEnd":176,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Factor"},"children":{}},"fastAvgPeriod":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Fast average period"},"meta":{"fullname":"lang.navigation.popup.fastAvgPeriod","name":"fastAvgPeriod","line":177,"lineEnd":177,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Fast average period"},"children":{}},"fibonacci":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Fibonacci"},"meta":{"fullname":"lang.navigation.popup.fibonacci","name":"fibonacci","line":120,"lineEnd":120,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Fibonacci"},"children":{}},"fibonacciTimeZones":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Fibonacci Time Zones"},"meta":{"fullname":"lang.navigation.popup.fibonacciTimeZones","name":"fibonacciTimeZones","line":121,"lineEnd":121,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Fibonacci Time Zones"},"children":{}},"fill":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Fill"},"meta":{"fullname":"lang.navigation.popup.fill","name":"fill","line":46,"lineEnd":46,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Fill"},"children":{}},"flags":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Flags"},"meta":{"fullname":"lang.navigation.popup.flags","name":"flags","line":130,"lineEnd":130,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Flags"},"children":{}},"fontSize":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Font size"},"meta":{"fullname":"lang.navigation.popup.fontSize","name":"fontSize","line":61,"lineEnd":61,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Font size"},"children":{}},"format":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Text"},"meta":{"fullname":"lang.navigation.popup.format","name":"format","line":47,"lineEnd":47,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Text"},"children":{}},"height":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Height"},"meta":{"fullname":"lang.navigation.popup.height","name":"height","line":63,"lineEnd":63,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Height"},"children":{}},"highIndex":{"doclet":{"type":{"names":["string"]},"defaultvalue":"High index"},"meta":{"fullname":"lang.navigation.popup.highIndex","name":"highIndex","line":172,"lineEnd":172,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"High index"},"children":{}},"horizontalLine":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Horizontal line"},"meta":{"fullname":"lang.navigation.popup.horizontalLine","name":"horizontalLine","line":111,"lineEnd":111,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Horizontal line"},"children":{}},"increment":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Increment"},"meta":{"fullname":"lang.navigation.popup.increment","name":"increment","line":169,"lineEnd":169,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Increment"},"children":{}},"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Index"},"meta":{"fullname":"lang.navigation.popup.index","name":"index","line":152,"lineEnd":152,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Index"},"children":{}},"indicatorAliases":{"doclet":{"description":"Configure the aliases for indicator names.","products":["highstock"],"since":"9.3.0","type":{"names":["*"]}},"meta":{"fullname":"lang.navigation.popup.indicatorAliases","name":"indicatorAliases","line":180,"lineEnd":185,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"abands":{"doclet":{"description":"Acceleration Bands alias.","defaultvalue":"['Acceleration Bands']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.abands","name":"abands","line":187,"lineEnd":187,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"ad":{"doclet":{"description":"Accumulation/Distribution alias.","defaultvalue":"['Accumulation/Distribution’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.ad","name":"ad","line":322,"lineEnd":327,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"ao":{"doclet":{"description":"Awesome oscillator alias.","defaultvalue":"['Awesome oscillator’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.ao","name":"ao","line":350,"lineEnd":355,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"apo":{"doclet":{"description":"Absolute price indicator alias.","defaultvalue":"['Absolute price indicator']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.apo","name":"apo","line":314,"lineEnd":314,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"aroon":{"doclet":{"description":"Aroon alias.","defaultvalue":"['Aroon']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.aroon","name":"aroon","line":329,"lineEnd":334,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"aroonoscillator":{"doclet":{"description":"Aroon oscillator alias.","defaultvalue":"['Aroon oscillator']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.aroonoscillator","name":"aroonoscillator","line":336,"lineEnd":341,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"atr":{"doclet":{"description":"Average True Range alias.","defaultvalue":"['Average True Range’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.atr","name":"atr","line":343,"lineEnd":348,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"bb":{"doclet":{"description":"Bollinger Bands alias.","defaultvalue":"['Bollinger Bands']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.bb","name":"bb","line":195,"lineEnd":200,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"cci":{"doclet":{"description":"Commodity Channel Index alias.","defaultvalue":"['Commodity Channel Index’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.cci","name":"cci","line":357,"lineEnd":362,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"chaikin":{"doclet":{"description":"Chaikin alias.","defaultvalue":"['Chaikin’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.chaikin","name":"chaikin","line":364,"lineEnd":369,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"cmf":{"doclet":{"description":"Chaikin Money Flow alias.","defaultvalue":"['Chaikin Money Flow’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.cmf","name":"cmf","line":371,"lineEnd":376,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"cmo":{"doclet":{"description":"Chande Momentum Oscillator alias.","defaultvalue":"['Chande Momentum Oscillator’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.cmo","name":"cmo","line":378,"lineEnd":383,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"dema":{"doclet":{"description":"Double Exponential Moving Average alias.","defaultvalue":"['Double Exponential Moving Average']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.dema","name":"dema","line":202,"lineEnd":207,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"disparityindex":{"doclet":{"description":"Disparity Index alias.","defaultvalue":"['Disparity Index’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.disparityindex","name":"disparityindex","line":385,"lineEnd":390,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"dmi":{"doclet":{"description":"Directional Movement Index alias.","defaultvalue":"['Directional Movement Index’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.dmi","name":"dmi","line":392,"lineEnd":397,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"dpo":{"doclet":{"description":"Detrended price oscillator alias.","defaultvalue":"['Detrended price oscillator’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.dpo","name":"dpo","line":399,"lineEnd":404,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"ema":{"doclet":{"description":"Exponential Moving Average alias.","defaultvalue":"['Exponential Moving Average']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.ema","name":"ema","line":209,"lineEnd":214,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"ikh":{"doclet":{"description":"Ichimoku Kinko Hyo alias.","defaultvalue":"['Ichimoku Kinko Hyo']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.ikh","name":"ikh","line":216,"lineEnd":221,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"keltnerchannels":{"doclet":{"description":"Keltner Channels alias.","defaultvalue":"['Keltner Channels']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.keltnerchannels","name":"keltnerchannels","line":223,"lineEnd":228,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"klinger":{"doclet":{"description":"Klinger Oscillator alias.","defaultvalue":"[‘Klinger Oscillator’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.klinger","name":"klinger","line":406,"lineEnd":411,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"linearRegression":{"doclet":{"description":"Linear Regression alias.","defaultvalue":"['Linear Regression']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.linearRegression","name":"linearRegression","line":230,"lineEnd":235,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"linearRegressionAngle":{"doclet":{"description":"Linear Regression Angle alias.","defaultvalue":"[‘Linear Regression Angle’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.linearRegressionAngle","name":"linearRegressionAngle","line":413,"lineEnd":418,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"linearRegressionIntercept":{"doclet":{"description":"Linear Regression Intercept alias.","defaultvalue":"[‘Linear Regression Intercept’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.linearRegressionIntercept","name":"linearRegressionIntercept","line":420,"lineEnd":425,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"linearRegressionSlope":{"doclet":{"description":"Linear Regression Slope alias.","defaultvalue":"[‘Linear Regression Slope’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.linearRegressionSlope","name":"linearRegressionSlope","line":427,"lineEnd":432,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"macd":{"doclet":{"description":"Moving Average Convergence Divergence alias.","defaultvalue":"['Moving Average Convergence Divergence’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.macd","name":"macd","line":434,"lineEnd":439,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"mfi":{"doclet":{"description":"Money Flow Index alias.","defaultvalue":"['Money Flow Index’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.mfi","name":"mfi","line":441,"lineEnd":446,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"momentum":{"doclet":{"description":"Momentum alias.","defaultvalue":"[‘Momentum’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.momentum","name":"momentum","line":448,"lineEnd":453,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"natr":{"doclet":{"description":"Normalized Average True Range alias.","defaultvalue":"['Normalized Average True Range’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.natr","name":"natr","line":455,"lineEnd":460,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"obv":{"doclet":{"description":"On-Balance Volume alias.","defaultvalue":"['On-Balance Volume’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.obv","name":"obv","line":462,"lineEnd":467,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"pc":{"doclet":{"description":"Price Channel alias.","defaultvalue":"['Price Channel']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.pc","name":"pc","line":244,"lineEnd":249,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"pivotpoints":{"doclet":{"description":"Pivot Points alias.","defaultvalue":"['Pivot Points']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.pivotpoints","name":"pivotpoints","line":237,"lineEnd":242,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"ppo":{"doclet":{"description":"Percentage Price oscillator alias.","defaultvalue":"['Percentage Price oscillator’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.ppo","name":"ppo","line":469,"lineEnd":474,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"priceenvelopes":{"doclet":{"description":"Price Envelopes alias.","defaultvalue":"['Price Envelopes']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.priceenvelopes","name":"priceenvelopes","line":251,"lineEnd":256,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"psar":{"doclet":{"description":"Parabolic SAR alias.","defaultvalue":"['Parabolic SAR']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.psar","name":"psar","line":258,"lineEnd":263,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"roc":{"doclet":{"description":"Rate of Change alias.","defaultvalue":"['Rate of Change’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.roc","name":"roc","line":476,"lineEnd":481,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"rsi":{"doclet":{"description":"Relative Strength Index alias.","defaultvalue":"['Relative Strength Index’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.rsi","name":"rsi","line":483,"lineEnd":488,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"slowstochastic":{"doclet":{"description":"Slow Stochastic alias.","defaultvalue":"[‘Slow Stochastic’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.slowstochastic","name":"slowstochastic","line":490,"lineEnd":495,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"sma":{"doclet":{"description":"Simple Moving Average alias.","defaultvalue":"['Simple Moving Average']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.sma","name":"sma","line":265,"lineEnd":270,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"stochastic":{"doclet":{"description":"Stochastic alias.","defaultvalue":"[‘Stochastic’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.stochastic","name":"stochastic","line":497,"lineEnd":502,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"supertrend":{"doclet":{"description":"Super Trend alias.","defaultvalue":"['Super Trend']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.supertrend","name":"supertrend","line":272,"lineEnd":277,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"tema":{"doclet":{"description":"Triple Exponential Moving Average alias.","defaultvalue":"['Triple Exponential Moving Average']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.tema","name":"tema","line":279,"lineEnd":284,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"trix":{"doclet":{"description":"TRIX alias.","defaultvalue":"[‘TRIX’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.trix","name":"trix","line":504,"lineEnd":509,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"vbp":{"doclet":{"description":"Volume by Price alias.","defaultvalue":"['Volume by Price']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.vbp","name":"vbp","line":286,"lineEnd":291,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"vwap":{"doclet":{"description":"Volume Weighted Moving Average alias.","defaultvalue":"['Volume Weighted Moving Average']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.vwap","name":"vwap","line":293,"lineEnd":298,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"williamsr":{"doclet":{"description":"Williams %R alias.","defaultvalue":"[‘Williams %R’]","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.williamsr","name":"williamsr","line":511,"lineEnd":516,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"wma":{"doclet":{"description":"Weighted Moving Average alias.","defaultvalue":"['Weighted Moving Average']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.wma","name":"wma","line":300,"lineEnd":305,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"zigzag":{"doclet":{"description":"Zig Zagalias.","defaultvalue":"['Zig Zag']","type":{"names":["Array.<string>"]},"since":"9.3.0"},"meta":{"fullname":"lang.navigation.popup.indicatorAliases.zigzag","name":"zigzag","line":307,"lineEnd":312,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}}}},"infinityLine":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Infinity line"},"meta":{"fullname":"lang.navigation.popup.infinityLine","name":"infinityLine","line":124,"lineEnd":124,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Infinity line"},"children":{}},"initialAccelerationFactor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Initial acceleration factor"},"meta":{"fullname":"lang.navigation.popup.initialAccelerationFactor","name":"initialAccelerationFactor","line":167,"lineEnd":167,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Initial acceleration factor"},"children":{}},"innerBackground":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Inner background"},"meta":{"fullname":"lang.navigation.popup.innerBackground","name":"innerBackground","line":140,"lineEnd":140,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Inner background"},"children":{}},"label":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Label"},"meta":{"fullname":"lang.navigation.popup.label","name":"label","line":104,"lineEnd":104,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Label"},"children":{}},"labelOptions":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Label options"},"meta":{"fullname":"lang.navigation.popup.labelOptions","name":"labelOptions","line":52,"lineEnd":52,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Label options"},"children":{}},"labels":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Labels"},"meta":{"fullname":"lang.navigation.popup.labels","name":"labels","line":53,"lineEnd":53,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Labels"},"children":{}},"line":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Line"},"meta":{"fullname":"lang.navigation.popup.line","name":"line","line":109,"lineEnd":109,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Line"},"children":{}},"lines":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Lines"},"meta":{"fullname":"lang.navigation.popup.lines","name":"lines","line":39,"lineEnd":39,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Lines"},"children":{}},"longPeriod":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Long period"},"meta":{"fullname":"lang.navigation.popup.longPeriod","name":"longPeriod","line":161,"lineEnd":161,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Long period"},"children":{}},"lowIndex":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Low index"},"meta":{"fullname":"lang.navigation.popup.lowIndex","name":"lowIndex","line":173,"lineEnd":173,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Low index"},"children":{}},"maxAccelerationFactor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Max acceleration factor"},"meta":{"fullname":"lang.navigation.popup.maxAccelerationFactor","name":"maxAccelerationFactor","line":168,"lineEnd":168,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Max acceleration factor"},"children":{}},"measure":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Measure"},"meta":{"fullname":"lang.navigation.popup.measure","name":"measure","line":125,"lineEnd":125,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Measure"},"children":{}},"measureX":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Measure X"},"meta":{"fullname":"lang.navigation.popup.measureX","name":"measureX","line":127,"lineEnd":127,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Measure X"},"children":{}},"measureXY":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Measure XY"},"meta":{"fullname":"lang.navigation.popup.measureXY","name":"measureXY","line":126,"lineEnd":126,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Measure XY"},"children":{}},"measureY":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Measure Y"},"meta":{"fullname":"lang.navigation.popup.measureY","name":"measureY","line":128,"lineEnd":128,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Measure Y"},"children":{}},"multiplier":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Multiplier"},"meta":{"fullname":"lang.navigation.popup.multiplier","name":"multiplier","line":170,"lineEnd":170,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Multiplier"},"children":{}},"multiplierATR":{"doclet":{"type":{"names":["string"]},"defaultvalue":"ATR multiplier"},"meta":{"fullname":"lang.navigation.popup.multiplierATR","name":"multiplierATR","line":159,"lineEnd":159,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"ATR multiplier"},"children":{}},"name":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Name"},"meta":{"fullname":"lang.navigation.popup.name","name":"name","line":51,"lineEnd":51,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Name"},"children":{}},"noFilterMatch":{"doclet":{"type":{"names":["string"]},"defaultvalue":"No match"},"meta":{"fullname":"lang.navigation.popup.noFilterMatch","name":"noFilterMatch","line":147,"lineEnd":147,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"No match"},"children":{}},"outerBackground":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Outer background"},"meta":{"fullname":"lang.navigation.popup.outerBackground","name":"outerBackground","line":142,"lineEnd":142,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Outer background"},"children":{}},"padding":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Padding"},"meta":{"fullname":"lang.navigation.popup.padding","name":"padding","line":60,"lineEnd":60,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Padding"},"children":{}},"parallelChannel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Parallel channel"},"meta":{"fullname":"lang.navigation.popup.parallelChannel","name":"parallelChannel","line":123,"lineEnd":123,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Parallel channel"},"children":{}},"period":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Period"},"meta":{"fullname":"lang.navigation.popup.period","name":"period","line":153,"lineEnd":153,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Period"},"children":{}},"periodATR":{"doclet":{"type":{"names":["string"]},"defaultvalue":"ATR period"},"meta":{"fullname":"lang.navigation.popup.periodATR","name":"periodATR","line":158,"lineEnd":158,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"ATR period"},"children":{}},"periodSenkouSpanB":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Senkou Span B period"},"meta":{"fullname":"lang.navigation.popup.periodSenkouSpanB","name":"periodSenkouSpanB","line":157,"lineEnd":157,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Senkou Span B period"},"children":{}},"periodTenkan":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Tenkan period"},"meta":{"fullname":"lang.navigation.popup.periodTenkan","name":"periodTenkan","line":156,"lineEnd":156,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Tenkan period"},"children":{}},"periods":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Periods"},"meta":{"fullname":"lang.navigation.popup.periods","name":"periods","line":154,"lineEnd":154,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Periods"},"children":{}},"pitchfork":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Pitchfork"},"meta":{"fullname":"lang.navigation.popup.pitchfork","name":"pitchfork","line":122,"lineEnd":122,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Pitchfork"},"children":{}},"ranges":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Ranges"},"meta":{"fullname":"lang.navigation.popup.ranges","name":"ranges","line":171,"lineEnd":171,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Ranges"},"children":{}},"ray":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Ray"},"meta":{"fullname":"lang.navigation.popup.ray","name":"ray","line":107,"lineEnd":107,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Ray"},"children":{}},"rectangle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Rectangle"},"meta":{"fullname":"lang.navigation.popup.rectangle","name":"rectangle","line":103,"lineEnd":103,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Rectangle"},"children":{}},"removeButton":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Remove"},"meta":{"fullname":"lang.navigation.popup.removeButton","name":"removeButton","line":136,"lineEnd":136,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Remove"},"children":{}},"saveButton":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Save"},"meta":{"fullname":"lang.navigation.popup.saveButton","name":"saveButton","line":134,"lineEnd":134,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Save"},"children":{}},"searchIndicators":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Search Indicators"},"meta":{"fullname":"lang.navigation.popup.searchIndicators","name":"searchIndicators","line":149,"lineEnd":149,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Search Indicators"},"children":{}},"segment":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Segment"},"meta":{"fullname":"lang.navigation.popup.segment","name":"segment","line":105,"lineEnd":105,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Segment"},"children":{}},"series":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Series"},"meta":{"fullname":"lang.navigation.popup.series","name":"series","line":137,"lineEnd":137,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Series"},"children":{}},"shapeOptions":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Shape options"},"meta":{"fullname":"lang.navigation.popup.shapeOptions","name":"shapeOptions","line":44,"lineEnd":44,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Shape options"},"children":{}},"shapes":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Shape options"},"meta":{"fullname":"lang.navigation.popup.shapes","name":"shapes","line":64,"lineEnd":64,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Shape options"},"children":{}},"shortPeriod":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Short period"},"meta":{"fullname":"lang.navigation.popup.shortPeriod","name":"shortPeriod","line":160,"lineEnd":160,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Short period"},"children":{}},"signalPeriod":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Signal period"},"meta":{"fullname":"lang.navigation.popup.signalPeriod","name":"signalPeriod","line":162,"lineEnd":162,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Signal period"},"children":{}},"simpleShapes":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Simple shapes"},"meta":{"fullname":"lang.navigation.popup.simpleShapes","name":"simpleShapes","line":38,"lineEnd":38,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Simple shapes"},"children":{}},"slowAvgPeriod":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Slow average period"},"meta":{"fullname":"lang.navigation.popup.slowAvgPeriod","name":"slowAvgPeriod","line":178,"lineEnd":178,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Slow average period"},"children":{}},"standardDeviation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Standard deviation"},"meta":{"fullname":"lang.navigation.popup.standardDeviation","name":"standardDeviation","line":155,"lineEnd":155,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Standard deviation"},"children":{}},"stroke":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Line color"},"meta":{"fullname":"lang.navigation.popup.stroke","name":"stroke","line":49,"lineEnd":49,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Line color"},"children":{}},"strokeWidth":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Line width"},"meta":{"fullname":"lang.navigation.popup.strokeWidth","name":"strokeWidth","line":48,"lineEnd":48,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Line width"},"children":{}},"style":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Style"},"meta":{"fullname":"lang.navigation.popup.style","name":"style","line":59,"lineEnd":59,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Style"},"children":{}},"timeCycles":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Time Cycles"},"meta":{"fullname":"lang.navigation.popup.timeCycles","name":"timeCycles","line":129,"lineEnd":129,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Time Cycles"},"children":{}},"title":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Title"},"meta":{"fullname":"lang.navigation.popup.title","name":"title","line":50,"lineEnd":50,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Title"},"children":{}},"topBand":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Top band"},"meta":{"fullname":"lang.navigation.popup.topBand","name":"topBand","line":165,"lineEnd":165,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Top band"},"children":{}},"tunnel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Tunnel"},"meta":{"fullname":"lang.navigation.popup.tunnel","name":"tunnel","line":145,"lineEnd":145,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Tunnel"},"children":{}},"typeOptions":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Details"},"meta":{"fullname":"lang.navigation.popup.typeOptions","name":"typeOptions","line":45,"lineEnd":45,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"Details"},"children":{}},"verticalArrow":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Vertical arrow"},"meta":{"fullname":"lang.navigation.popup.verticalArrow","name":"verticalArrow","line":119,"lineEnd":119,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Vertical arrow"},"children":{}},"verticalCounter":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Vertical counter"},"meta":{"fullname":"lang.navigation.popup.verticalCounter","name":"verticalCounter","line":117,"lineEnd":117,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Vertical counter"},"children":{}},"verticalLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Vertical label"},"meta":{"fullname":"lang.navigation.popup.verticalLabel","name":"verticalLabel","line":118,"lineEnd":118,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Vertical label"},"children":{}},"verticalLine":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Vertical line"},"meta":{"fullname":"lang.navigation.popup.verticalLine","name":"verticalLine","line":112,"lineEnd":112,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Vertical line"},"children":{}},"volume":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Volume"},"meta":{"fullname":"lang.navigation.popup.volume","name":"volume","line":138,"lineEnd":138,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Volume"},"children":{}},"xAxisUnit":{"doclet":{"type":{"names":["string"]},"defaultvalue":"x-axis unit"},"meta":{"fullname":"lang.navigation.popup.xAxisUnit","name":"xAxisUnit","line":175,"lineEnd":175,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"x-axis unit"},"children":{}}}}}},"noData":{"doclet":{"description":"The text to display when the chart contains no data.","see":["[noData](#noData)"],"samples":[{"name":"No-data text","value":"highcharts/no-data-to-display/no-data-line"}],"since":"3.0.8","products":["highcharts","highstock"],"requires":["module:modules/no-data-to-display"],"type":{"names":["string"]},"defaultvalue":"No data to display"},"meta":{"fullname":"lang.noData","name":"noData","line":24,"lineEnd":35,"column":4,"filename":"code/es-modules/Extensions/NoDataToDisplay/NoDataDefaults.js","default":"No data to display"},"children":{}},"numericSymbolMagnitude":{"doclet":{"description":"The magnitude of [numericSymbols](#lang.numericSymbol) replacements.\nUse 10000 for Japanese, Korean and various Chinese locales, which\nuse symbols for 10^4, 10^8 and 10^12.","samples":[{"name":"10000 magnitude for Japanese","value":"highcharts/lang/numericsymbolmagnitude/"}],"type":{"names":["number"]},"defaultvalue":"1000","since":"5.0.3"},"meta":{"fullname":"lang.numericSymbolMagnitude","name":"numericSymbolMagnitude","line":236,"lineEnd":248,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"numericSymbols":{"doclet":{"description":"[Metric prefixes](https://en.wikipedia.org/wiki/Metric_prefix) used\nto shorten high numbers in axis labels. Replacing any of the\npositions with `null` causes the full number to be written. Setting\n`numericSymbols` to `undefined` disables shortening altogether.","samples":[{"name":"Replacing the symbols with text","value":"highcharts/lang/numericsymbols/","products":["highcharts"]},{"name":"Replacing the symbols with text","value":"highcharts/lang/numericsymbols/","products":["highstock"]}],"type":{"names":["Array.<string>"]},"defaultvalue":"[\"k\", \"M\", \"G\", \"T\", \"P\", \"E\"]","since":"2.3.0"},"meta":{"fullname":"lang.numericSymbols","name":"numericSymbols","line":165,"lineEnd":177,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"pieSliceName":{"doclet":{"description":"The default name for a pie slice (point).","since":"12.2.0","type":{"names":["string"]},"defaultvalue":"Slice"},"meta":{"fullname":"lang.pieSliceName","name":"pieSliceName","line":231,"lineEnd":234,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"Slice"},"children":{}},"playAsSound":{"doclet":{"description":"The text for the Play as sound menu item in the export menu.","requires":["module:modules/sonification"],"since":"11.0.0"},"meta":{"fullname":"lang.playAsSound","name":"playAsSound","line":919,"lineEnd":925,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"printChart":{"doclet":{"description":"Exporting module only. The text for the menu item to print the chart.","since":"3.0.1","requires":["module:modules/exporting"],"type":{"names":["string"]},"defaultvalue":"Print chart"},"meta":{"fullname":"lang.printChart","name":"printChart","line":561,"lineEnd":566,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"Print chart"},"children":{}},"rangeSelector":{"doclet":{"description":"The default text for the rangeselector buttons.","since":"12.2.0","type":{"names":["*"]}},"meta":{"fullname":"lang.rangeSelector","name":"rangeSelector","line":53,"lineEnd":57,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{"allText":{"doclet":{"type":{"names":["string"]},"defaultvalue":"All"},"meta":{"fullname":"lang.rangeSelector.allText","name":"allText","line":59,"lineEnd":59,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"All"},"children":{}},"allTitle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"View all"},"meta":{"fullname":"lang.rangeSelector.allTitle","name":"allTitle","line":60,"lineEnd":60,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"View all"},"children":{}},"monthText":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{count}m"},"meta":{"fullname":"lang.rangeSelector.monthText","name":"monthText","line":61,"lineEnd":61,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"{count}m"},"children":{}},"monthTitle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"View {count} {#eq count 1}month{else}months{/eq}"},"meta":{"fullname":"lang.rangeSelector.monthTitle","name":"monthTitle","line":62,"lineEnd":62,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"View {count} {#eq count 1}month{else}months{/eq}"},"children":{}},"yearText":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{count}y"},"meta":{"fullname":"lang.rangeSelector.yearText","name":"yearText","line":63,"lineEnd":63,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"{count}y"},"children":{}},"yearTitle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"View {count} {#eq count 1}year{else}years{/eq}"},"meta":{"fullname":"lang.rangeSelector.yearTitle","name":"yearTitle","line":64,"lineEnd":64,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"View {count} {#eq count 1}year{else}years{/eq}"},"children":{}},"ytdText":{"doclet":{"type":{"names":["string"]},"defaultvalue":"YTD"},"meta":{"fullname":"lang.rangeSelector.ytdText","name":"ytdText","line":65,"lineEnd":65,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"YTD"},"children":{}},"ytdTitle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"View year to date"},"meta":{"fullname":"lang.rangeSelector.ytdTitle","name":"ytdTitle","line":66,"lineEnd":66,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"View year to date"},"children":{}}}},"rangeSelectorFrom":{"doclet":{"description":"The text for the label for the \"from\" input box in the range\nselector. Since v9.0, this string is empty as the label is not\nrendered by default.","products":["highstock","gantt"],"type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"lang.rangeSelectorFrom","name":"rangeSelectorFrom","line":39,"lineEnd":45,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":""},"children":{}},"rangeSelectorTo":{"doclet":{"description":"The text for the label for the \"to\" input box in the range selector.","products":["highstock","gantt"],"type":{"names":["string"]},"defaultvalue":"→"},"meta":{"fullname":"lang.rangeSelectorTo","name":"rangeSelectorTo","line":47,"lineEnd":51,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"→"},"children":{}},"rangeSelectorZoom":{"doclet":{"description":"The text for the label for the range selector buttons.","products":["highstock","gantt"],"type":{"names":["string"]},"defaultvalue":"Zoom"},"meta":{"fullname":"lang.rangeSelectorZoom","name":"rangeSelectorZoom","line":33,"lineEnd":37,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"Zoom"},"children":{}},"resetZoom":{"doclet":{"description":"The text for the label appearing when a chart is zoomed.","since":"1.2.4","type":{"names":["string"]},"defaultvalue":"Reset zoom"},"meta":{"fullname":"lang.resetZoom","name":"resetZoom","line":236,"lineEnd":248,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"Reset zoom"},"children":{}},"resetZoomTitle":{"doclet":{"description":"The tooltip title for the label appearing when a chart is zoomed.","since":"1.2.4","type":{"names":["string"]},"defaultvalue":"Reset zoom level 1:1"},"meta":{"fullname":"lang.resetZoomTitle","name":"resetZoomTitle","line":271,"lineEnd":275,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"Reset zoom level 1:1"},"children":{}},"seriesName":{"doclet":{"description":"[Format string](https://www.highcharts.com/docs/chart-concepts/templating) for the default series name.","since":"12.2.0","type":{"names":["string"]},"defaultvalue":"Series {add index 1}"},"meta":{"fullname":"lang.seriesName","name":"seriesName","line":141,"lineEnd":145,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"Series {add index 1}"},"children":{}},"shortMonths":{"doclet":{"description":"An array containing the months names in abbreviated form. Corresponds\nto the `%b` format in `Highcharts.dateFormat()`. Defaults to\n'undefined', meaning the default short month names are used according\nto the `lang.locale` or browser settings.","type":{"names":["Array.<string>"]},"defaultvalue":"undefined"},"meta":{"fullname":"lang.shortMonths","name":"shortMonths","line":147,"lineEnd":154,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"undefined"},"children":{}},"shortWeekdays":{"doclet":{"description":"Short week days, starting Sunday. Corresponds to the `%a` format in\n`Highcharts.dateFormat()`. Defaults to 'undefined', meaning\nthe default short weekday names are used according to the\n`lang.locale` or browser settings.","samples":[{"name":"Finnish two-letter abbreviations","value":"highcharts/lang/shortweekdays/"}],"type":{"names":["Array.<string>"]},"since":"4.2.4"},"meta":{"fullname":"lang.shortWeekdays","name":"shortWeekdays","line":165,"lineEnd":177,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"stockTools":{"doclet":{"description":"Configure the stockTools GUI titles(hints) in the chart. Requires\nthe `stock-tools.js` module to be loaded.","products":["highstock"],"since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"lang.stockTools","name":"stockTools","line":23,"lineEnd":29,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"gui":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"lang.stockTools.gui","name":"gui","line":31,"lineEnd":31,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"advanced":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Advanced"},"meta":{"fullname":"lang.stockTools.gui.advanced","name":"advanced","line":37,"lineEnd":37,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Advanced"},"children":{}},"arrowInfinityLine":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Arrow line"},"meta":{"fullname":"lang.stockTools.gui.arrowInfinityLine","name":"arrowInfinityLine","line":77,"lineEnd":77,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Arrow line"},"children":{}},"arrowRay":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Arrow ray"},"meta":{"fullname":"lang.stockTools.gui.arrowRay","name":"arrowRay","line":75,"lineEnd":75,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Arrow ray"},"children":{}},"arrowSegment":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Arrow segment"},"meta":{"fullname":"lang.stockTools.gui.arrowSegment","name":"arrowSegment","line":73,"lineEnd":73,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Arrow segment"},"children":{}},"circle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Circle"},"meta":{"fullname":"lang.stockTools.gui.circle","name":"circle","line":57,"lineEnd":57,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Circle"},"children":{}},"crooked3":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Crooked 3 line"},"meta":{"fullname":"lang.stockTools.gui.crooked3","name":"crooked3","line":81,"lineEnd":81,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Crooked 3 line"},"children":{}},"crooked5":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Crooked 5 line"},"meta":{"fullname":"lang.stockTools.gui.crooked5","name":"crooked5","line":83,"lineEnd":83,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Crooked 5 line"},"children":{}},"crookedLines":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Crooked lines"},"meta":{"fullname":"lang.stockTools.gui.crookedLines","name":"crookedLines","line":35,"lineEnd":35,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Crooked lines"},"children":{}},"currentPriceIndicator":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Current Price Indicators"},"meta":{"fullname":"lang.stockTools.gui.currentPriceIndicator","name":"currentPriceIndicator","line":45,"lineEnd":45,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Current Price Indicators"},"children":{}},"elliott3":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Elliott 3 line"},"meta":{"fullname":"lang.stockTools.gui.elliott3","name":"elliott3","line":84,"lineEnd":84,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Elliott 3 line"},"children":{}},"elliott5":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Elliott 5 line"},"meta":{"fullname":"lang.stockTools.gui.elliott5","name":"elliott5","line":85,"lineEnd":85,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Elliott 5 line"},"children":{}},"ellipse":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Ellipse"},"meta":{"fullname":"lang.stockTools.gui.ellipse","name":"ellipse","line":59,"lineEnd":59,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Ellipse"},"children":{}},"fibonacci":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Fibonacci"},"meta":{"fullname":"lang.stockTools.gui.fibonacci","name":"fibonacci","line":90,"lineEnd":90,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Fibonacci"},"children":{}},"fibonacciTimeZones":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Fibonacci Time Zones"},"meta":{"fullname":"lang.stockTools.gui.fibonacciTimeZones","name":"fibonacciTimeZones","line":92,"lineEnd":92,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Fibonacci Time Zones"},"children":{}},"flagCirclepin":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Flag circle"},"meta":{"fullname":"lang.stockTools.gui.flagCirclepin","name":"flagCirclepin","line":62,"lineEnd":62,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Flag circle"},"children":{}},"flagDiamondpin":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Flag diamond"},"meta":{"fullname":"lang.stockTools.gui.flagDiamondpin","name":"flagDiamondpin","line":64,"lineEnd":64,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Flag diamond"},"children":{}},"flagSimplepin":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Flag simple"},"meta":{"fullname":"lang.stockTools.gui.flagSimplepin","name":"flagSimplepin","line":66,"lineEnd":66,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Flag simple"},"children":{}},"flagSquarepin":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Flag square"},"meta":{"fullname":"lang.stockTools.gui.flagSquarepin","name":"flagSquarepin","line":65,"lineEnd":65,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Flag square"},"children":{}},"flags":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Flags"},"meta":{"fullname":"lang.stockTools.gui.flags","name":"flags","line":40,"lineEnd":40,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Flags"},"children":{}},"fullScreen":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Fullscreen"},"meta":{"fullname":"lang.stockTools.gui.fullScreen","name":"fullScreen","line":50,"lineEnd":50,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Fullscreen"},"children":{}},"horizontalLine":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Horizontal line"},"meta":{"fullname":"lang.stockTools.gui.horizontalLine","name":"horizontalLine","line":78,"lineEnd":78,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Horizontal line"},"children":{}},"indicators":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Indicators"},"meta":{"fullname":"lang.stockTools.gui.indicators","name":"indicators","line":44,"lineEnd":44,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Indicators"},"children":{}},"infinityLine":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Infinity line"},"meta":{"fullname":"lang.stockTools.gui.infinityLine","name":"infinityLine","line":80,"lineEnd":80,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Infinity line"},"children":{}},"label":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Label"},"meta":{"fullname":"lang.stockTools.gui.label","name":"label","line":60,"lineEnd":60,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Label"},"children":{}},"line":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Line"},"meta":{"fullname":"lang.stockTools.gui.line","name":"line","line":76,"lineEnd":76,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Line"},"children":{}},"lines":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Lines"},"meta":{"fullname":"lang.stockTools.gui.lines","name":"lines","line":34,"lineEnd":34,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Lines"},"children":{}},"measure":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Measure"},"meta":{"fullname":"lang.stockTools.gui.measure","name":"measure","line":36,"lineEnd":36,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Measure"},"children":{}},"measureX":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Measure X"},"meta":{"fullname":"lang.stockTools.gui.measureX","name":"measureX","line":69,"lineEnd":69,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Measure X"},"children":{}},"measureXY":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Measure XY"},"meta":{"fullname":"lang.stockTools.gui.measureXY","name":"measureXY","line":67,"lineEnd":67,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Measure XY"},"children":{}},"measureY":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Measure Y"},"meta":{"fullname":"lang.stockTools.gui.measureY","name":"measureY","line":70,"lineEnd":70,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Measure Y"},"children":{}},"parallelChannel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Parallel channel"},"meta":{"fullname":"lang.stockTools.gui.parallelChannel","name":"parallelChannel","line":94,"lineEnd":94,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Parallel channel"},"children":{}},"pitchfork":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Pitchfork"},"meta":{"fullname":"lang.stockTools.gui.pitchfork","name":"pitchfork","line":93,"lineEnd":93,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Pitchfork"},"children":{}},"ray":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Ray"},"meta":{"fullname":"lang.stockTools.gui.ray","name":"ray","line":74,"lineEnd":74,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Ray"},"children":{}},"rectangle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Rectangle"},"meta":{"fullname":"lang.stockTools.gui.rectangle","name":"rectangle","line":61,"lineEnd":61,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Rectangle"},"children":{}},"saveChart":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Save chart"},"meta":{"fullname":"lang.stockTools.gui.saveChart","name":"saveChart","line":43,"lineEnd":43,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Save chart"},"children":{}},"segment":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Segment"},"meta":{"fullname":"lang.stockTools.gui.segment","name":"segment","line":71,"lineEnd":71,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Segment"},"children":{}},"simpleShapes":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Simple shapes"},"meta":{"fullname":"lang.stockTools.gui.simpleShapes","name":"simpleShapes","line":32,"lineEnd":32,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Simple shapes"},"children":{}},"timeCycles":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Time Cycles"},"meta":{"fullname":"lang.stockTools.gui.timeCycles","name":"timeCycles","line":95,"lineEnd":95,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Time Cycles"},"children":{}},"toggleAnnotations":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Toggle annotations"},"meta":{"fullname":"lang.stockTools.gui.toggleAnnotations","name":"toggleAnnotations","line":38,"lineEnd":38,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Toggle annotations"},"children":{}},"typeCandlestick":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Candlestick"},"meta":{"fullname":"lang.stockTools.gui.typeCandlestick","name":"typeCandlestick","line":53,"lineEnd":53,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Candlestick"},"children":{}},"typeChange":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Type change"},"meta":{"fullname":"lang.stockTools.gui.typeChange","name":"typeChange","line":42,"lineEnd":42,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Type change"},"children":{}},"typeHLC":{"doclet":{"type":{"names":["string"]},"defaultvalue":"HLC"},"meta":{"fullname":"lang.stockTools.gui.typeHLC","name":"typeHLC","line":54,"lineEnd":54,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"HLC"},"children":{}},"typeHeikinAshi":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Heikin Ashi"},"meta":{"fullname":"lang.stockTools.gui.typeHeikinAshi","name":"typeHeikinAshi","line":56,"lineEnd":56,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Heikin Ashi"},"children":{}},"typeHollowCandlestick":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Hollow Candlestick"},"meta":{"fullname":"lang.stockTools.gui.typeHollowCandlestick","name":"typeHollowCandlestick","line":55,"lineEnd":55,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Hollow Candlestick"},"children":{}},"typeLine":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Line"},"meta":{"fullname":"lang.stockTools.gui.typeLine","name":"typeLine","line":52,"lineEnd":52,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Line"},"children":{}},"typeOHLC":{"doclet":{"type":{"names":["string"]},"defaultvalue":"OHLC"},"meta":{"fullname":"lang.stockTools.gui.typeOHLC","name":"typeOHLC","line":51,"lineEnd":51,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"OHLC"},"children":{}},"verticalArrow":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Vertical arrow"},"meta":{"fullname":"lang.stockTools.gui.verticalArrow","name":"verticalArrow","line":89,"lineEnd":89,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Vertical arrow"},"children":{}},"verticalCounter":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Vertical counter"},"meta":{"fullname":"lang.stockTools.gui.verticalCounter","name":"verticalCounter","line":86,"lineEnd":86,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Vertical counter"},"children":{}},"verticalLabel":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Vertical label"},"meta":{"fullname":"lang.stockTools.gui.verticalLabel","name":"verticalLabel","line":88,"lineEnd":88,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Vertical label"},"children":{}},"verticalLabels":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Vertical labels"},"meta":{"fullname":"lang.stockTools.gui.verticalLabels","name":"verticalLabels","line":39,"lineEnd":39,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Vertical labels"},"children":{}},"verticalLine":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Vertical line"},"meta":{"fullname":"lang.stockTools.gui.verticalLine","name":"verticalLine","line":79,"lineEnd":79,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Vertical line"},"children":{}},"zoomChange":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Zoom change"},"meta":{"fullname":"lang.stockTools.gui.zoomChange","name":"zoomChange","line":41,"lineEnd":41,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Zoom change"},"children":{}},"zoomX":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Zoom X"},"meta":{"fullname":"lang.stockTools.gui.zoomX","name":"zoomX","line":46,"lineEnd":46,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Zoom X"},"children":{}},"zoomXY":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Zooom XY"},"meta":{"fullname":"lang.stockTools.gui.zoomXY","name":"zoomXY","line":49,"lineEnd":49,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Zooom XY"},"children":{}},"zoomY":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Zoom Y"},"meta":{"fullname":"lang.stockTools.gui.zoomY","name":"zoomY","line":48,"lineEnd":48,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"Zoom Y"},"children":{}}}}}},"thousandsSep":{"doclet":{"description":"The default thousands separator used in the `Highcharts.numberFormat`\nmethod unless otherwise specified in the function arguments. Defaults\nto the locale thousands separator as determined by `lang.locale`.","type":{"names":["string"]},"defaultvalue":"undefined","since":"1.2.2"},"meta":{"fullname":"lang.thousandsSep","name":"thousandsSep","line":249,"lineEnd":258,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"viewData":{"doclet":{"description":"The text for the menu item.","since":"6.0.0","requires":["module:modules/export-data"],"type":{"names":["string"]},"defaultvalue":"View data table"},"meta":{"fullname":"lang.viewData","name":"viewData","line":272,"lineEnd":277,"column":4,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js","default":"View data table"},"children":{}},"viewFullscreen":{"doclet":{"description":"Exporting module only. The text for the menu item to view the chart\nin full screen.","since":"8.0.1","requires":["module:modules/exporting"],"type":{"names":["string"]},"defaultvalue":"View in full screen"},"meta":{"fullname":"lang.viewFullscreen","name":"viewFullscreen","line":545,"lineEnd":551,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"View in full screen"},"children":{}},"weekFrom":{"doclet":{"type":{"names":["string"]},"defaultvalue":"week from"},"meta":{"fullname":"lang.weekFrom","name":"weekFrom","line":98,"lineEnd":98,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"week from"},"children":{}},"weekdays":{"doclet":{"description":"An array containing the weekday names. Corresponds\nto the `%A` format in `Highcharts.dateFormat()`. Defaults to\n'undefined', meaning the default weekday names are used according to\nthe `lang.locale` or browser settings.","type":{"names":["Array.<string>"]},"defaultvalue":"undefined"},"meta":{"fullname":"lang.weekdays","name":"weekdays","line":156,"lineEnd":163,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"undefined"},"children":{}},"yAxisTitle":{"doclet":{"description":"The default title of the Y axis","since":"12.2.0","type":{"names":["string"]},"defaultvalue":"Values"},"meta":{"fullname":"lang.yAxisTitle","name":"yAxisTitle","line":265,"lineEnd":269,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"Values"},"children":{}},"zoomIn":{"doclet":{"description":"The title appearing on hovering the zoom in button. The text itself\ndefaults to \"+\" and can be changed in the button options.","type":{"names":["string"]},"defaultvalue":"Zoom in","products":["highmaps"]},"meta":{"fullname":"lang.zoomIn","name":"zoomIn","line":187,"lineEnd":195,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"zoomOut":{"doclet":{"description":"The title appearing on hovering the zoom out button. The text itself\ndefaults to \"-\" and can be changed in the button options.","type":{"names":["string"]},"defaultvalue":"Zoom out","products":["highmaps"]},"meta":{"fullname":"lang.zoomOut","name":"zoomOut","line":196,"lineEnd":204,"filename":"code/es-modules/Core/Defaults.js"},"children":{}}}},"legend":{"doclet":{"description":"The legend is a box containing a symbol and name for each series\nitem or point item in the chart. Each series (or points in case\nof pie charts) is represented by a symbol and its name in the legend.\n\nIt is possible to override the symbol creator function and create\n[custom legend symbols](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/studies/legend-custom-symbol/).","productdesc":[{"value":"A Highmaps legend by default contains one legend item per series, but if\na `colorAxis` is defined, the axis will be displayed in the legend.\nEither as a gradient, or as multiple legend items for `dataClasses`.","products":["highmaps"]}],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","name":"legend","fullname":"legend","line":13,"lineEnd":17,"column":0},"children":{"accessibility":{"doclet":{"description":"Accessibility options for the legend. Requires the Accessibility\nmodule.","since":"7.1.0","requires":["module:modules/accessibility"],"type":{"names":["*"]}},"meta":{"fullname":"legend.accessibility","name":"accessibility","line":910,"lineEnd":916,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable accessibility support for the legend.","since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"legend.accessibility.enabled","name":"enabled","line":918,"lineEnd":922,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":true},"children":{}},"keyboardNavigation":{"doclet":{"description":"Options for keyboard navigation for the legend.","since":"7.1.0","requires":["module:modules/accessibility"],"type":{"names":["*"]}},"meta":{"fullname":"legend.accessibility.keyboardNavigation","name":"keyboardNavigation","line":924,"lineEnd":929,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable keyboard navigation for the legend.","see":["[accessibility.keyboardNavigation](#accessibility.keyboardNavigation.enabled)"],"since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"legend.accessibility.keyboardNavigation.enabled","name":"enabled","line":931,"lineEnd":937,"column":16,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":true},"children":{}}}}}},"align":{"doclet":{"description":"The horizontal alignment of the legend box within the chart area.\nValid values are `left`, `center` and `right`.\n\nIn the case that the legend is aligned in a corner position, the\n`layout` option will determine whether to place it above/below\nor on the side of the plot area.","samples":[{"name":"Legend at the right of the chart","value":"highcharts/legend/align/","products":["highcharts"]},{"name":"Various legend options","value":"stock/legend/align/","products":["highstock"]},{"name":"Legend alignment","value":"maps/legend/alignment/","products":["highmaps"]}],"type":{"names":["Highcharts.AlignValue"]},"since":"2.0.0","defaultvalue":"center"},"meta":{"fullname":"legend.align","name":"align","line":967,"lineEnd":984,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"center"},"children":{}},"alignColumns":{"doclet":{"description":"If the [layout](legend.layout) is `horizontal` and the legend items\nspan over two lines or more, whether to align the items into vertical\ncolumns. Setting this to `false` makes room for more items, but will\nlook more messy.","samples":[{"name":"Align columns","value":"highcharts/legend/aligncolumns"}],"since":"6.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"legend.alignColumns","name":"alignColumns","line":986,"lineEnd":996,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":true},"children":{}},"backgroundColor":{"doclet":{"description":"The background color of the legend.","see":["In styled mode, the legend background fill can be applied with\n     the `.highcharts-legend-box` class."],"samples":[{"name":"Yellowish background","value":"highcharts/legend/backgroundcolor/","products":["highcharts"]},{"name":"Various legend options","value":"stock/legend/align/","products":["highstock"]},{"name":"Border and background options","value":"maps/legend/border-background/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"legend.backgroundColor","name":"backgroundColor","line":918,"lineEnd":933,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"borderColor":{"doclet":{"description":"The color of the drawn border around the legend.","see":["In styled mode, the legend border stroke can be applied with the\n     `.highcharts-legend-box` class."],"samples":[{"name":"Brown border","value":"highcharts/legend/bordercolor/","products":["highcharts"]},{"name":"Various legend options","value":"stock/legend/align/","products":["highstock"]},{"name":"Border and background options","value":"maps/legend/border-background/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#999999"},"meta":{"fullname":"legend.borderColor","name":"borderColor","line":1156,"lineEnd":1172,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"#999999"},"children":{}},"borderRadius":{"doclet":{"description":"The border corner radius of the legend.","samples":[{"name":"Square by default","value":"highcharts/legend/borderradius-default/","products":["highcharts"]},{"name":"5px rounded","value":"highcharts/legend/borderradius-round/","products":["highcharts"]},{"name":"Border and background options","value":"maps/legend/border-background/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"legend.borderRadius","name":"borderRadius","line":1222,"lineEnd":1231,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":0},"children":{}},"borderWidth":{"doclet":{"description":"The width of the drawn border around the legend.","see":["In styled mode, the legend border stroke width can be applied\n     with the `.highcharts-legend-box` class."],"samples":[{"name":"2px border width","value":"highcharts/legend/borderwidth/","products":["highcharts"]},{"name":"Various legend options","value":"stock/legend/align/","products":["highstock"]},{"name":"Border and background options","value":"maps/legend/border-background/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"legend.borderWidth","name":"borderWidth","line":934,"lineEnd":950,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"bubbleLegend":{"doclet":{"description":"The bubble legend is an additional element in legend which\npresents the scale of the bubble series. Individual bubble ranges\ncan be defined by user or calculated from series. In the case of\nautomatically calculated ranges, a 1px margin of error is\npermitted.","since":"7.0.0","products":["highcharts","highstock","highmaps"],"requires":["module:highcharts-more"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","name":"bubbleLegend","fullname":"legend.bubbleLegend","line":13,"lineEnd":17,"column":0},"children":{"borderColor":{"doclet":{"description":"The color of the ranges borders, can be also defined for an\nindividual range.","samples":[{"name":"Similar look to the bubble series","value":"highcharts/bubble-legend/similartoseries/"},{"name":"Individual bubble border color","value":"highcharts/bubble-legend/bordercolor/"}],"type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"legend.bubbleLegend.borderColor","name":"borderColor","line":31,"lineEnd":41,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}},"borderWidth":{"doclet":{"description":"The width of the ranges borders in pixels, can be also\ndefined for an individual range.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"legend.bubbleLegend.borderWidth","name":"borderWidth","line":43,"lineEnd":46,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":2},"children":{}},"className":{"doclet":{"description":"An additional class name to apply to the bubble legend'\ncircle graphical elements. This option does not replace\ndefault class names of the graphical element.","samples":[{"name":"Styling by CSS","value":"highcharts/css/bubble-legend/","products":["highcharts"]}],"type":{"names":["string"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"legend.bubbleLegend.className","name":"className","line":48,"lineEnd":57,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}},"color":{"doclet":{"description":"The main color of the bubble legend. Applies to ranges, if\nindividual color is not defined.","samples":[{"name":"Similar look to the bubble series","value":"highcharts/bubble-legend/similartoseries/"},{"name":"Individual bubble color","value":"highcharts/bubble-legend/color/"}],"type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"legend.bubbleLegend.color","name":"color","line":59,"lineEnd":69,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}},"connectorClassName":{"doclet":{"description":"An additional class name to apply to the bubble legend's\nconnector graphical elements. This option does not replace\ndefault class names of the graphical element.","samples":[{"name":"Styling by CSS","value":"highcharts/css/bubble-legend/","products":["highcharts"]}],"type":{"names":["string"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"legend.bubbleLegend.connectorClassName","name":"connectorClassName","line":71,"lineEnd":80,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}},"connectorColor":{"doclet":{"description":"The color of the connector, can be also defined\nfor an individual range.","type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"legend.bubbleLegend.connectorColor","name":"connectorColor","line":82,"lineEnd":87,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}},"connectorDistance":{"doclet":{"description":"The length of the connectors in pixels. If labels are\ncentered, the distance is reduced to 0.","samples":[{"name":"Increased connector length","value":"highcharts/bubble-legend/connectorandlabels/"}],"since":"7.0.0","type":{"names":["number"]},"defaultvalue":60},"meta":{"fullname":"legend.bubbleLegend.connectorDistance","name":"connectorDistance","line":89,"lineEnd":95,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":60},"children":{}},"connectorWidth":{"doclet":{"description":"The width of the connectors in pixels.","samples":[{"name":"Increased connector width","value":"highcharts/bubble-legend/connectorandlabels/"}],"since":"7.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"legend.bubbleLegend.connectorWidth","name":"connectorWidth","line":97,"lineEnd":102,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":1},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the bubble legend.","since":"7.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"legend.bubbleLegend.enabled","name":"enabled","line":104,"lineEnd":106,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":false},"children":{}},"labels":{"doclet":{"description":"Options for the bubble legend labels.","since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"legend.bubbleLegend.labels","name":"labels","line":108,"lineEnd":110,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js"},"children":{"align":{"doclet":{"description":"The alignment of the labels compared to the bubble\nlegend. Can be one of `left`, `center` or `right`.","samples":[{"name":"Labels on left","value":"highcharts/bubble-legend/connectorandlabels/"}],"type":{"names":["Highcharts.AlignValue"]},"since":"7.0.0","defaultvalue":"right"},"meta":{"fullname":"legend.bubbleLegend.labels.align","name":"align","line":149,"lineEnd":157,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"right"},"children":{}},"allowOverlap":{"doclet":{"description":"Whether to allow data labels to overlap.","since":"7.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"legend.bubbleLegend.labels.allowOverlap","name":"allowOverlap","line":123,"lineEnd":125,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":false},"children":{}},"className":{"doclet":{"description":"An additional class name to apply to the bubble legend\nlabel graphical elements. This option does not replace\ndefault class names of the graphical element.","samples":[{"name":"Styling by CSS","value":"highcharts/css/bubble-legend/","products":["highcharts"]}],"type":{"names":["string"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"legend.bubbleLegend.labels.className","name":"className","line":112,"lineEnd":121,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}},"format":{"doclet":{"description":"A format string for the bubble legend labels. Available\nvariables are the same as for `formatter`.","samples":[{"name":"Add a unit","value":"highcharts/bubble-legend/format/"}],"type":{"names":["string"]},"since":"7.0.0","defaultvalue":""},"meta":{"fullname":"legend.bubbleLegend.labels.format","name":"format","line":127,"lineEnd":135,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":""},"children":{}},"formatter":{"doclet":{"description":"Available `this` properties are:\n\n- `this.value`: The bubble value.\n\n- `this.radius`: The radius of the bubble range.\n\n- `this.center`: The center y position of the range.","type":{"names":["Highcharts.FormatterCallbackFunction.<Highcharts.BubbleLegendFormatterContextObject>"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"legend.bubbleLegend.labels.formatter","name":"formatter","line":137,"lineEnd":147,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}},"style":{"doclet":{"description":"CSS styles for the labels.","type":{"names":["Highcharts.CSSObject"]},"since":"7.0.0"},"meta":{"fullname":"legend.bubbleLegend.labels.style","name":"style","line":159,"lineEnd":163,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js"},"children":{}},"x":{"doclet":{"description":"The x position offset of the label relative to the\nconnector.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"legend.bubbleLegend.labels.x","name":"x","line":170,"lineEnd":173,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"The y position offset of the label relative to the\nconnector.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"legend.bubbleLegend.labels.y","name":"y","line":175,"lineEnd":178,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":0},"children":{}}}},"legendIndex":{"doclet":{"description":"The position of the bubble legend in the legend.","samples":[{"name":"Bubble legend as last item in legend","value":"highcharts/bubble-legend/connectorandlabels/"}],"since":"7.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"legend.bubbleLegend.legendIndex","name":"legendIndex","line":192,"lineEnd":192,"column":17,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":0},"children":{}},"maxSize":{"doclet":{"description":"Maximum bubble legend range size. If values for ranges are\nnot specified, the `minSize` and the `maxSize` are calculated\nfrom bubble series.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":60},"meta":{"fullname":"legend.bubbleLegend.maxSize","name":"maxSize","line":181,"lineEnd":185,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":60},"children":{}},"minSize":{"doclet":{"description":"Minimum bubble legend range size. If values for ranges are\nnot specified, the `minSize` and the `maxSize` are calculated\nfrom bubble series.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"legend.bubbleLegend.minSize","name":"minSize","line":186,"lineEnd":186,"column":17,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":10},"children":{}},"ranges":{"doclet":{"description":"Options for specific range. One range consists of bubble,\nlabel and connector.","samples":[{"name":"Manually defined ranges","value":"highcharts/bubble-legend/ranges/"},{"name":"Auto calculated ranges","value":"highcharts/bubble-legend/autoranges/"}],"type":{"names":["Array.<*>"]},"since":"7.0.0"},"meta":{"fullname":"legend.bubbleLegend.ranges","name":"ranges","line":198,"lineEnd":198,"column":20,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js"},"children":{"borderColor":{"doclet":{"description":"The color of the border for individual range.","type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"legend.bubbleLegend.ranges.borderColor","name":"borderColor","line":216,"lineEnd":219,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}},"color":{"doclet":{"description":"The color of the bubble for individual range.","type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"legend.bubbleLegend.ranges.color","name":"color","line":221,"lineEnd":224,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}},"connectorColor":{"doclet":{"description":"The color of the connector for individual range.","type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"legend.bubbleLegend.ranges.connectorColor","name":"connectorColor","line":226,"lineEnd":229,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}},"value":{"doclet":{"description":"Range size value, similar to bubble Z data.","type":{"names":["number"]},"since":"7.0.0","defaultvalue":null},"meta":{"fullname":"legend.bubbleLegend.ranges.value","name":"value","line":211,"lineEnd":214,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"undefined"},"children":{}}}},"sizeBy":{"doclet":{"description":"Whether the bubble legend range value should be represented\nby the area or the width of the bubble. The default, area,\ncorresponds best to the human perception of the size of each\nbubble.","samples":[{"name":"Size by width","value":"highcharts/bubble-legend/ranges/"}],"type":{"names":["Highcharts.BubbleSizeByValue"]},"since":"7.0.0","defaultvalue":"area"},"meta":{"fullname":"legend.bubbleLegend.sizeBy","name":"sizeBy","line":232,"lineEnd":242,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":"area"},"children":{}},"sizeByAbsoluteValue":{"doclet":{"description":"When this is true, the absolute value of z determines the\nsize of the bubble. This means that with the default\nzThreshold of 0, a bubble of value -1 will have the same size\nas a bubble of value 1, while a bubble of value 0 will have a\nsmaller size according to minSize.","since":"7.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"legend.bubbleLegend.sizeByAbsoluteValue","name":"sizeByAbsoluteValue","line":244,"lineEnd":250,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":false},"children":{}},"zIndex":{"doclet":{"description":"Define the visual z index of the bubble legend.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"legend.bubbleLegend.zIndex","name":"zIndex","line":252,"lineEnd":254,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":1},"children":{}},"zThreshold":{"doclet":{"description":"Ranges with lower value than zThreshold are skipped.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"legend.bubbleLegend.zThreshold","name":"zThreshold","line":256,"lineEnd":258,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleLegendDefaults.js","default":0},"children":{}}}},"className":{"doclet":{"description":"A CSS class name to apply to the legend group.","type":{"names":["string"]},"defaultvalue":"highcharts-no-tooltip"},"meta":{"fullname":"legend.className","name":"className","line":998,"lineEnd":1000,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"highcharts-no-tooltip"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the legend. There is also a series-specific option,\n[showInLegend](#plotOptions.series.showInLegend), that can hide the\nseries from the legend. In some series types this is `false` by\ndefault, so it must set to `true` in order to show the legend for the\nseries.","samples":[{"name":"Legend disabled","value":"highcharts/legend/enabled-false/","products":["highcharts"]},{"name":"Various legend options","value":"stock/legend/align/","products":["highstock"]},{"name":"Legend disabled","value":"maps/legend/enabled-false/","products":["highmaps"]}],"defaultByProduct":{"highstock":false,"highmaps":true,"gantt":false},"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"legend.enabled","name":"enabled","line":918,"lineEnd":933,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":true},"children":{}},"events":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"itemClick":{"doclet":{"description":"Fires when the legend item belonging to the series is clicked. One\nparameter, `event`, is passed to the function. The default action\nis to toggle the visibility of the series, point or data class. This\ncan be prevented by returning `false` or calling\n`event.preventDefault()`.","samples":[{"name":"Confirm hiding and showing","value":"highcharts/legend/itemclick/","products":["highcharts"]},{"name":"Confirm toggle visibility of pie slices","value":"highcharts/legend/pie-legend-itemclick/","products":["highcharts"]}],"type":{"names":["Highcharts.LegendItemClickCallbackFunction"]},"context":"Highcharts.Legend"},"meta":{"fullname":"legend.events.itemClick","name":"itemClick","line":1012,"lineEnd":1027,"filename":"code/es-modules/Core/Defaults.js"},"children":{}}}},"floating":{"doclet":{"description":"When the legend is floating, the plot area ignores it and is allowed\nto be placed below it.","samples":[{"name":"False by default","value":"highcharts/legend/floating-false/","products":["highcharts"]},{"name":"True","value":"highcharts/legend/floating-true/","products":["highcharts"]},{"name":"Floating legend","value":"maps/legend/alignment/","products":["highmaps"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"2.1.0"},"meta":{"fullname":"legend.floating","name":"floating","line":1028,"lineEnd":1043,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"itemCheckboxStyle":{"doclet":{"description":"Default styling for the checkbox next to a legend item when\n`showCheckbox` is true.","type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"width\": \"13px\", \"height\": \"13px\", \"position\":\"absolute\"}"},"meta":{"fullname":"legend.itemCheckboxStyle","name":"itemCheckboxStyle","line":1500,"lineEnd":1506,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"itemDistance":{"doclet":{"description":"In a legend with horizontal layout, the itemDistance defines the\npixel distance between each item.","samples":[{"name":"50px item distance","value":"highcharts/legend/layout-horizontal/","products":["highcharts"]},{"name":"50px item distance","value":"highcharts/legend/layout-horizontal/","products":["highstock"]}],"type":{"names":["number"]},"defaultByProduct":{"highcharts":20,"highstock":20,"highmaps":8},"since":"3.0.3"},"meta":{"fullname":"legend.itemDistance","name":"itemDistance","line":1067,"lineEnd":1082,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"itemHiddenStyle":{"doclet":{"description":"CSS styles for each legend item when the corresponding series or\npoint is hidden. Only a subset of CSS is supported, notably those\noptions related to text. Properties are inherited from `style`\nunless overridden here.","see":["In styled mode, the hidden legend items can be styled with\n     the `.highcharts-legend-item-hidden` class."],"samples":[{"name":"Darker gray color","value":"highcharts/legend/itemhiddenstyle/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"color\": \"#cccccc\"}"},"meta":{"fullname":"legend.itemHiddenStyle","name":"itemHiddenStyle","line":1459,"lineEnd":1473,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"itemHoverStyle":{"doclet":{"description":"CSS styles for each legend item in hover mode. Only a subset of\nCSS is supported, notably those options related to text. Properties\nare inherited from `style` unless overridden here.","see":["In styled mode, the hovered legend items can be styled with\n     the `.highcharts-legend-item:hover` pseudo-class."],"samples":[{"name":"Red on hover","value":"highcharts/legend/itemhoverstyle/","products":["highcharts"]},{"name":"Item text styles","value":"maps/legend/itemstyle/","products":["highmaps"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"color\": \"#000000\"}"},"meta":{"fullname":"legend.itemHoverStyle","name":"itemHoverStyle","line":1437,"lineEnd":1452,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"itemMarginBottom":{"doclet":{"description":"The pixel bottom margin for each legend item.","samples":[{"name":"Padding and item margins demonstrated","value":"highcharts/legend/padding-itemmargin/","products":["highcharts","highstock"]},{"name":"Padding and item margins demonstrated","value":"maps/legend/padding-itemmargin/","products":["highmaps"]}],"since":"2.2.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"legend.itemMarginBottom","name":"itemMarginBottom","line":1067,"lineEnd":1082,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":2},"children":{}},"itemMarginTop":{"doclet":{"description":"The pixel top margin for each legend item.","samples":[{"name":"Padding and item margins demonstrated","value":"highcharts/legend/padding-itemmargin/","products":["highcharts","highstock"]},{"name":"Padding and item margins demonstrated","value":"maps/legend/padding-itemmargin/","products":["highmaps"]}],"since":"2.2.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"legend.itemMarginTop","name":"itemMarginTop","line":1094,"lineEnd":1103,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":2},"children":{}},"itemStyle":{"doclet":{"description":"CSS styles for each legend item. Only a subset of CSS is supported,\nnotably those options related to text. The default `textOverflow`\nproperty makes long texts truncate. Set it to `undefined` to wrap\ntext instead. A `width` property can be added to control the text\nwidth.","see":["In styled mode, the legend items can be styled with the\n     `.highcharts-legend-item` class."],"samples":[{"name":"Bold black text","value":"highcharts/legend/itemstyle/","products":["highcharts"]},{"name":"Item text styles","value":"maps/legend/itemstyle/","products":["highmaps"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"color\": \"#333333\", \"cursor\": \"pointer\", \"fontSize\": \"0.8em\", \"fontWeight\": \"bold\", \"textOverflow\": \"ellipsis\"}"},"meta":{"fullname":"legend.itemStyle","name":"itemStyle","line":1345,"lineEnd":1357,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"itemWidth":{"doclet":{"description":"The width for each legend item. By default the items are laid out\nsuccessively. In a [horizontal layout](legend.layout), if the items\nare laid out across two rows or more, they will be vertically aligned\ndepending on the [legend.alignColumns](legend.alignColumns) option.","samples":[{"name":"Undefined by default","value":"highcharts/legend/itemwidth-default/","products":["highcharts"]},{"name":"80 for aligned legend items","value":"highcharts/legend/itemwidth-80/","products":["highcharts"]}],"type":{"names":["number"]},"since":"2.0.0"},"meta":{"fullname":"legend.itemWidth","name":"itemWidth","line":1105,"lineEnd":1119,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"labelFormat":{"doclet":{"description":"A [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nfor each legend label. Available variables relates to properties on\nthe series, or the point in case of pies.","samples":[{"name":"Add text","value":"highcharts/legend/labelformat/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"{name}","since":"1.3.0"},"meta":{"fullname":"legend.labelFormat","name":"labelFormat","line":1120,"lineEnd":1132,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"labelFormatter":{"doclet":{"description":"Callback function to format each of the series' labels. The `this`\nkeyword refers to the series object, or the point object in case of\npie charts. By default the series or point name is printed. Since\nv12.5.0, the callback also receives `ctx` as the first argument, so\nthat arrow functions can access the same context as regular\nfunctions using `this`.","productdesc":[{"value":"In Highmaps the context can also be a data class in case of a\n`colorAxis`.","products":["highmaps"]}],"samples":[{"name":"Add text","value":"highcharts/legend/labelformatter/","products":["highcharts"]},{"name":"Data classes with label formatter","value":"maps/legend/labelformatter/","products":["highmaps"]}],"type":{"names":["Highcharts.FormatterCallbackFunction.<(Point|Series)>"]}},"meta":{"fullname":"legend.labelFormatter","name":"labelFormatter","line":1105,"lineEnd":1119,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"layout":{"doclet":{"description":"The layout of the legend items. Can be one of `horizontal` or\n`vertical` or `proximate`. When `proximate`, the legend items will be\nplaced as close as possible to the graphs they're representing,\nexcept in inverted charts or when the legend position doesn't allow\nit.","samples":[{"name":"Horizontal by default","value":"highcharts/legend/layout-horizontal/","products":["highcharts"]},{"name":"Vertical","value":"highcharts/legend/layout-vertical/","products":["highcharts"]},{"name":"Labels proximate to the data","value":"highcharts/legend/layout-proximate"},{"name":"Horizontal by default","value":"stock/legend/layout-horizontal/","products":["highstock"]},{"name":"Vertical with data classes","value":"maps/legend/padding-itemmargin/","products":["highmaps"]},{"name":"Vertical with color axis gradient","value":"maps/legend/layout-vertical/","products":["highmaps"]}],"values":"[\"horizontal\", \"vertical\", \"proximate\"]","type":{"names":["string"]},"defaultvalue":"horizontal"},"meta":{"fullname":"legend.layout","name":"layout","line":1012,"lineEnd":1027,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"horizontal"},"children":{}},"lineHeight":{"doclet":{"description":"Line height for the legend items. Deprecated as of 2.1\\. Instead,\nthe line height for each item can be set using\n`itemStyle.lineHeight`, and the padding between items using\n`itemMarginTop` and `itemMarginBottom`.","samples":[{"name":"Setting padding","value":"highcharts/legend/lineheight/","products":["highcharts"]}],"deprecated":true,"type":{"names":["number"]},"defaultvalue":"16","since":"2.0.0","products":["highcharts","gantt"]},"meta":{"fullname":"legend.lineHeight","name":"lineHeight","line":1156,"lineEnd":1172,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"margin":{"doclet":{"description":"If the plot area sized is calculated automatically and the legend is\nnot floating, the legend margin is the space between the legend and\nthe axis labels or plot area.","samples":[{"name":"12 pixels by default","value":"highcharts/legend/margin-default/","products":["highcharts"]},{"name":"30 pixels","value":"highcharts/legend/margin-30/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"12","since":"2.1.0"},"meta":{"fullname":"legend.margin","name":"margin","line":1173,"lineEnd":1187,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"maxHeight":{"doclet":{"description":"Maximum pixel height for the legend. When the maximum height is\nextended, navigation will show.","type":{"names":["number"]},"since":"2.3.0"},"meta":{"fullname":"legend.maxHeight","name":"maxHeight","line":1198,"lineEnd":1205,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"maxWidth":{"doclet":{"description":"Maximum width for the legend. Can be a percentage of the chart width,\nor an integer representing how many pixels wide the legend can be.","samples":[{"name":"Max width set to 7%","value":"highcharts/legend/maxwidth/","products":["highcharts"]}],"type":{"names":["number","string"]}},"meta":{"fullname":"legend.maxWidth","name":"maxWidth","line":1188,"lineEnd":1197,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"navigation":{"doclet":{"description":"Options for the paging or navigation appearing when the legend is\noverflown. Navigation works well on screen, but not in static\nexported images. One way of working around that is to\n[increase the chart height in\nexport](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/legend/navigation-enabled-false/).","samples":[{"name":"Legend with vertical scrollable extension","value":"highcharts/legend/scrollable-vertical/"},{"name":"Legend with horizontal scrollable extension","value":"highcharts/legend/scrollable-horizontal/"}],"type":{"names":["*"]}},"meta":{"fullname":"legend.navigation","name":"navigation","line":1233,"lineEnd":1245,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{"activeColor":{"doclet":{"description":"The color for the active up or down arrow in the legend page\nnavigation.","see":["In styled mode, the active arrow be styled with the\n     `.highcharts-legend-nav-active` class."],"samples":[{"name":"Legend page navigation demonstrated","value":"highcharts/legend/navigation/","products":["highcharts"]},{"name":"Legend page navigation demonstrated","value":"highcharts/legend/navigation/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"since":"2.2.4","defaultvalue":"#0022ff"},"meta":{"fullname":"legend.navigation.activeColor","name":"activeColor","line":1312,"lineEnd":1326,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"#0022ff"},"children":{}},"animation":{"doclet":{"description":"How to animate the pages when navigating up or down. A value of\n`true` applies the default navigation given in the\n`chart.animation` option. Additional options can be given as an\nobject containing values for easing and duration.","samples":[{"name":"Legend page navigation demonstrated","value":"highcharts/legend/navigation/","products":["highcharts"]},{"name":"Legend page navigation demonstrated","value":"highcharts/legend/navigation/","products":["highstock"]}],"type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"defaultvalue":"true","since":"2.2.4"},"meta":{"fullname":"legend.navigation.animation","name":"animation","line":1247,"lineEnd":1262,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"arrowSize":{"doclet":{"description":"The pixel size of the up and down arrows in the legend paging\nnavigation.","samples":[{"name":"Legend page navigation demonstrated","value":"highcharts/legend/navigation/","products":["highcharts"]},{"name":"Legend page navigation demonstrated","value":"highcharts/legend/navigation/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"12","since":"2.2.4"},"meta":{"fullname":"legend.navigation.arrowSize","name":"arrowSize","line":1263,"lineEnd":1276,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"enabled":{"doclet":{"description":"Whether to enable the legend navigation. In most cases, disabling\nthe navigation results in an unwanted overflow.\n\nSee also the\n[adapt chart to legend](https://github.com/highcharts/adapt-chart-to-legend)\nplugin for a solution to extend the chart height to make room for\nthe legend, optionally in exported charts only.","type":{"names":["boolean"]},"defaultvalue":"true","since":"4.2.4"},"meta":{"fullname":"legend.navigation.enabled","name":"enabled","line":1277,"lineEnd":1290,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"inactiveColor":{"doclet":{"description":"The color of the inactive up or down arrow in the legend page\nnavigation. .","see":["In styled mode, the inactive arrow be styled with the\n     `.highcharts-legend-nav-inactive` class."],"samples":[{"name":"Legend page navigation demonstrated","value":"highcharts/legend/navigation/","products":["highcharts"]},{"name":"Legend page navigation demonstrated","value":"highcharts/legend/navigation/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"since":"2.2.4","defaultvalue":"#cccccc"},"meta":{"fullname":"legend.navigation.inactiveColor","name":"inactiveColor","line":1328,"lineEnd":1342,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"#cccccc"},"children":{}},"style":{"doclet":{"description":"Text styles for the legend page navigation.","see":["In styled mode, the navigation items are styled with the\n     `.highcharts-legend-navigation` class."],"samples":[{"name":"Legend page navigation demonstrated","value":"highcharts/legend/navigation/","products":["highcharts"]},{"name":"Legend page navigation demonstrated","value":"highcharts/legend/navigation/","products":["highstock"]}],"type":{"names":["Highcharts.CSSObject"]},"since":"2.2.4"},"meta":{"fullname":"legend.navigation.style","name":"style","line":1291,"lineEnd":1305,"filename":"code/es-modules/Core/Defaults.js"},"children":{}}}},"padding":{"doclet":{"description":"The inner padding of the legend box.","samples":[{"name":"Padding and item margins demonstrated","value":"highcharts/legend/padding-itemmargin/","products":["highcharts","highstock"]},{"name":"Padding and item margins demonstrated","value":"maps/legend/padding-itemmargin/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"8","since":"2.2.0"},"meta":{"fullname":"legend.padding","name":"padding","line":1345,"lineEnd":1357,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"reversed":{"doclet":{"description":"Whether to reverse the order of the legend items compared to the\norder of the series or points as defined in the configuration object.","see":["[yAxis.reversedStacks](#yAxis.reversedStacks),\n     [series.legendIndex](#series.legendIndex)"],"samples":[{"name":"Stacked bar with reversed legend","value":"highcharts/legend/reversed/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"1.2.5"},"meta":{"fullname":"legend.reversed","name":"reversed","line":1358,"lineEnd":1372,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"rtl":{"doclet":{"description":"Whether to show the symbol on the right side of the text rather than\nthe left side. This is common in Arabic and Hebrew.","samples":[{"name":"Symbol to the right","value":"highcharts/legend/rtl/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"2.2.0"},"meta":{"fullname":"legend.rtl","name":"rtl","line":1373,"lineEnd":1384,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"shadow":{"doclet":{"description":"Whether to apply a drop shadow to the legend. A `backgroundColor`\nalso needs to be applied for this to take effect. The shadow can be\nan object configuration containing `color`, `offsetX`, `offsetY`,\n`opacity` and `width`.","samples":[{"name":"White background and drop shadow","value":"highcharts/legend/shadow/","products":["highcharts"]},{"name":"Various legend options","value":"stock/legend/align/","products":["highstock"]},{"name":"Border and background options","value":"maps/legend/border-background/","products":["highmaps"]}],"type":{"names":["boolean","Highcharts.CSSObject"]},"defaultvalue":false},"meta":{"fullname":"legend.shadow","name":"shadow","line":1484,"lineEnd":1498,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":false},"children":{}},"squareSymbol":{"doclet":{"description":"When this is true, the legend symbol width will be the same as\nthe symbol height, which in turn defaults to the font size of the\nlegend items.","since":"5.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"legend.squareSymbol","name":"squareSymbol","line":1521,"lineEnd":1521,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":true},"children":{}},"style":{"doclet":{"description":"CSS styles for the legend area. In the 1.x versions the position\nof the legend area was determined by CSS. In 2.x, the position is\ndetermined by properties like `align`, `verticalAlign`, `x` and `y`,\nbut the styles are still parsed for backwards compatibility.","deprecated":true,"type":{"names":["Highcharts.CSSObject"]},"products":["highcharts","highstock"]},"meta":{"fullname":"legend.style","name":"style","line":1385,"lineEnd":1396,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"symbolHeight":{"doclet":{"description":"The pixel height of the symbol for series types that use a rectangle\nin the legend. Defaults to the font size of legend items.\n\nNote: This option is a default source of color axis height, if the\n[colorAxis.height](https://api.highcharts.com/highcharts/colorAxis.height)\noption is not set.","productdesc":[{"value":"In Highmaps, when the symbol is the gradient of a vertical color\naxis, the height defaults to 200.","products":["highmaps"]}],"samples":[{"name":"Sized vertical gradient","value":"maps/legend/layout-vertical-sized/","products":["highmaps"]},{"name":"No distance between data classes","value":"maps/legend/padding-itemmargin/","products":["highmaps"]}],"type":{"names":["number"]},"since":"3.0.8"},"meta":{"fullname":"legend.symbolHeight","name":"symbolHeight","line":1530,"lineEnd":1550,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"symbolPadding":{"doclet":{"description":"The pixel padding between the legend item symbol and the legend\nitem text.","samples":[{"name":"Greater symbol width and padding","value":"highcharts/legend/symbolpadding/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"legend.symbolPadding","name":"symbolPadding","line":1530,"lineEnd":1550,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":5},"children":{}},"symbolRadius":{"doclet":{"description":"The border radius of the symbol for series types that use a rectangle\nin the legend. Defaults to half the `symbolHeight`, effectively\ncreating a circle.\n\nFor color axis scales, it defaults to 3.","samples":[{"name":"Round symbols","value":"highcharts/legend/symbolradius/","products":["highcharts"]},{"name":"Round symbols","value":"highcharts/legend/symbolradius/","products":["highstock"]},{"name":"Round symbols","value":"highcharts/legend/symbolradius/","products":["highmaps"]}],"type":{"names":["number"]},"since":"3.0.8"},"meta":{"fullname":"legend.symbolRadius","name":"symbolRadius","line":1551,"lineEnd":1568,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"symbolWidth":{"doclet":{"description":"The pixel width of the legend item symbol. When the `squareSymbol`\noption is set, this defaults to the `symbolHeight`, otherwise 16.\n\nNote: This option is a default source of color axis width, if the\n[colorAxis.width](https://api.highcharts.com/highcharts/colorAxis.width)\noption is not set.","productdesc":[{"value":"In Highmaps, when the symbol is the gradient of a horizontal color\naxis, the width defaults to 200.","products":["highmaps"]}],"samples":[{"name":"Greater symbol width and padding","value":"highcharts/legend/symbolwidth/","products":["highcharts"]},{"name":"Padding and item margins demonstrated","value":"maps/legend/padding-itemmargin/","products":["highmaps"]},{"name":"Sized vertical gradient","value":"maps/legend/layout-vertical-sized/","products":["highmaps"]}],"type":{"names":["number"]}},"meta":{"fullname":"legend.symbolWidth","name":"symbolWidth","line":1569,"lineEnd":1590,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"title":{"doclet":{"description":"A title to be added on top of the legend.","samples":[{"name":"Legend title","value":"highcharts/legend/title/","products":["highcharts"]},{"name":"Legend with title","value":"maps/legend/alignment/","products":["highmaps"]}],"since":"3.0.0","type":{"names":["*"]}},"meta":{"fullname":"legend.title","name":"title","line":1700,"lineEnd":1709,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{"style":{"doclet":{"description":"Generic CSS styles for the legend title.","see":["In styled mode, the legend title is styled with the\n     `.highcharts-legend-title` class."],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"fontSize\": \"0.8em\", \"fontWeight\": \"bold\"}","since":"3.0.0"},"meta":{"fullname":"legend.title.style","name":"style","line":1711,"lineEnd":1717,"column":12,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"text":{"doclet":{"description":"A text or HTML string for the title.","type":{"names":["string"]},"since":"3.0.0"},"meta":{"fullname":"legend.title.text","name":"text","line":1711,"lineEnd":1717,"filename":"code/es-modules/Core/Defaults.js"},"children":{}}}},"useHTML":{"doclet":{"description":"Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the legend item texts.\n\nPrior to 4.1.7, when using HTML, [legend.navigation](#legend.navigation) was disabled.","samples":[{"name":"Legend with vertical scrollable extension","value":"highcharts/legend/scrollable-vertical/"},{"name":"Legend with horizontal scrollable extension","value":"highcharts/legend/scrollable-horizontal/"}],"type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"legend.useHTML","name":"useHTML","line":1591,"lineEnd":1606,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"valueDecimals":{"doclet":{"description":"For a color axis with data classes, how many decimals to render in\nthe legend. The default preserves the decimals of the range numbers.","type":{"names":["number"]},"defaultvalue":"-1","products":["highcharts","highmaps"]},"meta":{"fullname":"legend.valueDecimals","name":"valueDecimals","line":1607,"lineEnd":1615,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"valueSuffix":{"doclet":{"description":"For a color axis with data classes, a suffix for the range numbers in\nthe legend.","type":{"names":["string"]},"defaultvalue":"''","products":["highcharts","highmaps"]},"meta":{"fullname":"legend.valueSuffix","name":"valueSuffix","line":1616,"lineEnd":1624,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of the legend box. Can be one of `top`,\n`middle` or `bottom`. Vertical position can be further determined\nby the `y` option.\n\nIn the case that the legend is aligned in a corner position, the\n`layout` option will determine whether to place it above/below\nor on the side of the plot area.\n\nWhen the [layout](#legend.layout) option is `proximate`, the\n`verticalAlign` option doesn't apply.","samples":[{"name":"Legend 100px from the top of the chart","value":"highcharts/legend/verticalalign/","products":["highcharts"]},{"name":"Various legend options","value":"stock/legend/align/","products":["highstock"]},{"name":"Legend alignment","value":"maps/legend/alignment/","products":["highmaps"]}],"type":{"names":["Highcharts.VerticalAlignValue"]},"since":"2.0.0","defaultvalue":"bottom"},"meta":{"fullname":"legend.verticalAlign","name":"verticalAlign","line":1650,"lineEnd":1671,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"bottom"},"children":{}},"width":{"doclet":{"description":"The width of the legend box. If a number is set, it translates to\npixels. Since v7.0.2 it allows setting a percent string of the full\nchart width, for example `40%`.\n\nDefaults to the full chart width for legends below or above the\nchart, half the chart width for legends to the left and right.","samples":[{"name":"Aligned to the plot area","value":"highcharts/legend/width/","products":["highcharts"]},{"name":"A percent of the chart width","value":"highcharts/legend/width-percent/","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"2.0.0"},"meta":{"fullname":"legend.width","name":"width","line":1625,"lineEnd":1641,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"x":{"doclet":{"description":"The x offset of the legend relative to its horizontal alignment\n`align` within chart.spacingLeft and chart.spacingRight. Negative\nx moves it to the left, positive x moves it to the right.","samples":[{"name":"Aligned to the plot area","value":"highcharts/legend/width/","products":["highcharts"]}],"since":"2.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"legend.x","name":"x","line":1673,"lineEnd":1673,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":0},"children":{}},"y":{"doclet":{"description":"The vertical offset of the legend relative to it's vertical alignment\n`verticalAlign` within chart.spacingTop and chart.spacingBottom.\n Negative y moves it up, positive y moves it down.","samples":[{"name":"Legend 100px from the top of the chart","value":"highcharts/legend/verticalalign/","products":["highcharts"]},{"name":"Various legend options","value":"stock/legend/align/","products":["highstock"]},{"name":"Legend alignment","value":"maps/legend/alignment/","products":["highmaps"]}],"since":"2.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"legend.y","name":"y","line":1685,"lineEnd":1698,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":0},"children":{}}}},"loading":{"doclet":{"description":"The loading options control the appearance of the loading screen\nthat covers the plot area on chart operations. This screen only\nappears after an explicit call to `chart.showLoading()`. It is a\nutility for developers to communicate to the end user that something\nis going on, for example while retrieving new data via an XHR connection.\nThe \"Loading...\" text itself is not part of this configuration\nobject, but part of the `lang` object.","type":{"names":["*"]}},"meta":{"fullname":"loading","name":"loading","line":1744,"lineEnd":1752,"column":4,"filename":"code/es-modules/Core/Defaults.js"},"children":{"hideDuration":{"doclet":{"description":"The duration in milliseconds of the fade out effect.","samples":[{"name":"Fade in and out over a second","value":"highcharts/loading/hideduration/"}],"type":{"names":["number"]},"defaultvalue":"100","since":"1.2.0"},"meta":{"fullname":"loading.hideDuration","name":"hideDuration","line":1754,"lineEnd":1764,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"labelStyle":{"doclet":{"description":"CSS styles for the loading label `span`.","see":["In styled mode, the loading label is styled with the\n     `.highcharts-loading-inner` class."],"samples":[{"name":"Vertically centered","value":"highcharts/loading/labelstyle/","products":["highcharts","highmaps"]},{"name":"Label styles","value":"stock/loading/general/","products":["highstock"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"fontWeight\": \"bold\", \"position\": \"relative\", \"top\": \"45%\"}","since":"1.2.0"},"meta":{"fullname":"loading.labelStyle","name":"labelStyle","line":1754,"lineEnd":1764,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"showDuration":{"doclet":{"description":"The duration in milliseconds of the fade in effect.","samples":[{"name":"Fade in and out over a second","value":"highcharts/loading/hideduration/"}],"type":{"names":["number"]},"defaultvalue":"100","since":"1.2.0"},"meta":{"fullname":"loading.showDuration","name":"showDuration","line":1765,"lineEnd":1775,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"style":{"doclet":{"description":"CSS styles for the loading screen that covers the plot area.\n\nIn styled mode, the loading label is styled with the\n`.highcharts-loading` class.","samples":[{"name":"Gray plot area, white text","value":"highcharts/loading/style/","products":["highcharts","highmaps"]},{"name":"Gray plot area, white text","value":"stock/loading/general/","products":["highstock"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"position\": \"absolute\", \"backgroundColor\": \"#ffffff\", \"opacity\": 0.5, \"textAlign\": \"center\"}","since":"1.2.0"},"meta":{"fullname":"loading.style","name":"style","line":1805,"lineEnd":1819,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}}}},"mapNavigation":{"doclet":{"description":"The `mapNavigation` option handles buttons for navigation in addition to\n`mousewheel` and `doubleclick` handlers for map zooming.","products":["highmaps"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Maps/MapNavigationDefaults.js","name":"mapNavigation","fullname":"mapNavigation","line":21,"lineEnd":27,"column":0},"children":{"buttonOptions":{"doclet":{"description":"General options for the map navigation buttons. Individual options\ncan be given from the [mapNavigation.buttons](#mapNavigation.buttons)\noption set.","samples":[{"name":"Theming the navigation buttons","value":"maps/mapnavigation/button-theme/","products":["highmaps"]}],"type":{"names":["*"]}},"meta":{"fullname":"mapNavigation.buttonOptions","name":"buttonOptions","line":29,"lineEnd":36,"column":4,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{"align":{"doclet":{"description":"The alignment of the navigation buttons.","type":{"names":["Highcharts.AlignValue"]},"defaultvalue":"left"},"meta":{"fullname":"mapNavigation.buttonOptions.align","name":"align","line":45,"lineEnd":49,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":"left"},"children":{}},"alignTo":{"doclet":{"description":"What box to align the buttons to. Possible values are `plotBox`\nand `spacingBox`.","type":{"names":["Highcharts.ButtonRelativeToValue"]},"defaultvalue":"plotBox"},"meta":{"fullname":"mapNavigation.buttonOptions.alignTo","name":"alignTo","line":38,"lineEnd":43,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":"plotBox"},"children":{}},"height":{"doclet":{"description":"The pixel height of the map navigation buttons.","type":{"names":["number"]},"defaultvalue":18},"meta":{"fullname":"mapNavigation.buttonOptions.height","name":"height","line":66,"lineEnd":68,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":18},"children":{}},"padding":{"doclet":{"description":"Padding for the navigation buttons.","since":"5.0.0","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"mapNavigation.buttonOptions.padding","name":"padding","line":70,"lineEnd":74,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":5},"children":{}},"style":{"doclet":{"description":"Text styles for the map navigation buttons.","type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"fontSize\": \"1em\", \"fontWeight\": \"bold\"}"},"meta":{"fullname":"mapNavigation.buttonOptions.style","name":"style","line":76,"lineEnd":81,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{}},"theme":{"doclet":{"description":"A configuration object for the button theme. The object accepts\nSVG properties like `stroke-width`, `stroke` and `fill`. Tri-state\nbutton styles are supported by the `states.hover` and `states.select`\nobjects.","samples":[{"name":"Themed navigation buttons","value":"maps/mapnavigation/button-theme/","products":["highmaps"]}],"type":{"names":["Highcharts.SVGAttributes"]},"defaultvalue":"{\"stroke-width\": 1, \"text-align\": \"center\"}"},"meta":{"fullname":"mapNavigation.buttonOptions.theme","name":"theme","line":90,"lineEnd":101,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of the buttons. Individual alignment can\nbe adjusted by each button's `y` offset.","type":{"names":["Highcharts.VerticalAlignValue"]},"defaultvalue":"top"},"meta":{"fullname":"mapNavigation.buttonOptions.verticalAlign","name":"verticalAlign","line":51,"lineEnd":56,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":"top"},"children":{}},"width":{"doclet":{"description":"The width of the map navigation buttons.","type":{"names":["number"]},"defaultvalue":18},"meta":{"fullname":"mapNavigation.buttonOptions.width","name":"width","line":62,"lineEnd":64,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":18},"children":{}},"x":{"doclet":{"description":"The X offset of the buttons relative to its `align` setting.","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"mapNavigation.buttonOptions.x","name":"x","line":58,"lineEnd":60,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":0},"children":{}}}},"buttons":{"doclet":{"description":"The individual buttons for the map navigation. This usually includes\nthe zoom in and zoom out buttons. Properties for each button is\ninherited from [mapNavigation.buttonOptions](#mapNavigation.buttonOptions),\nwhile individual options can be overridden. But default, the `onclick`,\n`text` and `y` options are individual.","type":{"names":["*"]}},"meta":{"fullname":"mapNavigation.buttons","name":"buttons","line":113,"lineEnd":119,"column":4,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{"zoomIn":{"doclet":{"description":"Options for the zoom in button. Properties for the zoom in and zoom\nout buttons are inherited from\n[mapNavigation.buttonOptions](#mapNavigation.buttonOptions), while\nindividual options can be overridden. By default, the `onclick`,\n`text` and `y` options are individual.","extends":"mapNavigation.buttonOptions"},"meta":{"fullname":"mapNavigation.buttons.zoomIn","name":"zoomIn","line":121,"lineEnd":129,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{"onclick":{"doclet":{"description":"Click handler for the button.","type":{"names":["function"]},"defaultvalue":"function () { this.mapZoom(0.5); }"},"meta":{"fullname":"mapNavigation.buttons.zoomIn.onclick","name":"onclick","line":131,"lineEnd":131,"column":12,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{}},"text":{"doclet":{"description":"The text for the button. The tooltip (title) is a language option\ngiven by [lang.zoomIn](#lang.zoomIn).","type":{"names":["string"]},"defaultvalue":"+"},"meta":{"fullname":"mapNavigation.buttons.zoomIn.text","name":"text","line":141,"lineEnd":144,"column":12,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":"+"},"children":{}},"y":{"doclet":{"description":"The position of the zoomIn button relative to the vertical\nalignment.","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"mapNavigation.buttons.zoomIn.y","name":"y","line":146,"lineEnd":149,"column":12,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":0},"children":{}}}},"zoomOut":{"doclet":{"description":"Options for the zoom out button. Properties for the zoom in and\nzoom out buttons are inherited from\n[mapNavigation.buttonOptions](#mapNavigation.buttonOptions), while\nindividual options can be overridden. By default, the `onclick`,\n`text` and `y` options are individual.","extends":"mapNavigation.buttonOptions"},"meta":{"fullname":"mapNavigation.buttons.zoomOut","name":"zoomOut","line":152,"lineEnd":160,"column":8,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{"onclick":{"doclet":{"description":"Click handler for the button.","type":{"names":["function"]},"defaultvalue":"function () { this.mapZoom(2); }"},"meta":{"fullname":"mapNavigation.buttons.zoomOut.onclick","name":"onclick","line":162,"lineEnd":162,"column":12,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{}},"text":{"doclet":{"description":"The text for the button. The tooltip (title) is a language option\ngiven by [lang.zoomOut](#lang.zoomIn).","type":{"names":["string"]},"defaultvalue":"-"},"meta":{"fullname":"mapNavigation.buttons.zoomOut.text","name":"text","line":172,"lineEnd":175,"column":12,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":"-"},"children":{}},"y":{"doclet":{"description":"The position of the zoomOut button relative to the vertical\nalignment.","type":{"names":["number"]},"defaultvalue":28},"meta":{"fullname":"mapNavigation.buttons.zoomOut.y","name":"y","line":177,"lineEnd":180,"column":12,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":28},"children":{}}}}}},"enableButtons":{"doclet":{"description":"Whether to enable navigation buttons. By default it inherits the\n[enabled](#mapNavigation.enabled) setting.","type":{"names":["boolean"]}},"meta":{"fullname":"mapNavigation.enableButtons","name":"enableButtons","line":184,"lineEnd":190,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{}},"enableDoubleClickZoom":{"doclet":{"description":"Enables zooming in on an area on double clicking in the map. By default\nit inherits the [enabled](#mapNavigation.enabled) setting.","type":{"names":["boolean"]}},"meta":{"fullname":"mapNavigation.enableDoubleClickZoom","name":"enableDoubleClickZoom","line":206,"lineEnd":212,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{}},"enableDoubleClickZoomTo":{"doclet":{"description":"Whether to zoom in on an area when that area is double clicked.","samples":[{"name":"Enable double click zoom to","value":"maps/mapnavigation/doubleclickzoomto/","products":["highmaps"]}],"type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"mapNavigation.enableDoubleClickZoomTo","name":"enableDoubleClickZoomTo","line":213,"lineEnd":222,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{}},"enableMouseWheelZoom":{"doclet":{"description":"Enables zooming by mouse wheel. By default it inherits the [enabled](#mapNavigation.enabled) setting.","type":{"names":["boolean"]}},"meta":{"fullname":"mapNavigation.enableMouseWheelZoom","name":"enableMouseWheelZoom","line":223,"lineEnd":229,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{}},"enableTouchZoom":{"doclet":{"description":"Whether to enable multitouch zooming. Note that if the chart covers the\nviewport, this prevents the user from using multitouch and touchdrag on\nthe web page, so you should make sure the user is not trapped inside the\nchart. By default it inherits the [enabled](#mapNavigation.enabled)\nsetting.","type":{"names":["boolean"]}},"meta":{"fullname":"mapNavigation.enableTouchZoom","name":"enableTouchZoom","line":230,"lineEnd":239,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Whether to enable map navigation. The default is not to enable\nnavigation, as many choropleth maps are simple and don't need it.\nAdditionally, when touch zoom and mouse wheel zoom is enabled, it breaks\nthe default behavior of these interactions in the website, and the\nimplementer should be aware of this.\n\nIndividual interactions can be enabled separately, namely buttons,\nmultitouch zoom, double click zoom, double click zoom to element and\nmouse wheel zoom.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"mapNavigation.enabled","name":"enabled","line":191,"lineEnd":205,"filename":"code/es-modules/Maps/MapNavigationDefaults.js"},"children":{}},"mouseWheelSensitivity":{"doclet":{"description":"Sensitivity of mouse wheel or trackpad scrolling. 1 is no sensitivity,\nwhile with 2, one mouse wheel delta will zoom in 50%.","since":"4.2.4","type":{"names":["number"]},"defaultvalue":1.1},"meta":{"fullname":"mapNavigation.mouseWheelSensitivity","name":"mouseWheelSensitivity","line":184,"lineEnd":190,"column":4,"filename":"code/es-modules/Maps/MapNavigationDefaults.js","default":1.1},"children":{}}}},"mapView":{"doclet":{"description":"The `mapView` options control the initial view of the chart, and how\nprojection is set up for raw geoJSON maps (beta as of v9.3).\n\nTo set the view dynamically after chart generation, see\n[mapView.setView](/class-reference/Highcharts.MapView#setView).","since":"9.3.0","products":["highmaps"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Maps/MapViewDefaults.js","name":"mapView","fullname":"mapView","line":12,"lineEnd":16,"column":0},"children":{"center":{"doclet":{"description":"The center of the map in terms of longitude and latitude. For\npreprojected maps (like the GeoJSON files in Map Collection v1.x),\nthe units are projected x and y units.","samples":[{"name":"Custom view of a world map","value":"maps/mapview/center-zoom","products":["highmaps"]},{"name":"Report the current view of a preprojected map","value":"maps/mapview/get-view","products":["highmaps"]}],"type":{"names":["Highcharts.LonLatArray"]},"defaultvalue":"[0, 0]","since":"9.3.0"},"meta":{"fullname":"mapView.center","name":"center","line":29,"lineEnd":41,"column":4,"filename":"code/es-modules/Maps/MapViewDefaults.js"},"children":{}},"fitToGeometry":{"doclet":{"description":"Fit the map to a geometry object consisting of individual points or\npolygons. This is practical for responsive maps where we want to\nfocus on a specific area regardless of map size - unlike setting\n`center` and `zoom`, where the view doesn't scale with different map\nsizes.\n\nThe geometry can be combined with the [padding](#mapView.padding)\noption to avoid touching the edges of the chart.","samples":[{"name":"Fitting the view to geometries","value":"maps/mapview/fittogeometry"}],"type":{"names":["object"]},"since":"10.3.3","defaultvalue":"undefined"},"meta":{"fullname":"mapView.fitToGeometry","name":"fitToGeometry","line":43,"lineEnd":58,"column":4,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":"undefined"},"children":{}},"insetOptions":{"doclet":{"description":"Generic options for the placement and appearance of map insets like\nnon-contiguous territories.","since":"10.0.0","products":["highmaps"],"type":{"names":["*"]}},"meta":{"fullname":"mapView.insetOptions","name":"insetOptions","line":166,"lineEnd":173,"column":4,"filename":"code/es-modules/Maps/MapViewDefaults.js"},"children":{"borderColor":{"doclet":{"description":"The border color of the insets.","samples":[{"name":"Inset border options","value":"maps/mapview/insetoptions-border"}],"type":{"names":["Highcharts.ColorType"]},"since":"10.0.0","defaultvalue":"#cccccc"},"meta":{"fullname":"mapView.insetOptions.borderColor","name":"borderColor","line":175,"lineEnd":182,"column":8,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":"#cccccc"},"children":{}},"borderWidth":{"doclet":{"description":"The pixel border width of the insets.","samples":[{"name":"Inset border options","value":"maps/mapview/insetoptions-border"}],"since":"10.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"mapView.insetOptions.borderWidth","name":"borderWidth","line":184,"lineEnd":189,"column":8,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":1},"children":{}},"padding":{"doclet":{"description":"The padding of the insets. Can be either a number of pixels, a\npercentage string, or an array of either. If an array is given, it\nsets the top, right, bottom, left paddings respectively.","type":{"names":["number","string","Array.<(number|string)>"]},"since":"10.0.0","defaultvalue":"10%"},"meta":{"fullname":"mapView.insetOptions.padding","name":"padding","line":191,"lineEnd":197,"column":8,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":"10%"},"children":{}},"relativeTo":{"doclet":{"description":"What coordinate system the `field` and `borderPath` should relate to.\n\nIf `plotBox`, they will be fixed to the plot box and responsively\nmove in relation to the main map.\n\nIf `mapBoundingBox`, they will be fixed to the map bounding box,\nwhich is constant and centered in different chart sizes and ratios.","type":{"names":["Highcharts.MapViewInsetOptionsRelativeToValue"]},"since":"10.0.0","defaultvalue":"mapBoundingBox"},"meta":{"fullname":"mapView.insetOptions.relativeTo","name":"relativeTo","line":199,"lineEnd":209,"column":8,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":"mapBoundingBox"},"children":{}},"units":{"doclet":{"description":"What units to use for the `field` and `borderPath` geometries. If\n`percent` (default), they relate to the box given in `relativeTo`. If\n`pixels`, they are absolute values.","values":"[\"percent\", \"pixels\"]","since":"10.0.0","type":{"names":["string"]},"defaultvalue":"percent"},"meta":{"fullname":"mapView.insetOptions.units","name":"units","line":211,"lineEnd":232,"column":8,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":"percent"},"children":{}}}},"insets":{"doclet":{"description":"The individual MapView insets, typically used for non-contiguous\nareas of a country. Each item inherits from the generic\n`insetOptions`.\n\nSome of the TopoJSON files of the [Highcharts Map\nCollection](https://code.highcharts.com/mapdata/) include a property\ncalled `hc-recommended-mapview`, and some of these include insets. In\norder to override the recommended inset options, an inset option with\na matching id can be applied, and it will be merged into the embedded\nsettings.","samples":[{"name":"Extending the embedded insets","value":"maps/mapview/insets-extended"},{"name":"Complete inset config from scratch","value":"maps/mapview/insets-complete"}],"extends":"mapView.insetOptions","type":{"names":["Array.<Object>"]},"products":["highmaps"],"since":"9.3.0"},"meta":{"fullname":"mapView.insets","name":"insets","line":211,"lineEnd":232,"filename":"code/es-modules/Maps/MapViewDefaults.js"},"children":{"borderPath":{"doclet":{"description":"A geometry object of type `MultiLineString` defining the border path\nof the inset in terms of `units`. If undefined, a border is rendered\naround the `field` geometry. It is recommended that the `borderPath`\npartly follows the outline of the `field` in order to make pointer\npositioning consistent.","samples":[{"name":"Complete inset config with `borderPath`","value":"maps/mapview/insets-complete"}],"products":["highmaps"],"type":{"names":["Object","undefined"]},"since":"9.3.0"},"meta":{"fullname":"mapView.insets.borderPath","name":"borderPath","line":233,"lineEnd":246,"filename":"code/es-modules/Maps/MapViewDefaults.js"},"children":{}},"field":{"doclet":{"description":"A geometry object of type `Polygon` defining where in the chart the\ninset should be rendered, in terms of `units` and relative to the\n`relativeTo` setting. If a `borderPath` is omitted, a border is\nrendered around the field. If undefined, the inset is rendered in the\nfull plot area.","samples":[{"name":"Border path emitted, field is rendered","value":"maps/mapview/insets-extended"}],"products":["highmaps"],"type":{"names":["object","undefined"]},"since":"9.3.0"},"meta":{"fullname":"mapView.insets.field","name":"field","line":247,"lineEnd":260,"filename":"code/es-modules/Maps/MapViewDefaults.js"},"children":{}},"geoBounds":{"doclet":{"description":"A geometry object of type `Polygon` encircling the shapes that should\nbe rendered in the inset, in terms of geographic coordinates.\nGeometries within this geometry are removed from the default map view\nand rendered in the inset.","samples":[{"name":"Complete inset config with `geoBounds`","value":"maps/mapview/insets-complete"}],"products":["highmaps"],"type":{"names":["object"]},"since":"9.3.0"},"meta":{"fullname":"mapView.insets.geoBounds","name":"geoBounds","line":261,"lineEnd":273,"filename":"code/es-modules/Maps/MapViewDefaults.js"},"children":{}},"id":{"doclet":{"description":"The id of the inset, used for internal reference.","samples":[{"name":"Extending recommended insets by id","value":"maps/mapview/insets-extended"}],"products":["highmaps"],"type":{"names":["string"]},"since":"9.3.0"},"meta":{"fullname":"mapView.insets.id","name":"id","line":274,"lineEnd":283,"filename":"code/es-modules/Maps/MapViewDefaults.js"},"children":{}},"projection":{"doclet":{"description":"The projection options for the inset.","products":["highmaps"],"type":{"names":["Object"]},"extends":"mapView.projection","since":"9.3.0"},"meta":{"fullname":"mapView.insets.projection","name":"projection","line":284,"lineEnd":291,"filename":"code/es-modules/Maps/MapViewDefaults.js"},"children":{}}}},"maxZoom":{"doclet":{"description":"Prevents the end user from zooming too far in on the map. See\n[zoom](#mapView.zoom).","samples":[{"name":"Prevent zooming in too far","value":"maps/mapview/maxzoom","products":["highmaps"]}],"type":{"names":["number","undefined"]},"since":"9.3.0","defaultvalue":null},"meta":{"fullname":"mapView.maxZoom","name":"maxZoom","line":60,"lineEnd":68,"column":4,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":"undefined"},"children":{}},"padding":{"doclet":{"description":"The padding inside the plot area when auto fitting to the map bounds.\nA number signifies pixels, and a percentage is relative to the plot\narea size.\n\nAn array sets individual padding for the sides in the order [top,\nright, bottom, left].","samples":[{"name":"Visible plot area and percentage padding","value":"maps/chart/plotbackgroundcolor-color","products":["highmaps"]},{"name":"Padding for individual sides","value":"maps/demo/mappoint-mapmarker","products":["highmaps"]}],"type":{"names":["Highcharts.MapViewPaddingType"]},"since":"9.3.0","defaultvalue":0},"meta":{"fullname":"mapView.padding","name":"padding","line":70,"lineEnd":84,"column":4,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":0},"children":{}},"projection":{"doclet":{"description":"The projection options allow applying client side projection to a map\ngiven in geographic coordinates, typically from TopoJSON or GeoJSON.","samples":[{"name":"Projection explorer","value":"maps/demo/projection-explorer"},{"name":"Orthographic projection","value":"maps/demo/topojson-projection"},{"name":"Custom UTM projection definition","value":"maps/mapview/projection-custom-proj4js"},{"name":"Custom Robinson projection definition","value":"maps/mapview/projection-custom-d3geo"}],"type":{"names":["object"]},"since":"9.3.0"},"meta":{"fullname":"mapView.projection","name":"projection","line":86,"lineEnd":100,"column":4,"filename":"code/es-modules/Maps/MapViewDefaults.js"},"children":{"name":{"doclet":{"description":"Projection name. Built-in projections are `EqualEarth`,\n`LambertConformalConic`, `Miller`, `Orthographic` and `WebMercator`.","samples":[{"name":"Projection explorer","value":"maps/demo/projection-explorer"},{"name":"Custom UTM projection definition","value":"maps/mapview/projection-custom-proj4js"},{"name":"Custom Robinson projection definition","value":"maps/mapview/projection-custom-d3geo"},{"name":"Orthographic projection","value":"maps/demo/topojson-projection"}],"type":{"names":["string"]},"since":"9.3.0","defaultvalue":"undefined"},"meta":{"fullname":"mapView.projection.name","name":"name","line":102,"lineEnd":116,"column":8,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":"undefined"},"children":{}},"parallels":{"doclet":{"description":"The two standard parallels that define the map layout in conic\nprojections, like the LambertConformalConic projection. If only\none number is given, the second parallel will be the same as the\nfirst.","samples":[{"name":"LCC projection with parallels","value":"maps/mapview/projection-parallels"},{"name":"Projection explorer","value":"maps/demo/projection-explorer"}],"type":{"names":["Array.<number>"]},"since":"9.3.0","defaultvalue":"undefined"},"meta":{"fullname":"mapView.projection.parallels","name":"parallels","line":118,"lineEnd":130,"column":8,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":"undefined"},"children":{}},"rotation":{"doclet":{"description":"Rotation of the projection in terms of degrees `[lambda, phi,\ngamma]`. When given, a three-axis spherical rotation is be applied\nto the globe prior to the projection.\n\n* `lambda` shifts the longitudes by the given value.\n* `phi` shifts the latitudes by the given value. Can be omitted.\n* `gamma` applies a _roll_. Can be omitted.","samples":[{"name":"Projection explorer","value":"maps/demo/projection-explorer"},{"name":"America-centric world map","value":"maps/mapview/projection-america-centric"}],"type":{"names":["Highcharts.ProjectionRotationOption"]},"since":"9.3.0","defaultvalue":"undefined"},"meta":{"fullname":"mapView.projection.rotation","name":"rotation","line":132,"lineEnd":146,"column":8,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":"undefined"},"children":{}}}},"zoom":{"doclet":{"description":"The zoom level of a map. Higher zoom levels means more zoomed in. An\nincrease of 1 zooms in to a quarter of the viewed area (half the\nwidth and height). Defaults to fitting to the map bounds.\n\nIn a `WebMercator` projection, a zoom level of 0 represents\nthe world in a 256x256 pixel square. This is a common concept for WMS\ntiling software.","samples":[{"name":"Custom view of a world map","value":"maps/mapview/center-zoom","products":["highmaps"]},{"name":"Report the current view of a preprojected map","value":"maps/mapview/get-view","products":["highmaps"]}],"type":{"names":["number"]},"since":"9.3.0","defaultvalue":null},"meta":{"fullname":"mapView.zoom","name":"zoom","line":149,"lineEnd":164,"column":4,"filename":"code/es-modules/Maps/MapViewDefaults.js","default":"undefined"},"children":{}}}},"navigation":{"doclet":{"description":"A collection of options for buttons and menus appearing in the exporting\nmodule or in Stock Tools.","requires":["module:modules/exporting"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js","name":"navigation","fullname":"navigation","line":19,"lineEnd":23,"column":0},"children":{"annotationsOptions":{"doclet":{"description":"Additional options to be merged into all annotations.","samples":[{"name":"Set red color of all line annotations","value":"stock/stocktools/navigation-annotation-options"}],"type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"annotations","exclude":["crookedLine","elliottWave","fibonacci","infinityLine","measure","pitchfork","tunnel","verticalLine","basicAnnotation"],"requires":["module:modules/annotations"]},"meta":{"fullname":"navigation.annotationsOptions","name":"annotationsOptions","line":392,"lineEnd":404,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{}},"bindings":{"doclet":{"description":"Bindings definitions for custom HTML buttons. Each binding implements\nsimple event-driven interface:\n\n- `className`: classname used to bind event to\n\n- `init`: initial event, fired on button click\n\n- `start`: fired on first click on a chart\n\n- `steps`: array of sequential events fired one after another on each\n  of users clicks\n\n- `end`: last event to be called after last step event","type":{"names":["Highcharts.Dictionary.<Highcharts.NavigationBindingsOptionsObject>"]},"samples":[{"name":"Custom stock tools bindings","value":"stock/stocktools/custom-stock-tools-bindings","products":["highstock"]}],"since":"7.0.0","requires":["module:modules/annotations"],"products":["highcharts","highstock"]},"meta":{"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js","name":"bindings","fullname":"navigation.bindings","line":19,"lineEnd":23,"column":0},"children":{"arrowInfinityLine":{"doclet":{"description":"A line with arrow annotation. Includes `start` and one event in `steps`\narray.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.arrowInfinityLine","name":"arrowInfinityLine","line":277,"lineEnd":284,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.arrowInfinityLine.annotationsOptions","name":"annotationsOptions","line":288,"lineEnd":293,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"arrowRay":{"doclet":{"description":"A ray with an arrow annotation bindings. Includes `start` and one event\nin `steps` array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.arrowRay","name":"arrowRay","line":179,"lineEnd":186,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.arrowRay.annotationsOptions","name":"annotationsOptions","line":190,"lineEnd":195,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"arrowSegment":{"doclet":{"description":"A segment with an arrow annotation bindings. Includes `start` and one\nevent in `steps` array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.arrowSegment","name":"arrowSegment","line":81,"lineEnd":88,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.arrowSegment.annotationsOptions","name":"annotationsOptions","line":92,"lineEnd":97,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"circleAnnotation":{"doclet":{"description":"A circle annotation bindings. Includes `start` and one event in\n`steps` array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.circleAnnotation","name":"circleAnnotation","line":113,"lineEnd":119,"column":8,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.circleAnnotation.annotationsOptions","name":"annotationsOptions","line":123,"lineEnd":128,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{}}}},"crooked3":{"doclet":{"description":"Crooked line (three points) annotation bindings. Includes `start` and two\nevents in `steps` (for second and third points in crooked line) array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.crooked3","name":"crooked3","line":411,"lineEnd":418,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.crooked3.annotationsOptions","name":"annotationsOptions","line":423,"lineEnd":428,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"crooked5":{"doclet":{"description":"Crooked line (five points) annotation bindings. Includes `start` and four\nevents in `steps` (for all consequent points in crooked line) array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.crooked5","name":"crooked5","line":458,"lineEnd":465,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.crooked5.annotationsOptions","name":"annotationsOptions","line":469,"lineEnd":474,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"currentPriceIndicator":{"doclet":{"description":"Hides/shows two price indicators:\n- last price in the dataset\n- last price in the selected range","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.currentPriceIndicator","name":"currentPriceIndicator","line":1420,"lineEnd":1428,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"elliott3":{"doclet":{"description":"Elliott wave (three points) annotation bindings. Includes `start` and two\nevents in `steps` (for second and third points) array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.elliott3","name":"elliott3","line":508,"lineEnd":515,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.elliott3.annotationsOptions","name":"annotationsOptions","line":519,"lineEnd":524,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"elliott5":{"doclet":{"description":"Elliott wave (five points) annotation bindings. Includes `start` and four\nevent in `steps` (for all consequent points in Elliott wave) array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.elliott5","name":"elliott5","line":556,"lineEnd":563,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.elliott5.annotationsOptions","name":"annotationsOptions","line":567,"lineEnd":572,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"ellipseAnnotation":{"doclet":{"description":"An ellipse annotation bindings. Includes `start` and two events in\n`steps` array. First updates the second point, responsible for a\nrx width, and second updates the ry width.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.ellipseAnnotation","name":"ellipseAnnotation","line":174,"lineEnd":181,"column":8,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.ellipseAnnotation.annotationsOptions","name":"annotationsOptions","line":184,"lineEnd":189,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{}},"className":{"doclet":{"type":{"names":["string"]},"defaultvalue":"highcharts-ellipse-annotation"},"meta":{"fullname":"navigation.bindings.ellipseAnnotation.className","name":"className","line":183,"lineEnd":183,"column":12,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"highcharts-ellipse-annotation"},"children":{}}}},"fibonacci":{"doclet":{"description":"A fibonacci annotation bindings. Includes `start` and two events in\n`steps` array (updates second point, then height).","samples":[{"name":"Custom stock tools bindings","value":"stock/stocktools/custom-stock-tools-bindings","products":["highstock"]}],"type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.fibonacci","name":"fibonacci","line":768,"lineEnd":768,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.fibonacci.annotationsOptions","name":"annotationsOptions","line":782,"lineEnd":787,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"className":{"doclet":{"type":{"names":["string"]},"defaultvalue":"highcharts-fibonacci"},"meta":{"fullname":"navigation.bindings.fibonacci.className","name":"className","line":781,"lineEnd":781,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js","default":"highcharts-fibonacci"},"children":{}}}},"fibonacciTimeZones":{"doclet":{"description":"The Fibonacci Time Zones annotation bindings. Includes `start` and one\nevent in `steps` array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.fibonacciTimeZones","name":"fibonacciTimeZones","line":1094,"lineEnd":1101,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.fibonacciTimeZones.annotationsOptions","name":"annotationsOptions","line":1105,"lineEnd":1110,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"flagCirclepin":{"doclet":{"description":"A flag series bindings. Includes `start` event. On click, finds the\nclosest point and marks it with a flag with `'circlepin'` shape.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.flagCirclepin","name":"flagCirclepin","line":1154,"lineEnd":1154,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"flagDiamondpin":{"doclet":{"description":"A flag series bindings. Includes `start` event. On click, finds the\nclosest point and marks it with a flag with `'diamondpin'` shape.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.flagDiamondpin","name":"flagDiamondpin","line":1169,"lineEnd":1176,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"flagSimplepin":{"doclet":{"description":"A flag series bindings. Includes `start` event.\nOn click, finds the closest point and marks it with a flag without pin\nshape.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.flagSimplepin","name":"flagSimplepin","line":1198,"lineEnd":1206,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"flagSquarepin":{"doclet":{"description":"A flag series bindings. Includes `start` event.\nOn click, finds the closest point and marks it with a flag with\n`'squarepin'` shape.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.flagSquarepin","name":"flagSquarepin","line":1183,"lineEnd":1191,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"fullScreen":{"doclet":{"description":"Displays chart in fullscreen.\n\n**Note**: Fullscreen is not supported on iPhone due to iOS limitations.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.fullScreen","name":"fullScreen","line":1399,"lineEnd":1407,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"noDataState":{"doclet":{"type":{"names":["string"]},"defaultvalue":"normal"},"meta":{"fullname":"navigation.bindings.fullScreen.noDataState","name":"noDataState","line":1411,"lineEnd":1411,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js","default":"normal"},"children":{}}}},"horizontalLine":{"doclet":{"description":"A horizontal line annotation. Includes `start` event.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.horizontalLine","name":"horizontalLine","line":329,"lineEnd":335,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.horizontalLine.annotationsOptions","name":"annotationsOptions","line":339,"lineEnd":344,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"indicators":{"doclet":{"description":"Indicators bindings. Includes `init` event to show a popup.\n\nNote: In order to show base series from the chart in the popup's\ndropdown each series requires\n[series.id](https://api.highcharts.com/highstock/series.line.id) to be\ndefined.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.indicators","name":"indicators","line":1451,"lineEnd":1462,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"infinityLine":{"doclet":{"description":"A line annotation. Includes `start` and one event in `steps` array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.infinityLine","name":"infinityLine","line":230,"lineEnd":236,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.infinityLine.annotationsOptions","name":"annotationsOptions","line":240,"lineEnd":245,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"labelAnnotation":{"doclet":{"description":"A label annotation bindings. Includes `start` event only.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.labelAnnotation","name":"labelAnnotation","line":295,"lineEnd":300,"column":8,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.labelAnnotation.annotationsOptions","name":"annotationsOptions","line":304,"lineEnd":309,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{}}}},"measureX":{"doclet":{"description":"A measure (x-dimension) annotation bindings. Includes `start` and one\nevent in `steps` array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.measureX","name":"measureX","line":608,"lineEnd":615,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.measureX.annotationsOptions","name":"annotationsOptions","line":619,"lineEnd":624,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"measureXY":{"doclet":{"description":"A measure (xy-dimension) annotation bindings. Includes `start` and one\nevent in `steps` array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.measureXY","name":"measureXY","line":715,"lineEnd":722,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.measureXY.annotationsOptions","name":"annotationsOptions","line":726,"lineEnd":731,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"measureY":{"doclet":{"description":"A measure (y-dimension) annotation bindings. Includes `start` and one\nevent in `steps` array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.measureY","name":"measureY","line":661,"lineEnd":668,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.measureY.annotationsOptions","name":"annotationsOptions","line":672,"lineEnd":677,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"parallelChannel":{"doclet":{"description":"A parallel channel (tunnel) annotation bindings. Includes `start` and\ntwo events in `steps` array (updates second point, then height).","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.parallelChannel","name":"parallelChannel","line":816,"lineEnd":823,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.parallelChannel.annotationsOptions","name":"annotationsOptions","line":827,"lineEnd":832,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"pitchfork":{"doclet":{"description":"An Andrew's pitchfork annotation bindings. Includes `start` and two\nevents in `steps` array (sets second and third control points).","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.pitchfork","name":"pitchfork","line":862,"lineEnd":869,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.pitchfork.annotationsOptions","name":"annotationsOptions","line":873,"lineEnd":878,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"ray":{"doclet":{"description":"A ray annotation bindings. Includes `start` and one event in `steps`\narray.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.ray","name":"ray","line":131,"lineEnd":138,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.ray.annotationsOptions","name":"annotationsOptions","line":142,"lineEnd":147,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"rectangleAnnotation":{"doclet":{"description":"A rectangle annotation bindings. Includes `start` and one event\nin `steps` array.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.rectangleAnnotation","name":"rectangleAnnotation","line":229,"lineEnd":235,"column":8,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.rectangleAnnotation.annotationsOptions","name":"annotationsOptions","line":239,"lineEnd":244,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{}}}},"saveChart":{"doclet":{"description":"Save a chart in localStorage under `highcharts-chart` key.\nStored items:\n- annotations\n- indicators (with yAxes)\n- flags","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.saveChart","name":"saveChart","line":1513,"lineEnd":1523,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"noDataState":{"doclet":{"type":{"names":["string"]},"defaultvalue":"normal"},"meta":{"fullname":"navigation.bindings.saveChart.noDataState","name":"noDataState","line":1527,"lineEnd":1527,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js","default":"normal"},"children":{}}}},"segment":{"doclet":{"description":"A segment annotation bindings. Includes `start` and one event in `steps`\narray.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.segment","name":"segment","line":33,"lineEnd":33,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.segment.annotationsOptions","name":"annotationsOptions","line":45,"lineEnd":50,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"seriesTypeCandlestick":{"doclet":{"description":"Changes main series to `'candlestick'` type.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.seriesTypeCandlestick","name":"seriesTypeCandlestick","line":1325,"lineEnd":1331,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"seriesTypeHLC":{"doclet":{"description":"Change main series to `'hlc'` type.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.seriesTypeHLC","name":"seriesTypeHLC","line":1363,"lineEnd":1369,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"className":{"doclet":{"type":{"names":["string"]},"defaultvalue":"highcharts-series-type-hlc"},"meta":{"fullname":"navigation.bindings.seriesTypeHLC.className","name":"className","line":1371,"lineEnd":1371,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js","default":"highcharts-series-type-hlc"},"children":{}}}},"seriesTypeHeikinAshi":{"doclet":{"description":"Changes main series to `'heikinashi'` type.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.seriesTypeHeikinAshi","name":"seriesTypeHeikinAshi","line":1344,"lineEnd":1350,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"seriesTypeHollowCandlestick":{"doclet":{"description":"Changes main series to `'hollowcandlestick'` type.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.seriesTypeHollowCandlestick","name":"seriesTypeHollowCandlestick","line":1380,"lineEnd":1386,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"seriesTypeLine":{"doclet":{"description":"Changes main series to `'line'` type.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.seriesTypeLine","name":"seriesTypeLine","line":1286,"lineEnd":1292,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"seriesTypeOhlc":{"doclet":{"description":"Changes main series to `'ohlc'` type.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.seriesTypeOhlc","name":"seriesTypeOhlc","line":1306,"lineEnd":1312,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"timeCycles":{"doclet":{"description":"A time cycles annotation bindings. Includes `start` event and 1 `step`\nevent. first click marks the beginning of the circle, and the second one\nsets its diameter.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.timeCycles","name":"timeCycles","line":963,"lineEnd":971,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.timeCycles.annotationsOptions","name":"annotationsOptions","line":974,"lineEnd":979,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"className":{"doclet":{"type":{"names":["string"]},"defaultvalue":"highcharts-time-cycles"},"meta":{"fullname":"navigation.bindings.timeCycles.className","name":"className","line":973,"lineEnd":973,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js","default":"highcharts-time-cycles"},"children":{}}}},"toggleAnnotations":{"doclet":{"description":"Hides/shows all annotations on a chart.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.toggleAnnotations","name":"toggleAnnotations","line":1480,"lineEnd":1486,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"verticalArrow":{"doclet":{"description":"A vertical arrow annotation bindings. Includes `start` event. On click,\nfinds the closest point and marks it with an arrow.\n`#06b535` is the color of the arrow when\npointing from above and `#f21313`\nwhen pointing from below the point.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.verticalArrow","name":"verticalArrow","line":1041,"lineEnd":1051,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.verticalArrow.annotationsOptions","name":"annotationsOptions","line":1055,"lineEnd":1060,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"verticalCounter":{"doclet":{"description":"A vertical counter annotation bindings. Includes `start` event. On click,\nfinds the closest point and marks it with a numeric annotation -\nincrementing counter on each add.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.verticalCounter","name":"verticalCounter","line":915,"lineEnd":915,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.verticalCounter.annotationsOptions","name":"annotationsOptions","line":928,"lineEnd":933,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"verticalLabel":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"navigation.bindings.verticalLabel","name":"verticalLabel","line":1006,"lineEnd":1006,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions"},"meta":{"fullname":"navigation.bindings.verticalLabel.annotationsOptions","name":"annotationsOptions","line":1009,"lineEnd":1014,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"verticalLine":{"doclet":{"description":"A vertical line annotation. Includes `start` event.","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.verticalLine","name":"verticalLine","line":370,"lineEnd":376,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{"annotationsOptions":{"doclet":{"description":"Options to customize the bindings' annotation shapes and labels.","type":{"names":["Highcharts.AnnotationsOptions"]},"extends":"navigation.annotationsOptions","since":"7.0.0"},"meta":{"fullname":"navigation.bindings.verticalLine.annotationsOptions","name":"annotationsOptions","line":380,"lineEnd":385,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"zoomX":{"doclet":{"description":"Enables zooming in xAxis on a chart. Includes `start` event which\nchanges [chart.zoomType](#chart.zoomType).","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.zoomX","name":"zoomX","line":1213,"lineEnd":1213,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"zoomXY":{"doclet":{"description":"Enables zooming in xAxis and yAxis on a chart. Includes `start` event\nwhich changes [chart.zoomType](#chart.zoomType).","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.zoomXY","name":"zoomXY","line":1262,"lineEnd":1269,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}},"zoomY":{"doclet":{"description":"Enables zooming in yAxis on a chart. Includes `start` event which\nchanges [chart.zoomType](#chart.zoomType).","type":{"names":["Highcharts.NavigationBindingsOptionsObject"]},"products":["highstock"],"defaultByProduct":{},"since":"7.0.0"},"meta":{"fullname":"navigation.bindings.zoomY","name":"zoomY","line":1238,"lineEnd":1245,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsBindings.js"},"children":{}}}},"bindingsClassName":{"doclet":{"description":"A CSS class name where all bindings will be attached to. Multiple\ncharts on the same page should have separate class names to prevent\nduplicating events.\n\nDefault value of versions < 7.0.4 `highcharts-bindings-wrapper`","since":"7.0.0","type":{"names":["string"]},"defaultvalue":"highcharts-bindings-container"},"meta":{"fullname":"navigation.bindingsClassName","name":"bindingsClassName","line":73,"lineEnd":82,"column":4,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js","default":"highcharts-bindings-container"},"children":{}},"breadcrumbs":{"doclet":{"description":"Options for breadcrumbs. Breadcrumbs general options are defined in\n`navigation.breadcrumbs`. Specific options for drilldown are set in\n`drilldown.breadcrumbs` and for tree-like series traversing, in\n`plotOptions[series].breadcrumbs`.","since":"10.0.0","products":["highcharts"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","name":"breadcrumbs","fullname":"navigation.breadcrumbs","line":30,"lineEnd":39,"column":0},"children":{"buttonSpacing":{"doclet":{"description":"The default padding for each button and separator in each direction.","type":{"names":["number"]},"since":"10.0.0","defaultvalue":5},"meta":{"fullname":"navigation.breadcrumbs.buttonSpacing","name":"buttonSpacing","line":41,"lineEnd":46,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":5},"children":{}},"buttonTheme":{"doclet":{"description":"A collection of attributes for the buttons. The object takes SVG\nattributes like `fill`, `stroke`, `stroke-width`, as well as `style`,\na collection of CSS properties for the text.\n\nThe object can also be extended with states, so you can set\npresentational options for `hover`, `select` or `disabled` button\nstates.","samples":[{"name":"Themed, single button","value":"highcharts/breadcrumbs/single-button","products":["highcharts"]}],"type":{"names":["Highcharts.SVGAttributes"]},"since":"10.0.0","products":["highcharts"]},"meta":{"fullname":"navigation.breadcrumbs.buttonTheme","name":"buttonTheme","line":48,"lineEnd":63,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js"},"children":{"style":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"navigation.breadcrumbs.buttonTheme.style","name":"style","line":81,"lineEnd":81,"column":8,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#334eff"},"meta":{"fullname":"navigation.breadcrumbs.buttonTheme.style.color","name":"color","line":82,"lineEnd":82,"column":12,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":"#334eff"},"children":{}}}}}},"events":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"click":{"doclet":{"description":"Fires when clicking on a breadcrumb button. Two arguments are passed\nto the function. First is the click event. Second is the breadcrumb\noptions for the clicked button.\n\n```js\nclick: function (e, breadcrumb) {\n  console.log(breadcrumb.level);\n}\n```\n\nReturn false to stop default buttons click action.","type":{"names":["Highcharts.BreadcrumbsClickCallbackFunction"]},"since":"10.0.0"},"meta":{"fullname":"navigation.breadcrumbs.events.click","name":"click","line":85,"lineEnd":101,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js"},"children":{}}}},"floating":{"doclet":{"description":"When the breadcrumbs are floating, the plot area will not move to\nmake space for it. By default, the chart will not make space for the\nbuttons. This property won't work when positioned in the middle.","samples":[{"name":"Floating button","value":"highcharts/breadcrumbs/single-button"}],"type":{"names":["boolean"]},"since":"10.0.0","defaultvalue":false},"meta":{"fullname":"navigation.breadcrumbs.floating","name":"floating","line":85,"lineEnd":101,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":false},"children":{}},"format":{"doclet":{"description":"A format string for the breadcrumbs button. Variables are enclosed by\ncurly brackets. Available values are passed in the declared point\noptions.","type":{"names":["string","undefined"]},"since":"10.0.0","defaultvalue":"undefined","samples":[{"name":"Display custom values in breadcrumb button.","value":"highcharts/breadcrumbs/format","products":["highcharts"]}]},"meta":{"fullname":"navigation.breadcrumbs.format","name":"format","line":114,"lineEnd":124,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":"undefined"},"children":{}},"formatter":{"doclet":{"description":"Callback function to format the breadcrumb text from scratch.","type":{"names":["Highcharts.BreadcrumbsFormatterCallbackFunction"]},"since":"10.0.0","defaultvalue":"undefined"},"meta":{"fullname":"navigation.breadcrumbs.formatter","name":"formatter","line":126,"lineEnd":133,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js"},"children":{}},"position":{"doclet":{"description":"Positioning for the button row. The breadcrumbs buttons will be\naligned properly for the default chart layout (title,  subtitle,\nlegend, range selector) for the custom chart layout set the position\nproperties.","samples":[{"name":"Single, right aligned button","value":"highcharts/breadcrumbs/single-button","products":["highcharts"]}],"type":{"names":["Highcharts.BreadcrumbsAlignOptions"]},"since":"10.0.0","products":["highcharts","highmaps"]},"meta":{"fullname":"navigation.breadcrumbs.position","name":"position","line":155,"lineEnd":167,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js"},"children":{"align":{"doclet":{"description":"Horizontal alignment of the breadcrumbs buttons.","type":{"names":["Highcharts.AlignValue"]},"since":"10.0.0","defaultvalue":"left"},"meta":{"fullname":"navigation.breadcrumbs.position.align","name":"align","line":169,"lineEnd":173,"column":8,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":"left"},"children":{}},"verticalAlign":{"doclet":{"description":"Vertical alignment of the breadcrumbs buttons.","type":{"names":["Highcharts.VerticalAlignValue"]},"since":"10.0.0","defaultvalue":"top"},"meta":{"fullname":"navigation.breadcrumbs.position.verticalAlign","name":"verticalAlign","line":175,"lineEnd":179,"column":8,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":"top"},"children":{}},"x":{"doclet":{"description":"The X offset of the breadcrumbs button group.","type":{"names":["number"]},"since":"10.0.0","defaultvalue":0},"meta":{"fullname":"navigation.breadcrumbs.position.x","name":"x","line":181,"lineEnd":185,"column":8,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"The Y offset of the breadcrumbs button group. When `undefined`,\nand `floating` is `false`, the `y` position is adapted so that\nthe breadcrumbs are rendered outside the target area.","type":{"names":["number","undefined"]},"since":"10.0.0","defaultvalue":null},"meta":{"fullname":"navigation.breadcrumbs.position.y","name":"y","line":187,"lineEnd":193,"column":8,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":"undefined"},"children":{}}}},"relativeTo":{"doclet":{"description":"What box to align the button to. Can be either `plotBox` or\n`spacingBox`.","type":{"names":["Highcharts.ButtonRelativeToValue"]},"defaultvalue":"plotBox","since":"10.0.0","products":["highcharts","highmaps"]},"meta":{"fullname":"navigation.breadcrumbs.relativeTo","name":"relativeTo","line":126,"lineEnd":133,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":"plotBox"},"children":{}},"rtl":{"doclet":{"description":"Whether to reverse the order of buttons. This is common in Arabic\nand Hebrew.","samples":[{"name":"Breadcrumbs in RTL","value":"highcharts/breadcrumbs/rtl","products":["highcharts"]}],"type":{"names":["boolean"]},"since":"10.2.0","defaultvalue":false},"meta":{"fullname":"navigation.breadcrumbs.rtl","name":"rtl","line":144,"lineEnd":153,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":false},"children":{}},"separator":{"doclet":{"description":"Options object for Breadcrumbs separator.","since":"10.0.0","type":{"names":["*"]}},"meta":{"fullname":"navigation.breadcrumbs.separator","name":"separator","line":196,"lineEnd":200,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js"},"children":{"style":{"doclet":{"description":"CSS styles for the breadcrumbs separator.\n\nIn styled mode, the breadcrumbs separators are styled by the\n`.highcharts-separator` rule with its different states.","type":{"names":["Highcharts.CSSObject"]},"since":"10.0.0"},"meta":{"fullname":"navigation.breadcrumbs.separator.style","name":"style","line":208,"lineEnd":216,"column":8,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#666666"},"meta":{"fullname":"navigation.breadcrumbs.separator.style.color","name":"color","line":218,"lineEnd":218,"column":12,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":"#666666"},"children":{}},"fontSize":{"doclet":{"type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"navigation.breadcrumbs.separator.style.fontSize","name":"fontSize","line":219,"lineEnd":219,"column":12,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":"0.8em"},"children":{}}}},"text":{"doclet":{"type":{"names":["string"]},"since":"10.0.0","products":["highcharts"],"defaultvalue":"/"},"meta":{"fullname":"navigation.breadcrumbs.separator.text","name":"text","line":202,"lineEnd":206,"column":8,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":"/"},"children":{}}}},"showFullPath":{"doclet":{"description":"Show full path or only a single button.","samples":[{"name":"Single, styled button","value":"highcharts/breadcrumbs/single-button","products":["highcharts"]}],"type":{"names":["boolean"]},"since":"10.0.0","defaultvalue":true},"meta":{"fullname":"navigation.breadcrumbs.showFullPath","name":"showFullPath","line":222,"lineEnd":230,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":true},"children":{}},"style":{"doclet":{"description":"CSS styles for all breadcrumbs.\n\nIn styled mode, the breadcrumbs buttons are styled by the\n`.highcharts-breadcrumbs-buttons .highcharts-button` rule with its\ndifferent states.","type":{"names":["Highcharts.SVGAttributes"]},"since":"10.0.0"},"meta":{"fullname":"navigation.breadcrumbs.style","name":"style","line":232,"lineEnd":241,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js"},"children":{}},"useHTML":{"doclet":{"description":"Whether to use HTML to render the breadcrumbs items texts.","type":{"names":["boolean"]},"since":"10.0.0","defaultvalue":false},"meta":{"fullname":"navigation.breadcrumbs.useHTML","name":"useHTML","line":243,"lineEnd":248,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":false},"children":{}},"zIndex":{"doclet":{"description":"The z index of the breadcrumbs group.","type":{"names":["number"]},"since":"10.0.0","defaultvalue":7},"meta":{"fullname":"navigation.breadcrumbs.zIndex","name":"zIndex","line":250,"lineEnd":255,"column":4,"filename":"code/es-modules/Extensions/Breadcrumbs/BreadcrumbsDefaults.js","default":7},"children":{}}}},"buttonOptions":{"doclet":{"description":"A collection of options for buttons appearing in the exporting\nmodule.\n\nIn styled mode, the buttons are styled with the\n`.highcharts-contextbutton` and `.highcharts-button-symbol` classes.","requires":["module:modules/exporting"],"type":{"names":["*"]}},"meta":{"fullname":"navigation.buttonOptions","name":"buttonOptions","line":613,"lineEnd":621,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"align":{"doclet":{"description":"Alignment for the buttons.","samples":[{"name":"Center aligned","value":"highcharts/navigation/buttonoptions-align/"}],"type":{"names":["Highcharts.AlignValue"]},"since":"2.0.0","defaultvalue":"right"},"meta":{"fullname":"navigation.buttonOptions.align","name":"align","line":661,"lineEnd":669,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"right"},"children":{}},"buttonSpacing":{"doclet":{"description":"The pixel spacing between buttons, and between the context button and\nthe title.","samples":[{"name":"Adjust the spacing when using text button","value":"highcharts/title/widthadjust"}],"since":"2.0.0","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"navigation.buttonOptions.buttonSpacing","name":"buttonSpacing","line":671,"lineEnd":679,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":5},"children":{}},"enabled":{"doclet":{"description":"Whether to enable buttons.","samples":[{"name":"Exporting module loaded but buttons disabled","value":"highcharts/navigation/buttonoptions-enabled/"}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"2.0.0"},"meta":{"fullname":"navigation.buttonOptions.enabled","name":"enabled","line":623,"lineEnd":633,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"height":{"doclet":{"description":"Pixel height of the buttons.","samples":[{"name":"Bigger buttons","value":"highcharts/navigation/buttonoptions-height/"}],"since":"2.0.0","type":{"names":["number"]},"defaultvalue":28},"meta":{"fullname":"navigation.buttonOptions.height","name":"height","line":681,"lineEnd":688,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":28},"children":{}},"symbolFill":{"doclet":{"description":"Fill color for the symbol within the button.","samples":[{"name":"Blue symbol stroke for one of the buttons","value":"highcharts/navigation/buttonoptions-symbolfill/"}],"type":{"names":["Highcharts.ColorType"]},"since":"2.0.0","defaultvalue":"#666666"},"meta":{"fullname":"navigation.buttonOptions.symbolFill","name":"symbolFill","line":748,"lineEnd":756,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"#666666"},"children":{}},"symbolSize":{"doclet":{"description":"The pixel size of the symbol on the button.","samples":[{"name":"Bigger buttons","value":"highcharts/navigation/buttonoptions-height/"}],"since":"2.0.0","type":{"names":["number"]},"defaultvalue":14},"meta":{"fullname":"navigation.buttonOptions.symbolSize","name":"symbolSize","line":623,"lineEnd":633,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":14},"children":{}},"symbolStroke":{"doclet":{"description":"The color of the symbol's stroke or line.","samples":[{"name":"Blue symbol stroke","value":"highcharts/navigation/buttonoptions-symbolstroke/"}],"type":{"names":["Highcharts.ColorString"]},"since":"2.0.0","defaultvalue":"#666666"},"meta":{"fullname":"navigation.buttonOptions.symbolStroke","name":"symbolStroke","line":758,"lineEnd":766,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"#666666"},"children":{}},"symbolStrokeWidth":{"doclet":{"description":"The pixel stroke width of the symbol on the button.","samples":[{"name":"Bigger buttons","value":"highcharts/navigation/buttonoptions-height/"}],"since":"2.0.0","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"navigation.buttonOptions.symbolStrokeWidth","name":"symbolStrokeWidth","line":768,"lineEnd":775,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":3},"children":{}},"symbolX":{"doclet":{"description":"The x position of the center of the symbol inside the button.","samples":[{"name":"Bigger buttons","value":"highcharts/navigation/buttonoptions-height/"}],"since":"2.0.0","type":{"names":["number"]},"defaultvalue":14.5},"meta":{"fullname":"navigation.buttonOptions.symbolX","name":"symbolX","line":643,"lineEnd":650,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":14.5},"children":{}},"symbolY":{"doclet":{"description":"The y position of the center of the symbol inside the button.","samples":[{"name":"Bigger buttons","value":"highcharts/navigation/buttonoptions-height/"}],"since":"2.0.0","type":{"names":["number"]},"defaultvalue":13.5},"meta":{"fullname":"navigation.buttonOptions.symbolY","name":"symbolY","line":652,"lineEnd":659,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":13.5},"children":{}},"text":{"doclet":{"description":"A text string to add to the individual button.","samples":[{"name":"Full text button","value":"highcharts/exporting/buttons-text/"},{"name":"Icon using CSS font in text","value":"highcharts/exporting/buttons-text-usehtml/"},{"name":"Combined symbol and text","value":"highcharts/exporting/buttons-text-symbol/"}],"type":{"names":["string"]},"defaultvalue":"null","since":"3.0.0"},"meta":{"fullname":"navigation.buttonOptions.text","name":"text","line":690,"lineEnd":704,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"theme":{"doclet":{"description":"A configuration object for the button theme. The object accepts\nSVG properties like `stroke-width`, `stroke` and `fill`.\nTri-state button styles are supported by the `states.hover` and\n`states.select` objects.","samples":[{"name":"Theming the buttons","value":"highcharts/navigation/buttonoptions-theme/"}],"requires":["module:modules/exporting"],"since":"3.0.0","type":{"names":["*"]}},"meta":{"fullname":"navigation.buttonOptions.theme","name":"theme","line":777,"lineEnd":789,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{"fill":{"doclet":{"description":"The default fill exists only to capture hover events.","type":{"names":["Highcharts.ColorType"]},"since":"3.0.0","defaultvalue":"#ffffff"},"meta":{"fullname":"navigation.buttonOptions.theme.fill","name":"fill","line":791,"lineEnd":795,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"#ffffff"},"children":{}},"padding":{"doclet":{"description":"Padding for the button.","since":"3.0.0","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"navigation.buttonOptions.theme.padding","name":"padding","line":797,"lineEnd":799,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":5},"children":{}},"stroke":{"doclet":{"description":"Default stroke for the buttons.","type":{"names":["Highcharts.ColorString"]},"since":"3.0.0","defaultvalue":"none"},"meta":{"fullname":"navigation.buttonOptions.theme.stroke","name":"stroke","line":801,"lineEnd":805,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"none"},"children":{}},"stroke-linecap":{"doclet":{"description":"Default stroke linecap for the buttons.","since":"3.0.0","type":{"names":["string"]},"defaultvalue":"round"},"meta":{"fullname":"navigation.buttonOptions.theme.stroke-linecap","name":"stroke-linecap","line":807,"lineEnd":809,"column":12,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"round"},"children":{}}}},"useHTML":{"doclet":{"description":"Whether to use HTML for rendering the button. HTML allows for things\nlike inline CSS or image-based icons.","samples":[{"name":"Icon using CSS font in text","value":"highcharts/exporting/buttons-text-usehtml/"}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"10.3.0"},"meta":{"fullname":"navigation.buttonOptions.useHTML","name":"useHTML","line":705,"lineEnd":716,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of the buttons. Can be one of `\"top\"`,\n`\"middle\"` or `\"bottom\"`.","samples":[{"name":"Buttons at lower right","value":"highcharts/navigation/buttonoptions-verticalalign/"}],"type":{"names":["Highcharts.VerticalAlignValue"]},"since":"2.0.0","defaultvalue":"top"},"meta":{"fullname":"navigation.buttonOptions.verticalAlign","name":"verticalAlign","line":728,"lineEnd":737,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":"top"},"children":{}},"width":{"doclet":{"description":"The pixel width of the button.","samples":[{"name":"Bigger buttons","value":"highcharts/navigation/buttonoptions-height/"}],"since":"2.0.0","type":{"names":["number"]},"defaultvalue":28},"meta":{"fullname":"navigation.buttonOptions.width","name":"width","line":739,"lineEnd":746,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":28},"children":{}},"y":{"doclet":{"description":"The vertical offset of the button's position relative to its\n`verticalAlign`. By default adjusted for the chart title alignment.","samples":[{"name":"Buttons at lower right","value":"highcharts/navigation/buttonoptions-verticalalign/"}],"since":"2.0.0","type":{"names":["number"]},"defaultvalue":-5},"meta":{"fullname":"navigation.buttonOptions.y","name":"y","line":690,"lineEnd":704,"column":8,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js","default":-5},"children":{}}}},"events":{"doclet":{"description":"Events to communicate between Stock Tools and custom GUI.","since":"7.0.0","products":["highcharts","highstock"],"type":{"names":["*"]}},"meta":{"fullname":"navigation.events","name":"events","line":341,"lineEnd":349,"column":4,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{"closePopup":{"doclet":{"description":"A `closePopup` event. Fired when Popup should be hidden, for example\nwhen clicking on an annotation again.","type":{"names":["function"]},"since":"7.0.0"},"meta":{"fullname":"navigation.events.closePopup","name":"closePopup","line":356,"lineEnd":362,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{}},"deselectButton":{"doclet":{"description":"Event fired when button state should change, for example after\nadding an annotation.","type":{"names":["function"]},"samples":[{"name":"Change icon in a dropddown on event","value":"highcharts/annotations/gui/"},{"name":"Change button class on event","value":"highcharts/annotations/gui-buttons/"}],"since":"7.0.0"},"meta":{"fullname":"navigation.events.deselectButton","name":"deselectButton","line":373,"lineEnd":383,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{}},"selectButton":{"doclet":{"description":"Event fired on a button click.","type":{"names":["function"]},"samples":[{"name":"Change icon in a dropddown on event","value":"highcharts/annotations/gui/"},{"name":"Change button class on event","value":"highcharts/annotations/gui-buttons/"}],"since":"7.0.0"},"meta":{"fullname":"navigation.events.selectButton","name":"selectButton","line":363,"lineEnd":372,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{}},"showPopup":{"doclet":{"description":"A `showPopup` event. Fired when selecting for example an annotation.","type":{"names":["function"]},"since":"7.0.0"},"meta":{"fullname":"navigation.events.showPopup","name":"showPopup","line":350,"lineEnd":355,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{}}}},"iconsURL":{"doclet":{"description":"Path where Highcharts will look for icons. Change this to use icons\nfrom a different server.","type":{"names":["string"]},"defaultByProduct":{},"since":"7.1.3"},"meta":{"fullname":"navigation.iconsURL","name":"iconsURL","line":341,"lineEnd":349,"filename":"code/es-modules/Extensions/Annotations/NavigationBindingsDefaults.js"},"children":{}},"menuItemHoverStyle":{"doclet":{"description":"CSS styles for the hover state of the individual items within the\npopup menu appearing by default when the export icon is clicked. The\nmenu items are rendered in HTML.","see":["In styled mode, the menu items are styled with the\n     `.highcharts-menu-item` class."],"samples":[{"name":"Bold text on hover","value":"highcharts/navigation/menuitemhoverstyle/"}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"background\": \"#f2f2f2\" }","since":"2.0.0"},"meta":{"fullname":"navigation.menuItemHoverStyle","name":"menuItemHoverStyle","line":867,"lineEnd":881,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"menuItemStyle":{"doclet":{"description":"CSS styles for the individual items within the popup menu appearing\nby default when the export icon is clicked. The menu items are\nrendered in HTML. Font size defaults to `11px` on desktop and `14px`\non touch devices.","see":["In styled mode, the menu items are styled with the\n     `.highcharts-menu-item` class."],"samples":[{"name":"Add a grey stripe to the left","value":"highcharts/navigation/menuitemstyle/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"padding\": \"0.5em\", \"color\": \"#333333\", \"background\": \"none\", \"borderRadius\": \"3px\", \"fontSize\": \"0.8em\", \"transition\": \"background 250ms, color 250ms\"}","since":"2.0.0"},"meta":{"fullname":"navigation.menuItemStyle","name":"menuItemStyle","line":837,"lineEnd":852,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}},"menuStyle":{"doclet":{"description":"CSS styles for the popup menu appearing by default when the export\nicon is clicked. This menu is rendered in HTML.","see":["In styled mode, the menu is styled with the `.highcharts-menu`\n     class."],"samples":[{"name":"Light gray menu background","value":"highcharts/navigation/menustyle/"}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"background\": \"#ffffff\", \"borderRadius\": \"3px\", \"padding\": \"0.5em\"}","since":"2.0.0"},"meta":{"fullname":"navigation.menuStyle","name":"menuStyle","line":813,"lineEnd":826,"column":4,"filename":"code/es-modules/Extensions/Exporting/ExportingDefaults.js"},"children":{}}}},"navigator":{"doclet":{"description":"The navigator is a small series below the main series, displaying\na view of the entire data set. It provides tools to zoom in and\nout on parts of the data as well as panning across the dataset.","products":["highstock","gantt"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","name":"navigator","fullname":"navigator","line":16,"lineEnd":20,"column":0},"children":{"accessibility":{"doclet":{"description":"Accessibility options for the navigator. Requires the\nAccessibility module.","since":"11.2.0","requires":["module:modules/accessibility"],"type":{"names":["*"]}},"meta":{"fullname":"navigator.accessibility","name":"accessibility","line":966,"lineEnd":972,"column":8,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable accessibility support for the navigator.","since":"11.2.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"navigator.accessibility.enabled","name":"enabled","line":974,"lineEnd":978,"column":12,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js","default":true},"children":{}}}},"adaptToUpdatedData":{"doclet":{"description":"Whether the navigator and scrollbar should adapt to updated data\nin the base X axis. When loading data async, as in the demo below,\nthis should be `false`. Otherwise new data will trigger navigator\nredraw, which will cause unwanted looping. In the demo below, the\ndata in the navigator is set only once. On navigating, only the main\nchart content is updated.","samples":[{"name":"Set to false with async data loading","value":"stock/demo/lazy-loading/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"navigator.adaptToUpdatedData","name":"adaptToUpdatedData","line":30,"lineEnd":44,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"baseSeries":{"doclet":{"description":"An integer identifying the index to use for the base series, or a\nstring representing the id of the series.\n\n**Note**: As of Highcharts 5.0, this is now a deprecated option.\nPrefer [series.showInNavigator](#plotOptions.series.showInNavigator).","see":["[series.showInNavigator](#plotOptions.series.showInNavigator)"],"deprecated":true,"type":{"names":["number","string"]},"defaultvalue":"0"},"meta":{"fullname":"navigator.baseSeries","name":"baseSeries","line":45,"lineEnd":58,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the navigator.","samples":[{"name":"Disable the navigator","value":"stock/navigator/enabled/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"navigator.enabled","name":"enabled","line":59,"lineEnd":68,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"handles":{"doclet":{"description":"Options for the handles for dragging the zoomed area.","samples":[{"name":"Colored handles","value":"stock/navigator/handles/","products":["highstock"]}],"type":{"names":["*"]}},"meta":{"fullname":"navigator.handles","name":"handles","line":102,"lineEnd":107,"column":4,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{"backgroundColor":{"doclet":{"description":"The fill for the handle.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#f2f2f2"},"meta":{"fullname":"navigator.handles.backgroundColor","name":"backgroundColor","line":173,"lineEnd":177,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"#f2f2f2"},"children":{}},"borderColor":{"doclet":{"description":"The stroke for the handle border and the stripes inside.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#999999"},"meta":{"fullname":"navigator.handles.borderColor","name":"borderColor","line":179,"lineEnd":183,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"#999999"},"children":{}},"borderRadius":{"doclet":{"description":"Border radius of the handles.","samples":[{"name":"Border radius on the navigator handles.","value":"stock/navigator/handles-border-radius/","products":["highstock"]}],"since":"11.4.2","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"navigator.handles.borderRadius","name":"borderRadius","line":118,"lineEnd":125,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":0},"children":{}},"enabled":{"doclet":{"description":"Allows to enable/disable handles.","since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"navigator.handles.enabled","name":"enabled","line":157,"lineEnd":161,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":true},"children":{}},"height":{"doclet":{"description":"Height for handles.","samples":[{"name":"Styled handles","value":"stock/navigator/styled-handles/","products":["highstock"]}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":15},"meta":{"fullname":"navigator.handles.height","name":"height","line":127,"lineEnd":134,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":15},"children":{}},"lineWidth":{"doclet":{"description":"The width for the handle border and the stripes inside.","samples":[{"name":"Styled handles","value":"stock/navigator/styled-handles/","products":["highstock"]}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"navigator.handles.lineWidth","name":"lineWidth","line":163,"lineEnd":171,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":1},"children":{}},"symbols":{"doclet":{"description":"Array to define shapes of handles. 0-index for left, 1-index for\nright.\n\nAdditionally, the URL to a graphic can be given on this form:\n`url(graphic.png)`. Note that for the image to be applied to\nexported charts, its URL needs to be accessible by the export\nserver.\n\nCustom callbacks for symbol path generation can also be added to\n`Highcharts.SVGRenderer.prototype.symbols`. The callback is then\nused by its method name, as shown in the demo.","samples":[{"name":"Styled handles","value":"stock/navigator/styled-handles/","products":["highstock"]}],"type":{"names":["Array.<string>"]},"defaultvalue":"[\"navigator-handle\", \"navigator-handle\"]","since":"6.0.0"},"meta":{"fullname":"navigator.handles.symbols","name":"symbols","line":136,"lineEnd":155,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"width":{"doclet":{"description":"Width for handles.","samples":[{"name":"Styled handles","value":"stock/navigator/styled-handles/","products":["highstock"]}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":7},"meta":{"fullname":"navigator.handles.width","name":"width","line":109,"lineEnd":116,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":7},"children":{}}}},"height":{"doclet":{"description":"The height of the navigator.","samples":[{"name":"A higher navigator","value":"stock/navigator/height/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":40},"meta":{"fullname":"navigator.height","name":"height","line":30,"lineEnd":44,"column":4,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":40},"children":{}},"margin":{"doclet":{"description":"The distance from the nearest element, the X axis or X axis labels.","samples":[{"name":"A margin of 2 draws the navigator closer to the X axis labels","value":"stock/navigator/margin/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":22},"meta":{"fullname":"navigator.margin","name":"margin","line":85,"lineEnd":90,"column":4,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":22},"children":{}},"maskFill":{"doclet":{"description":"The color of the mask covering the areas of the navigator series\nthat are currently not visible in the main series. The default\ncolor is bluish with an opacity of 0.3 to see the series below.","see":["In styled mode, the mask is styled with the\n     `.highcharts-navigator-mask` and\n     `.highcharts-navigator-mask-inside` classes."],"samples":[{"name":"Blue, semi transparent mask","value":"stock/navigator/maskfill/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"rgba(102,133,194,0.3)"},"meta":{"fullname":"navigator.maskFill","name":"maskFill","line":186,"lineEnd":200,"column":4,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"maskInside":{"doclet":{"description":"Whether the mask should be inside the range marking the zoomed\nrange, or outside. In Highcharts Stock 1.x it was always `false`.","samples":[{"name":"False, mask outside","value":"stock/demo/maskinside-false/","products":["highstock"]}],"since":"2.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"navigator.maskInside","name":"maskInside","line":92,"lineEnd":100,"column":4,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":true},"children":{}},"opposite":{"doclet":{"description":"When the chart is inverted, whether to draw the navigator on the\nopposite side.","type":{"names":["boolean"]},"defaultvalue":"false","since":"5.0.8"},"meta":{"fullname":"navigator.opposite","name":"opposite","line":69,"lineEnd":77,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"outlineColor":{"doclet":{"description":"The color of the line marking the currently zoomed area in the\nnavigator.","samples":[{"name":"2px blue outline","value":"stock/navigator/outline/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"navigator.outlineColor","name":"outlineColor","line":202,"lineEnd":211,"column":4,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"#999999"},"children":{}},"outlineWidth":{"doclet":{"description":"The width of the line marking the currently zoomed area in the\nnavigator.","see":["In styled mode, the outline stroke width is set with the\n     `.highcharts-navigator-outline` class."],"samples":[{"name":"2px blue outline","value":"stock/navigator/outline/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"navigator.outlineWidth","name":"outlineWidth","line":213,"lineEnd":224,"column":4,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":1},"children":{}},"series":{"doclet":{"description":"Options for the navigator series. Available options are the same\nas any series, documented at [plotOptions](#plotOptions.series)\nand [series](#series).\n\nUnless data is explicitly defined on navigator.series, the data\nis borrowed from the first series in the chart.\n\nDefault series options for the navigator series are:\n```js\nseries: {\n    type: 'areaspline',\n    fillOpacity: 0.05,\n    dataGrouping: {\n        smoothed: true\n    },\n    lineWidth: 1,\n    marker: {\n        enabled: false\n    }\n}\n```","see":["In styled mode, the navigator series is styled with the\n     `.highcharts-navigator-series` class."],"samples":[{"name":"Using a separate data set for the navigator","value":"stock/navigator/series-data/","products":["highstock"]},{"name":"A green navigator series","value":"stock/navigator/series/","products":["highstock"]}],"type":{"names":["*","Array.<*>","Highcharts.SeriesOptionsType","Array.<Highcharts.SeriesOptionsType>"]}},"meta":{"fullname":"navigator.series","name":"series","line":226,"lineEnd":258,"column":4,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{"className":{"doclet":{"type":{"names":["string"]},"defaultvalue":"highcharts-navigator-series"},"meta":{"fullname":"navigator.series.className","name":"className","line":339,"lineEnd":339,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"highcharts-navigator-series"},"children":{}},"color":{"doclet":{"description":"Sets the fill color of the navigator series.","type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"navigator.series.color","name":"color","line":340,"lineEnd":345,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"data":{"doclet":{"description":"Unless data is explicitly defined, the data is borrowed from the\nfirst series in the chart.","type":{"names":["Array.<(number|Array.<(number|string|null)>|object|null)>"]},"products":["highstock"]},"meta":{"fullname":"navigator.series.data","name":"data","line":295,"lineEnd":302,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"dataGrouping":{"doclet":{"description":"Data grouping options for the navigator series.","extends":"plotOptions.series.dataGrouping"},"meta":{"fullname":"navigator.series.dataGrouping","name":"dataGrouping","line":295,"lineEnd":302,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{"anchor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"middle"},"meta":{"fullname":"navigator.series.dataGrouping.anchor","name":"anchor","line":314,"lineEnd":314,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"middle"},"children":{}},"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"average"},"meta":{"fullname":"navigator.series.dataGrouping.approximation","name":"approximation","line":309,"lineEnd":309,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"average"},"children":{}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"navigator.series.dataGrouping.enabled","name":"enabled","line":310,"lineEnd":310,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":true},"children":{}},"firstAnchor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"firstPoint"},"meta":{"fullname":"navigator.series.dataGrouping.firstAnchor","name":"firstAnchor","line":312,"lineEnd":312,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"firstPoint"},"children":{}},"groupPixelWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"navigator.series.dataGrouping.groupPixelWidth","name":"groupPixelWidth","line":311,"lineEnd":311,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":2},"children":{}},"lastAnchor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"lastPoint"},"meta":{"fullname":"navigator.series.dataGrouping.lastAnchor","name":"lastAnchor","line":315,"lineEnd":315,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"lastPoint"},"children":{}}}},"dataLabels":{"doclet":{"description":"Data label options for the navigator series. Data labels are\ndisabled by default on the navigator series.","extends":"plotOptions.series.dataLabels"},"meta":{"fullname":"navigator.series.dataLabels","name":"dataLabels","line":328,"lineEnd":333,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"navigator.series.dataLabels.enabled","name":"enabled","line":335,"lineEnd":335,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":false},"children":{}},"zIndex":{"doclet":{"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"navigator.series.dataLabels.zIndex","name":"zIndex","line":336,"lineEnd":336,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":2},"children":{}}}},"fillOpacity":{"doclet":{"description":"The fill opacity of the navigator series.","type":{"names":["number"]},"defaultvalue":0.05},"meta":{"fullname":"navigator.series.fillOpacity","name":"fillOpacity","line":277,"lineEnd":279,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":0.05},"children":{}},"id":{"doclet":{"type":{"names":["string"]},"defaultvalue":"highcharts-navigator-series"},"meta":{"fullname":"navigator.series.id","name":"id","line":338,"lineEnd":338,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"highcharts-navigator-series"},"children":{}},"lineColor":{"doclet":{"description":"Line color for the navigator series. Allows setting the color\nwhile disallowing the default candlestick setting.","type":{"names":["Highcharts.ColorString","null"]},"defaultvalue":null},"meta":{"fullname":"navigator.series.lineColor","name":"lineColor","line":340,"lineEnd":345,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":null},"children":{}},"lineWidth":{"doclet":{"description":"The pixel line width of the navigator series.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"navigator.series.lineWidth","name":"lineWidth","line":281,"lineEnd":283,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":1},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"navigator.series.marker","name":"marker","line":352,"lineEnd":352,"column":25,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"navigator.series.marker.enabled","name":"enabled","line":354,"lineEnd":354,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":false},"children":{}}}},"pointRange":{"doclet":{"description":"Since Highcharts Stock v8, default value is the same as default\n`pointRange` defined for a specific type (e.g. `null` for\ncolumn type).\n\nIn Highcharts Stock version < 8, defaults to 0.","type":{"names":["number","null"]}},"meta":{"fullname":"navigator.series.pointRange","name":"pointRange","line":356,"lineEnd":365,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"threshold":{"doclet":{"description":"The threshold option. Setting it to 0 will make the default\nnavigator area series draw its area from the 0 value and up.","type":{"names":["number","null"]},"defaultvalue":null},"meta":{"fullname":"navigator.series.threshold","name":"threshold","line":356,"lineEnd":365,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":null},"children":{}},"type":{"doclet":{"description":"The type of the navigator series.\n\nHeads up:\nIn column-type navigator, zooming is limited to at least one\npoint with its `pointRange`.","samples":[{"name":"Column type navigator","value":"stock/navigator/column/","products":["highstock"]}],"type":{"names":["string"]},"defaultByProduct":{"highstock":"`areaspline` if defined, otherwise `line`","gantt":"gantt"}},"meta":{"fullname":"navigator.series.type","name":"type","line":260,"lineEnd":273,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}}}},"stickToMax":{"doclet":{"description":"Enable or disable navigator sticking to right, while adding new\npoints. If `undefined`, the navigator sticks to the axis maximum only\nif it was already at the maximum prior to adding points.","type":{"names":["boolean"]},"defaultvalue":"undefined","since":"10.2.1","samples":[{"name":"stickToMax set to false","value":"stock/navigator/sticktomax-false/","products":["highstock"]}]},"meta":{"fullname":"navigator.stickToMax","name":"stickToMax","line":374,"lineEnd":385,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"xAxis":{"doclet":{"description":"Options for the navigator X axis. Default series options for the\nnavigator xAxis are:\n```js\nxAxis: {\n    tickWidth: 0,\n    lineWidth: 0,\n    gridLineWidth: 1,\n    tickPixelInterval: 200,\n    labels: {\n           align: 'left',\n        style: {\n            color: '#888'\n        },\n        x: 3,\n        y: -4\n    }\n}\n```","extends":"xAxis","exclude":["linkedTo","maxZoom","minRange","opposite","range","scrollbar","showEmpty","maxRange"]},"meta":{"fullname":"navigator.xAxis","name":"xAxis","line":374,"lineEnd":385,"column":4,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{"crosshair":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"navigator.xAxis.crosshair","name":"crosshair","line":458,"lineEnd":458,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":false},"children":{}},"gridLineColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#e6e6e6"},"meta":{"fullname":"navigator.xAxis.gridLineColor","name":"gridLineColor","line":436,"lineEnd":436,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"#e6e6e6"},"children":{}},"gridLineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"navigator.xAxis.gridLineWidth","name":"gridLineWidth","line":438,"lineEnd":438,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":1},"children":{}},"id":{"doclet":{"type":{"names":["string"]},"defaultvalue":"navigator-x-axis"},"meta":{"fullname":"navigator.xAxis.id","name":"id","line":437,"lineEnd":437,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"navigator-x-axis"},"children":{}},"labels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"navigator.xAxis.labels","name":"labels","line":440,"lineEnd":440,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"left"},"meta":{"fullname":"navigator.xAxis.labels.align","name":"align","line":441,"lineEnd":441,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"left"},"children":{}},"style":{"doclet":{"type":{"names":["Highcharts.CSSObject"]}},"meta":{"fullname":"navigator.xAxis.labels.style","name":"style","line":442,"lineEnd":444,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"x":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"navigator.xAxis.labels.x","name":"x","line":455,"lineEnd":455,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":3},"children":{}},"y":{"doclet":{"type":{"names":["number"]},"defaultvalue":-4},"meta":{"fullname":"navigator.xAxis.labels.y","name":"y","line":456,"lineEnd":456,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":-4},"children":{}}}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"navigator.xAxis.lineWidth","name":"lineWidth","line":435,"lineEnd":435,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":0},"children":{}},"overscroll":{"doclet":{"description":"Additional range on the right side of the xAxis. Works similar to\n`xAxis.maxPadding`, but the value is set in terms of axis values,\npercentage or pixels.\n\nIf it's a number, it is interpreted as axis values, which in a\ndatetime axis equals milliseconds.\n\nIf it's a percentage string, is interpreted as percentages of the\naxis length. An overscroll of 50% will make a 100px axis 50px longer.\n\nIf it's a pixel string, it is interpreted as a fixed pixel value, but\nlimited to 90% of the axis length.\n\nIf it's undefined, the value is inherited from `xAxis.overscroll`.\n\nCan be set for both, main xAxis and navigator's xAxis.","type":{"names":["number","string","undefined"]},"since":"6.0.0"},"meta":{"fullname":"navigator.xAxis.overscroll","name":"overscroll","line":411,"lineEnd":432,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"tickLength":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"navigator.xAxis.tickLength","name":"tickLength","line":434,"lineEnd":434,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":0},"children":{}},"tickPixelInterval":{"doclet":{"type":{"names":["number"]},"defaultvalue":200},"meta":{"fullname":"navigator.xAxis.tickPixelInterval","name":"tickPixelInterval","line":439,"lineEnd":439,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":200},"children":{}}}},"yAxis":{"doclet":{"description":"Options for the navigator Y axis. Default series options for the\nnavigator yAxis are:\n```js\nyAxis: {\n    gridLineWidth: 0,\n    startOnTick: false,\n    endOnTick: false,\n    minPadding: 0.1,\n    maxPadding: 0.1,\n    labels: {\n        enabled: false\n    },\n    title: {\n        text: null\n    },\n    tickWidth: 0\n}\n```","extends":"yAxis","exclude":["height","linkedTo","maxZoom","minRange","ordinal","range","showEmpty","scrollbar","top","units","maxRange","minLength","maxLength","resize"]},"meta":{"fullname":"navigator.yAxis","name":"yAxis","line":460,"lineEnd":484,"column":4,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{"className":{"doclet":{"type":{"names":["string"]},"defaultvalue":"highcharts-navigator-yaxis"},"meta":{"fullname":"navigator.yAxis.className","name":"className","line":486,"lineEnd":486,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"highcharts-navigator-yaxis"},"children":{}},"crosshair":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"navigator.yAxis.crosshair","name":"crosshair","line":496,"lineEnd":496,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":false},"children":{}},"endOnTick":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"navigator.yAxis.endOnTick","name":"endOnTick","line":489,"lineEnd":489,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":false},"children":{}},"gridLineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"navigator.yAxis.gridLineWidth","name":"gridLineWidth","line":487,"lineEnd":487,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":0},"children":{}},"id":{"doclet":{"type":{"names":["string"]},"defaultvalue":"navigator-y-axis"},"meta":{"fullname":"navigator.yAxis.id","name":"id","line":491,"lineEnd":491,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"navigator-y-axis"},"children":{}},"labels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"navigator.yAxis.labels","name":"labels","line":493,"lineEnd":493,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"navigator.yAxis.labels.enabled","name":"enabled","line":494,"lineEnd":494,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":false},"children":{}}}},"maxPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"navigator.yAxis.maxPadding","name":"maxPadding","line":492,"lineEnd":492,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":0.1},"children":{}},"minPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"navigator.yAxis.minPadding","name":"minPadding","line":490,"lineEnd":490,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":0.1},"children":{}},"startOnTick":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"navigator.yAxis.startOnTick","name":"startOnTick","line":488,"lineEnd":488,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":false},"children":{}},"tickLength":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"navigator.yAxis.tickLength","name":"tickLength","line":500,"lineEnd":500,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":0},"children":{}},"tickWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"navigator.yAxis.tickWidth","name":"tickWidth","line":501,"lineEnd":501,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":0},"children":{}},"title":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"navigator.yAxis.title","name":"title","line":497,"lineEnd":497,"column":8,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{"text":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"navigator.yAxis.title.text","name":"text","line":498,"lineEnd":498,"column":12,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js","default":"undefined"},"children":{}}}}}}}},"noData":{"doclet":{"description":"Options for displaying a message like \"No data to display\".\nThis feature requires the file no-data-to-display.js to be loaded in the\npage. The actual text to display is set in the lang.noData option.","samples":[{"name":"Line chart with no-data module","value":"highcharts/no-data-to-display/no-data-line"},{"name":"Pie chart with no-data module","value":"highcharts/no-data-to-display/no-data-pie"}],"products":["highcharts","highstock","gantt"],"requires":["module:modules/no-data-to-display"],"since":"3.0.8","type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/NoDataToDisplay/NoDataDefaults.js","name":"noData","fullname":"noData","line":38,"lineEnd":52,"column":0},"children":{"attr":{"doclet":{"description":"An object of additional SVG attributes for the no-data label.","type":{"names":["Highcharts.SVGAttributes"]},"products":["highcharts","highstock","gantt"],"requires":["module:modules/no-data-to-display"],"since":"3.0.8"},"meta":{"fullname":"noData.attr","name":"attr","line":54,"lineEnd":61,"filename":"code/es-modules/Extensions/NoDataToDisplay/NoDataDefaults.js"},"children":{}},"position":{"doclet":{"description":"The position of the no-data label, relative to the plot area.","type":{"names":["Highcharts.AlignObject"]},"requires":["module:modules/no-data-to-display"],"since":"3.0.8"},"meta":{"fullname":"noData.position","name":"position","line":65,"lineEnd":73,"column":4,"filename":"code/es-modules/Extensions/NoDataToDisplay/NoDataDefaults.js"},"children":{"align":{"doclet":{"description":"Horizontal alignment of the label.","type":{"names":["Highcharts.AlignValue"]},"requires":["module:modules/no-data-to-display"],"since":"3.0.8","defaultvalue":"center"},"meta":{"fullname":"noData.position.align","name":"align","line":93,"lineEnd":98,"column":8,"filename":"code/es-modules/Extensions/NoDataToDisplay/NoDataDefaults.js","default":"center"},"children":{}},"verticalAlign":{"doclet":{"description":"Vertical alignment of the label.","type":{"names":["Highcharts.VerticalAlignValue"]},"requires":["module:modules/no-data-to-display"],"since":"3.0.8","defaultvalue":"middle"},"meta":{"fullname":"noData.position.verticalAlign","name":"verticalAlign","line":100,"lineEnd":105,"column":8,"filename":"code/es-modules/Extensions/NoDataToDisplay/NoDataDefaults.js","default":"middle"},"children":{}},"x":{"doclet":{"description":"Horizontal offset of the label, in pixels.","requires":["module:modules/no-data-to-display"],"since":"3.0.8","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"noData.position.x","name":"x","line":81,"lineEnd":85,"column":8,"filename":"code/es-modules/Extensions/NoDataToDisplay/NoDataDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"Vertical offset of the label, in pixels.","requires":["module:modules/no-data-to-display"],"since":"3.0.8","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"noData.position.y","name":"y","line":87,"lineEnd":91,"column":8,"filename":"code/es-modules/Extensions/NoDataToDisplay/NoDataDefaults.js","default":0},"children":{}}}},"style":{"doclet":{"description":"CSS styles for the no-data label.","samples":[{"name":"Styled no-data text","value":"highcharts/no-data-to-display/no-data-line"}],"type":{"names":["Highcharts.CSSObject"]},"requires":["module:modules/no-data-to-display"],"since":"3.0.8"},"meta":{"fullname":"noData.style","name":"style","line":108,"lineEnd":116,"column":4,"filename":"code/es-modules/Extensions/NoDataToDisplay/NoDataDefaults.js"},"children":{}},"useHTML":{"doclet":{"description":"Whether to insert the label as HTML, or as pseudo-HTML rendered with\nSVG.","since":"4.1.10","products":["highcharts","highstock","gantt"],"requires":["module:modules/no-data-to-display"]},"meta":{"fullname":"noData.useHTML","name":"useHTML","line":65,"lineEnd":73,"filename":"code/es-modules/Extensions/NoDataToDisplay/NoDataDefaults.js"},"children":{}}}},"pane":{"doclet":{"description":"The pane serves as a container for axes and backgrounds for circular\ngauges and polar charts.\n\nWhen used in `Highcharts.setOptions` for theming, the pane must be a single\nobject, otherwise arrays are supported.","type":{"names":["*","Array.<*>"]},"since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js","name":"pane","fullname":"pane","line":129,"lineEnd":141,"column":0},"children":{"background":{"doclet":{"description":"A background item or an array of such for the pane. When used in\n`Highcharts.setOptions` for theming, the background must be a single item.","samples":[{"name":"Speedometer gauge with multiple backgrounds","value":"highcharts/demo/gauge-speedometer/","products":["highcharts"]}],"type":{"names":["*","Array.<*>"]},"requires":["module:highcharts-more"],"since":"2.3.0"},"meta":{"fullname":"pane.background","name":"background","line":143,"lineEnd":143,"column":4,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js"},"children":{"backgroundColor":{"doclet":{"description":"The background color or gradient for the pane.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"{ linearGradient: { x1: 0, y1: 0, x2: 0, y2: 1 }, stops: [[0, #ffffff], [1, #e6e6e6]] }","since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"fullname":"pane.background.backgroundColor","name":"backgroundColor","line":86,"lineEnd":94,"column":4,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js"},"children":{}},"borderColor":{"doclet":{"description":"The pane background border color.","type":{"names":["Highcharts.ColorType"]},"since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"],"defaultvalue":"#cccccc"},"meta":{"fullname":"pane.background.borderColor","name":"borderColor","line":77,"lineEnd":84,"column":4,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js","default":"#cccccc"},"children":{}},"borderRadius":{"doclet":{"description":"The border radius of the pane background when the shape is `arc`. Can be\na number (pixels) or a percentage string.","since":"11.4.2","samples":[{"name":"Circular gauge and pane with equal border radius","value":"highcharts/series-solidgauge/pane-borderradius"}],"products":["highcharts"],"type":{"names":["number","string"]},"requires":["module:highcharts-more"],"defaultvalue":0},"meta":{"fullname":"pane.background.borderRadius","name":"borderRadius","line":57,"lineEnd":67,"column":4,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js","default":0},"children":{}},"borderWidth":{"doclet":{"description":"The pixel border width of the pane background.","since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"pane.background.borderWidth","name":"borderWidth","line":69,"lineEnd":75,"column":4,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js","default":1},"children":{}},"className":{"doclet":{"description":"An additional class name to apply to the pane background.","samples":[{"name":"Panes styled by CSS","value":"highcharts/css/pane/","products":["highcharts"]},{"name":"Panes styled by CSS","value":"highcharts/css/pane/","products":["highstock"]},{"name":"Panes styled by CSS","value":"highcharts/css/pane/","products":["highmaps"]}],"type":{"names":["string"]},"since":"5.0.0","requires":["module:highcharts-more"]},"meta":{"fullname":"pane.background.className","name":"className","line":31,"lineEnd":45,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js"},"children":{}},"innerRadius":{"doclet":{"description":"The inner radius of the pane background. Can be either numeric\n(pixels) or a percentage string.","type":{"names":["number","string"]},"since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"],"defaultvalue":0},"meta":{"fullname":"pane.background.innerRadius","name":"innerRadius","line":105,"lineEnd":105,"column":29,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js","default":0},"children":{}},"outerRadius":{"doclet":{"description":"The outer radius of the circular pane background. Can be either\nnumeric (pixels) or a percentage string.","type":{"names":["number","string"]},"since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"],"defaultvalue":"105%"},"meta":{"fullname":"pane.background.outerRadius","name":"outerRadius","line":117,"lineEnd":117,"column":26,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js","default":"105%"},"children":{}},"shape":{"doclet":{"description":"The shape of the pane background. When `solid`, the background\nis circular. When `arc`, the background extends only from the min\nto the max of the value axis.","type":{"names":["Highcharts.PaneBackgroundShapeValue"]},"since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"],"defaultvalue":"circle"},"meta":{"fullname":"pane.background.shape","name":"shape","line":31,"lineEnd":45,"column":4,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js","default":"circle"},"children":{}}}},"center":{"doclet":{"description":"The center of a polar chart or angular gauge, given as an array\nof [x, y] positions. Positions can be given as integers that\ntransform to pixels, or as percentages of the plot area size.","samples":[{"name":"Two gauges with different center","value":"highcharts/demo/gauge-vu-meter/","products":["highcharts"]}],"type":{"names":["Array.<(string|number)>"]},"since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"fullname":"pane.center","name":"center","line":144,"lineEnd":157,"column":4,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js"},"children":{}},"endAngle":{"doclet":{"description":"The end angle of the polar X axis or gauge value axis, given in\ndegrees where 0 is north. Defaults to\n[startAngle](#pane.startAngle) plus 360.","samples":[{"name":"VU-meter with custom start and end angle","value":"highcharts/demo/gauge-vu-meter/","products":["highcharts"]}],"type":{"names":["number"]},"since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"fullname":"pane.endAngle","name":"endAngle","line":144,"lineEnd":157,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js"},"children":{}},"innerSize":{"doclet":{"description":"The inner size of the pane, either as a number defining pixels, or a\npercentage defining a percentage of the pane's size.","samples":[{"name":"The inner size set to 20%","value":"highcharts/series-polar/column-inverted-inner","products":["highcharts"]}],"type":{"names":["number","string"]},"products":["highcharts"],"requires":["module:highcharts-more"],"since":"2.3.0","defaultvalue":"0%"},"meta":{"fullname":"pane.innerSize","name":"innerSize","line":185,"lineEnd":195,"column":4,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js","default":"0%"},"children":{}},"size":{"doclet":{"description":"The size of the pane, either as a number defining pixels, or a\npercentage defining a percentage of the available plot area (the\nsmallest of the plot height or plot width).","samples":[{"name":"Smaller size","value":"highcharts/demo/gauge-vu-meter/","products":["highcharts"]}],"type":{"names":["number","string"]},"products":["highcharts"],"requires":["module:highcharts-more"],"since":"2.3.0","defaultvalue":"85%"},"meta":{"fullname":"pane.size","name":"size","line":172,"lineEnd":183,"column":4,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js","default":"85%"},"children":{}},"startAngle":{"doclet":{"description":"The start angle of the polar X axis or gauge axis, given in degrees\nwhere 0 is north.","samples":[{"name":"VU-meter with custom start and end angle","value":"highcharts/demo/gauge-vu-meter/","products":["highcharts"]}],"since":"2.3.0","products":["highcharts"],"requires":["module:highcharts-more"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"pane.startAngle","name":"startAngle","line":197,"lineEnd":207,"column":4,"filename":"code/es-modules/Extensions/Pane/PaneDefaults.js","default":0},"children":{}}}},"plotOptions":{"meta":{"filename":"code/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js","name":"plotOptions","fullname":"plotOptions","line":129,"lineEnd":133,"column":0},"doclet":{"description":"The plotOptions is a wrapper object for config objects for each series\ntype. The config objects for each series can also be overridden for\neach series item as given in the series array.\n\nConfiguration options for the series are given in three levels. Options\nfor all series in a chart are given in the [plotOptions.series](#plotOptions.series) object. Then options for all series of a specific\ntype are given in the plotOptions of that type, for example\n`plotOptions.line`. Next, options for one single series are given in\n[the series array](#series).","type":{"names":["*"]}},"children":{"abands":{"doclet":{"description":"Acceleration bands (ABANDS). This series requires the `linkedTo` option\nto be set and should be loaded after the\n`stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `abands` series are defined in\n   [plotOptions.abands](plotOptions.abands).\n3. Options for one single series are given in\n   [the series instance array](series.abands).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        abands: {\n            // shared options for all abands series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'abands'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.abands.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === abands) {\n    // code specific to the abands series\n}\n```\n            ","samples":[{"name":"Acceleration Bands","value":"stock/indicators/acceleration-bands","products":["highstock"]}],"extends":"plotOptions.sma","mixes":["Highcharts.MultipleLinesMixin"],"since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking",""],"requires":["module:stock/indicators/indicators","module:stock/indicators/acceleration-bands"]},"meta":{"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js","name":"abands","fullname":"plotOptions.abands","line":119,"lineEnd":123,"column":0},"children":{"bottomLine":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.abands.bottomLine","name":"bottomLine","line":175,"lineEnd":175,"column":4,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.abands.bottomLine.styles","name":"styles","line":176,"lineEnd":176,"column":8,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js"},"children":{"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.abands.bottomLine.styles.lineWidth","name":"lineWidth","line":177,"lineEnd":179,"column":12,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js","default":1},"children":{}}}}}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.abands.dataGrouping","name":"dataGrouping","line":183,"lineEnd":183,"column":4,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.abands.dataGrouping.approximation","name":"approximation","line":184,"lineEnd":184,"column":8,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js","default":"averages"},"children":{}}}},"fillColor":{"doclet":{"description":"Option for fill color between lines in Acceleration bands Indicator.","samples":[{"name":"Background fill between lines.","value":"stock/indicators/indicator-area-fill","products":["highstock"]}],"type":{"names":["Highcharts.Color"]},"since":"9.3.2"},"meta":{"fullname":"plotOptions.abands.fillColor","name":"fillColor","line":145,"lineEnd":155,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js"},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.abands.lineWidth","name":"lineWidth","line":166,"lineEnd":166,"column":4,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js","default":1},"children":{}},"topLine":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.abands.topLine","name":"topLine","line":167,"lineEnd":167,"column":4,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.abands.topLine.styles","name":"styles","line":168,"lineEnd":168,"column":8,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js"},"children":{"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.abands.topLine.styles.lineWidth","name":"lineWidth","line":169,"lineEnd":171,"column":12,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js","default":1},"children":{}}}}}}}},"ad":{"doclet":{"description":"Accumulation Distribution (AD). This series requires `linkedTo` option to\nbe set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ad` series are defined in\n   [plotOptions.ad](plotOptions.ad).\n3. Options for one single series are given in\n   [the series instance array](series.ad).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ad: {\n            // shared options for all ad series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ad'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ad.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ad) {\n    // code specific to the ad series\n}\n```\n            ","samples":[{"name":"Accumulation/Distribution indicator","value":"stock/indicators/accumulation-distribution"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/accumulation-distribution"]},"meta":{"filename":"code/es-modules/Stock/Indicators/AD/ADIndicator.js","name":"ad","fullname":"plotOptions.ad","line":78,"lineEnd":82,"column":0},"children":{"params":{"doclet":{"exclude":["index"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ad.params","name":"params","line":98,"lineEnd":100,"column":4,"filename":"code/es-modules/Stock/Indicators/AD/ADIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.ad.params.index","name":"index","line":102,"lineEnd":102,"column":8,"filename":"code/es-modules/Stock/Indicators/AD/ADIndicator.js","default":"undefined"},"children":{}},"volumeSeriesID":{"doclet":{"description":"The id of volume series which is mandatory.\nFor example using OHLC data, volumeSeriesID='volume' means\nthe indicator will be calculated using OHLC and volume values.","since":"6.0.0","type":{"names":["string"]},"defaultvalue":"volume"},"meta":{"fullname":"plotOptions.ad.params.volumeSeriesID","name":"volumeSeriesID","line":102,"lineEnd":102,"column":23,"filename":"code/es-modules/Stock/Indicators/AD/ADIndicator.js","default":"volume"},"children":{}}}}}},"ao":{"doclet":{"description":"Awesome Oscillator. This series requires the `linkedTo` option to\nbe set and should be loaded after the `stock/indicators/indicators.js`\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ao` series are defined in\n   [plotOptions.ao](plotOptions.ao).\n3. Options for one single series are given in\n   [the series instance array](series.ao).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ao: {\n            // shared options for all ao series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ao'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ao.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ao) {\n    // code specific to the ao series\n}\n```\n            ","samples":[{"name":"Awesome","value":"stock/indicators/ao","products":["highstock"]}],"extends":"plotOptions.sma","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","joinBy","keys","navigatorOptions","params","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/ao"]},"meta":{"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js","name":"ao","fullname":"plotOptions.ao","line":96,"lineEnd":100,"column":0},"children":{"crisp":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.ao.crisp","name":"crisp","line":151,"lineEnd":151,"column":4,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js","default":false},"children":{}},"greaterBarColor":{"doclet":{"description":"Color of the Awesome oscillator series bar that is greater than the\nprevious one. Note that if a `color` is defined, the `color`\ntakes precedence and the `greaterBarColor` is ignored.","samples":[{"name":"greaterBarColor","value":"stock/indicators/ao/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","defaultvalue":"#06b535"},"meta":{"fullname":"plotOptions.ao.greaterBarColor","name":"greaterBarColor","line":124,"lineEnd":134,"column":4,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js","default":"#06b535"},"children":{}},"groupPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.2},"meta":{"fullname":"plotOptions.ao.groupPadding","name":"groupPadding","line":149,"lineEnd":149,"column":4,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js","default":0.2},"children":{}},"lowerBarColor":{"doclet":{"description":"Color of the Awesome oscillator series bar that is lower than the\nprevious one. Note that if a `color` is defined, the `color`\ntakes precedence and the `lowerBarColor` is ignored.","samples":[{"name":"lowerBarColor","value":"stock/indicators/ao/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","defaultvalue":"#f21313"},"meta":{"fullname":"plotOptions.ao.lowerBarColor","name":"lowerBarColor","line":136,"lineEnd":146,"column":4,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js","default":"#f21313"},"children":{}},"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ao.params","name":"params","line":119,"lineEnd":119,"column":4,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.ao.params.index","name":"index","line":120,"lineEnd":120,"column":8,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.ao.params.period","name":"period","line":122,"lineEnd":122,"column":8,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js","default":"undefined"},"children":{}}}},"pointPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.2},"meta":{"fullname":"plotOptions.ao.pointPadding","name":"pointPadding","line":150,"lineEnd":150,"column":4,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js","default":0.2},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ao.states","name":"states","line":152,"lineEnd":152,"column":4,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ao.states.hover","name":"hover","line":153,"lineEnd":153,"column":8,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js"},"children":{"halo":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ao.states.hover.halo","name":"halo","line":154,"lineEnd":154,"column":12,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js"},"children":{"size":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.ao.states.hover.halo.size","name":"size","line":155,"lineEnd":155,"column":16,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js","default":0},"children":{}}}}}}}},"threshold":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.ao.threshold","name":"threshold","line":148,"lineEnd":148,"column":4,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js","default":0},"children":{}}}},"apo":{"doclet":{"description":"Absolute Price Oscillator. This series requires the `linkedTo` option to\nbe set and should be loaded after the `stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `apo` series are defined in\n   [plotOptions.apo](plotOptions.apo).\n3. Options for one single series are given in\n   [the series instance array](series.apo).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        apo: {\n            // shared options for all apo series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'apo'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.apo.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === apo) {\n    // code specific to the apo series\n}\n```\n            ","samples":[{"name":"Absolute Price Oscillator","value":"stock/indicators/apo","products":["highstock"]}],"extends":"plotOptions.ema","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/apo"]},"meta":{"filename":"code/es-modules/Stock/Indicators/APO/APOIndicator.js","name":"apo","fullname":"plotOptions.apo","line":73,"lineEnd":77,"column":0},"children":{"params":{"doclet":{"description":"Parameters used in calculation of Absolute Price Oscillator\nseries points.","exclude":["period"],"since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.apo.params","name":"params","line":96,"lineEnd":101,"column":4,"filename":"code/es-modules/Stock/Indicators/APO/APOIndicator.js"},"children":{"period":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.apo.params.period","name":"period","line":103,"lineEnd":103,"column":8,"filename":"code/es-modules/Stock/Indicators/APO/APOIndicator.js","default":"undefined"},"children":{}},"periods":{"doclet":{"description":"Periods for Absolute Price Oscillator calculations.","type":{"names":["Array.<number>"]},"defaultvalue":"[10, 20]","since":"7.0.0"},"meta":{"fullname":"plotOptions.apo.params.periods","name":"periods","line":103,"lineEnd":103,"column":24,"filename":"code/es-modules/Stock/Indicators/APO/APOIndicator.js"},"children":{}}}}}},"arcdiagram":{"doclet":{"description":"Arc diagram series is a chart drawing style in which\n the vertices of the chart are positioned along a line\n on the Euclidean plane and the edges are drawn as a semicircle\n in one of the two half-planes delimited by the line,\n or as smooth curves formed by sequences of semicircles.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `arcdiagram` series are defined in\n   [plotOptions.arcdiagram](plotOptions.arcdiagram).\n3. Options for one single series are given in\n   [the series instance array](series.arcdiagram).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        arcdiagram: {\n            // shared options for all arcdiagram series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'arcdiagram'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.arcdiagram.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === arcdiagram) {\n    // code specific to the arcdiagram series\n}\n```\n            ","samples":[{"name":"Arc Diagram","value":"highcharts/demo/arc-diagram/"}],"extends":"plotOptions.sankey","since":"10.0.0","products":["highcharts"],"requires":["module:modules/arc-diagram"],"exclude":["curveFactor","connectEnds","connectNulls","colorAxis","colorKey","dataSorting","dragDrop","getExtremesFromAll","legendSymbolColor","nodeAlignment","nodePadding","centerInCategory","pointInterval","pointIntervalUnit","pointPlacement","pointStart","relativeXValue","softThreshold","stack","stacking","step","xAxis","yAxis"]},"meta":{"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js","name":"arcdiagram","fullname":"plotOptions.arcdiagram","line":14,"lineEnd":18,"column":0},"children":{"centeredLinks":{"doclet":{"description":"The option to center links rather than position them one after\nanother","type":{"names":["boolean"]},"since":"10.0.0","defaultvalue":"false","products":["highcharts"]},"meta":{"fullname":"plotOptions.arcdiagram.centeredLinks","name":"centeredLinks","line":41,"lineEnd":49,"column":4,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js","default":false},"children":{}},"dataLabels":{"doclet":{"description":"Options for the data labels appearing on top of the nodes and links.\nFor arc diagram charts, data labels are visible for the nodes by\ndefault, but hidden for links. This is controlled by modifying the\n`nodeFormat`, and the `format` that applies to links and is an empty\nstring by default.","declare":"Highcharts.SeriesArcDiagramDataLabelsOptionsObject","since":"10.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.arcdiagram.dataLabels","name":"dataLabels","line":63,"lineEnd":71,"column":4,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{"linkTextPath":{"doclet":{"description":"Options for a _link_ label text which should follow link\nconnection. Border and background are disabled for a label that\nfollows a path.\n\n**Note:** Only SVG-based renderer supports this option. Setting\n`useHTML` to true will disable this option.","extends":"plotOptions.networkgraph.dataLabels.linkTextPath","since":"10.0.0"},"meta":{"fullname":"plotOptions.arcdiagram.dataLabels.linkTextPath","name":"linkTextPath","line":73,"lineEnd":83,"column":8,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{"attributes":{"doclet":{"type":{"names":["Highcharts.SVGAttributes"]},"defaultvalue":"{\"startOffset\":\"25%\"}"},"meta":{"fullname":"plotOptions.arcdiagram.dataLabels.linkTextPath.attributes","name":"attributes","line":85,"lineEnd":88,"column":12,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{}}}}}},"equalNodes":{"doclet":{"description":"Whether nodes with different values should have the same size. If set\nto true, all nodes are calculated based on the `nodePadding` and\ncurrent `plotArea`. It is possible to override it using the\n`marker.radius` option.","type":{"names":["boolean"]},"since":"10.0.0","defaultvalue":"false","products":["highcharts"]},"meta":{"fullname":"plotOptions.arcdiagram.equalNodes","name":"equalNodes","line":51,"lineEnd":61,"column":4,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js","default":false},"children":{}},"marker":{"doclet":{"description":"Options for the point markers of arc diagram series. Properties like\n`fillColor`, `lineColor` and `lineWidth` define the visual appearance of\nthe markers, while the `symbol` option defines their shape.\n\nIn styled mode, the markers can be styled with the `.highcharts-point`,\n`.highcharts-point-hover` and `.highcharts-point-select` class names.","extends":"plotOptions.series.marker","exclude":["enabled","enabledThreshold","height","width"],"since":"10.0.0"},"meta":{"fullname":"plotOptions.arcdiagram.marker","name":"marker","line":97,"lineEnd":107,"column":4,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{"fillOpacity":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.arcdiagram.marker.fillOpacity","name":"fillOpacity","line":132,"lineEnd":132,"column":8,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js","default":1},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.arcdiagram.marker.lineWidth","name":"lineWidth","line":133,"lineEnd":133,"column":8,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js","default":0},"children":{}},"symbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"circle"},"meta":{"fullname":"plotOptions.arcdiagram.marker.symbol","name":"symbol","line":135,"lineEnd":135,"column":8,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js","default":"circle"},"children":{}}}},"reversed":{"doclet":{"description":"Whether the series should be placed on the other side of the\n`plotArea`.","type":{"names":["boolean"]},"since":"10.0.0","defaultvalue":"false","products":["highcharts"]},"meta":{"fullname":"plotOptions.arcdiagram.reversed","name":"reversed","line":150,"lineEnd":158,"column":4,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js","default":false},"children":{}}}},"area":{"doclet":{"description":"The area series type.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `area` series are defined in\n   [plotOptions.area](plotOptions.area).\n3. Options for one single series are given in\n   [the series instance array](series.area).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        area: {\n            // shared options for all area series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'area'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.area.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === area) {\n    // code specific to the area series\n}\n```\n            ","samples":[{"name":"Area chart","value":"highcharts/demo/area-chart/","products":["highcharts"]},{"name":"Area chart","value":"stock/demo/area/","products":["highstock"]}],"extends":"plotOptions.line","exclude":["useOhlcData"],"products":["highcharts","highstock"]},"meta":{"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js","name":"area","fullname":"plotOptions.area","line":12,"lineEnd":16,"column":0},"children":{"color":{"doclet":{"see":["[fillColor](#plotOptions.area.fillColor)","[fillOpacity](#plotOptions.area.fillOpacity)"]},"meta":{"fullname":"plotOptions.area.color","name":"color","line":31,"lineEnd":36,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{}},"fillColor":{"doclet":{"description":"Fill color or gradient for the area. When `undefined`, the series'\n`color` is used with the series' `fillOpacity`.\n\nIn styled mode, the fill color can be set with the `.highcharts-area`\nclass name.","see":["[color](#plotOptions.area.color)","[fillOpacity](#plotOptions.area.fillOpacity)"],"samples":[{"name":"Undefined by default","value":"highcharts/plotoptions/area-fillcolor-default/","products":["highcharts"]},{"name":"Gradient","value":"highcharts/plotoptions/area-fillcolor-gradient/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.area.fillColor","name":"fillColor","line":37,"lineEnd":55,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{}},"fillOpacity":{"doclet":{"description":"Fill opacity for the area. When you set an explicit `fillColor`,\nthe `fillOpacity` is not applied. Instead, you should define the\nopacity in the `fillColor` with an rgba color definition. The\n`fillOpacity` setting, also the default setting, overrides the alpha\ncomponent of the `color` setting.\n\nIn styled mode, the fill opacity can be set with the\n`.highcharts-area` class name.","see":["[color](#plotOptions.area.color)","[fillColor](#plotOptions.area.fillColor)"],"samples":[{"name":"Automatic fill color and fill opacity of 0.1","value":"highcharts/plotoptions/area-fillopacity/","products":["highcharts"]}],"type":{"names":["number"]},"defaultByProduct":{"highcharts":0.75,"highstock":0.75},"products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.area.fillOpacity","name":"fillOpacity","line":56,"lineEnd":77,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"areaMarker"},"meta":{"fullname":"plotOptions.area.legendSymbol","name":"legendSymbol","line":144,"lineEnd":144,"column":4,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js","default":"areaMarker"},"children":{}},"lineColor":{"doclet":{"description":"A separate color for the graph line. By default the line takes the\n`color` of the series, but the lineColor setting allows setting a\nseparate color for the line without altering the `fillColor`.\n\nIn styled mode, the line stroke can be set with the\n`.highcharts-graph` class name.","samples":[{"name":"Dark gray line","value":"highcharts/plotoptions/area-linecolor/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.area.lineColor","name":"lineColor","line":78,"lineEnd":92,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{}},"negativeFillColor":{"doclet":{"description":"A separate color for the negative part of the area. Note that `zones`\ntakes precedence over the negative fill color.\n\nIn styled mode, a negative color is set with the\n`.highcharts-negative` class name.","see":["[negativeColor](#plotOptions.area.negativeColor)"],"samples":[{"name":"Negative color in styled mode","value":"highcharts/css/series-negative-color/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.area.negativeFillColor","name":"negativeFillColor","line":93,"lineEnd":109,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{}},"threshold":{"doclet":{"description":"The Y axis value to serve as the base for the area, for\ndistinguishing between values above and below a threshold. The area\nbetween the graph and the threshold is filled.\n\n* If a number is given, the Y axis will scale to the threshold.\n* If `null`, the scaling behaves like a line series with fill between\n  the graph and the Y axis minimum.\n* If `Infinity` or `-Infinity`, the area between the graph and the\n  corresponding Y axis extreme is filled (since v6.1.0).","samples":[{"name":"A threshold of 100","value":"highcharts/plotoptions/area-threshold/","products":["highcharts"]},{"name":"A threshold of Infinity","value":"highcharts/plotoptions/area-threshold-infinity/","products":["highcharts"]}],"type":{"names":["number","null"]},"since":"2.0.0","products":["highcharts","highstock"],"defaultvalue":0},"meta":{"fullname":"plotOptions.area.threshold","name":"threshold","line":31,"lineEnd":36,"column":4,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js","default":0},"children":{}},"trackByArea":{"doclet":{"description":"Whether the whole area or just the line should respond to mouseover\ntooltips and other mouse or touch events.","samples":[{"name":"Display the tooltip when the area is hovered","value":"highcharts/plotoptions/area-trackbyarea/","products":["highcharts","highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"1.1.6","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.area.trackByArea","name":"trackByArea","line":110,"lineEnd":122,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{}}}},"arearange":{"doclet":{"description":"The area range series is a cartesian series with higher and lower values for\neach point along an X axis, where the area between the values is shaded.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `arearange` series are defined in\n   [plotOptions.arearange](plotOptions.arearange).\n3. Options for one single series are given in\n   [the series instance array](series.arearange).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        arearange: {\n            // shared options for all arearange series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'arearange'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.arearange.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === arearange) {\n    // code specific to the arearange series\n}\n```\n            ","samples":[{"name":"Area range chart","value":"highcharts/demo/arearange/","products":["highcharts"]},{"name":"Area range chart","value":"stock/demo/arearange/","products":["highstock"]}],"extends":"plotOptions.area","products":["highcharts","highstock"],"exclude":["stack","stacking"],"requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js","name":"arearange","fullname":"plotOptions.arearange","line":12,"lineEnd":16,"column":0},"children":{"color":{"doclet":{"see":["[fillColor](#plotOptions.arearange.fillColor)","[fillOpacity](#plotOptions.arearange.fillOpacity)"],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.arearange.color","name":"color","line":41,"lineEnd":46,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeries.js"},"children":{}},"colorKey":{"doclet":{"defaultvalue":"low","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.arearange.colorKey","name":"colorKey","line":47,"lineEnd":50,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeries.js"},"children":{}},"dataLabels":{"meta":{"fullname":"plotOptions.arearange.dataLabels","name":"dataLabels","line":95,"lineEnd":106,"column":4,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"doclet":{"description":"Extended data labels for range series types. Range series data\nlabels use no `x` and `y` options. Instead, they have `xLow`,\n`xHigh`, `yLow` and `yHigh` options to allow the higher and lower\ndata label sets individually.","declare":"Highcharts.SeriesAreaRangeDataLabelsOptionsObject","exclude":["x","y"],"since":"2.3.0","products":["highcharts","highstock"],"type":{"names":["*"]}},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.arearange.dataLabels.align","name":"align","line":108,"lineEnd":108,"column":8,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js","default":"undefined"},"children":{}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.arearange.dataLabels.verticalAlign","name":"verticalAlign","line":109,"lineEnd":109,"column":8,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js","default":"undefined"},"children":{}},"xHigh":{"doclet":{"description":"X offset of the higher data labels relative to the point value.","samples":[{"name":"Data labels on range series","value":"highcharts/plotoptions/arearange-datalabels/"}],"since":"2.3.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.arearange.dataLabels.xHigh","name":"xHigh","line":119,"lineEnd":124,"column":8,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js","default":0},"children":{}},"xLow":{"doclet":{"description":"X offset of the lower data labels relative to the point value.","samples":[{"name":"Data labels on range series","value":"highcharts/plotoptions/arearange-datalabels/"},{"name":"Data labels on range series","value":"highcharts/plotoptions/arearange-datalabels/"}],"since":"2.3.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.arearange.dataLabels.xLow","name":"xLow","line":110,"lineEnd":117,"column":8,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js","default":0},"children":{}},"yHigh":{"doclet":{"description":"Y offset of the higher data labels relative to the point value.","samples":[{"name":"Data labels on range series","value":"highcharts/plotoptions/arearange-datalabels/"}],"since":"2.3.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.arearange.dataLabels.yHigh","name":"yHigh","line":133,"lineEnd":138,"column":8,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js","default":0},"children":{}},"yLow":{"doclet":{"description":"Y offset of the lower data labels relative to the point value.","samples":[{"name":"Data labels on range series","value":"highcharts/plotoptions/arearange-datalabels/"}],"since":"2.3.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.arearange.dataLabels.yLow","name":"yLow","line":126,"lineEnd":131,"column":8,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js","default":0},"children":{}}}},"dragDrop":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"draggableHigh":{"doclet":{"description":"Allow high value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.arearange.dragDrop.draggableHigh","name":"draggableHigh","line":429,"lineEnd":436,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}},"draggableLow":{"doclet":{"description":"Allow low value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.arearange.dragDrop.draggableLow","name":"draggableLow","line":403,"lineEnd":410,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}}}},"fillColor":{"doclet":{"see":["[color](#plotOptions.arearange.color)","[fillOpacity](#plotOptions.arearange.fillOpacity)"],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.arearange.fillColor","name":"fillColor","line":51,"lineEnd":56,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeries.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#plotOptions.arearange.color)","[fillColor](#plotOptions.arearange.fillColor)"],"defaultByProduct":{"highcharts":"0.75","highstock":"0.75"}},"meta":{"fullname":"plotOptions.arearange.fillOpacity","name":"fillOpacity","line":57,"lineEnd":64,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeries.js"},"children":{}},"lowMarker":{"doclet":{"description":"Options for the lower markers of the arearange-like series. When `lowMarker`\nis not defined, options inherit from the marker.","see":["[marker](#series.arearange.marker)"],"samples":[{"name":"Area range chart with `lowMarker` option","value":"highcharts/series-arearange/lowmarker/","products":["highcharts"]}],"declare":"Highcharts.PointMarkerOptionsObject","extends":"plotOptions.series.marker","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.arearange.lowMarker","name":"lowMarker","line":235,"lineEnd":248,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{"symbol":{"doclet":{"declare":"Highcharts.PointMarkerOptionsObject","extends":"plotOptions.series.marker.symbol","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.arearange.lowMarker.symbol","name":"symbol","line":249,"lineEnd":254,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{}}}},"shadow":{"doclet":{"description":"Whether to apply a drop shadow to the graph line. Since 2.3 the\nshadow can be an object configuration containing `color`, `offsetX`,\n`offsetY`, `opacity` and `width`.","type":{"names":["boolean","Highcharts.ShadowOptionsObject"]},"products":["highcharts"]},"meta":{"fullname":"plotOptions.arearange.shadow","name":"shadow","line":65,"lineEnd":73,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeries.js"},"children":{}},"threshold":{"doclet":{"type":{"names":["number","null"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.arearange.threshold","name":"threshold","line":78,"lineEnd":80,"column":4,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js","default":null},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.arearange.tooltip","name":"tooltip","line":82,"lineEnd":82,"column":4,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{series.color}\">●</span> {series.name}: <b>{point.low}</b> - <b>{point.high}</b><br/>"},"meta":{"fullname":"plotOptions.arearange.tooltip.pointFormat","name":"pointFormat","line":83,"lineEnd":83,"column":8,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js","default":"<span style=\"color:{series.color}\">●</span> {series.name}: <b>{point.low}</b> - <b>{point.high}</b><br/>"},"children":{}}}}}},"areaspline":{"doclet":{"description":"The area spline series is an area series where the graph between the\npoints is smoothed into a spline.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `areaspline` series are defined in\n   [plotOptions.areaspline](plotOptions.areaspline).\n3. Options for one single series are given in\n   [the series instance array](series.areaspline).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        areaspline: {\n            // shared options for all areaspline series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'areaspline'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.areaspline.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === areaspline) {\n    // code specific to the areaspline series\n}\n```\n            ","samples":[{"name":"Area spline chart","value":"highcharts/demo/areaspline/","products":["highcharts"]},{"name":"Area spline chart","value":"stock/demo/areaspline/","products":["highstock"]}],"extends":"plotOptions.area","exclude":["step","boostThreshold","boostBlending"],"products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.areaspline","name":"areaspline","line":56,"lineEnd":69,"filename":"code/es-modules/Series/AreaSpline/AreaSplineSeries.js"},"children":{"color":{"doclet":{"see":["[fillColor](#plotOptions.areaspline.fillColor)","[fillOpacity](#plotOptions.areaspline.fillOpacity)"]},"meta":{"fullname":"plotOptions.areaspline.color","name":"color","line":70,"lineEnd":75,"filename":"code/es-modules/Series/AreaSpline/AreaSplineSeries.js"},"children":{}},"fillColor":{"doclet":{"see":["[color](#plotOptions.areaspline.color)","[fillOpacity](#plotOptions.areaspline.fillOpacity)"]},"meta":{"fullname":"plotOptions.areaspline.fillColor","name":"fillColor","line":76,"lineEnd":81,"filename":"code/es-modules/Series/AreaSpline/AreaSplineSeries.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#plotOptions.areaspline.color)","[fillColor](#plotOptions.areaspline.fillColor)"],"defaultvalue":"0.75","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.areaspline.fillOpacity","name":"fillOpacity","line":82,"lineEnd":88,"filename":"code/es-modules/Series/AreaSpline/AreaSplineSeries.js"},"children":{}}}},"areasplinerange":{"doclet":{"description":"The area spline range is a cartesian series type with higher and\nlower Y values along an X axis. The area inside the range is colored, and\nthe graph outlining the area is a smoothed spline.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `areasplinerange` series are defined in\n   [plotOptions.areasplinerange](plotOptions.areasplinerange).\n3. Options for one single series are given in\n   [the series instance array](series.areasplinerange).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        areasplinerange: {\n            // shared options for all areasplinerange series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'areasplinerange'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.areasplinerange.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === areasplinerange) {\n    // code specific to the areasplinerange series\n}\n```\n            ","samples":[{"name":"Area spline range","value":"stock/demo/areasplinerange/","products":["highstock","highstock"]}],"extends":"plotOptions.arearange","since":"2.3.0","exclude":["step","boostThreshold","boostBlending"],"products":["highcharts","highstock"],"requires":["module:highcharts-more"]},"meta":{"fullname":"plotOptions.areasplinerange","name":"areasplinerange","line":54,"lineEnd":68,"filename":"code/es-modules/Series/AreaSplineRange/AreaSplineRangeSeries.js"},"children":{"color":{"doclet":{"see":["[fillColor](#plotOptions.areasplinerange.fillColor)","[fillOpacity](#plotOptions.areasplinerange.fillOpacity)"]},"meta":{"fullname":"plotOptions.areasplinerange.color","name":"color","line":69,"lineEnd":74,"filename":"code/es-modules/Series/AreaSplineRange/AreaSplineRangeSeries.js"},"children":{}},"fillColor":{"doclet":{"see":["[color](#plotOptions.areasplinerange.color)","[fillOpacity](#plotOptions.areasplinerange.fillOpacity)"]},"meta":{"fullname":"plotOptions.areasplinerange.fillColor","name":"fillColor","line":75,"lineEnd":80,"filename":"code/es-modules/Series/AreaSplineRange/AreaSplineRangeSeries.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#plotOptions.areasplinerange.color)","[fillColor](#plotOptions.areasplinerange.fillColor)"],"defaultvalue":"0.75","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.areasplinerange.fillOpacity","name":"fillOpacity","line":81,"lineEnd":87,"filename":"code/es-modules/Series/AreaSplineRange/AreaSplineRangeSeries.js"},"children":{}}}},"aroon":{"doclet":{"description":"Aroon. This series requires the `linkedTo` option to be\nset and should be loaded after the `stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `aroon` series are defined in\n   [plotOptions.aroon](plotOptions.aroon).\n3. Options for one single series are given in\n   [the series instance array](series.aroon).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        aroon: {\n            // shared options for all aroon series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'aroon'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.aroon.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === aroon) {\n    // code specific to the aroon series\n}\n```\n            ","samples":[{"name":"Aroon","value":"stock/indicators/aroon","products":["highstock"]}],"extends":"plotOptions.sma","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/aroon"]},"meta":{"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js","name":"aroon","fullname":"plotOptions.aroon","line":85,"lineEnd":89,"column":0},"children":{"aroonDown":{"doclet":{"description":"AroonDown line options.","since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.aroon.aroonDown","name":"aroonDown","line":124,"lineEnd":126,"column":4,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js"},"children":{"styles":{"doclet":{"description":"Styles for an aroonDown line.","since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.aroon.aroonDown.styles","name":"styles","line":128,"lineEnd":130,"column":8,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line. If not set, it's inherited from\n[plotOptions.aroon.color](#plotOptions.aroon.color).","type":{"names":["Highcharts.ColorString"]},"since":"7.0.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.aroon.aroonDown.styles.lineColor","name":"lineColor","line":136,"lineEnd":141,"column":12,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.aroon.aroonDown.styles.lineWidth","name":"lineWidth","line":132,"lineEnd":134,"column":12,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js","default":1},"children":{}}}}}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.aroon.dataGrouping","name":"dataGrouping","line":145,"lineEnd":145,"column":4,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.aroon.dataGrouping.approximation","name":"approximation","line":146,"lineEnd":146,"column":8,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js","default":"averages"},"children":{}}}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.aroon.marker","name":"marker","line":118,"lineEnd":118,"column":4,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.aroon.marker.enabled","name":"enabled","line":119,"lineEnd":119,"column":8,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js","default":false},"children":{}}}},"params":{"doclet":{"description":"Parameters used in calculation of aroon series points.","exclude":["index"],"since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.aroon.params","name":"params","line":109,"lineEnd":113,"column":4,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.aroon.params.index","name":"index","line":115,"lineEnd":115,"column":8,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":25},"meta":{"fullname":"plotOptions.aroon.params.period","name":"period","line":115,"lineEnd":115,"column":23,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js","default":25},"children":{}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.aroon.tooltip","name":"tooltip","line":121,"lineEnd":121,"column":4,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b><br/>Aroon Up: {point.y}<br/>Aroon Down: {point.aroonDown}<br/>"},"meta":{"fullname":"plotOptions.aroon.tooltip.pointFormat","name":"pointFormat","line":122,"lineEnd":122,"column":8,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js","default":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b><br/>Aroon Up: {point.y}<br/>Aroon Down: {point.aroonDown}<br/>"},"children":{}}}}}},"aroonoscillator":{"doclet":{"description":"Aroon Oscillator. This series requires the `linkedTo` option to be set\nand should be loaded after the `stock/indicators/indicators.js` and\n`stock/indicators/aroon.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `aroonoscillator` series are defined in\n   [plotOptions.aroonoscillator](plotOptions.aroonoscillator).\n3. Options for one single series are given in\n   [the series instance array](series.aroonoscillator).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        aroonoscillator: {\n            // shared options for all aroonoscillator series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'aroonoscillator'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.aroonoscillator.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === aroonoscillator) {\n    // code specific to the aroonoscillator series\n}\n```\n            ","samples":[{"name":"Aroon Oscillator","value":"stock/indicators/aroon-oscillator","products":["highstock"]}],"extends":"plotOptions.aroon","since":"7.0.0","products":["highstock"],"exclude":["allAreas","aroonDown","colorAxis","compare","compareBase","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/aroon","module:stock/indicators/aroon-oscillator"]},"meta":{"filename":"code/es-modules/Stock/Indicators/AroonOscillator/AroonOscillatorIndicator.js","name":"aroonoscillator","fullname":"plotOptions.aroonoscillator","line":53,"lineEnd":57,"column":0},"children":{"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.aroonoscillator.tooltip","name":"tooltip","line":79,"lineEnd":79,"column":4,"filename":"code/es-modules/Stock/Indicators/AroonOscillator/AroonOscillatorIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b>: {point.y}"},"meta":{"fullname":"plotOptions.aroonoscillator.tooltip.pointFormat","name":"pointFormat","line":80,"lineEnd":80,"column":8,"filename":"code/es-modules/Stock/Indicators/AroonOscillator/AroonOscillatorIndicator.js","default":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b>: {point.y}"},"children":{}}}}}},"atr":{"doclet":{"description":"Average true range indicator (ATR). This series requires `linkedTo`\noption to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `atr` series are defined in\n   [plotOptions.atr](plotOptions.atr).\n3. Options for one single series are given in\n   [the series instance array](series.atr).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        atr: {\n            // shared options for all atr series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'atr'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.atr.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === atr) {\n    // code specific to the atr series\n}\n```\n            ","samples":[{"name":"ATR indicator","value":"stock/indicators/atr"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/atr"]},"meta":{"filename":"code/es-modules/Stock/Indicators/ATR/ATRIndicator.js","name":"atr","fullname":"plotOptions.atr","line":95,"lineEnd":99,"column":0},"children":{"params":{"doclet":{"exclude":["index"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.atr.params","name":"params","line":115,"lineEnd":117,"column":4,"filename":"code/es-modules/Stock/Indicators/ATR/ATRIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.atr.params.index","name":"index","line":119,"lineEnd":119,"column":8,"filename":"code/es-modules/Stock/Indicators/ATR/ATRIndicator.js","default":"undefined"},"children":{}}}}}},"bar":{"doclet":{"description":"A bar series is a special type of column series where the columns are\nhorizontal.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `bar` series are defined in\n   [plotOptions.bar](plotOptions.bar).\n3. Options for one single series are given in\n   [the series instance array](series.bar).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        bar: {\n            // shared options for all bar series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'bar'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.bar.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === bar) {\n    // code specific to the bar series\n}\n```\n            ","samples":[{"name":"Bar chart","value":"highcharts/demo/bar-chart/"}],"extends":"plotOptions.column","products":["highcharts"]},"meta":{"filename":"code/es-modules/Series/Bar/BarSeries.js","name":"bar","fullname":"plotOptions.bar","line":31,"lineEnd":35,"column":0},"children":{}},"bb":{"doclet":{"description":"Bollinger bands (BB). This series requires the `linkedTo` option to be\nset and should be loaded after the `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `bb` series are defined in\n   [plotOptions.bb](plotOptions.bb).\n3. Options for one single series are given in\n   [the series instance array](series.bb).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        bb: {\n            // shared options for all bb series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'bb'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.bb.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === bb) {\n    // code specific to the bb series\n}\n```\n            ","samples":[{"name":"Bollinger bands","value":"stock/indicators/bollinger-bands"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/bollinger-bands"]},"meta":{"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","name":"bb","fullname":"plotOptions.bb","line":103,"lineEnd":107,"column":0},"children":{"bottomLine":{"doclet":{"description":"Bottom line options.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bb.bottomLine","name":"bottomLine","line":144,"lineEnd":146,"column":4,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js"},"children":{"styles":{"doclet":{"description":"Styles for the bottom line.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bb.bottomLine.styles","name":"styles","line":148,"lineEnd":150,"column":8,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line. If not set, it's inherited from\n[plotOptions.bb.color](#plotOptions.bb.color).","type":{"names":["Highcharts.ColorString"]},"since":"6.0.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.bb.bottomLine.styles.lineColor","name":"lineColor","line":156,"lineEnd":161,"column":12,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.bb.bottomLine.styles.lineWidth","name":"lineWidth","line":152,"lineEnd":154,"column":12,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","default":1},"children":{}}}}}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bb.dataGrouping","name":"dataGrouping","line":194,"lineEnd":194,"column":4,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.bb.dataGrouping.approximation","name":"approximation","line":195,"lineEnd":195,"column":8,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","default":"averages"},"children":{}}}},"fillColor":{"doclet":{"description":"Option for fill color between lines in Bollinger Bands Indicator.","samples":[{"name":"Background fill between lines.","value":"stock/indicators/indicator-area-fill","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"since":"9.3.2"},"meta":{"fullname":"plotOptions.bb.fillColor","name":"fillColor","line":123,"lineEnd":132,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js"},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bb.marker","name":"marker","line":191,"lineEnd":191,"column":4,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.bb.marker.enabled","name":"enabled","line":192,"lineEnd":192,"column":8,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","default":false},"children":{}}}},"params":{"doclet":{"description":"Parameters used in calculation of the regression points.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bb.params","name":"params","line":123,"lineEnd":132,"column":4,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.bb.params.index","name":"index","line":142,"lineEnd":142,"column":8,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","default":3},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":20},"meta":{"fullname":"plotOptions.bb.params.period","name":"period","line":137,"lineEnd":137,"column":8,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","default":20},"children":{}},"standardDeviation":{"doclet":{"description":"Standard deviation for top and bottom bands.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.bb.params.standardDeviation","name":"standardDeviation","line":138,"lineEnd":140,"column":8,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","default":2},"children":{}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bb.tooltip","name":"tooltip","line":188,"lineEnd":188,"column":4,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b><br/>Top: {point.top}<br/>Middle: {point.middle}<br/>Bottom: {point.bottom}<br/>"},"meta":{"fullname":"plotOptions.bb.tooltip.pointFormat","name":"pointFormat","line":189,"lineEnd":189,"column":8,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","default":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b><br/>Top: {point.top}<br/>Middle: {point.middle}<br/>Bottom: {point.bottom}<br/>"},"children":{}}}},"topLine":{"doclet":{"description":"Top line options.","extends":"plotOptions.bb.bottomLine","since":"6.0.0"},"meta":{"fullname":"plotOptions.bb.topLine","name":"topLine","line":165,"lineEnd":169,"column":4,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js"},"children":{"styles":{"doclet":{"description":"Styles for the top line.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bb.topLine.styles","name":"styles","line":171,"lineEnd":173,"column":8,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line. If not set, it's inherited from\n[plotOptions.bb.color](#plotOptions.bb.color).","type":{"names":["Highcharts.ColorString"]},"since":"6.0.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.bb.topLine.styles.lineColor","name":"lineColor","line":179,"lineEnd":184,"column":12,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.bb.topLine.styles.lineWidth","name":"lineWidth","line":175,"lineEnd":177,"column":12,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js","default":1},"children":{}}}}}}}},"bellcurve":{"doclet":{"description":"A bell curve is an areaspline series which represents the probability\ndensity function of the normal distribution. It calculates mean and\nstandard deviation of the base series data and plots the curve according\nto the calculated parameters.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `bellcurve` series are defined in\n   [plotOptions.bellcurve](plotOptions.bellcurve).\n3. Options for one single series are given in\n   [the series instance array](series.bellcurve).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        bellcurve: {\n            // shared options for all bellcurve series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'bellcurve'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.bellcurve.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === bellcurve) {\n    // code specific to the bellcurve series\n}\n```\n            ","samples":[{"name":"Bell curve","value":"highcharts/demo/bellcurve/","products":["highcharts"]}],"extends":"plotOptions.areaspline","since":"6.0.0","products":["highcharts"],"exclude":["boostThreshold","connectNulls","dragDrop","stacking","pointInterval","pointIntervalUnit"],"requires":["module:modules/histogram-bellcurve"]},"meta":{"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js","name":"bellcurve","fullname":"plotOptions.bellcurve","line":13,"lineEnd":17,"column":0},"children":{"color":{"doclet":{"see":["[fillColor](#plotOptions.bellcurve.fillColor)","[fillOpacity](#plotOptions.bellcurve.fillOpacity)"]},"meta":{"fullname":"plotOptions.bellcurve.color","name":"color","line":36,"lineEnd":41,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js"},"children":{}},"fillColor":{"doclet":{"see":["[color](#plotOptions.bellcurve.color)","[fillOpacity](#plotOptions.bellcurve.fillOpacity)"]},"meta":{"fullname":"plotOptions.bellcurve.fillColor","name":"fillColor","line":42,"lineEnd":47,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#plotOptions.bellcurve.color)","[fillColor](#plotOptions.bellcurve.fillColor)"],"defaultByProduct":{"highcharts":"0.75","highstock":"0.75"}},"meta":{"fullname":"plotOptions.bellcurve.fillOpacity","name":"fillOpacity","line":48,"lineEnd":55,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js"},"children":{}},"intervals":{"doclet":{"description":"This option allows to define the length of the bell curve. A unit of\nthe length of the bell curve is standard deviation.","samples":[{"name":"Intervals and points in interval","value":"highcharts/plotoptions/bellcurve-intervals-pointsininterval"}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.bellcurve.intervals","name":"intervals","line":36,"lineEnd":41,"column":4,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js","default":3},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bellcurve.marker","name":"marker","line":72,"lineEnd":72,"column":4,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.bellcurve.marker.enabled","name":"enabled","line":73,"lineEnd":73,"column":8,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js","default":false},"children":{}}}},"pointsInInterval":{"doclet":{"description":"Defines how many points should be plotted within 1 interval. See\n`plotOptions.bellcurve.intervals`.","samples":[{"name":"Intervals and points in interval","value":"highcharts/plotoptions/bellcurve-intervals-pointsininterval"}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.bellcurve.pointsInInterval","name":"pointsInInterval","line":64,"lineEnd":70,"column":4,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js","default":3},"children":{}}}},"boxplot":{"doclet":{"description":"A box plot is a convenient way of depicting groups of data through their\nfive-number summaries: the smallest observation (sample minimum), lower\nquartile (Q1), median (Q2), upper quartile (Q3), and largest observation\n(sample maximum).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `boxplot` series are defined in\n   [plotOptions.boxplot](plotOptions.boxplot).\n3. Options for one single series are given in\n   [the series instance array](series.boxplot).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        boxplot: {\n            // shared options for all boxplot series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'boxplot'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.boxplot.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === boxplot) {\n    // code specific to the boxplot series\n}\n```\n            ","samples":[{"name":"Box plot","value":"highcharts/demo/box-plot/"},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]},{"name":"Jittered scatter plot on top of a box plot","value":"highcharts/series-scatter/jitter-boxplot","products":["highcharts"]}],"extends":"plotOptions.column","exclude":["borderColor","borderRadius","borderWidth","groupZPadding","states","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js","name":"boxplot","fullname":"plotOptions.boxplot","line":12,"lineEnd":16,"column":0},"children":{"boxDashStyle":{"doclet":{"description":"The dash style of the box.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"8.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.boxplot.boxDashStyle","name":"boxDashStyle","line":159,"lineEnd":172,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"colorKey":{"doclet":{"defaultvalue":"high","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.boxplot.colorKey","name":"colorKey","line":238,"lineEnd":241,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"dragDrop":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"draggableHigh":{"doclet":{"description":"Allow high value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.boxplot.dragDrop.draggableHigh","name":"draggableHigh","line":182,"lineEnd":189,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}},"draggableLow":{"doclet":{"description":"Allow low value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.boxplot.dragDrop.draggableLow","name":"draggableLow","line":113,"lineEnd":120,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}},"draggableQ1":{"doclet":{"description":"Allow Q1 value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.boxplot.dragDrop.draggableQ1","name":"draggableQ1","line":134,"lineEnd":141,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}},"draggableQ3":{"doclet":{"description":"Allow Q3 value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.boxplot.dragDrop.draggableQ3","name":"draggableQ3","line":161,"lineEnd":168,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}}}},"fillColor":{"doclet":{"description":"The fill color of the box.\n\nIn styled mode, the fill color can be set with the\n`.highcharts-boxplot-box` class.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#ffffff","since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.boxplot.fillColor","name":"fillColor","line":64,"lineEnd":77,"column":4,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js","default":"#ffffff"},"children":{}},"lineWidth":{"doclet":{"description":"The width of the line surrounding the box. If any of\n[stemWidth](#plotOptions.boxplot.stemWidth),\n[medianWidth](#plotOptions.boxplot.medianWidth)\nor [whiskerWidth](#plotOptions.boxplot.whiskerWidth) are `null`,\nthe lineWidth also applies to these lines.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Error bar styling","value":"highcharts/plotoptions/error-bar-styling/","products":["highcharts"]}],"since":"3.0.0","products":["highcharts"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.boxplot.lineWidth","name":"lineWidth","line":79,"lineEnd":93,"column":4,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js","default":1},"children":{}},"medianColor":{"doclet":{"description":"The color of the median line. If `undefined`, the general series\ncolor applies.\n\nIn styled mode, the median stroke width can be set with the\n`.highcharts-boxplot-median` class.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]},{"name":"Error bar styling","value":"highcharts/plotoptions/error-bar-styling/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.boxplot.medianColor","name":"medianColor","line":95,"lineEnd":113,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"medianDashStyle":{"doclet":{"description":"The dash style of the median.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"8.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.boxplot.medianDashStyle","name":"medianDashStyle","line":173,"lineEnd":186,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"medianWidth":{"doclet":{"description":"The pixel width of the median line. If `null`, the\n[lineWidth](#plotOptions.boxplot.lineWidth) is used.\n\nIn styled mode, the median stroke width can be set with the\n`.highcharts-boxplot-median` class.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]}],"type":{"names":["number","null"]},"since":"3.0.0","products":["highcharts"],"defaultvalue":2},"meta":{"fullname":"plotOptions.boxplot.medianWidth","name":"medianWidth","line":95,"lineEnd":113,"column":4,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js","default":2},"children":{}},"stemColor":{"doclet":{"description":"The color of the stem, the vertical line extending from the box to\nthe whiskers. If `undefined`, the series color is used.\n\nIn styled mode, the stem stroke can be set with the\n`.highcharts-boxplot-stem` class.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]},{"name":"Error bar styling","value":"highcharts/plotoptions/error-bar-styling/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.boxplot.stemColor","name":"stemColor","line":140,"lineEnd":158,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"stemDashStyle":{"doclet":{"description":"The dash style of the stem, the vertical line extending from the\nbox to the whiskers.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]},{"name":"Error bar styling","value":"highcharts/plotoptions/error-bar-styling/","products":["highcharts"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.boxplot.stemDashStyle","name":"stemDashStyle","line":187,"lineEnd":203,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"stemWidth":{"doclet":{"description":"The width of the stem, the vertical line extending from the box to\nthe whiskers. If `undefined`, the width is inherited from the\n[lineWidth](#plotOptions.boxplot.lineWidth) option.\n\nIn styled mode, the stem stroke width can be set with the\n`.highcharts-boxplot-stem` class.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]},{"name":"Error bar styling","value":"highcharts/plotoptions/error-bar-styling/","products":["highcharts"]}],"type":{"names":["number"]},"since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.boxplot.stemWidth","name":"stemWidth","line":218,"lineEnd":237,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"threshold":{"doclet":{"type":{"names":["number","null"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.boxplot.threshold","name":"threshold","line":38,"lineEnd":40,"column":4,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js","default":null},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.boxplot.tooltip","name":"tooltip","line":42,"lineEnd":42,"column":4,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> <b>{series.name}</b><br/>Maximum: {point.high}<br/>Upper quartile: {point.q3}<br/>Median: {point.median}<br/>Lower quartile: {point.q1}<br/>Minimum: {point.low}<br/>"},"meta":{"fullname":"plotOptions.boxplot.tooltip.pointFormat","name":"pointFormat","line":43,"lineEnd":43,"column":8,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> <b>{series.name}</b><br/>Maximum: {point.high}<br/>Upper quartile: {point.q3}<br/>Median: {point.median}<br/>Lower quartile: {point.q1}<br/>Minimum: {point.low}<br/>"},"children":{}}}},"whiskerColor":{"doclet":{"description":"The color of the whiskers, the horizontal lines marking low and high\nvalues. When `undefined`, the general series color is used.\n\nIn styled mode, the whisker stroke can be set with the\n`.highcharts-boxplot-whisker` class .","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.boxplot.whiskerColor","name":"whiskerColor","line":242,"lineEnd":258,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"whiskerDashStyle":{"doclet":{"description":"The dash style of the whiskers.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"8.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.boxplot.whiskerDashStyle","name":"whiskerDashStyle","line":204,"lineEnd":217,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"whiskerLength":{"doclet":{"description":"The length of the whiskers, the horizontal lines marking low and\nhigh values. It can be a numerical pixel value, or a percentage\nvalue of the box width. Set `0` to disable whiskers.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"3.0.0","products":["highcharts"],"defaultvalue":"50%"},"meta":{"fullname":"plotOptions.boxplot.whiskerLength","name":"whiskerLength","line":51,"lineEnd":62,"column":4,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js","default":"50%"},"children":{}},"whiskerWidth":{"doclet":{"description":"The line width of the whiskers, the horizontal lines marking low and\nhigh values. When `undefined`, the general\n[lineWidth](#plotOptions.boxplot.lineWidth) applies.\n\nIn styled mode, the whisker stroke width can be set with the\n`.highcharts-boxplot-whisker` class.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]}],"since":"3.0.0","products":["highcharts"],"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.boxplot.whiskerWidth","name":"whiskerWidth","line":131,"lineEnd":139,"column":4,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js","default":2},"children":{}}}},"bubble":{"doclet":{"description":"A bubble series is a three dimensional series type where each point\nrenders an X, Y and Z value. Each points is drawn as a bubble where the\nposition along the X and Y axes mark the X and Y values, and the size of\nthe bubble relates to the Z value.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `bubble` series are defined in\n   [plotOptions.bubble](plotOptions.bubble).\n3. Options for one single series are given in\n   [the series instance array](series.bubble).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        bubble: {\n            // shared options for all bubble series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'bubble'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.bubble.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === bubble) {\n    // code specific to the bubble series\n}\n```\n            ","samples":[{"name":"Bubble chart","value":"highcharts/demo/bubble/","products":["highcharts"]}],"extends":"plotOptions.scatter","exclude":["cluster"],"products":["highcharts","highstock"],"requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","name":"bubble","fullname":"plotOptions.bubble","line":352,"lineEnd":356,"column":0},"children":{"animationLimit":{"doclet":{"description":"If there are more points in the series than the `animationLimit`, the\nanimation won't run. Animation affects overall performance and\ndoesn't work well with heavy data series.","since":"6.1.0","type":{"names":["number"]},"defaultvalue":250},"meta":{"fullname":"plotOptions.bubble.animationLimit","name":"animationLimit","line":382,"lineEnd":388,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":250},"children":{}},"colorKey":{"doclet":{"defaultvalue":"z","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.bubble.colorKey","name":"colorKey","line":559,"lineEnd":562,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bubble.dataLabels","name":"dataLabels","line":373,"lineEnd":373,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{"inside":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.bubble.dataLabels.inside","name":"inside","line":379,"lineEnd":379,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":true},"children":{}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"middle"},"meta":{"fullname":"plotOptions.bubble.dataLabels.verticalAlign","name":"verticalAlign","line":380,"lineEnd":380,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":"middle"},"children":{}}}},"displayNegative":{"doclet":{"description":"Whether to display negative sized bubbles. The threshold is given\nby the [zThreshold](#plotOptions.bubble.zThreshold) option, and negative\nbubbles can be visualized by setting\n[negativeColor](#plotOptions.bubble.negativeColor).","samples":[{"name":"Negative bubbles","value":"highcharts/plotoptions/bubble-negative/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0"},"meta":{"fullname":"plotOptions.bubble.displayNegative","name":"displayNegative","line":390,"lineEnd":403,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{}},"marker":{"doclet":{"extends":"plotOptions.series.marker","exclude":["enabled","enabledThreshold","height","radius","width"]},"meta":{"fullname":"plotOptions.bubble.marker","name":"marker","line":390,"lineEnd":403,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{"fillOpacity":{"doclet":{"description":"The fill opacity of the bubble markers.","type":{"names":["number"]},"defaultvalue":0.5},"meta":{"fullname":"plotOptions.bubble.marker.fillOpacity","name":"fillOpacity","line":411,"lineEnd":413,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":0.5},"children":{}},"lineColor":{"doclet":{"type":{"names":["*"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.bubble.marker.lineColor","name":"lineColor","line":409,"lineEnd":409,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":null},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.bubble.marker.lineWidth","name":"lineWidth","line":409,"lineEnd":409,"column":25,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":1},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bubble.marker.states","name":"states","line":422,"lineEnd":422,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bubble.marker.states.hover","name":"hover","line":423,"lineEnd":423,"column":12,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{"radiusPlus":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.bubble.marker.states.hover.radiusPlus","name":"radiusPlus","line":424,"lineEnd":424,"column":16,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":0},"children":{}}}}}},"symbol":{"doclet":{"description":"A predefined shape or symbol for the marker. Possible values are\n\"circle\", \"square\", \"diamond\", \"triangle\" and \"triangle-down\".\n\nAdditionally, the URL to a graphic can be given on the form\n`url(graphic.png)`. Note that for the image to be applied to\nexported charts, its URL needs to be accessible by the export\nserver.\n\nCustom callbacks for symbol path generation can also be added to\n`Highcharts.SVGRenderer.prototype.symbols`. The callback is then\nused by its method name, as shown in the demo.","samples":[{"name":"Bubble chart with various symbols","value":"highcharts/plotoptions/bubble-symbol/","products":["highcharts"]},{"name":"General chart with predefined, graphic and custom markers","value":"highcharts/plotoptions/series-marker-symbol/","products":["highcharts"]}],"type":{"names":["Highcharts.SymbolKeyValue","string"]},"since":"5.0.11","defaultvalue":"circle"},"meta":{"fullname":"plotOptions.bubble.marker.symbol","name":"symbol","line":427,"lineEnd":447,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":"circle"},"children":{}}}},"maxSize":{"doclet":{"description":"Maximum bubble size. Bubbles will automatically size between the\n`minSize` and `maxSize` to reflect the `z` value of each bubble.\nCan be either pixels (when no unit is given), or a percentage of\nthe smallest one of the plot width and height.","samples":[{"name":"Bubble size","value":"highcharts/plotoptions/bubble-size/","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"3.0.0","products":["highcharts","highstock"],"defaultvalue":"20%"},"meta":{"fullname":"plotOptions.bubble.maxSize","name":"maxSize","line":464,"lineEnd":476,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":"20%"},"children":{}},"minSize":{"doclet":{"description":"Minimum bubble size. Bubbles will automatically size between the\n`minSize` and `maxSize` to reflect the `z` value of each bubble.\nCan be either pixels (when no unit is given), or a percentage of\nthe smallest one of the plot width and height.","samples":[{"name":"Bubble size","value":"highcharts/plotoptions/bubble-size/","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"3.0.0","products":["highcharts","highstock"],"defaultvalue":8},"meta":{"fullname":"plotOptions.bubble.minSize","name":"minSize","line":450,"lineEnd":462,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":8},"children":{}},"negativeColor":{"doclet":{"description":"When a point's Z value is below the\n[zThreshold](#plotOptions.bubble.zThreshold)\nsetting, this color is used.","samples":[{"name":"Negative bubbles","value":"highcharts/plotoptions/bubble-negative/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.bubble.negativeColor","name":"negativeColor","line":478,"lineEnd":490,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{}},"sizeBy":{"doclet":{"description":"Whether the bubble's value should be represented by the area or the\nwidth of the bubble. The default, `area`, corresponds best to the\nhuman perception of the size of each bubble.","samples":[{"name":"Comparison of area and size","value":"highcharts/plotoptions/bubble-sizeby/","products":["highcharts"]}],"type":{"names":["Highcharts.BubbleSizeByValue"]},"defaultvalue":"area","since":"3.0.7"},"meta":{"fullname":"plotOptions.bubble.sizeBy","name":"sizeBy","line":491,"lineEnd":503,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{}},"sizeByAbsoluteValue":{"doclet":{"description":"When this is true, the absolute value of z determines the size of\nthe bubble. This means that with the default `zThreshold` of 0, a\nbubble of value -1 will have the same size as a bubble of value 1,\nwhile a bubble of value 0 will have a smaller size according to\n`minSize`.","samples":[{"name":"Size by absolute value, various thresholds","value":"highcharts/plotoptions/bubble-sizebyabsolutevalue/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"4.1.9","products":["highcharts"]},"meta":{"fullname":"plotOptions.bubble.sizeByAbsoluteValue","name":"sizeByAbsoluteValue","line":504,"lineEnd":519,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{}},"softThreshold":{"doclet":{"description":"When this is true, the series will not cause the Y axis to cross\nthe zero plane (or [threshold](#plotOptions.series.threshold) option)\nunless the data actually crosses the plane.\n\nFor example, if `softThreshold` is `false`, a series of 0, 1, 2,\n3 will make the Y axis show negative values according to the\n`minPadding` option. If `softThreshold` is `true`, the Y axis starts\nat 0.","since":"4.1.9","products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.bubble.softThreshold","name":"softThreshold","line":478,"lineEnd":490,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":false},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bubble.states","name":"states","line":534,"lineEnd":534,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bubble.states.hover","name":"hover","line":535,"lineEnd":535,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{"halo":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bubble.states.hover.halo","name":"halo","line":536,"lineEnd":536,"column":12,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{"size":{"doclet":{"type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"plotOptions.bubble.states.hover.halo.size","name":"size","line":537,"lineEnd":537,"column":16,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":5},"children":{}}}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bubble.tooltip","name":"tooltip","line":541,"lineEnd":541,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"({point.x}, {point.y}), Size: {point.z}"},"meta":{"fullname":"plotOptions.bubble.tooltip.pointFormat","name":"pointFormat","line":542,"lineEnd":542,"column":8,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":"({point.x}, {point.y}), Size: {point.z}"},"children":{}}}},"turboThreshold":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.bubble.turboThreshold","name":"turboThreshold","line":544,"lineEnd":544,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":0},"children":{}},"zMax":{"doclet":{"description":"The minimum for the Z value range. Defaults to the highest Z value\nin the data.","see":["[zMin](#plotOptions.bubble.zMin)"],"samples":[{"name":"Z has a possible range of 0-100","value":"highcharts/plotoptions/bubble-zmin-zmax/","products":["highcharts"]}],"type":{"names":["number"]},"since":"4.0.3","products":["highcharts"]},"meta":{"fullname":"plotOptions.bubble.zMax","name":"zMax","line":545,"lineEnd":558,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{}},"zMin":{"doclet":{"description":"The minimum for the Z value range. Defaults to the lowest Z value\nin the data.","see":["[zMax](#plotOptions.bubble.zMax)"],"samples":[{"name":"Z has a possible range of 0-100","value":"highcharts/plotoptions/bubble-zmin-zmax/","products":["highcharts"]}],"type":{"names":["number"]},"since":"4.0.3","products":["highcharts"]},"meta":{"fullname":"plotOptions.bubble.zMin","name":"zMin","line":563,"lineEnd":576,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{}},"zThreshold":{"doclet":{"description":"When [displayNegative](#plotOptions.bubble.displayNegative) is `false`,\nbubbles with lower Z values are skipped. When `displayNegative`\nis `true` and a [negativeColor](#plotOptions.bubble.negativeColor)\nis given, points with lower Z is colored.","samples":[{"name":"Negative bubbles","value":"highcharts/plotoptions/bubble-negative/","products":["highcharts"]}],"since":"3.0.0","products":["highcharts"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.bubble.zThreshold","name":"zThreshold","line":545,"lineEnd":558,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":0},"children":{}},"zoneAxis":{"doclet":{"type":{"names":["string"]},"defaultvalue":"z"},"meta":{"fullname":"plotOptions.bubble.zoneAxis","name":"zoneAxis","line":590,"lineEnd":590,"column":4,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js","default":"z"},"children":{}}}},"bullet":{"doclet":{"description":"A bullet graph is a variation of a bar graph. The bullet graph features\na single measure, compares it to a target, and displays it in the context\nof qualitative ranges of performance that could be set using\n[plotBands](#yAxis.plotBands) on [yAxis](#yAxis).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `bullet` series are defined in\n   [plotOptions.bullet](plotOptions.bullet).\n3. Options for one single series are given in\n   [the series instance array](series.bullet).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        bullet: {\n            // shared options for all bullet series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'bullet'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.bullet.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === bullet) {\n    // code specific to the bullet series\n}\n```\n            ","samples":[{"name":"Bullet graph","value":"highcharts/demo/bullet-graph/","products":["highcharts"]}],"extends":"plotOptions.column","since":"6.0.0","products":["highcharts"],"exclude":["allAreas","boostThreshold","colorAxis","compare","compareBase","dataSorting","boostBlending"],"requires":["module:modules/bullet"]},"meta":{"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js","name":"bullet","fullname":"plotOptions.bullet","line":11,"lineEnd":27,"column":0},"children":{"dragDrop":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"draggableTarget":{"doclet":{"description":"Allow target value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.bullet.dragDrop.draggableTarget","name":"draggableTarget","line":224,"lineEnd":231,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}}}},"targetOptions":{"doclet":{"description":"All options related with look and positioning of targets.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bullet.targetOptions","name":"targetOptions","line":29,"lineEnd":33,"column":4,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js"},"children":{"borderColor":{"doclet":{"description":"The border color of the rectangle representing the target. When\nnot set, the point's border color is used.\n\nIn styled mode, use class `highcharts-bullet-target` instead.","type":{"names":["Highcharts.ColorString"]},"since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.bullet.targetOptions.borderColor","name":"borderColor","line":49,"lineEnd":59,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js"},"children":{}},"borderRadius":{"doclet":{"description":"The border radius of the rectangle representing the target.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.bullet.targetOptions.borderRadius","name":"borderRadius","line":83,"lineEnd":85,"column":8,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js","default":0},"children":{}},"borderWidth":{"doclet":{"description":"The border width of the rectangle representing the target.\n\nIn styled mode, use class `highcharts-bullet-target` instead.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.bullet.targetOptions.borderWidth","name":"borderWidth","line":49,"lineEnd":59,"column":8,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js","default":0},"children":{}},"color":{"doclet":{"description":"The color of the rectangle representing the target. When not set,\npoint's color (if set in point's options -\n[`color`](#series.bullet.data.color)) or zone of the target value\n(if [`zones`](#plotOptions.bullet.zones) or\n[`negativeColor`](#plotOptions.bullet.negativeColor) are set)\nor the same color as the point has is used.\n\nIn styled mode, use class `highcharts-bullet-target` instead.","type":{"names":["Highcharts.ColorType"]},"since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.bullet.targetOptions.color","name":"color","line":60,"lineEnd":74,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js"},"children":{}},"height":{"doclet":{"description":"The height of the rectangle representing the target.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.bullet.targetOptions.height","name":"height","line":43,"lineEnd":47,"column":8,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js","default":3},"children":{}},"width":{"doclet":{"description":"The width of the rectangle representing the target. Could be set\nas a pixel value or as a percentage of a column width.","type":{"names":["number","string"]},"since":"6.0.0","defaultvalue":"140%"},"meta":{"fullname":"plotOptions.bullet.targetOptions.width","name":"width","line":35,"lineEnd":41,"column":8,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js","default":"140%"},"children":{}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.bullet.tooltip","name":"tooltip","line":88,"lineEnd":88,"column":4,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{series.color}\">●</span> {series.name}: <b>{point.y}</b>. Target: <b>{point.target}</b><br/>"},"meta":{"fullname":"plotOptions.bullet.tooltip.pointFormat","name":"pointFormat","line":89,"lineEnd":89,"column":8,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js","default":"<span style=\"color:{series.color}\">●</span> {series.name}: <b>{point.y}</b>. Target: <b>{point.target}</b><br/>"},"children":{}}}}}},"candlestick":{"doclet":{"description":"A candlestick chart is a style of financial chart used to describe\nprice movements over time.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `candlestick` series are defined in\n   [plotOptions.candlestick](plotOptions.candlestick).\n3. Options for one single series are given in\n   [the series instance array](series.candlestick).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        candlestick: {\n            // shared options for all candlestick series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'candlestick'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.candlestick.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === candlestick) {\n    // code specific to the candlestick series\n}\n```\n            ","samples":[{"name":"Candlestick chart","value":"stock/demo/candlestick/"}],"extends":"plotOptions.ohlc","exclude":["borderColor","borderRadius","borderWidth"],"products":["highstock"]},"meta":{"filename":"code/es-modules/Series/Candlestick/CandlestickSeriesDefaults.js","name":"candlestick","fullname":"plotOptions.candlestick","line":12,"lineEnd":16,"column":0},"children":{"lineColor":{"doclet":{"description":"The color of the line/border of the candlestick.\n\nIn styled mode, the line stroke can be set with the\n`.highcharts-candlestick-series .highcharts-point` rule.","see":["[upLineColor](#plotOptions.candlestick.upLineColor)"],"samples":[{"name":"Candlestick line colors","value":"stock/plotoptions/candlestick-linecolor/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#000000","products":["highstock"]},"meta":{"fullname":"plotOptions.candlestick.lineColor","name":"lineColor","line":62,"lineEnd":76,"column":4,"filename":"code/es-modules/Series/Candlestick/CandlestickSeriesDefaults.js","default":"#000000"},"children":{}},"lineWidth":{"doclet":{"description":"The pixel width of the candlestick line/border. Defaults to `1`.\n\n\nIn styled mode, the line stroke width can be set with the\n`.highcharts-candlestick-series .highcharts-point` rule.","products":["highstock"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.candlestick.lineWidth","name":"lineWidth","line":78,"lineEnd":86,"column":4,"filename":"code/es-modules/Series/Candlestick/CandlestickSeriesDefaults.js","default":1},"children":{}},"stickyTracking":{"doclet":{"products":["highstock"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.candlestick.stickyTracking","name":"stickyTracking","line":104,"lineEnd":106,"column":4,"filename":"code/es-modules/Series/Candlestick/CandlestickSeriesDefaults.js","default":true},"children":{}},"threshold":{"doclet":{"type":{"names":["number","null"]},"products":["highstock"],"defaultvalue":null},"meta":{"fullname":"plotOptions.candlestick.threshold","name":"threshold","line":57,"lineEnd":60,"column":4,"filename":"code/es-modules/Series/Candlestick/CandlestickSeriesDefaults.js","default":null},"children":{}},"upColor":{"doclet":{"description":"The fill color of the candlestick when values are rising.\n\nIn styled mode, the up color can be set with the\n`.highcharts-candlestick-series .highcharts-point-up` rule.","samples":[{"name":"Custom colors","value":"stock/plotoptions/candlestick-color/","products":["highstock"]},{"name":"Colors in styled mode","value":"highcharts/css/candlestick/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#ffffff","products":["highstock"]},"meta":{"fullname":"plotOptions.candlestick.upColor","name":"upColor","line":88,"lineEnd":102,"column":4,"filename":"code/es-modules/Series/Candlestick/CandlestickSeriesDefaults.js","default":"#ffffff"},"children":{}},"upLineColor":{"doclet":{"description":"The specific line color for up candle sticks. The default is to\ninherit the general `lineColor` setting.","samples":[{"name":"Candlestick line colors","value":"stock/plotoptions/candlestick-linecolor/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"since":"1.3.6","products":["highstock"]},"meta":{"fullname":"plotOptions.candlestick.upLineColor","name":"upLineColor","line":30,"lineEnd":41,"filename":"code/es-modules/Series/Candlestick/CandlestickSeriesDefaults.js"},"children":{}}}},"cci":{"doclet":{"description":"Commodity Channel Index (CCI). This series requires `linkedTo` option to\nbe set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `cci` series are defined in\n   [plotOptions.cci](plotOptions.cci).\n3. Options for one single series are given in\n   [the series instance array](series.cci).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        cci: {\n            // shared options for all cci series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'cci'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.cci.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === cci) {\n    // code specific to the cci series\n}\n```\n            ","samples":[{"name":"CCI indicator","value":"stock/indicators/cci"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/cci"]},"meta":{"filename":"code/es-modules/Stock/Indicators/CCI/CCIIndicator.js","name":"cci","fullname":"plotOptions.cci","line":90,"lineEnd":94,"column":0},"children":{"params":{"doclet":{"exclude":["index"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.cci.params","name":"params","line":110,"lineEnd":112,"column":4,"filename":"code/es-modules/Stock/Indicators/CCI/CCIIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.cci.params.index","name":"index","line":114,"lineEnd":114,"column":8,"filename":"code/es-modules/Stock/Indicators/CCI/CCIIndicator.js","default":"undefined"},"children":{}}}}}},"chaikin":{"doclet":{"description":"Chaikin Oscillator. This series requires the `linkedTo` option to\nbe set and should be loaded after the `stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `chaikin` series are defined in\n   [plotOptions.chaikin](plotOptions.chaikin).\n3. Options for one single series are given in\n   [the series instance array](series.chaikin).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        chaikin: {\n            // shared options for all chaikin series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'chaikin'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.chaikin.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === chaikin) {\n    // code specific to the chaikin series\n}\n```\n            ","samples":[{"name":"Chaikin Oscillator","value":"stock/indicators/chaikin","products":["highstock"]}],"extends":"plotOptions.ema","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/chaikin"]},"meta":{"filename":"code/es-modules/Stock/Indicators/Chaikin/ChaikinIndicator.js","name":"chaikin","fullname":"plotOptions.chaikin","line":81,"lineEnd":85,"column":0},"children":{"params":{"doclet":{"description":"Parameters used in calculation of Chaikin Oscillator\nseries points.","exclude":["index"],"since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.chaikin.params","name":"params","line":104,"lineEnd":109,"column":4,"filename":"code/es-modules/Stock/Indicators/Chaikin/ChaikinIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.chaikin.params.index","name":"index","line":111,"lineEnd":111,"column":8,"filename":"code/es-modules/Stock/Indicators/Chaikin/ChaikinIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"description":"Parameter used indirectly for calculating the `AD` indicator.\nDecides about the number of data points that are taken\ninto account for the indicator calculations.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":9},"meta":{"fullname":"plotOptions.chaikin.params.period","name":"period","line":118,"lineEnd":122,"column":8,"filename":"code/es-modules/Stock/Indicators/Chaikin/ChaikinIndicator.js","default":9},"children":{}},"periods":{"doclet":{"description":"Periods for Chaikin Oscillator calculations.","type":{"names":["Array.<number>"]},"defaultvalue":"[3, 10]","since":"7.0.0"},"meta":{"fullname":"plotOptions.chaikin.params.periods","name":"periods","line":124,"lineEnd":129,"column":8,"filename":"code/es-modules/Stock/Indicators/Chaikin/ChaikinIndicator.js"},"children":{}},"volumeSeriesID":{"doclet":{"description":"The id of volume series which is mandatory.\nFor example using OHLC data, volumeSeriesID='volume' means\nthe indicator will be calculated using OHLC and volume values.","since":"7.0.0","type":{"names":["string"]},"defaultvalue":"volume"},"meta":{"fullname":"plotOptions.chaikin.params.volumeSeriesID","name":"volumeSeriesID","line":111,"lineEnd":111,"column":23,"filename":"code/es-modules/Stock/Indicators/Chaikin/ChaikinIndicator.js","default":"volume"},"children":{}}}}}},"cmf":{"doclet":{"description":"Chaikin Money Flow indicator (cmf).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `cmf` series are defined in\n   [plotOptions.cmf](plotOptions.cmf).\n3. Options for one single series are given in\n   [the series instance array](series.cmf).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        cmf: {\n            // shared options for all cmf series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'cmf'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.cmf.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === cmf) {\n    // code specific to the cmf series\n}\n```\n            ","samples":[{"name":"Chaikin Money Flow indicator","value":"stock/indicators/cmf/"}],"extends":"plotOptions.sma","since":"6.0.0","exclude":["animationLimit"],"products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/cmf"]},"meta":{"filename":"code/es-modules/Stock/Indicators/CMF/CMFIndicator.js","name":"cmf","fullname":"plotOptions.cmf","line":183,"lineEnd":196,"column":0},"children":{"params":{"doclet":{"exclude":["index"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.cmf.params","name":"params","line":198,"lineEnd":200,"column":4,"filename":"code/es-modules/Stock/Indicators/CMF/CMFIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.cmf.params.index","name":"index","line":202,"lineEnd":202,"column":8,"filename":"code/es-modules/Stock/Indicators/CMF/CMFIndicator.js","default":"undefined"},"children":{}},"volumeSeriesID":{"doclet":{"description":"The id of another series to use its data as volume data for the\nindicator calculation.","type":{"names":["string"]},"defaultvalue":"volume"},"meta":{"fullname":"plotOptions.cmf.params.volumeSeriesID","name":"volumeSeriesID","line":202,"lineEnd":202,"column":23,"filename":"code/es-modules/Stock/Indicators/CMF/CMFIndicator.js","default":"volume"},"children":{}}}}}},"cmo":{"doclet":{"description":"Chande Momentum Oscillator (CMO) technical indicator. This series\nrequires the `linkedTo` option to be set and should be loaded after\nthe `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `cmo` series are defined in\n   [plotOptions.cmo](plotOptions.cmo).\n3. Options for one single series are given in\n   [the series instance array](series.cmo).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        cmo: {\n            // shared options for all cmo series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'cmo'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.cmo.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === cmo) {\n    // code specific to the cmo series\n}\n```\n            ","samples":[{"name":"CMO indicator","value":"stock/indicators/cmo"}],"extends":"plotOptions.sma","since":"9.1.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/cmo"]},"meta":{"filename":"code/es-modules/Stock/Indicators/CMO/CMOIndicator.js","name":"cmo","fullname":"plotOptions.cmo","line":102,"lineEnd":106,"column":0},"children":{"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.cmo.params","name":"params","line":123,"lineEnd":123,"column":4,"filename":"code/es-modules/Stock/Indicators/CMO/CMOIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.cmo.params.index","name":"index","line":125,"lineEnd":125,"column":8,"filename":"code/es-modules/Stock/Indicators/CMO/CMOIndicator.js","default":3},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":20},"meta":{"fullname":"plotOptions.cmo.params.period","name":"period","line":124,"lineEnd":124,"column":8,"filename":"code/es-modules/Stock/Indicators/CMO/CMOIndicator.js","default":20},"children":{}}}}}},"column":{"doclet":{"description":"Column series display one column per value along an X axis.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `column` series are defined in\n   [plotOptions.column](plotOptions.column).\n3. Options for one single series are given in\n   [the series instance array](series.column).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        column: {\n            // shared options for all column series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'column'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.column.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === column) {\n    // code specific to the column series\n}\n```\n            ","samples":[{"name":"Column chart","value":"highcharts/demo/column-basic/","products":["highcharts"]},{"name":"Column chart","value":"stock/demo/column/","products":["highstock"]}],"extends":"plotOptions.line","exclude":["connectEnds","connectNulls","gapSize","gapUnit","linecap","lineWidth","marker","step","useOhlcData"],"products":["highcharts","highstock"]},"meta":{"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","name":"column","fullname":"plotOptions.column","line":12,"lineEnd":16,"column":0},"children":{"borderColor":{"doclet":{"description":"The color of the border surrounding each column or bar.\n\nIn styled mode, the border stroke can be set with the\n`.highcharts-point` rule.","samples":[{"name":"Dark gray border","value":"highcharts/plotoptions/column-bordercolor/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#ffffff","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.borderColor","name":"borderColor","line":330,"lineEnd":345,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":"#ffffff"},"children":{}},"borderRadius":{"doclet":{"description":"The corner radius of the border surrounding each column or bar. A number\nsignifies pixels. A percentage string, like for example `50%`, signifies\na relative size. For columns this is relative to the column width, for\npies it is relative to the radius and the inner radius.","samples":[{"name":"Rounded columns","value":"highcharts/plotoptions/column-borderradius/","products":["highcharts"]},{"name":"Column and pie with rounded border","value":"highcharts/plotoptions/series-border-radius"}],"type":{"names":["number","string","Highcharts.BorderRadiusOptionsObject"]},"products":["highcharts","highstock","gantt"],"defaultvalue":3},"meta":{"fullname":"plotOptions.column.borderRadius","name":"borderRadius","line":32,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":3},"children":{}},"borderWidth":{"doclet":{"description":"The width of the border surrounding each column or bar. Defaults to\n`1` when there is room for a border, but to `0` when the columns are\nso dense that a border would cover the next column.\n\nIn styled mode, the stroke width can be set with the\n`.highcharts-point` rule.","samples":[{"name":"2px black border","value":"highcharts/plotoptions/column-borderwidth/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"undefined","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.borderWidth","name":"borderWidth","line":330,"lineEnd":345,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"centerInCategory":{"doclet":{"description":"When `true`, the columns will center in the category, ignoring null\nor missing points. When `false`, space will be reserved for null or\nmissing points.","samples":[{"name":"Center in category","value":"highcharts/series-column/centerincategory/","products":["highcharts"]},{"name":"Center in category, stacked and grouped","value":"highcharts/series/stack-centerincategory/","products":["highcharts"]}],"since":"8.0.1","products":["highcharts","highstock","gantt"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.column.centerInCategory","name":"centerInCategory","line":47,"lineEnd":70,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":false},"children":{}},"colorByPoint":{"doclet":{"description":"When using automatic point colors pulled from the global\n[colors](colors) or series-specific\n[plotOptions.column.colors](series.colors) collections, this option\ndetermines whether the chart should receive one color per series or\none color per point.\n\nIn styled mode, the `colors` or `series.colors` arrays are not\nsupported, and instead this option gives the points individual color\nclass names on the form `highcharts-color-{n}`.","see":["[series colors](#plotOptions.column.colors)"],"samples":[{"name":"False by default","value":"highcharts/plotoptions/column-colorbypoint-false/","products":["highcharts"]},{"name":"True","value":"highcharts/plotoptions/column-colorbypoint-true/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"2.0.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.colorByPoint","name":"colorByPoint","line":47,"lineEnd":70,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"colors":{"doclet":{"description":"A series specific or series type specific color set to apply instead\nof the global [colors](#colors) when [colorByPoint](#plotOptions.column.colorByPoint) is true.","type":{"names":["Array.<Highcharts.ColorType>"]},"since":"3.0.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.colors","name":"colors","line":71,"lineEnd":80,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"cropThreshold":{"doclet":{"description":"When the series contains less points than the crop threshold, all\npoints are drawn, even if the points fall outside the visible plot\narea at the current zoom. The advantage of drawing all points\n(including markers and columns), is that animation is performed on\nupdates. On the other hand, when the series contains more points than\nthe crop threshold, the series data is cropped to only contain points\nthat fall within the plot area. The advantage of cropping away\ninvisible points is to increase performance on large series.","products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":50},"meta":{"fullname":"plotOptions.column.cropThreshold","name":"cropThreshold","line":200,"lineEnd":211,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":50},"children":{}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"groupPixelWidth":{"doclet":{"description":"The approximate pixel width of each group. If for example a series\nwith 30 points is displayed over a 600 pixel wide plot area, no grouping\nis performed. If however the series contains so many points that\nthe spacing is less than the groupPixelWidth, Highcharts will try\nto group it into appropriate groups so that each is more or less\ntwo pixels wide. Defaults to `10`.","samples":[{"name":"Two series with the same data density but different groupPixelWidth","value":"stock/plotoptions/series-datagrouping-grouppixelwidth/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"10"},"meta":{"fullname":"plotOptions.column.dataGrouping.groupPixelWidth","name":"groupPixelWidth","line":444,"lineEnd":458,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}}}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.column.dataLabels","name":"dataLabels","line":302,"lineEnd":302,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.column.dataLabels.align","name":"align","line":303,"lineEnd":303,"column":8,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":"undefined"},"children":{}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.column.dataLabels.verticalAlign","name":"verticalAlign","line":304,"lineEnd":304,"column":8,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":"undefined"},"children":{}},"y":{"doclet":{"description":"The y position offset of the label relative to the point in\npixels.","type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.column.dataLabels.y","name":"y","line":305,"lineEnd":310,"column":8,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":"undefined"},"children":{}}}},"depth":{"doclet":{"description":"Depth of the columns in a 3D column chart.","type":{"names":["number"]},"defaultvalue":"25","since":"4.0.0","products":["highcharts"],"requires":["module:highcharts-3d"]},"meta":{"fullname":"plotOptions.column.depth","name":"depth","line":444,"lineEnd":453,"filename":"code/es-modules/Series/Column3D/Column3DComposition.js"},"children":{}},"dragDrop":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"dragHandle":{"doclet":{"description":"Options for the drag handles available in column series.","declare":"Highcharts.DragDropHandleOptionsObject","since":"6.2.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.column.dragDrop.dragHandle","name":"dragHandle","line":243,"lineEnd":249,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{"cursor":{"doclet":{"description":"The mouse cursor to use for the drag handles. By default this is\nintelligently switching between `ew-resize` and `ns-resize` depending on\nthe direction the point is being dragged.","type":{"names":["string"]},"since":"6.2.0"},"meta":{"fullname":"plotOptions.column.dragDrop.dragHandle.cursor","name":"cursor","line":261,"lineEnd":269,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"pathFormatter":{"doclet":{"description":"Function to define the SVG path to use for the drag handles. Takes\nthe point as argument. Should return an SVG path in array format. The\nSVG path is automatically positioned on the point.","type":{"names":["function"]},"since":"6.2.0"},"meta":{"fullname":"plotOptions.column.dragDrop.dragHandle.pathFormatter","name":"pathFormatter","line":251,"lineEnd":259,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}}}}}},"edgeColor":{"doclet":{"description":"3D columns only. The color of the edges. Similar to `borderColor`, except it\ndefaults to the same color as the column.","type":{"names":["Highcharts.ColorString"]},"products":["highcharts"],"requires":["module:highcharts-3d"]},"meta":{"fullname":"plotOptions.column.edgeColor","name":"edgeColor","line":454,"lineEnd":462,"filename":"code/es-modules/Series/Column3D/Column3DComposition.js"},"children":{}},"edgeWidth":{"doclet":{"description":"3D columns only. The width of the colored edges.","type":{"names":["number"]},"defaultvalue":"1","products":["highcharts"],"requires":["module:highcharts-3d"]},"meta":{"fullname":"plotOptions.column.edgeWidth","name":"edgeWidth","line":463,"lineEnd":471,"filename":"code/es-modules/Series/Column3D/Column3DComposition.js"},"children":{}},"groupPadding":{"doclet":{"description":"Padding between each value groups, in x axis units.","samples":[{"name":"0.2 by default","value":"highcharts/plotoptions/column-grouppadding-default/","products":["highcharts"]},{"name":"No group padding - all columns are evenly spaced","value":"highcharts/plotoptions/column-grouppadding-none/","products":["highcharts"]}],"products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":0.2},"meta":{"fullname":"plotOptions.column.groupPadding","name":"groupPadding","line":95,"lineEnd":104,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":0.2},"children":{}},"groupZPadding":{"doclet":{"description":"The spacing between columns on the Z Axis in a 3D chart.","type":{"names":["number"]},"defaultvalue":"1","since":"4.0.0","products":["highcharts"],"requires":["module:highcharts-3d"]},"meta":{"fullname":"plotOptions.column.groupZPadding","name":"groupZPadding","line":472,"lineEnd":481,"filename":"code/es-modules/Series/Column3D/Column3DComposition.js"},"children":{}},"grouping":{"doclet":{"description":"Whether to group non-stacked columns or to let them render\nindependent of each other. Non-grouped columns will be laid out\nindividually and overlap each other.","samples":[{"name":"Grouping disabled","value":"highcharts/plotoptions/column-grouping-false/","products":["highcharts"]},{"name":"Grouping disabled","value":"highcharts/plotoptions/column-grouping-false/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"2.3.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.grouping","name":"grouping","line":106,"lineEnd":121,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"maxPointWidth":{"doclet":{"description":"The maximum allowed pixel width for a column, translated to the\nheight of a bar in a bar chart. This prevents the columns from\nbecoming too wide when there is a small number of points in the\nchart.","see":["[pointWidth](#plotOptions.column.pointWidth)"],"samples":[{"name":"Limited to 50","value":"highcharts/plotoptions/column-maxpointwidth-20/","products":["highcharts"]},{"name":"Limited to 50","value":"highcharts/plotoptions/column-maxpointwidth-20/","products":["highstock"]}],"type":{"names":["number"]},"since":"4.1.8","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.maxPointWidth","name":"maxPointWidth","line":124,"lineEnd":141,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"minPointLength":{"doclet":{"description":"The minimal height for a column or width for a bar. By default,\n0 values are not shown. To visualize a 0 (or close to zero) point,\nset the minimal point length to a pixel value like 3\\. In stacked\ncolumn charts, minPointLength might not be respected for tightly\npacked values.","samples":[{"name":"Zero base value","value":"highcharts/plotoptions/column-minpointlength/","products":["highcharts"]},{"name":"Positive and negative close to zero values","value":"highcharts/plotoptions/column-minpointlength-pos-and-neg/","products":["highcharts"]}],"products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.column.minPointLength","name":"minPointLength","line":155,"lineEnd":172,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":0},"children":{}},"pointPadding":{"doclet":{"description":"Padding between each column or bar, in x axis units.","samples":[{"name":"0.1 by default","value":"highcharts/plotoptions/column-pointpadding-default/","products":["highcharts"]},{"name":"0.25","value":"highcharts/plotoptions/column-pointpadding-025/","products":["highcharts"]},{"name":"0 for tightly packed columns","value":"highcharts/plotoptions/column-pointpadding-none/","products":["highcharts"]}],"products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.column.pointPadding","name":"pointPadding","line":123,"lineEnd":123,"column":18,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":0.1},"children":{}},"pointRange":{"doclet":{"description":"The X axis range that each point is valid for. This determines the\nwidth of the column. On a categorized axis, the range will be 1\nby default (one category unit). On linear and datetime axes, the\nrange will be computed as the distance between the two closest data\npoints.\n\nThe default `null` means it is computed automatically, but this\noption can be used to override the automatic value.\n\nThis option is set by default to 1 if data sorting is enabled.","samples":[{"name":"Set the point range to one day on a data set with one week between the points","value":"highcharts/plotoptions/column-pointrange/","products":["highcharts"]}],"type":{"names":["number","null"]},"since":"2.3.0","products":["highcharts","highstock","gantt"],"defaultvalue":null},"meta":{"fullname":"plotOptions.column.pointRange","name":"pointRange","line":213,"lineEnd":232,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":null},"children":{}},"pointWidth":{"doclet":{"description":"A pixel value specifying a fixed width for each column or bar point.\nWhen set to `undefined`, the width is calculated from the\n`pointPadding` and `groupPadding`. The width effects the dimension\nthat is not based on the point value. For column series it is the\nhorizontal length and for bar series it is the vertical length.","see":["[maxPointWidth](#plotOptions.column.maxPointWidth)"],"samples":[{"name":"20px wide columns regardless of chart width or the amount of data points","value":"highcharts/plotoptions/column-pointwidth-20/","products":["highcharts"]}],"type":{"names":["number"]},"since":"1.2.5","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.pointWidth","name":"pointWidth","line":155,"lineEnd":172,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.column.states","name":"states","line":234,"lineEnd":234,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{"hover":{"doclet":{"description":"Options for the hovered point. These settings override the normal\nstate options when a point is moused over or touched.","extends":"plotOptions.series.states.hover","exclude":["halo","lineWidth","lineWidthPlus","marker"],"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.states.hover","name":"hover","line":235,"lineEnd":242,"column":8,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{"borderColor":{"doclet":{"description":"A specific border color for the hovered point. Defaults to\ninherit the normal state border color.","type":{"names":["Highcharts.ColorType"]},"products":["highcharts","gantt"]},"meta":{"fullname":"plotOptions.column.states.hover.borderColor","name":"borderColor","line":246,"lineEnd":253,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"brightness":{"doclet":{"description":"How much to brighten the point on interaction.\n\nIn styled mode, the hover brightening is by default replaced\nwith a fill-opacity set in the `.highcharts-point:hover`\nrule.","samples":[{"name":"Brighten by 0.5","value":"highcharts/plotoptions/column-states-hover-brightness/","products":["highcharts"]}],"products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.column.states.hover.brightness","name":"brightness","line":246,"lineEnd":253,"column":12,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":0.1},"children":{}},"color":{"doclet":{"description":"A specific color for the hovered point.","type":{"names":["Highcharts.ColorType"]},"products":["highcharts","gantt"]},"meta":{"fullname":"plotOptions.column.states.hover.color","name":"color","line":254,"lineEnd":260,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}}}},"select":{"doclet":{"description":"Options for the selected point. These settings override the\nnormal state options when a point is selected.","extends":"plotOptions.series.states.select","exclude":["halo","lineWidth","lineWidthPlus","marker"],"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.states.select","name":"select","line":275,"lineEnd":282,"column":8,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{"borderColor":{"doclet":{"description":"A specific border color for the selected point.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#000000","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.states.select.borderColor","name":"borderColor","line":292,"lineEnd":298,"column":12,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":"#000000"},"children":{}},"color":{"doclet":{"description":"A specific color for the selected point.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.column.states.select.color","name":"color","line":284,"lineEnd":290,"column":12,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":"#cccccc"},"children":{}}}}}},"stickyTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.column.stickyTracking","name":"stickyTracking","line":316,"lineEnd":316,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":false},"children":{}},"threshold":{"doclet":{"description":"The Y axis value to serve as the base for the columns, for\ndistinguishing between values above and below a threshold. If `null`,\nthe columns extend from the padding Y axis minimum.","type":{"names":["number","null"]},"since":"2.0.0","products":["highcharts"],"defaultvalue":0},"meta":{"fullname":"plotOptions.column.threshold","name":"threshold","line":320,"lineEnd":328,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":0},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.column.tooltip","name":"tooltip","line":317,"lineEnd":317,"column":4,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{"distance":{"doclet":{"type":{"names":["number"]},"defaultvalue":6},"meta":{"fullname":"plotOptions.column.tooltip.distance","name":"distance","line":318,"lineEnd":318,"column":8,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js","default":6},"children":{}}}}}},"columnpyramid":{"doclet":{"description":"Column pyramid series display one pyramid per value along an X axis.\nTo display horizontal pyramids, set [chart.inverted](#chart.inverted) to\n`true`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `columnpyramid` series are defined in\n   [plotOptions.columnpyramid](plotOptions.columnpyramid).\n3. Options for one single series are given in\n   [the series instance array](series.columnpyramid).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        columnpyramid: {\n            // shared options for all columnpyramid series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'columnpyramid'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.columnpyramid.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === columnpyramid) {\n    // code specific to the columnpyramid series\n}\n```\n            ","samples":[{"name":"Column pyramid","value":"highcharts/demo/column-pyramid/","products":["highcharts","highstock"]},{"name":"Column pyramid stacked","value":"highcharts/plotoptions/columnpyramid-stacked/","products":["highcharts","highstock"]},{"name":"Column pyramid inverted","value":"highcharts/plotoptions/columnpyramid-inverted/","products":["highcharts","highstock"]}],"extends":"plotOptions.column","since":"7.0.0","products":["highcharts","highstock"],"exclude":["boostThreshold","borderRadius","crisp","depth","edgeColor","edgeWidth","groupZPadding","negativeColor","softThreshold","threshold","zoneAxis","zones","boostBlending"],"requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Series/ColumnPyramid/ColumnPyramidSeriesDefaults.js","name":"columnpyramid","fullname":"plotOptions.columnpyramid","line":12,"lineEnd":16,"column":0},"children":{}},"columnrange":{"doclet":{"description":"The column range is a cartesian series type with higher and lower\nY values along an X axis. To display horizontal bars, set\n[chart.inverted](#chart.inverted) to `true`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `columnrange` series are defined in\n   [plotOptions.columnrange](plotOptions.columnrange).\n3. Options for one single series are given in\n   [the series instance array](series.columnrange).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        columnrange: {\n            // shared options for all columnrange series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'columnrange'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.columnrange.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === columnrange) {\n    // code specific to the columnrange series\n}\n```\n            ","samples":[{"name":"Inverted column range","value":"highcharts/demo/columnrange/","products":["highcharts","highstock"]}],"extends":"plotOptions.column","since":"2.3.0","exclude":["negativeColor","stacking","softThreshold","threshold"],"products":["highcharts","highstock"],"requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js","name":"columnrange","fullname":"plotOptions.columnrange","line":18,"lineEnd":22,"column":0},"children":{"borderRadius":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.columnrange.borderRadius","name":"borderRadius","line":39,"lineEnd":39,"column":4,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js"},"children":{"where":{"doclet":{"type":{"names":["string"]},"defaultvalue":"all"},"meta":{"fullname":"plotOptions.columnrange.borderRadius.where","name":"where","line":40,"lineEnd":40,"column":8,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js","default":"all"},"children":{}}}},"dataLabels":{"doclet":{"description":"Extended data labels for range series types. Range series data labels\nhave no `x` and `y` options. Instead, they have `xLow`, `xHigh`,\n`yLow` and `yHigh` options to allow the higher and lower data label\nsets individually.","declare":"Highcharts.SeriesAreaRangeDataLabelsOptionsObject","extends":"plotOptions.arearange.dataLabels","since":"2.3.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.columnrange.dataLabels","name":"dataLabels","line":42,"lineEnd":53,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js"},"children":{}},"dragDrop":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"draggableHigh":{"doclet":{"description":"Allow high value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.columnrange.dragDrop.draggableHigh","name":"draggableHigh","line":375,"lineEnd":382,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}},"draggableLow":{"doclet":{"description":"Allow low value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.columnrange.dragDrop.draggableLow","name":"draggableLow","line":351,"lineEnd":358,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}}}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rectangle"},"meta":{"fullname":"plotOptions.columnrange.legendSymbol","name":"legendSymbol","line":55,"lineEnd":55,"column":4,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js","default":"rectangle"},"children":{}},"pointRange":{"doclet":{"type":{"names":["*"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.columnrange.pointRange","name":"pointRange","line":42,"lineEnd":53,"column":4,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js","default":null},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.columnrange.states","name":"states","line":58,"lineEnd":58,"column":4,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js"},"children":{}}}},"contour":{"doclet":{"description":"A contour plot is a graphical representation of three-dimensional data\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `contour` series are defined in\n   [plotOptions.contour](plotOptions.contour).\n3. Options for one single series are given in\n   [the series instance array](series.contour).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        contour: {\n            // shared options for all contour series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'contour'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.contour.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === contour) {\n    // code specific to the contour series\n}\n```\n            ","productdesc":[{"value":"Requires `modules/contour`.","products":["highcharts"]}],"samples":[{"name":"/","value":""}],"extends":"plotOptions.scatter","exclude":["animationLimit","cluster","connectEnds","connectNulls","cropThreshold","dashStyle","dragDrop","getExtremesFromAll","jitter","legendSymbolColor","linecap","pointInterval","pointIntervalUnit","pointRange","pointStart","shadow","softThreshold","stacking","step","threshold"],"products":["highcharts","highmaps"]},"meta":{"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js","name":"contour","fullname":"plotOptions.contour","line":12,"lineEnd":16,"column":0},"children":{"clip":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.contour.clip","name":"clip","line":41,"lineEnd":41,"column":4,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js","default":false},"children":{}},"colorKey":{"doclet":{"description":"This must be set to `'value'` to make the colorAxis track with the contour\nplot.","type":{"names":["string"]},"defaultvalue":"value"},"meta":{"fullname":"plotOptions.contour.colorKey","name":"colorKey","line":36,"lineEnd":39,"column":4,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js","default":"value"},"children":{}},"contourInterval":{"doclet":{"description":"The interval between contour lines. Determines the spacing of value\nlevels where lines are drawn on the plot. By default, the interval is\ncalculated using the value range.","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.contour.contourInterval","name":"contourInterval","line":60,"lineEnd":67,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{}},"contourOffset":{"doclet":{"description":"The offset for contour line positioning. Shifts the contour levels so\nlines and bands are drawn at `contourOffset + n * contourInterval`\ninstead of `n * contourInterval`.\n\nExample: with `contourInterval: 10` and `contourOffset: 5`, levels are\nat 5, 15, 25, etc. Use this to align levels with a reference value\nwithout changing the data. Non-positive values are treated as 0.","type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"plotOptions.contour.contourOffset","name":"contourOffset","line":68,"lineEnd":80,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{}},"lineWidth":{"doclet":{"description":"This setting controls the visibility and size of contour lines. For now,\nonly '1' and '0' are valid options, effectively controlling the\nvisibility of the lines.","type":{"names":["number"]},"defaultvalue":"1"},"meta":{"fullname":"plotOptions.contour.lineWidth","name":"lineWidth","line":51,"lineEnd":59,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{}},"marker":{"doclet":{"exclude":["radius","enabledThreshold","fillColor","lineColor"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.contour.marker","name":"marker","line":42,"lineEnd":50,"column":4,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.contour.marker.states","name":"states","line":106,"lineEnd":106,"column":8,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{"hover":{"doclet":{"exclude":["radius","radiusPlus"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.contour.marker.states.hover","name":"hover","line":107,"lineEnd":109,"column":12,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{"lineColor":{"doclet":{"description":"Color of the marker outline. Defaults to `'black'`.","type":{"names":["string"]},"defaultvalue":"black"},"meta":{"fullname":"plotOptions.contour.marker.states.hover.lineColor","name":"lineColor","line":111,"lineEnd":119,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{}}}}}},"symbol":{"doclet":{"description":"A predefined shape or symbol for the marker. When undefined, the\nsymbol is pulled from options.symbols. Other possible values are\n`'circle'`, `'square'`,`'diamond'`, `'triangle'`,\n`'triangle-down'`, `'rect'`, `'ellipse'`, and `'cross'`.\n\nAdditionally, the URL to a graphic can be given on this form:\n`'url(graphic.png)'`. Note that for the image to be applied to\nexported charts, its URL needs to be accessible by the export\nserver.\n\nCustom callbacks for symbol path generation can also be added to\n`Highcharts.SVGRenderer.prototype.symbols`. The callback is then\nused by its method name, as shown in the demo.","samples":[{"name":"Predefined, graphic and custom markers","value":"highcharts/plotoptions/series-marker-symbol/","products":["highcharts"]},{"name":"Predefined, graphic and custom markers","value":"highcharts/plotoptions/series-marker-symbol/","products":["highstock"]}],"type":{"names":["string"]},"defaultvalue":"cross"},"meta":{"fullname":"plotOptions.contour.marker.symbol","name":"symbol","line":85,"lineEnd":104,"column":8,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js","default":"cross"},"children":{}}}},"smoothColoring":{"doclet":{"description":"Whether to use gradually transitioning color gradients between contour\nlevels. When disabled, each contour level is filled with a single flat\ncolor.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"plotOptions.contour.smoothColoring","name":"smoothColoring","line":42,"lineEnd":50,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.contour.states","name":"states","line":124,"lineEnd":124,"column":4,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{}},"zIndex":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.contour.zIndex","name":"zIndex","line":130,"lineEnd":130,"column":4,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js","default":0},"children":{}}}},"cylinder":{"doclet":{"description":"A cylinder graph is a variation of a 3d column graph. The cylinder graph\nfeatures cylindrical points.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `cylinder` series are defined in\n   [plotOptions.cylinder](plotOptions.cylinder).\n3. Options for one single series are given in\n   [the series instance array](series.cylinder).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        cylinder: {\n            // shared options for all cylinder series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'cylinder'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.cylinder.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === cylinder) {\n    // code specific to the cylinder series\n}\n```\n            ","samples":[{"name":"Cylinder graph","value":"highcharts/demo/cylinder/","products":["highcharts"]}],"extends":"plotOptions.column","since":"7.0.0","products":["highcharts"],"exclude":["allAreas","boostThreshold","colorAxis","compare","compareBase","dragDrop","boostBlending"],"requires":["module:modules/cylinder"]},"meta":{"filename":"code/es-modules/Series/Cylinder/CylinderSeriesDefaults.js","name":"cylinder","fullname":"plotOptions.cylinder","line":15,"lineEnd":19,"column":0},"children":{}},"dema":{"doclet":{"description":"Double exponential moving average (DEMA) indicator. This series requires\n`linkedTo` option to be set and should be loaded after the\n`stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `dema` series are defined in\n   [plotOptions.dema](plotOptions.dema).\n3. Options for one single series are given in\n   [the series instance array](series.dema).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        dema: {\n            // shared options for all dema series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'dema'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.dema.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === dema) {\n    // code specific to the dema series\n}\n```\n            ","samples":[{"name":"DEMA indicator","value":"stock/indicators/dema","products":["highstock"]}],"extends":"plotOptions.ema","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/dema"]},"meta":{"filename":"code/es-modules/Stock/Indicators/DEMA/DEMAIndicator.js","name":"dema","fullname":"plotOptions.dema","line":95,"lineEnd":99,"column":0},"children":{}},"dependencywheel":{"doclet":{"description":"A dependency wheel chart is a type of flow diagram, where all nodes are laid\nout in a circle, and the flow between the are drawn as link bands.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `dependencywheel` series are defined in\n   [plotOptions.dependencywheel](plotOptions.dependencywheel).\n3. Options for one single series are given in\n   [the series instance array](series.dependencywheel).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        dependencywheel: {\n            // shared options for all dependencywheel series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'dependencywheel'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.dependencywheel.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === dependencywheel) {\n    // code specific to the dependencywheel series\n}\n```\n            ","samples":[{"name":"Dependency wheel","value":"highcharts/demo/dependency-wheel/"}],"extends":"plotOptions.sankey","exclude":["dataSorting","nodeAlignment","nodeDistance"],"since":"7.1.0","products":["highcharts"],"requires":["module:modules/dependency-wheel"]},"meta":{"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js","name":"dependencywheel","fullname":"plotOptions.dependencywheel","line":14,"lineEnd":18,"column":0},"children":{"borderRadius":{"doclet":{"description":"The corner radius of the border surrounding each node. A number\nsignifies pixels. A percentage string, like for example `50%`, signifies\na relative size. For nodes this is relative to the node width.","type":{"names":["number","string","Highcharts.BorderRadiusOptionsObject"]},"defaultvalue":"3","products":["highcharts"],"since":"11.0.0"},"meta":{"fullname":"plotOptions.dependencywheel.borderRadius","name":"borderRadius","line":34,"lineEnd":44,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}},"center":{"doclet":{"description":"The center of the wheel relative to the plot area. Can be\npercentages or pixel values. The default behavior is to\ncenter the wheel inside the plot area.","type":{"names":["Array.<(number|string|null)>"]},"defaultvalue":"[null, null]","products":["highcharts"],"since":"7.1.0"},"meta":{"fullname":"plotOptions.dependencywheel.center","name":"center","line":34,"lineEnd":44,"column":4,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}},"curveFactor":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.6},"meta":{"fullname":"plotOptions.dependencywheel.curveFactor","name":"curveFactor","line":98,"lineEnd":98,"column":4,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js","default":0.6},"children":{}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dependencywheel.dataLabels","name":"dataLabels","line":103,"lineEnd":103,"column":4,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{"distance":{"doclet":{"description":"Distance between the data label and the center of the node.","type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"plotOptions.dependencywheel.dataLabels.distance","name":"distance","line":45,"lineEnd":51,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}},"format":{"doclet":{"description":"A format string for data labels of the links between nodes. Available\nvariables are the same as for `formatter`.","see":["[nodeFormat](#nodeFormat) for formatting node labels"]},"meta":{"fullname":"plotOptions.dependencywheel.dataLabels.format","name":"format","line":52,"lineEnd":59,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}},"formatter":{"doclet":{"description":"Callback to format data labels of the links between nodes. The `format`\noption takes precedence over the `formatter` option.","see":["[nodeFormatter](#nodeFormatter) for formatting node labels"]},"meta":{"fullname":"plotOptions.dependencywheel.dataLabels.formatter","name":"formatter","line":60,"lineEnd":67,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}},"nodeFormat":{"doclet":{"description":"The format string specifying what to show for nodes in the sankey\ndiagram. By default the nodeFormatter returns `{point.name}`. Available\nvariables are the same as for `nodeFormatter`."},"meta":{"fullname":"plotOptions.dependencywheel.dataLabels.nodeFormat","name":"nodeFormat","line":68,"lineEnd":74,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}},"nodeFormatter":{"doclet":{"description":"Callback to format data labels of nodes in the dependency wheel. The\n`nodeFormat` option takes precedence over the `nodeFormatter` option."},"meta":{"fullname":"plotOptions.dependencywheel.dataLabels.nodeFormatter","name":"nodeFormatter","line":75,"lineEnd":80,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}},"textPath":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dependencywheel.dataLabels.textPath","name":"textPath","line":104,"lineEnd":104,"column":8,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{"attributes":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dependencywheel.dataLabels.textPath.attributes","name":"attributes","line":115,"lineEnd":115,"column":12,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{"dy":{"doclet":{"description":"Text path shift along its y-axis.","type":{"names":["Highcharts.SVGAttributes"]},"defaultvalue":"5","since":"7.1.0"},"meta":{"fullname":"plotOptions.dependencywheel.dataLabels.textPath.attributes.dy","name":"dy","line":116,"lineEnd":123,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}}}}}}}},"size":{"doclet":{"description":"Size of the wheel in pixel or percent relative to the canvas space.","type":{"names":["number","string"]},"defaultvalue":"100%","since":"7.1.0"},"meta":{"fullname":"plotOptions.dependencywheel.size","name":"size","line":81,"lineEnd":87,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}},"startAngle":{"doclet":{"description":"The start angle of the dependency wheel, in degrees where 0 is up.","since":"7.1.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.dependencywheel.startAngle","name":"startAngle","line":99,"lineEnd":101,"column":4,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js","default":0},"children":{}}}},"disparityindex":{"doclet":{"description":"Disparity Index.\nThis series requires the `linkedTo` option to be set and should\nbe loaded after the `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `disparityindex` series are defined in\n   [plotOptions.disparityindex](plotOptions.disparityindex).\n3. Options for one single series are given in\n   [the series instance array](series.disparityindex).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        disparityindex: {\n            // shared options for all disparityindex series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'disparityindex'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.disparityindex.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === disparityindex) {\n    // code specific to the disparityindex series\n}\n```\n            ","samples":[{"name":"Disparity Index indicator","value":"stock/indicators/disparity-index"}],"extends":"plotOptions.sma","since":"9.1.0","products":["highstock"],"exclude":["allAreas","colorAxis","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/disparity-index"]},"meta":{"filename":"code/es-modules/Stock/Indicators/DisparityIndex/DisparityIndexIndicator.js","name":"disparityindex","fullname":"plotOptions.disparityindex","line":76,"lineEnd":80,"column":0},"children":{"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.disparityindex.dataGrouping","name":"dataGrouping","line":116,"lineEnd":116,"column":4,"filename":"code/es-modules/Stock/Indicators/DisparityIndex/DisparityIndexIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.disparityindex.dataGrouping.approximation","name":"approximation","line":117,"lineEnd":117,"column":8,"filename":"code/es-modules/Stock/Indicators/DisparityIndex/DisparityIndexIndicator.js","default":"averages"},"children":{}}}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.disparityindex.marker","name":"marker","line":113,"lineEnd":113,"column":4,"filename":"code/es-modules/Stock/Indicators/DisparityIndex/DisparityIndexIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.disparityindex.marker.enabled","name":"enabled","line":114,"lineEnd":114,"column":8,"filename":"code/es-modules/Stock/Indicators/DisparityIndex/DisparityIndexIndicator.js","default":false},"children":{}}}},"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.disparityindex.params","name":"params","line":100,"lineEnd":100,"column":4,"filename":"code/es-modules/Stock/Indicators/DisparityIndex/DisparityIndexIndicator.js"},"children":{"average":{"doclet":{"description":"The average used to calculate the Disparity Index indicator.\nBy default it uses SMA, with EMA as an option. To use other\naverages, e.g. TEMA, the `stock/indicators/tema.js` file needs to\nbe loaded.\n\nIf value is different than `ema`, `dema`, `tema` or `wma`,\nthen sma is used.","type":{"names":["string"]},"defaultvalue":"sma"},"meta":{"fullname":"plotOptions.disparityindex.params.average","name":"average","line":101,"lineEnd":109,"column":8,"filename":"code/es-modules/Stock/Indicators/DisparityIndex/DisparityIndexIndicator.js","default":"sma"},"children":{}},"index":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.disparityindex.params.index","name":"index","line":111,"lineEnd":111,"column":8,"filename":"code/es-modules/Stock/Indicators/DisparityIndex/DisparityIndexIndicator.js","default":3},"children":{}}}}}},"dmi":{"doclet":{"description":"Directional Movement Index (DMI).\nThis series requires the `linkedTo` option to be set and should\nbe loaded after the `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `dmi` series are defined in\n   [plotOptions.dmi](plotOptions.dmi).\n3. Options for one single series are given in\n   [the series instance array](series.dmi).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        dmi: {\n            // shared options for all dmi series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'dmi'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.dmi.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === dmi) {\n    // code specific to the dmi series\n}\n```\n            ","samples":[{"name":"DMI indicator","value":"stock/indicators/dmi"}],"extends":"plotOptions.sma","since":"9.1.0","products":["highstock"],"exclude":["allAreas","colorAxis","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/dmi"]},"meta":{"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js","name":"dmi","fullname":"plotOptions.dmi","line":132,"lineEnd":136,"column":0},"children":{"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dmi.dataGrouping","name":"dataGrouping","line":216,"lineEnd":216,"column":4,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.dmi.dataGrouping.approximation","name":"approximation","line":217,"lineEnd":217,"column":8,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js","default":"averages"},"children":{}}}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dmi.marker","name":"marker","line":162,"lineEnd":162,"column":4,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.dmi.marker.enabled","name":"enabled","line":163,"lineEnd":163,"column":8,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js","default":false},"children":{}}}},"minusDILine":{"doclet":{"description":"-DI line options.","since":"9.1.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dmi.minusDILine","name":"minusDILine","line":196,"lineEnd":198,"column":4,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js"},"children":{"styles":{"doclet":{"description":"Styles for the -DI line.","since":"9.1.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dmi.minusDILine.styles","name":"styles","line":200,"lineEnd":202,"column":8,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line.","type":{"names":["Highcharts.ColorString"]},"since":"9.1.0","defaultvalue":"#f21313"},"meta":{"fullname":"plotOptions.dmi.minusDILine.styles.lineColor","name":"lineColor","line":208,"lineEnd":212,"column":12,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js","default":"#f21313"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","since":"9.1.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.dmi.minusDILine.styles.lineWidth","name":"lineWidth","line":204,"lineEnd":206,"column":12,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js","default":1},"children":{}}}}}},"params":{"doclet":{"exclude":["index"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dmi.params","name":"params","line":156,"lineEnd":158,"column":4,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.dmi.params.index","name":"index","line":160,"lineEnd":160,"column":8,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js","default":"undefined"},"children":{}}}},"plusDILine":{"doclet":{"description":"+DI line options.","since":"9.1.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dmi.plusDILine","name":"plusDILine","line":176,"lineEnd":178,"column":4,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js"},"children":{"styles":{"doclet":{"description":"Styles for the +DI line.","since":"9.1.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dmi.plusDILine.styles","name":"styles","line":180,"lineEnd":182,"column":8,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line.","type":{"names":["Highcharts.ColorString"]},"since":"9.1.0","defaultvalue":"#06b535"},"meta":{"fullname":"plotOptions.dmi.plusDILine.styles.lineColor","name":"lineColor","line":188,"lineEnd":192,"column":12,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js","default":"#06b535"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","since":"9.1.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.dmi.plusDILine.styles.lineWidth","name":"lineWidth","line":184,"lineEnd":186,"column":12,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js","default":1},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dmi.tooltip","name":"tooltip","line":165,"lineEnd":165,"column":4,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color: {point.color}\">●</span><b> {series.name}</b><br/><span style=\"color: {point.color}\">DX</span>: {point.y}<br/><span style=\"color: {point.series.options.plusDILine.styles.lineColor}\">+DI</span>: {point.plusDI}<br/><span style=\"color: {point.series.options.minusDILine.styles.lineColor}\">-DI</span>: {point.minusDI}<br/>"},"meta":{"fullname":"plotOptions.dmi.tooltip.pointFormat","name":"pointFormat","line":166,"lineEnd":166,"column":8,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js","default":"<span style=\"color: {point.color}\">●</span><b> {series.name}</b><br/><span style=\"color: {point.color}\">DX</span>: {point.y}<br/><span style=\"color: {point.series.options.plusDILine.styles.lineColor}\">+DI</span>: {point.plusDI}<br/><span style=\"color: {point.series.options.minusDILine.styles.lineColor}\">-DI</span>: {point.minusDI}<br/>"},"children":{}}}}}},"dpo":{"doclet":{"description":"Detrended Price Oscillator. This series requires the `linkedTo` option to\nbe set and should be loaded after the `stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `dpo` series are defined in\n   [plotOptions.dpo](plotOptions.dpo).\n3. Options for one single series are given in\n   [the series instance array](series.dpo).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        dpo: {\n            // shared options for all dpo series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'dpo'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.dpo.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === dpo) {\n    // code specific to the dpo series\n}\n```\n            ","samples":[{"name":"Detrended Price Oscillator","value":"stock/indicators/dpo","products":["highstock"]}],"extends":"plotOptions.sma","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/dpo"]},"meta":{"filename":"code/es-modules/Stock/Indicators/DPO/DPOIndicator.js","name":"dpo","fullname":"plotOptions.dpo","line":82,"lineEnd":86,"column":0},"children":{"params":{"doclet":{"description":"Parameters used in calculation of Detrended Price Oscillator series\npoints.","since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dpo.params","name":"params","line":106,"lineEnd":109,"column":4,"filename":"code/es-modules/Stock/Indicators/DPO/DPOIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.dpo.params.index","name":"index","line":111,"lineEnd":111,"column":8,"filename":"code/es-modules/Stock/Indicators/DPO/DPOIndicator.js","default":0},"children":{}},"period":{"doclet":{"description":"Period for Detrended Price Oscillator","since":"7.0.0","type":{"names":["number"]},"defaultvalue":21},"meta":{"fullname":"plotOptions.dpo.params.period","name":"period","line":112,"lineEnd":114,"column":8,"filename":"code/es-modules/Stock/Indicators/DPO/DPOIndicator.js","default":21},"children":{}}}}}},"dumbbell":{"doclet":{"description":"The dumbbell series is a cartesian series with higher and lower values\nfor each point along an X axis, connected with a line between the\nvalues.\n\nRequires `highcharts-more.js` and `modules/dumbbell.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `dumbbell` series are defined in\n   [plotOptions.dumbbell](plotOptions.dumbbell).\n3. Options for one single series are given in\n   [the series instance array](series.dumbbell).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        dumbbell: {\n            // shared options for all dumbbell series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'dumbbell'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.dumbbell.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === dumbbell) {\n    // code specific to the dumbbell series\n}\n```\n            ","samples":[{"name":"Dumbbell chart","value":"highcharts/demo/dumbbell/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/series-dumbbell/styled-mode-dumbbell/","products":["highcharts"]}],"extends":"plotOptions.arearange","products":["highcharts","highstock"],"exclude":["boostThreshold","fillOpacity","legendSymbolColor","lineWidth","stack","stacking","stickyTracking","trackByArea"],"since":"8.0.0"},"meta":{"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js","name":"dumbbell","fullname":"plotOptions.dumbbell","line":12,"lineEnd":16,"column":0},"children":{"connectorColor":{"doclet":{"description":"Color of the line that connects the dumbbell point's values.\nBy default it is the series' color.","type":{"names":["string"]},"products":["highcharts","highstock"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.dumbbell.connectorColor","name":"connectorColor","line":68,"lineEnd":76,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{}},"connectorWidth":{"doclet":{"description":"Pixel width of the line that connects the dumbbell point's\nvalues.","since":"8.0.0","products":["highcharts","highstock"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.dumbbell.connectorWidth","name":"connectorWidth","line":44,"lineEnd":50,"column":4,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js","default":1},"children":{}},"crisp":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.dumbbell.crisp","name":"crisp","line":55,"lineEnd":55,"column":4,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js","default":false},"children":{}},"groupPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.2},"meta":{"fullname":"plotOptions.dumbbell.groupPadding","name":"groupPadding","line":54,"lineEnd":54,"column":4,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js","default":0.2},"children":{}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rectangle"},"meta":{"fullname":"plotOptions.dumbbell.legendSymbol","name":"legendSymbol","line":57,"lineEnd":57,"column":4,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js","default":"rectangle"},"children":{}},"lowColor":{"doclet":{"description":"Color of the start markers in a dumbbell graph. This option takes\npriority over the series color. To avoid this, set `lowColor` to\n`undefined`.","type":{"names":["Highcharts.ColorType"]},"since":"8.0.0","products":["highcharts","highstock"],"defaultvalue":"#333333"},"meta":{"fullname":"plotOptions.dumbbell.lowColor","name":"lowColor","line":58,"lineEnd":66,"column":4,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js","default":"#333333"},"children":{}},"lowMarker":{"doclet":{"description":"Options for the lower markers of the dumbbell-like series. When `lowMarker`\nis not defined, options inherit form the marker.","see":["[marker](#series.arearange.marker)"],"declare":"Highcharts.PointMarkerOptionsObject","extends":"plotOptions.series.marker","defaultvalue":"undefined","products":["highcharts","highstock"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.dumbbell.lowMarker","name":"lowMarker","line":175,"lineEnd":186,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{"symbol":{"doclet":{"samples":[{"name":"Dumbbell chart with lowMarker option","value":"highcharts/demo/dumbbell-markers","products":["highcharts"]}],"declare":"Highcharts.PointMarkerOptionsObject","extends":"plotOptions.series.marker.symbol","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.dumbbell.lowMarker.symbol","name":"symbol","line":187,"lineEnd":196,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{}}}},"pointPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.dumbbell.pointPadding","name":"pointPadding","line":56,"lineEnd":56,"column":4,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js","default":0.1},"children":{}},"pointRange":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.dumbbell.pointRange","name":"pointRange","line":43,"lineEnd":43,"column":4,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js","default":1},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dumbbell.states","name":"states","line":68,"lineEnd":76,"column":4,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.dumbbell.states.hover","name":"hover","line":82,"lineEnd":82,"column":8,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{"connectorWidthPlus":{"doclet":{"description":"The additional connector line width for a hovered point.","since":"8.0.0","products":["highcharts","highstock"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.dumbbell.states.hover.connectorWidthPlus","name":"connectorWidthPlus","line":85,"lineEnd":90,"column":12,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js","default":1},"children":{}}}}}}}},"ema":{"doclet":{"description":"Exponential moving average indicator (EMA). This series requires the\n`linkedTo` option to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ema` series are defined in\n   [plotOptions.ema](plotOptions.ema).\n3. Options for one single series are given in\n   [the series instance array](series.ema).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ema: {\n            // shared options for all ema series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ema'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ema.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ema) {\n    // code specific to the ema series\n}\n```\n            ","samples":[{"name":"Exponential moving average indicator","value":"stock/indicators/ema"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators"]},"meta":{"filename":"code/es-modules/Stock/Indicators/EMA/EMAIndicator.js","name":"ema","fullname":"plotOptions.ema","line":79,"lineEnd":83,"column":0},"children":{"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ema.params","name":"params","line":98,"lineEnd":98,"column":4,"filename":"code/es-modules/Stock/Indicators/EMA/EMAIndicator.js"},"children":{"index":{"doclet":{"description":"The point index which indicator calculations will base. For\nexample using OHLC data, index=2 means the indicator will be\ncalculated using Low values.\n\nBy default index value used to be set to 0. Since\nHighcharts Stock 7 by default index is set to 3\nwhich means that the ema indicator will be\ncalculated using Close values.","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.ema.params.index","name":"index","line":99,"lineEnd":108,"column":8,"filename":"code/es-modules/Stock/Indicators/EMA/EMAIndicator.js","default":3},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":9},"meta":{"fullname":"plotOptions.ema.params.period","name":"period","line":110,"lineEnd":110,"column":8,"filename":"code/es-modules/Stock/Indicators/EMA/EMAIndicator.js","default":9},"children":{}}}}}},"errorbar":{"doclet":{"description":"Error bars are a graphical representation of the variability of data and\nare used on graphs to indicate the error, or uncertainty in a reported\nmeasurement.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `errorbar` series are defined in\n   [plotOptions.errorbar](plotOptions.errorbar).\n3. Options for one single series are given in\n   [the series instance array](series.errorbar).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        errorbar: {\n            // shared options for all errorbar series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'errorbar'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.errorbar.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === errorbar) {\n    // code specific to the errorbar series\n}\n```\n            ","samples":[{"name":"Error bars on a column series","value":"highcharts/demo/error-bar/"},{"name":"Error bars on a scatter series","value":"highcharts/series-errorbar/on-scatter/"},{"name":"Error bars with data labels","value":"highcharts/series-errorbar/datalabels/"}],"extends":"plotOptions.boxplot","exclude":["boostBlending","boostThreshold"],"products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js","name":"errorbar","fullname":"plotOptions.errorbar","line":12,"lineEnd":16,"column":0},"children":{"color":{"doclet":{"description":"The main color of the bars. This can be overridden by\n[stemColor](#plotOptions.errorbar.stemColor) and\n[whiskerColor](#plotOptions.errorbar.whiskerColor) individually.","samples":[{"name":"Error bar styling","value":"highcharts/plotoptions/error-bar-styling/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#000000","since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.errorbar.color","name":"color","line":36,"lineEnd":48,"column":4,"filename":"code/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js","default":"#000000"},"children":{}},"dragDrop":{"doclet":{"exclude":["draggableQ1","draggableQ3"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js","name":"dragDrop","fullname":"plotOptions.errorbar.dragDrop","line":216,"lineEnd":219,"column":0},"children":{}},"grouping":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.errorbar.grouping","name":"grouping","line":50,"lineEnd":50,"column":4,"filename":"code/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js","default":false},"children":{}},"linkedTo":{"doclet":{"description":"The parent series of the error bar. The default value links it to\nthe previous series. Otherwise, use the id of the parent series.","since":"3.0.0","products":["highcharts"],"type":{"names":["string"]},"defaultvalue":":previous"},"meta":{"fullname":"plotOptions.errorbar.linkedTo","name":"linkedTo","line":51,"lineEnd":57,"column":4,"filename":"code/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js","default":":previous"},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.errorbar.tooltip","name":"tooltip","line":59,"lineEnd":59,"column":4,"filename":"code/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> {series.name}: <b>{point.low}</b> - <b>{point.high}</b><br/>"},"meta":{"fullname":"plotOptions.errorbar.tooltip.pointFormat","name":"pointFormat","line":60,"lineEnd":60,"column":8,"filename":"code/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> {series.name}: <b>{point.low}</b> - <b>{point.high}</b><br/>"},"children":{}}}},"whiskerWidth":{"doclet":{"description":"The line width of the whiskers, the horizontal lines marking\nlow and high values. When `null`, the general\n[lineWidth](#plotOptions.errorbar.lineWidth) applies.","samples":[{"name":"Error bar styling","value":"highcharts/plotoptions/error-bar-styling/","products":["highcharts"]}],"type":{"names":["number"]},"since":"3.0.0","products":["highcharts"],"defaultvalue":null},"meta":{"fullname":"plotOptions.errorbar.whiskerWidth","name":"whiskerWidth","line":62,"lineEnd":73,"column":4,"filename":"code/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js","default":null},"children":{}}}},"flags":{"doclet":{"description":"Flags are used to mark events in stock charts. They can be added on the\ntimeline, or attached to a specific series.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `flags` series are defined in\n   [plotOptions.flags](plotOptions.flags).\n3. Options for one single series are given in\n   [the series instance array](series.flags).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        flags: {\n            // shared options for all flags series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'flags'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.flags.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === flags) {\n    // code specific to the flags series\n}\n```\n            ","samples":[{"name":"Flags on a line series","value":"stock/demo/flags-general/"}],"extends":"plotOptions.column","exclude":["animation","borderColor","borderWidth","colorByPoint","cropThreshold","dataGrouping","pointPadding","pointWidth","turboThreshold"],"products":["highstock"]},"meta":{"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","name":"flags","fullname":"plotOptions.flags","line":12,"lineEnd":16,"column":0},"children":{"allowOverlapX":{"doclet":{"description":"Whether the flags are allowed to overlap sideways. If `false`, the\nflags are moved sideways using an algorithm that seeks to place every\nflag as close as possible to its original position.","samples":[{"name":"Allow sideways overlap","value":"stock/plotoptions/flags-allowoverlapx","products":["highstock"]}],"since":"6.0.4","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.flags.allowOverlapX","name":"allowOverlapX","line":65,"lineEnd":65,"column":19,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":false},"children":{}},"borderRadius":{"doclet":{"description":"The corner radius of the border surrounding each flag. For `squarepin`\nshaped flags only. A number signifies pixels. A percentage string, like\nfor example 50%, signifies a relative size.","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.flags.borderRadius","name":"borderRadius","line":32,"lineEnd":36,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":0},"children":{}},"fillColor":{"doclet":{"description":"The fill color for the flags.","type":{"names":["Highcharts.ColorType"]},"products":["highstock"],"defaultvalue":"#ffffff"},"meta":{"fullname":"plotOptions.flags.fillColor","name":"fillColor","line":141,"lineEnd":152,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":"#ffffff"},"children":{}},"height":{"doclet":{"description":"Fixed height of the flag's shape. By default, height is\nautocalculated according to the flag's title.","type":{"names":["number"]},"products":["highstock"]},"meta":{"fullname":"plotOptions.flags.height","name":"height","line":164,"lineEnd":171,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}},"lineColor":{"doclet":{"description":"The color of the line/border of the flag.\n\nIn styled mode, the stroke is set in the\n`.highcharts-flag-series.highcharts-point` rule.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#000000","products":["highstock"]},"meta":{"fullname":"plotOptions.flags.lineColor","name":"lineColor","line":179,"lineEnd":189,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}},"lineWidth":{"doclet":{"description":"The pixel width of the flag's line/border.","products":["highstock"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.flags.lineWidth","name":"lineWidth","line":179,"lineEnd":189,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":1},"children":{}},"onKey":{"doclet":{"description":"In case the flag is placed on a series, on what point key to place\nit. Line and columns have one key, `y`. In range or OHLC-type series,\nhowever, the flag can optionally be placed on the `open`, `high`,\n`low` or `close` key.","samples":[{"name":"Range series, flag on high","value":"stock/plotoptions/flags-onkey/","products":["highstock"]}],"type":{"names":["\"y\"","\"open\"","\"high\"","\"low\"","\"close\""]},"defaultvalue":"y","since":"4.2.2","products":["highstock"]},"meta":{"fullname":"plotOptions.flags.onKey","name":"onKey","line":38,"lineEnd":53,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}},"onSeries":{"doclet":{"description":"The id of the series that the flags should be drawn on. If no id\nis given, the flags are drawn on the x axis.","samples":[{"name":"Flags on series and on x axis","value":"stock/plotoptions/flags/","products":["highstock"]}],"type":{"names":["string"]},"products":["highstock"]},"meta":{"fullname":"plotOptions.flags.onSeries","name":"onSeries","line":54,"lineEnd":64,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}},"shape":{"doclet":{"description":"The shape of the marker. Can be one of \"flag\", \"circlepin\",\n\"squarepin\", or an image of the format `url(/path-to-image.jpg)`.\nIndividual shapes can also be set for each point.","samples":[{"name":"Different shapes","value":"stock/plotoptions/flags/","products":["highstock"]}],"type":{"names":["Highcharts.FlagsShapeValue"]},"products":["highstock"],"defaultvalue":"flag"},"meta":{"fullname":"plotOptions.flags.shape","name":"shape","line":77,"lineEnd":87,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":"flag"},"children":{}},"stackDistance":{"doclet":{"description":"When multiple flags in the same series fall on the same value, this\nnumber determines the vertical offset between them.","samples":[{"name":"A greater stack distance","value":"stock/plotoptions/flags-stackdistance/","products":["highstock"]}],"products":["highstock"],"type":{"names":["number"]},"defaultvalue":12},"meta":{"fullname":"plotOptions.flags.stackDistance","name":"stackDistance","line":89,"lineEnd":97,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":12},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.flags.states","name":"states","line":196,"lineEnd":196,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{"hover":{"doclet":{"extends":"plotOptions.column.states.hover","products":["highstock"]},"meta":{"fullname":"plotOptions.flags.states.hover","name":"hover","line":197,"lineEnd":200,"column":8,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{"fillColor":{"doclet":{"description":"The fill or background color of the flag.","type":{"names":["Highcharts.ColorType"]},"products":["highstock"],"defaultvalue":"#ccd3ff"},"meta":{"fullname":"plotOptions.flags.states.hover.fillColor","name":"fillColor","line":209,"lineEnd":214,"column":12,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":"#ccd3ff"},"children":{}},"lineColor":{"doclet":{"description":"The color of the line/border of the flag.","type":{"names":["Highcharts.ColorType"]},"products":["highstock"],"defaultvalue":"#000000"},"meta":{"fullname":"plotOptions.flags.states.hover.lineColor","name":"lineColor","line":202,"lineEnd":207,"column":12,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":"#000000"},"children":{}}}}}},"style":{"doclet":{"description":"The text styles of the flag.\n\nIn styled mode, the styles are set in the\n`.highcharts-flag-series .highcharts-point` rule.","type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"fontSize\": \"11px\", \"fontWeight\": \"bold\"}","products":["highstock"]},"meta":{"fullname":"plotOptions.flags.style","name":"style","line":218,"lineEnd":227,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}},"textAlign":{"doclet":{"description":"Text alignment for the text inside the flag.","since":"5.0.0","products":["highstock"],"values":"[\"left\", \"center\", \"right\"]","type":{"names":["string"]},"defaultvalue":"center"},"meta":{"fullname":"plotOptions.flags.textAlign","name":"textAlign","line":99,"lineEnd":105,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":"center"},"children":{}},"threshold":{"doclet":{"type":{"names":["number","null"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.flags.threshold","name":"threshold","line":120,"lineEnd":122,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":null},"children":{}},"title":{"doclet":{"description":"The text to display on each flag. This can be defined on series\nlevel, or individually for each point. Defaults to `\"A\"`.","type":{"names":["string"]},"defaultvalue":"A","products":["highstock"]},"meta":{"fullname":"plotOptions.flags.title","name":"title","line":124,"lineEnd":132,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}},"tooltip":{"doclet":{"description":"Specific tooltip options for flag series. Flag series tooltips are\ndifferent from most other types in that a flag doesn't have a data\nvalue, so the tooltip rather displays the `text` option for each\npoint.","extends":"plotOptions.series.tooltip","exclude":["changeDecimals","valueDecimals","valuePrefix","valueSuffix"],"products":["highstock"]},"meta":{"fullname":"plotOptions.flags.tooltip","name":"tooltip","line":107,"lineEnd":116,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{point.text}"},"meta":{"fullname":"plotOptions.flags.tooltip.pointFormat","name":"pointFormat","line":118,"lineEnd":118,"column":8,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":"{point.text}"},"children":{}}}},"useHTML":{"doclet":{"description":"Whether to use HTML to render the flag texts. Using HTML allows for\nadvanced formatting, images and reliable bi-directional text\nrendering. Note that exported images won't respect the HTML, and that\nHTML won't respect Z-index settings.","type":{"names":["boolean"]},"defaultvalue":"false","since":"1.3.0","products":["highstock"]},"meta":{"fullname":"plotOptions.flags.useHTML","name":"useHTML","line":141,"lineEnd":152,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}},"width":{"doclet":{"description":"Fixed width of the flag's shape. By default, width is autocalculated\naccording to the flag's title.","samples":[{"name":"Flags with fixed width","value":"stock/demo/flags-shapes/","products":["highstock"]}],"type":{"names":["number"]},"products":["highstock"]},"meta":{"fullname":"plotOptions.flags.width","name":"width","line":153,"lineEnd":163,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}},"y":{"doclet":{"description":"The y position of the top left corner of the flag relative to either\nthe series (if onSeries is defined), or the x axis. Defaults to\n`-30`.","products":["highstock"],"type":{"names":["number"]},"defaultvalue":-30},"meta":{"fullname":"plotOptions.flags.y","name":"y","line":124,"lineEnd":132,"column":4,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js","default":-30},"children":{}}}},"flowmap":{"doclet":{"description":"A flowmap series is a series laid out on top of a map series allowing to\ndisplay route paths (e.g. flight or ship routes) or flows on a map. It\ncreates a link between two points on a map chart.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `flowmap` series are defined in\n   [plotOptions.flowmap](plotOptions.flowmap).\n3. Options for one single series are given in\n   [the series instance array](series.flowmap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        flowmap: {\n            // shared options for all flowmap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'flowmap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.flowmap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === flowmap) {\n    // code specific to the flowmap series\n}\n```\n            ","since":"11.0.0","extends":"plotOptions.mapline","exclude":["affectsMapView","allAreas","allowPointSelect","boostBlending","boostThreshold","borderColor","borderWidth","dashStyle","dataLabels","dragDrop","joinBy","mapData","negativeColor","onPoint","shadow","showCheckbox"],"products":["highmaps"],"requires":["module:modules/flowmap"]},"meta":{"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","name":"flowmap","fullname":"plotOptions.flowmap","line":400,"lineEnd":404,"column":0},"children":{"animation":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.flowmap.animation","name":"animation","line":420,"lineEnd":420,"column":4,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","default":true},"children":{}},"curveFactor":{"doclet":{"description":"The `curveFactor` option for all links. Value higher than 0 will\ncurve the link clockwise. A negative value will curve it counter\nclockwise. If the value is 0 the link will be a straight line. By\ndefault undefined curveFactor get an automatic curve.","samples":[{"name":"Setting different values for curveFactor","value":"maps/series-flowmap/curve-factor","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"undefined","since":"11.0.0"},"meta":{"fullname":"plotOptions.flowmap.curveFactor","name":"curveFactor","line":421,"lineEnd":433,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"fillColor":{"doclet":{"description":"The fill color of all the links. If not set, the series color will be\nused with the opacity set in\n[fillOpacity](#plotOptions.flowmap.fillOpacity).","type":{"names":["Highcharts.ColorType"]},"since":"11.0.0"},"meta":{"fullname":"plotOptions.flowmap.fillColor","name":"fillColor","line":437,"lineEnd":444,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"fillOpacity":{"doclet":{"description":"The opacity of the color fill for all links.","type":{"names":["number"]},"samples":[{"name":"Setting different values for fillOpacity","value":"maps/series-flowmap/fill-opacity","products":["highmaps"]}],"since":"11.0.0","defaultvalue":0.5},"meta":{"fullname":"plotOptions.flowmap.fillOpacity","name":"fillOpacity","line":437,"lineEnd":444,"column":4,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","default":0.5},"children":{}},"lineWidth":{"doclet":{"description":"Specify the `lineWidth` of the links if they are not specified.","type":{"names":["number"]},"since":"11.0.0","defaultvalue":null},"meta":{"fullname":"plotOptions.flowmap.lineWidth","name":"lineWidth","line":524,"lineEnd":528,"column":4,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","default":"undefined"},"children":{}},"linkedTo":{"doclet":{"description":"The [id](#series.id) of another series to link to. Additionally, the\nvalue can be \":previous\" to link to the previous series. When two\nseries are linked, only the first one appears in the legend. Toggling\nthe visibility of this also toggles the linked series, which is\nnecessary for operations such as zoom or updates on the flowmap\nseries.","type":{"names":["string"]},"since":"11.0.0"},"meta":{"fullname":"plotOptions.flowmap.linkedTo","name":"linkedTo","line":453,"lineEnd":463,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"markerEnd":{"doclet":{"description":"A `markerEnd` creates an arrow symbol indicating the direction of\nflow at the destination. Specifying a `markerEnd` here will create\none for each link.","declare":"Highcharts.SeriesFlowMapSeriesOptionsObject","since":"11.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.flowmap.markerEnd","name":"markerEnd","line":453,"lineEnd":463,"column":4,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{"enabled":{"doclet":{"description":"Enable or disable the `markerEnd`.","type":{"names":["boolean"]},"samples":[{"name":"Setting different markerType for markerEnd","value":"maps/series-flowmap/marker-end","products":["highmaps"]}],"since":"11.0.0","defaultvalue":true},"meta":{"fullname":"plotOptions.flowmap.markerEnd.enabled","name":"enabled","line":472,"lineEnd":478,"column":8,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","default":true},"children":{}},"height":{"doclet":{"description":"Height of the `markerEnd`. Can be a number in pixels or a\npercentage based on the weight of the link.","type":{"names":["number","string"]},"since":"11.0.0","defaultvalue":"40%"},"meta":{"fullname":"plotOptions.flowmap.markerEnd.height","name":"height","line":480,"lineEnd":485,"column":8,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","default":"40%"},"children":{}},"markerType":{"doclet":{"description":"Change the shape of the `markerEnd`.\nCan be `arrow` or `mushroom`.","type":{"names":["string"]},"since":"11.0.0","defaultvalue":"arrow"},"meta":{"fullname":"plotOptions.flowmap.markerEnd.markerType","name":"markerType","line":494,"lineEnd":499,"column":8,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","default":"arrow"},"children":{}},"width":{"doclet":{"description":"Width of the `markerEnd`. Can be a number in pixels or a\npercentage based on the weight of the link.","type":{"names":["number","string"]},"since":"11.0.0","defaultvalue":"40%"},"meta":{"fullname":"plotOptions.flowmap.markerEnd.width","name":"width","line":487,"lineEnd":492,"column":8,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","default":"40%"},"children":{}}}},"maxWidth":{"doclet":{"description":"Maximum width of a link expressed in pixels. The weight of a link is\nmapped between `maxWidth` and `minWidth`.","type":{"names":["number"]},"since":"11.0.0","defaultvalue":25},"meta":{"fullname":"plotOptions.flowmap.maxWidth","name":"maxWidth","line":510,"lineEnd":515,"column":4,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","default":25},"children":{}},"minWidth":{"doclet":{"description":"Minimum width of a link expressed in pixels. The weight of a link is\nmapped between `maxWidth` and `minWidth`.","type":{"names":["number"]},"since":"11.0.0","defaultvalue":5},"meta":{"fullname":"plotOptions.flowmap.minWidth","name":"minWidth","line":517,"lineEnd":522,"column":4,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","default":5},"children":{}},"opacity":{"doclet":{"description":"The opacity of all the links. Affects the opacity for the entire\nlink, including stroke. See also\n[fillOpacity](#plotOptions.flowmap.fillOpacity), that affects the\nopacity of only the fill color.","since":"11.0.0"},"meta":{"fullname":"plotOptions.flowmap.opacity","name":"opacity","line":530,"lineEnd":537,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"weight":{"doclet":{"description":"The weight for all links with unspecified weights. The weight of a\nlink determines its thickness compared to other links.","samples":[{"name":"Example ship route","value":"maps/series-flowmap/ship-route/","products":["highmaps"]}],"type":{"names":["number"]},"products":["highmaps"],"since":"11.0.0"},"meta":{"fullname":"plotOptions.flowmap.weight","name":"weight","line":538,"lineEnd":547,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"width":{"doclet":{"description":"If no weight has previously been specified, this will set the width\nof all the links without being compared to and scaled according to\nother weights.","type":{"names":["number"]},"since":"11.0.0","defaultvalue":1},"meta":{"fullname":"plotOptions.flowmap.width","name":"width","line":502,"lineEnd":508,"column":4,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js","default":1},"children":{}}}},"funnel":{"doclet":{"description":"Funnel charts are a type of chart often used to visualize stages in a\nsales project, where the top are the initial stages with the most\nclients. It requires that the modules/funnel.js file is loaded.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `funnel` series are defined in\n   [plotOptions.funnel](plotOptions.funnel).\n3. Options for one single series are given in\n   [the series instance array](series.funnel).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        funnel: {\n            // shared options for all funnel series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'funnel'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.funnel.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === funnel) {\n    // code specific to the funnel series\n}\n```\n            ","samples":[{"name":"Funnel demo","value":"highcharts/demo/funnel/"}],"extends":"plotOptions.pie","exclude":["innerSize","size","dataSorting"],"products":["highcharts"],"requires":["module:modules/funnel"]},"meta":{"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","name":"funnel","fullname":"plotOptions.funnel","line":14,"lineEnd":18,"column":0},"children":{"animation":{"doclet":{"description":"Initial animation is by default disabled for the funnel chart.","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.funnel.animation","name":"animation","line":34,"lineEnd":36,"column":4,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":false},"children":{}},"borderRadius":{"doclet":{"description":"The corner radius of the border surrounding all points or series. A\nnumber signifies pixels. A percentage string, like for example `50%`,\nsignifies a size relative to the series width.","samples":[{"name":"Funnel and pyramid with rounded border","value":"highcharts/plotoptions/funnel-border-radius"}],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.funnel.borderRadius","name":"borderRadius","line":38,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":0},"children":{}},"center":{"doclet":{"description":"The center of the series. By default, it is centered in the middle\nof the plot area, so it fills the plot area height.","type":{"names":["Array.<(number|string)>"]},"defaultvalue":"[\"50%\", \"50%\"]","since":"3.0.0"},"meta":{"fullname":"plotOptions.funnel.center","name":"center","line":47,"lineEnd":54,"column":4,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js"},"children":{}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.funnel.dataLabels","name":"dataLabels","line":108,"lineEnd":108,"column":4,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js"},"children":{"connectorWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.funnel.dataLabels.connectorWidth","name":"connectorWidth","line":109,"lineEnd":109,"column":8,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":1},"children":{}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"middle"},"meta":{"fullname":"plotOptions.funnel.dataLabels.verticalAlign","name":"verticalAlign","line":110,"lineEnd":110,"column":8,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":"middle"},"children":{}}}},"height":{"doclet":{"description":"The height of the funnel or pyramid. If it is a number it defines\nthe pixel height, if it is a percentage string it is the percentage\nof the plot area height.","samples":[{"name":"Funnel demo","value":"highcharts/demo/funnel/","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"3.0.0","defaultvalue":"100%"},"meta":{"fullname":"plotOptions.funnel.height","name":"height","line":76,"lineEnd":86,"column":4,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":"100%"},"children":{}},"neckHeight":{"doclet":{"description":"The height of the neck, the lower part of the funnel. A number\ndefines pixel width, a percentage string defines a percentage of the\nplot area height.","type":{"names":["number","string"]},"defaultvalue":"25%"},"meta":{"fullname":"plotOptions.funnel.neckHeight","name":"neckHeight","line":88,"lineEnd":94,"column":4,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":"25%"},"children":{}},"neckWidth":{"doclet":{"description":"The width of the neck, the lower part of the funnel. A number defines\npixel width, a percentage string defines a percentage of the plot\narea width.","samples":[{"name":"Funnel demo","value":"highcharts/demo/funnel/","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"3.0.0","defaultvalue":"30%"},"meta":{"fullname":"plotOptions.funnel.neckWidth","name":"neckWidth","line":64,"lineEnd":74,"column":4,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":"30%"},"children":{}},"reversed":{"doclet":{"description":"A reversed funnel has the widest area down. A reversed funnel with\nno neck width and neck height is a pyramid.","since":"3.0.10","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.funnel.reversed","name":"reversed","line":96,"lineEnd":101,"column":4,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":false},"children":{}},"states":{"doclet":{"description":"Options for the series states.","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.funnel.states","name":"states","line":112,"lineEnd":114,"column":4,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js"},"children":{"hover":{"doclet":{"exclude":["halo","marker","lineWidth","lineWidthPlus"]},"meta":{"fullname":"plotOptions.funnel.states.hover","name":"hover","line":116,"lineEnd":119,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js"},"children":{}},"select":{"doclet":{"description":"Options for a selected funnel item.","exclude":["halo","marker","lineWidth","lineWidthPlus"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.funnel.states.select","name":"select","line":116,"lineEnd":119,"column":8,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js"},"children":{"borderColor":{"doclet":{"description":"A specific border color for the selected point.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"#000000"},"meta":{"fullname":"plotOptions.funnel.states.select.borderColor","name":"borderColor","line":132,"lineEnd":136,"column":12,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":"#000000"},"children":{}},"color":{"doclet":{"description":"A specific color for the selected point.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"plotOptions.funnel.states.select.color","name":"color","line":126,"lineEnd":130,"column":12,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":"#cccccc"},"children":{}}}}}},"width":{"doclet":{"description":"The width of the funnel compared to the width of the plot area,\nor the pixel width if it is a number.","type":{"names":["number","string"]},"since":"3.0.0","defaultvalue":"90%"},"meta":{"fullname":"plotOptions.funnel.width","name":"width","line":56,"lineEnd":62,"column":4,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js","default":"90%"},"children":{}}}},"funnel3d":{"doclet":{"description":"A funnel3d is a 3d version of funnel series type. Funnel charts are\na type of chart often used to visualize stages in a sales project,\nwhere the top are the initial stages with the most clients.\n\nIt requires that the `highcharts-3d.js`, `cylinder.js` and\n`funnel3d.js` module are loaded.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `funnel3d` series are defined in\n   [plotOptions.funnel3d](plotOptions.funnel3d).\n3. Options for one single series are given in\n   [the series instance array](series.funnel3d).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        funnel3d: {\n            // shared options for all funnel3d series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'funnel3d'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.funnel3d.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === funnel3d) {\n    // code specific to the funnel3d series\n}\n```\n            ","samples":[{"name":"Funnel3d","value":"highcharts/demo/funnel3d/"}],"extends":"plotOptions.column","exclude":["allAreas","boostThreshold","colorAxis","compare","compareBase","dataSorting","boostBlending"],"products":["highcharts"],"since":"7.1.0","requires":["module:highcharts-3d","module:modules/cylinder","module:modules/funnel3d"]},"meta":{"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","name":"funnel3d","fullname":"plotOptions.funnel3d","line":11,"lineEnd":31,"column":0},"children":{"animation":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.funnel3d.animation","name":"animation","line":88,"lineEnd":88,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":false},"children":{}},"colorByPoint":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.funnel3d.colorByPoint","name":"colorByPoint","line":90,"lineEnd":90,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":true},"children":{}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.funnel3d.dataLabels","name":"dataLabels","line":92,"lineEnd":92,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js"},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"right"},"meta":{"fullname":"plotOptions.funnel3d.dataLabels.align","name":"align","line":93,"lineEnd":93,"column":8,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":"right"},"children":{}},"crop":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.funnel3d.dataLabels.crop","name":"crop","line":94,"lineEnd":94,"column":8,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":false},"children":{}},"inside":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.funnel3d.dataLabels.inside","name":"inside","line":95,"lineEnd":95,"column":8,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":false},"children":{}},"overflow":{"doclet":{"type":{"names":["string"]},"defaultvalue":"allow"},"meta":{"fullname":"plotOptions.funnel3d.dataLabels.overflow","name":"overflow","line":96,"lineEnd":96,"column":8,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":"allow"},"children":{}}}},"edgeWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.funnel3d.edgeWidth","name":"edgeWidth","line":89,"lineEnd":89,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":0},"children":{}},"gradientForSides":{"doclet":{"description":"By default sides fill is set to a gradient through this option being\nset to `true`. Set to `false` to get solid color for the sides.","products":["highcharts"],"since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.funnel3d.gradientForSides","name":"gradientForSides","line":81,"lineEnd":86,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":true},"children":{}},"height":{"doclet":{"description":"The height of the series. If it is a number it defines\nthe pixel height, if it is a percentage string it is the percentage\nof the plot area height.","type":{"names":["number","string"]},"samples":[{"name":"Funnel3d demo","value":"highcharts/demo/funnel3d/","products":["highcharts"]}],"products":["highcharts"],"since":"7.1.0","defaultvalue":"100%"},"meta":{"fullname":"plotOptions.funnel3d.height","name":"height","line":54,"lineEnd":62,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":"100%"},"children":{}},"neckHeight":{"doclet":{"description":"The height of the neck, the lower part of the funnel. A number\ndefines pixel width, a percentage string defines a percentage\nof the plot area height.","type":{"names":["number","string"]},"samples":[{"name":"Funnel3d demo","value":"highcharts/demo/funnel3d/","products":["highcharts"]}],"products":["highcharts"],"since":"7.1.0","defaultvalue":"25%"},"meta":{"fullname":"plotOptions.funnel3d.neckHeight","name":"neckHeight","line":64,"lineEnd":72,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":"25%"},"children":{}},"neckWidth":{"doclet":{"description":"The width of the neck, the lower part of the funnel. A number defines\npixel width, a percentage string defines a percentage of the plot\narea width.","type":{"names":["number","string"]},"samples":[{"name":"Funnel3d demo","value":"highcharts/demo/funnel3d/","products":["highcharts"]}],"products":["highcharts"],"since":"7.1.0","defaultvalue":"30%"},"meta":{"fullname":"plotOptions.funnel3d.neckWidth","name":"neckWidth","line":44,"lineEnd":52,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":"30%"},"children":{}},"reversed":{"doclet":{"description":"A reversed funnel has the widest area down. A reversed funnel with\nno neck width and neck height is a pyramid.","products":["highcharts"],"since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.funnel3d.reversed","name":"reversed","line":74,"lineEnd":79,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":false},"children":{}},"showInLegend":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.funnel3d.showInLegend","name":"showInLegend","line":91,"lineEnd":91,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":false},"children":{}},"width":{"doclet":{"description":"The max width of the series compared to the width of the plot area,\nor the pixel width if it is a number.","type":{"names":["number","string"]},"samples":[{"name":"Funnel3d demo","value":"highcharts/demo/funnel3d/","products":["highcharts"]}],"products":["highcharts"],"since":"7.1.0","defaultvalue":"90%"},"meta":{"fullname":"plotOptions.funnel3d.width","name":"width","line":35,"lineEnd":42,"column":4,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js","default":"90%"},"children":{}}}},"gantt":{"doclet":{"description":"A `gantt` series. If the [type](#series.gantt.type) option is not specified,\nit is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `gantt` series are defined in\n   [plotOptions.gantt](plotOptions.gantt).\n3. Options for one single series are given in\n   [the series instance array](series.gantt).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        gantt: {\n            // shared options for all gantt series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'gantt'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.gantt.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === gantt) {\n    // code specific to the gantt series\n}\n```\n            ","extends":"plotOptions.xrange","products":["gantt"],"requires":["module:highcharts-gantt"]},"meta":{"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","name":"gantt","fullname":"plotOptions.gantt","line":14,"lineEnd":18,"column":0},"children":{"connectors":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.gantt.connectors","name":"connectors","line":69,"lineEnd":69,"column":4,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{"animation":{"doclet":{"declare":"Highcharts.ConnectorsAnimationOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.gantt.connectors.animation","name":"animation","line":71,"lineEnd":73,"column":8,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{"reversed":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.gantt.connectors.animation.reversed","name":"reversed","line":75,"lineEnd":75,"column":12,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":true},"children":{}}}},"endMarker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.gantt.connectors.endMarker","name":"endMarker","line":84,"lineEnd":84,"column":8,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"right"},"meta":{"fullname":"plotOptions.gantt.connectors.endMarker.align","name":"align","line":85,"lineEnd":85,"column":28,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":"right"},"children":{}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.gantt.connectors.endMarker.enabled","name":"enabled","line":85,"lineEnd":85,"column":12,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":false},"children":{}}}},"radius":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.gantt.connectors.radius","name":"radius","line":77,"lineEnd":77,"column":8,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":0},"children":{}},"startMarker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.gantt.connectors.startMarker","name":"startMarker","line":78,"lineEnd":78,"column":8,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"left"},"meta":{"fullname":"plotOptions.gantt.connectors.startMarker.align","name":"align","line":82,"lineEnd":82,"column":12,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":"left"},"children":{}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.gantt.connectors.startMarker.enabled","name":"enabled","line":79,"lineEnd":79,"column":12,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":true},"children":{}},"radius":{"doclet":{"type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"plotOptions.gantt.connectors.startMarker.radius","name":"radius","line":81,"lineEnd":81,"column":12,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":4},"children":{}},"symbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"arrow-filled"},"meta":{"fullname":"plotOptions.gantt.connectors.startMarker.symbol","name":"symbol","line":80,"lineEnd":80,"column":12,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":"arrow-filled"},"children":{}}}},"type":{"doclet":{"type":{"names":["string"]},"defaultvalue":"simpleConnect"},"meta":{"fullname":"plotOptions.gantt.connectors.type","name":"type","line":70,"lineEnd":70,"column":8,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":"simpleConnect"},"children":{}}}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.gantt.dataLabels","name":"dataLabels","line":42,"lineEnd":42,"column":4,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.gantt.dataLabels.enabled","name":"enabled","line":43,"lineEnd":43,"column":8,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":true},"children":{}}}},"dragDrop":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"draggableEnd":{"doclet":{"description":"Allow end value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.gantt.dragDrop.draggableEnd","name":"draggableEnd","line":515,"lineEnd":522,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}},"draggableStart":{"doclet":{"description":"Allow start value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.gantt.dragDrop.draggableStart","name":"draggableStart","line":502,"lineEnd":509,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}}}},"grouping":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.gantt.grouping","name":"grouping","line":29,"lineEnd":39,"column":4,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":false},"children":{}},"partialFill":{"doclet":{"description":"A partial fill for each point, typically used to visualize how much\nof a task is performed.","see":["[completed](#series.gantt.data.completed)"],"samples":[{"name":"Gantt with progress indicator","value":"gantt/demo/progress-indicator"}]},"meta":{"fullname":"plotOptions.gantt.partialFill","name":"partialFill","line":29,"lineEnd":39,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.gantt.tooltip","name":"tooltip","line":45,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{"headerFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"font-size: 0.8em\">{series.name}</span><br/>"},"meta":{"fullname":"plotOptions.gantt.tooltip.headerFormat","name":"headerFormat","line":46,"lineEnd":46,"column":8,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":"<span style=\"font-size: 0.8em\">{series.name}</span><br/>"},"children":{}},"pointFormat":{"doclet":{"type":{"names":["*"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.gantt.tooltip.pointFormat","name":"pointFormat","line":47,"lineEnd":47,"column":8,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js","default":null},"children":{}}}}}},"gauge":{"doclet":{"description":"Gauges are circular plots displaying one or more values with a dial\npointing to values along the perimeter.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `gauge` series are defined in\n   [plotOptions.gauge](plotOptions.gauge).\n3. Options for one single series are given in\n   [the series instance array](series.gauge).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        gauge: {\n            // shared options for all gauge series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'gauge'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.gauge.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === gauge) {\n    // code specific to the gauge series\n}\n```\n            ","samples":[{"name":"Gauge chart","value":"highcharts/demo/gauge-speedometer/"}],"extends":"plotOptions.line","exclude":["animationLimit","boostThreshold","colorAxis","colorKey","connectEnds","connectNulls","cropThreshold","dashStyle","dragDrop","findNearestPointBy","getExtremesFromAll","marker","negativeColor","pointPlacement","shadow","softThreshold","stacking","states","step","threshold","turboThreshold","xAxis","zoneAxis","zones","dataSorting","boostBlending"],"products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","name":"gauge","fullname":"plotOptions.gauge","line":186,"lineEnd":190,"column":0},"children":{"dataLabels":{"doclet":{"description":"Data labels for the gauge. For gauges, the data labels are\nenabled by default and shown in a bordered box below the point.","since":"2.3.0","products":["highcharts"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.gauge.dataLabels","name":"dataLabels","line":210,"lineEnd":223,"column":4,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{"borderColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"plotOptions.gauge.dataLabels.borderColor","name":"borderColor","line":232,"lineEnd":232,"column":8,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":"#cccccc"},"children":{}},"borderRadius":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.gauge.dataLabels.borderRadius","name":"borderRadius","line":233,"lineEnd":233,"column":8,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":3},"children":{}},"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.gauge.dataLabels.borderWidth","name":"borderWidth","line":234,"lineEnd":234,"column":8,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":1},"children":{}},"crop":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.gauge.dataLabels.crop","name":"crop","line":235,"lineEnd":235,"column":8,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":false},"children":{}},"defer":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.gauge.dataLabels.defer","name":"defer","line":236,"lineEnd":236,"column":8,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":false},"children":{}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.gauge.dataLabels.enabled","name":"enabled","line":237,"lineEnd":237,"column":8,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":true},"children":{}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"top"},"meta":{"fullname":"plotOptions.gauge.dataLabels.verticalAlign","name":"verticalAlign","line":238,"lineEnd":238,"column":8,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":"top"},"children":{}},"y":{"doclet":{"type":{"names":["number"]},"defaultvalue":15},"meta":{"fullname":"plotOptions.gauge.dataLabels.y","name":"y","line":239,"lineEnd":239,"column":8,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":15},"children":{}},"zIndex":{"doclet":{"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.gauge.dataLabels.zIndex","name":"zIndex","line":240,"lineEnd":240,"column":8,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":2},"children":{}}}},"dial":{"doclet":{"description":"Options for the dial or arrow pointer of the gauge.\n\nIn styled mode, the dial is styled with the\n`.highcharts-gauge-series .highcharts-dial` rule.","samples":[{"name":"Styled mode","value":"highcharts/css/gauge/","products":["highcharts"]}],"type":{"names":["*"]},"since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.dial","name":"dial","line":242,"lineEnd":254,"column":4,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{"backgroundColor":{"doclet":{"description":"The background or fill color of the gauge's dial.","samples":[{"name":"Dial options demonstrated","value":"highcharts/plotoptions/gauge-dial/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#000000","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.dial.backgroundColor","name":"backgroundColor","line":256,"lineEnd":267,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"baseLength":{"doclet":{"description":"The length of the dial's base part, relative to the total\nradius or length of the dial.","samples":[{"name":"Dial options demonstrated","value":"highcharts/plotoptions/gauge-dial/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"70%","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.dial.baseLength","name":"baseLength","line":269,"lineEnd":281,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"baseWidth":{"doclet":{"description":"The pixel width of the base of the gauge dial. The base is\nthe part closest to the pivot, defined by baseLength.","samples":[{"name":"Dial options demonstrated","value":"highcharts/plotoptions/gauge-dial/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"3","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.dial.baseWidth","name":"baseWidth","line":283,"lineEnd":295,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"borderColor":{"doclet":{"description":"The border color or stroke of the gauge's dial. By default,\nthe borderWidth is 0, so this must be set in addition to a\ncustom border color.","samples":[{"name":"Dial options demonstrated","value":"highcharts/plotoptions/gauge-dial/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.dial.borderColor","name":"borderColor","line":297,"lineEnd":310,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"borderWidth":{"doclet":{"description":"The width of the gauge dial border in pixels.","samples":[{"name":"Dial options demonstrated","value":"highcharts/plotoptions/gauge-dial/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.dial.borderWidth","name":"borderWidth","line":312,"lineEnd":323,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"path":{"doclet":{"description":"An array with an SVG path for the custom dial.","samples":[{"name":"Dial options demonstrated","value":"highcharts/plotoptions/gauge-path/","products":["highcharts"]}],"type":{"names":["Highcharts.SVGPathArray"]},"since":"10.2.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.dial.path","name":"path","line":325,"lineEnd":335,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"radius":{"doclet":{"description":"The radius or length of the dial, in percentages relative to\nthe radius of the gauge itself.","samples":[{"name":"Dial options demonstrated","value":"highcharts/plotoptions/gauge-dial/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"80%","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.dial.radius","name":"radius","line":336,"lineEnd":348,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"rearLength":{"doclet":{"description":"The length of the dial's rear end, the part that extends out\non the other side of the pivot. Relative to the dial's\nlength.","samples":[{"name":"Dial options demonstrated","value":"highcharts/plotoptions/gauge-dial/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"10%","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.dial.rearLength","name":"rearLength","line":350,"lineEnd":363,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"topWidth":{"doclet":{"description":"The width of the top of the dial, closest to the perimeter.\nThe pivot narrows in from the base to the top.","samples":[{"name":"Dial options demonstrated","value":"highcharts/plotoptions/gauge-dial/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"1","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.dial.topWidth","name":"topWidth","line":365,"lineEnd":377,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}}}},"overshoot":{"doclet":{"description":"Allow the dial to overshoot the end of the perimeter axis by\nthis many degrees. Say if the gauge axis goes from 0 to 60, a\nvalue of 100, or 1000, will show 5 degrees beyond the end of the\naxis when this option is set to 5.","see":["[wrap](#plotOptions.gauge.wrap)"],"samples":[{"name":"Allow 5 degrees overshoot","value":"highcharts/plotoptions/gauge-overshoot/","products":["highcharts"]}],"type":{"names":["number"]},"since":"3.0.10","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.overshoot","name":"overshoot","line":380,"lineEnd":395,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"pivot":{"doclet":{"description":"Options for the pivot or the center point of the gauge.\n\nIn styled mode, the pivot is styled with the\n`.highcharts-gauge-series .highcharts-pivot` rule.","samples":[{"name":"Styled mode","value":"highcharts/css/gauge/","products":["highcharts"]}],"type":{"names":["*"]},"since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.pivot","name":"pivot","line":380,"lineEnd":395,"column":4,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{"backgroundColor":{"doclet":{"description":"The background color or fill of the pivot.","samples":[{"name":"Pivot options demonstrated","value":"highcharts/plotoptions/gauge-pivot/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#000000","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.pivot.backgroundColor","name":"backgroundColor","line":451,"lineEnd":462,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"borderColor":{"doclet":{"description":"The border or stroke color of the pivot. In able to change\nthis, the borderWidth must also be set to something other\nthan the default 0.","samples":[{"name":"Pivot options demonstrated","value":"highcharts/plotoptions/gauge-pivot/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.pivot.borderColor","name":"borderColor","line":436,"lineEnd":449,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"borderWidth":{"doclet":{"description":"The border or stroke width of the pivot.","samples":[{"name":"Pivot options demonstrated","value":"highcharts/plotoptions/gauge-pivot/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.pivot.borderWidth","name":"borderWidth","line":423,"lineEnd":434,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}},"radius":{"doclet":{"description":"The pixel radius of the pivot.","samples":[{"name":"Pivot options demonstrated","value":"highcharts/plotoptions/gauge-pivot/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"5","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.pivot.radius","name":"radius","line":410,"lineEnd":421,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}}}},"showInLegend":{"doclet":{"description":"Whether to display this particular series or series type in the\nlegend. Defaults to false for gauge series.","since":"2.3.0","products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.gauge.showInLegend","name":"showInLegend","line":468,"lineEnd":474,"column":4,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":false},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.gauge.tooltip","name":"tooltip","line":465,"lineEnd":465,"column":4,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{"headerFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"plotOptions.gauge.tooltip.headerFormat","name":"headerFormat","line":466,"lineEnd":466,"column":8,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js","default":""},"children":{}}}},"wrap":{"doclet":{"description":"When this option is `true`, the dial will wrap around the axes.\nFor instance, in a full-range gauge going from 0 to 360, a value\nof 400 will point to 40\\. When `wrap` is `false`, the dial stops\nat 360.","see":["[overshoot](#plotOptions.gauge.overshoot)"],"type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.gauge.wrap","name":"wrap","line":210,"lineEnd":223,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}}}},"geoheatmap":{"doclet":{"description":"A `geoheatmap` series is a variety of heatmap series, composed into\nthe map projection, where the units are expressed in the latitude\nand longitude, and individual values contained in a matrix are\nrepresented as colors.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `geoheatmap` series are defined in\n   [plotOptions.geoheatmap](plotOptions.geoheatmap).\n3. Options for one single series are given in\n   [the series instance array](series.geoheatmap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        geoheatmap: {\n            // shared options for all geoheatmap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'geoheatmap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.geoheatmap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === geoheatmap) {\n    // code specific to the geoheatmap series\n}\n```\n            ","samples":[{"name":"GeoHeatmap Chart with interpolation on Europe map","value":"maps/demo/geoheatmap-europe/"},{"name":"GeoHeatmap Chart on the Equal Earth Projection","value":"maps/series-geoheatmap/geoheatmap-equalearth/"}],"extends":"plotOptions.map","since":"11.0.0","products":["highmaps"],"exclude":["allAreas","dragDrop","findNearestPointBy","geometry","joinBy","negativeColor","onPoint","stickyTracking"],"requires":["module:modules/geoheatmap"]},"meta":{"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js","name":"geoheatmap","fullname":"plotOptions.geoheatmap","line":330,"lineEnd":348,"column":0},"children":{"borderWidth":{"doclet":{"description":"The border width of each geoheatmap tile.\n\nIn styled mode, the border stroke width is given in the\n`.highcharts-point` class.","samples":[{"name":"borderWidth set to 1 to create a grid","value":"maps/demo/geoheatmap-orthographic/"}],"type":{"names":["number","null"]},"defaultvalue":"0","products":["highmaps"],"since":"11.0.0"},"meta":{"fullname":"plotOptions.geoheatmap.borderWidth","name":"borderWidth","line":354,"lineEnd":367,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js"},"children":{}},"color":{"doclet":{"description":"The main color of the series. In heat maps this color is rarely\nused, as we mostly use the color to denote the value of each\npoint. Unless options are set in the [colorAxis](#colorAxis), the\ndefault value is pulled from the [options.colors](#colors) array.","type":{"names":["Highcharts.ColorType"]},"products":["highmaps"],"since":"11.0.0"},"meta":{"fullname":"plotOptions.geoheatmap.color","name":"color","line":380,"lineEnd":389,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js"},"children":{}},"colsize":{"doclet":{"description":"The column size - how many longitude units each column in the\ngeoheatmap should span.","samples":[{"name":"1 by default, set to 5","value":"maps/demo/geoheatmap-europe/"}],"products":["highmaps"],"since":"11.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.geoheatmap.colsize","name":"colsize","line":369,"lineEnd":378,"column":4,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js","default":1},"children":{}},"interpolation":{"doclet":{"description":"Make the geoheatmap render its data points as an interpolated\nimage. It can be used to show a Temperature Map-like charts.","samples":[{"name":"Advanced demo of GeoHeatmap interpolation with multiple datasets","value":"maps/demo/geoheatmap-earth-statistics"}],"type":{"names":["boolean","Highcharts.InterpolationOptionsObject"]},"since":"11.2.0","products":["highmaps"]},"meta":{"fullname":"plotOptions.geoheatmap.interpolation","name":"interpolation","line":402,"lineEnd":413,"column":4,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js"},"children":{"blur":{"doclet":{"description":"Represents how much blur should be added to the interpolated\nimage. Works best in the range of 0-1, all higher values\nwould need a lot more performance of the machine to calculate\nmore detailed interpolation.\n\n * **Note:** Useful, if the data is spread into wide range of\n longitude and latitude values.","samples":[{"name":"Simple demo of GeoHeatmap interpolation","value":"maps/series-geoheatmap/turkey-fire-areas"}],"since":"11.2.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.geoheatmap.interpolation.blur","name":"blur","line":421,"lineEnd":434,"column":8,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js","default":1},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the interpolation of the geoheatmap series.","since":"11.2.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.geoheatmap.interpolation.enabled","name":"enabled","line":415,"lineEnd":419,"column":8,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js","default":false},"children":{}}}},"nullColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"transparent"},"meta":{"fullname":"plotOptions.geoheatmap.nullColor","name":"nullColor","line":350,"lineEnd":350,"column":4,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js","default":"transparent"},"children":{}},"rowsize":{"doclet":{"description":"The rowsize size - how many latitude units each row in the\ngeoheatmap should span.","samples":[{"name":"1 by default, set to 5","value":"maps/demo/geoheatmap-europe/"}],"products":["highmaps"],"since":"11.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.geoheatmap.rowsize","name":"rowsize","line":380,"lineEnd":389,"column":4,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js","default":1},"children":{}},"stickyTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.geoheatmap.stickyTracking","name":"stickyTracking","line":401,"lineEnd":401,"column":4,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js","default":true},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.geoheatmap.tooltip","name":"tooltip","line":351,"lineEnd":351,"column":4,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Lat: {point.lat}, Lon: {point.lon}, Value: {point.value}<br/>"},"meta":{"fullname":"plotOptions.geoheatmap.tooltip.pointFormat","name":"pointFormat","line":352,"lineEnd":352,"column":8,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js","default":"Lat: {point.lat}, Lon: {point.lon}, Value: {point.value}<br/>"},"children":{}}}}}},"heatmap":{"doclet":{"description":"A heatmap is a graphical representation of data where the individual\nvalues contained in a matrix are represented as colors.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `heatmap` series are defined in\n   [plotOptions.heatmap](plotOptions.heatmap).\n3. Options for one single series are given in\n   [the series instance array](series.heatmap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        heatmap: {\n            // shared options for all heatmap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'heatmap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.heatmap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === heatmap) {\n    // code specific to the heatmap series\n}\n```\n            ","productdesc":[{"value":"Requires `modules/heatmap`.","products":["highcharts"]}],"samples":[{"name":"Simple heatmap","value":"highcharts/demo/heatmap/"},{"name":"Heavy heatmap","value":"highcharts/demo/heatmap-canvas/"}],"extends":"plotOptions.scatter","exclude":["animationLimit","cluster","connectEnds","connectNulls","cropThreshold","dashStyle","dragDrop","findNearestPointBy","getExtremesFromAll","jitter","legendSymbolColor","linecap","lineWidth","pointInterval","pointIntervalUnit","pointRange","pointStart","shadow","softThreshold","stacking","step","threshold"],"products":["highcharts","highmaps"]},"meta":{"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","name":"heatmap","fullname":"plotOptions.heatmap","line":13,"lineEnd":17,"column":0},"children":{"animation":{"doclet":{"description":"Animation is disabled by default on the heatmap series.","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.heatmap.animation","name":"animation","line":40,"lineEnd":42,"column":4,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":false},"children":{}},"borderRadius":{"doclet":{"description":"The border radius for each heatmap item. The border's color and\nwidth can be set in marker options.","see":["[lineColor](#plotOptions.heatmap.marker.lineColor)","[lineWidth](#plotOptions.heatmap.marker.lineWidth)"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.heatmap.borderRadius","name":"borderRadius","line":44,"lineEnd":50,"column":4,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":0},"children":{}},"borderWidth":{"doclet":{"description":"The border width for each heatmap item.","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.heatmap.borderWidth","name":"borderWidth","line":52,"lineEnd":54,"column":4,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":0},"children":{}},"clip":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.heatmap.clip","name":"clip","line":283,"lineEnd":283,"column":4,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":true},"children":{}},"color":{"doclet":{"description":"The main color of the series. In heat maps this color is rarely used,\nas we mostly use the color to denote the value of each point. Unless\noptions are set in the [colorAxis](#colorAxis), the default value\nis pulled from the [options.colors](#colors) array.","type":{"names":["Highcharts.ColorType"]},"since":"4.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.heatmap.color","name":"color","line":68,"lineEnd":78,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"colorKey":{"doclet":{"defaultvalue":"value","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.heatmap.colorKey","name":"colorKey","line":64,"lineEnd":67,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"colsize":{"doclet":{"description":"The column size - how many X axis units each column in the heatmap\nshould span.","samples":[{"name":"One day","value":"maps/demo/heatmap/","products":["highcharts"]},{"name":"One day","value":"maps/demo/heatmap/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"1","since":"4.0.0","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.heatmap.colsize","name":"colsize","line":79,"lineEnd":93,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.heatmap.dataLabels","name":"dataLabels","line":125,"lineEnd":125,"column":4,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"crop":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.heatmap.dataLabels.crop","name":"crop","line":133,"lineEnd":133,"column":8,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":false},"children":{}},"inside":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.heatmap.dataLabels.inside","name":"inside","line":131,"lineEnd":131,"column":8,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":true},"children":{}},"padding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.heatmap.dataLabels.padding","name":"padding","line":138,"lineEnd":138,"column":8,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":0},"children":{}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"middle"},"meta":{"fullname":"plotOptions.heatmap.dataLabels.verticalAlign","name":"verticalAlign","line":132,"lineEnd":132,"column":8,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":"middle"},"children":{}}}},"interpolation":{"doclet":{"description":"Make the heatmap render its data points as an interpolated image.","samples":[{"name":"Interpolated heatmap image displaying user activity on a website","value":"highcharts/demo/heatmap-interpolation"},{"name":"Interpolated heatmap toggle","value":"highcharts/series-heatmap/interpolation"}],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.heatmap.interpolation","name":"interpolation","line":56,"lineEnd":63,"column":4,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":false},"children":{}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rectangle"},"meta":{"fullname":"plotOptions.heatmap.legendSymbol","name":"legendSymbol","line":303,"lineEnd":303,"column":4,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":"rectangle"},"children":{}},"marker":{"doclet":{"exclude":["radius","enabledThreshold"],"since":"8.1","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.heatmap.marker","name":"marker","line":140,"lineEnd":143,"column":4,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"lineColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.heatmap.marker.lineColor","name":"lineColor","line":168,"lineEnd":168,"column":8,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":"undefined"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.heatmap.marker.states","name":"states","line":169,"lineEnd":169,"column":8,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"hover":{"doclet":{"exclude":["radius","radiusPlus"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.heatmap.marker.states.hover","name":"hover","line":170,"lineEnd":172,"column":12,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"height":{"doclet":{"description":"Set the marker's fixed height on hover state.","samples":[{"name":"70px fixed marker's width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-width","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.heatmap.marker.states.hover.height","name":"height","line":185,"lineEnd":195,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"heightPlus":{"doclet":{"description":"The number of pixels to increase the height of the\nselected point.","samples":[{"name":"20px greater width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.heatmap.marker.states.hover.heightPlus","name":"heightPlus","line":208,"lineEnd":219,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"lineWidthPlus":{"doclet":{"description":"The additional line width for a hovered point.","samples":[{"name":"5 pixels wider lineWidth on hover","value":"maps/plotoptions/heatmap-marker-states-hover-linewidthplus","products":["highcharts"]},{"name":"5 pixels wider lineWidth on hover","value":"maps/plotoptions/heatmap-marker-states-hover-linewidthplus","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.heatmap.marker.states.hover.lineWidthPlus","name":"lineWidthPlus","line":174,"lineEnd":184,"column":16,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":0},"children":{}},"width":{"doclet":{"description":"Set the marker's fixed width on hover state.","samples":[{"name":"70px fixed marker's width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-width","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.heatmap.marker.states.hover.width","name":"width","line":174,"lineEnd":184,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"widthPlus":{"doclet":{"description":"The number of pixels to increase the width of the\nselected point.","samples":[{"name":"20px greater width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.heatmap.marker.states.hover.widthPlus","name":"widthPlus","line":196,"lineEnd":207,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}}}},"select":{"doclet":{"exclude":["radius"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.heatmap.marker.states.select","name":"select","line":230,"lineEnd":232,"column":12,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"height":{"doclet":{"description":"Set the marker's fixed height on select state.","samples":[{"name":"70px fixed marker's width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-width","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.heatmap.marker.states.select.height","name":"height","line":245,"lineEnd":255,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"heightPlus":{"doclet":{"description":"The number of pixels to increase the height of the\nselected point.","samples":[{"name":"20px greater width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.heatmap.marker.states.select.heightPlus","name":"heightPlus","line":268,"lineEnd":279,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"width":{"doclet":{"description":"Set the marker's fixed width on select state.","samples":[{"name":"70px fixed marker's width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-width","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.heatmap.marker.states.select.width","name":"width","line":234,"lineEnd":244,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"widthPlus":{"doclet":{"description":"The number of pixels to increase the width of the\nselected point.","samples":[{"name":"20px greater width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.heatmap.marker.states.select.widthPlus","name":"widthPlus","line":256,"lineEnd":267,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}}}}}},"symbol":{"doclet":{"description":"A predefined shape or symbol for the marker. When undefined, the\nsymbol is pulled from options.symbols. Other possible values are\n`'circle'`, `'square'`,`'diamond'`, `'triangle'`,\n`'triangle-down'`, `'rect'`, and `'ellipse'`.\n\nAdditionally, the URL to a graphic can be given on this form:\n`'url(graphic.png)'`. Note that for the image to be applied to\nexported charts, its URL needs to be accessible by the export\nserver.\n\nCustom callbacks for symbol path generation can also be added to\n`Highcharts.SVGRenderer.prototype.symbols`. The callback is then\nused by its method name, as shown in the demo.","samples":[{"name":"Predefined, graphic and custom markers","value":"highcharts/plotoptions/series-marker-symbol/","products":["highcharts"]},{"name":"Predefined, graphic and custom markers","value":"highcharts/plotoptions/series-marker-symbol/","products":["highstock"]}],"type":{"names":["string"]},"defaultvalue":"rect"},"meta":{"fullname":"plotOptions.heatmap.marker.symbol","name":"symbol","line":145,"lineEnd":164,"column":8,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":"rect"},"children":{}}}},"nullColor":{"doclet":{"description":"The color applied to null points. In styled mode, a general CSS class\nis applied instead.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#f7f7f7"},"meta":{"fullname":"plotOptions.heatmap.nullColor","name":"nullColor","line":118,"lineEnd":123,"column":4,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":"#f7f7f7"},"children":{}},"pointPadding":{"doclet":{"description":"Padding between the points in the heatmap.","type":{"names":["number"]},"defaultvalue":"0","since":"6.0.0"},"meta":{"fullname":"plotOptions.heatmap.pointPadding","name":"pointPadding","line":56,"lineEnd":63,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"rowsize":{"doclet":{"description":"The row size - how many Y axis units each heatmap row should span.","samples":[{"name":"1 by default","value":"maps/demo/heatmap/","products":["highcharts"]},{"name":"1 by default","value":"maps/demo/heatmap/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"1","since":"4.0.0","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.heatmap.rowsize","name":"rowsize","line":94,"lineEnd":107,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.heatmap.states","name":"states","line":289,"lineEnd":289,"column":4,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.heatmap.states.hover","name":"hover","line":290,"lineEnd":290,"column":8,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"brightness":{"doclet":{"description":"How much to brighten the point on interaction.\n\nIn styled mode, the hover brightening is by default replaced\nwith a fill-opacity set in the `.highcharts-point:hover`\nrule.","type":{"names":["number"]},"defaultvalue":0.2},"meta":{"fullname":"plotOptions.heatmap.states.hover.brightness","name":"brightness","line":292,"lineEnd":292,"column":25,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":0.2},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.heatmap.tooltip","name":"tooltip","line":285,"lineEnd":285,"column":22,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{point.x}, {point.y}: {point.value}<br/>"},"meta":{"fullname":"plotOptions.heatmap.tooltip.pointFormat","name":"pointFormat","line":287,"lineEnd":287,"column":8,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js","default":"{point.x}, {point.y}: {point.value}<br/>"},"children":{}}}}}},"heikinashi":{"doclet":{"description":"An HeikinAshi series is a style of financial chart used to describe price\nmovements over time. It displays open, high, low and close values per\ndata point.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `heikinashi` series are defined in\n   [plotOptions.heikinashi](plotOptions.heikinashi).\n3. Options for one single series are given in\n   [the series instance array](series.heikinashi).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        heikinashi: {\n            // shared options for all heikinashi series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'heikinashi'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.heikinashi.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === heikinashi) {\n    // code specific to the heikinashi series\n}\n```\n            ","samples":[{"name":"Heikin Ashi series","value":"stock/demo/heikinashi/"}],"extends":"plotOptions.candlestick","products":["highstock"],"requires":["module:modules/heikinashi"]},"meta":{"filename":"code/es-modules/Series/HeikinAshi/HeikinAshiSeriesDefaults.js","name":"heikinashi","fullname":"plotOptions.heikinashi","line":12,"lineEnd":16,"column":0},"children":{"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.heikinashi.dataGrouping","name":"dataGrouping","line":31,"lineEnd":31,"column":4,"filename":"code/es-modules/Series/HeikinAshi/HeikinAshiSeriesDefaults.js"},"children":{"groupAll":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.heikinashi.dataGrouping.groupAll","name":"groupAll","line":32,"lineEnd":32,"column":8,"filename":"code/es-modules/Series/HeikinAshi/HeikinAshiSeriesDefaults.js","default":true},"children":{}}}}}},"histogram":{"doclet":{"description":"A histogram is a column series which represents the distribution of the\ndata set in the base series. Histogram splits data into bins and shows\ntheir frequencies.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `histogram` series are defined in\n   [plotOptions.histogram](plotOptions.histogram).\n3. Options for one single series are given in\n   [the series instance array](series.histogram).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        histogram: {\n            // shared options for all histogram series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'histogram'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.histogram.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === histogram) {\n    // code specific to the histogram series\n}\n```\n            ","samples":[{"name":"Histogram","value":"highcharts/demo/histogram/","products":["highcharts"]}],"extends":"plotOptions.column","exclude":["boostThreshold","dragDrop","pointInterval","pointIntervalUnit","stacking","boostBlending"],"products":["highcharts"],"since":"6.0.0","requires":["module:modules/histogram-bellcurve"]},"meta":{"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js","name":"histogram","fullname":"plotOptions.histogram","line":12,"lineEnd":16,"column":0},"children":{"binWidth":{"doclet":{"description":"Width of each bin. By default the bin's width is calculated as\n`(max - min) / number of bins`. This option takes precedence over\n[binsNumber](#plotOptions.histogram.binsNumber).","type":{"names":["number"]},"since":"6.0.0","defaultvalue":null},"meta":{"fullname":"plotOptions.histogram.binWidth","name":"binWidth","line":45,"lineEnd":51,"column":4,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js","default":"undefined"},"children":{}},"binsNumber":{"doclet":{"description":"A preferable number of bins. It is a suggestion, so a histogram may\nhave a different number of bins. By default it is set to the square\nroot of the base series' data length. Available options are:\n`square-root`, `sturges`, `rice`. You can also define a function\nwhich takes a `baseSeries` as a parameter and should return a\npositive integer.","type":{"names":["\"square-root\"","\"sturges\"","\"rice\"","number","function"]},"since":"6.0.0","defaultvalue":null},"meta":{"fullname":"plotOptions.histogram.binsNumber","name":"binsNumber","line":34,"lineEnd":43,"column":4,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js","default":"square-root"},"children":{}},"groupPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.histogram.groupPadding","name":"groupPadding","line":54,"lineEnd":54,"column":4,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js","default":0},"children":{}},"grouping":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.histogram.grouping","name":"grouping","line":55,"lineEnd":55,"column":4,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js","default":false},"children":{}},"pointPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.histogram.pointPadding","name":"pointPadding","line":53,"lineEnd":53,"column":4,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js","default":0},"children":{}},"pointPlacement":{"doclet":{"type":{"names":["string"]},"defaultvalue":"between"},"meta":{"fullname":"plotOptions.histogram.pointPlacement","name":"pointPlacement","line":56,"lineEnd":56,"column":4,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js","default":"between"},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.histogram.tooltip","name":"tooltip","line":57,"lineEnd":57,"column":4,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js"},"children":{"headerFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"plotOptions.histogram.tooltip.headerFormat","name":"headerFormat","line":58,"lineEnd":58,"column":8,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js","default":""},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"font-size: 0.8em\">{point.x} - {point.x2}</span><br/><span style=\"color:{point.color}\">●</span> {series.name} <b>{point.y}</b><br/>"},"meta":{"fullname":"plotOptions.histogram.tooltip.pointFormat","name":"pointFormat","line":59,"lineEnd":59,"column":8,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js","default":"<span style=\"font-size: 0.8em\">{point.x} - {point.x2}</span><br/><span style=\"color:{point.color}\">●</span> {series.name} <b>{point.y}</b><br/>"},"children":{}}}}}},"hlc":{"doclet":{"description":"An HLC chart is a style of financial chart used to describe price\nmovements over time. It displays high, low and close values per\ndata point.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `hlc` series are defined in\n   [plotOptions.hlc](plotOptions.hlc).\n3. Options for one single series are given in\n   [the series instance array](series.hlc).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        hlc: {\n            // shared options for all hlc series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'hlc'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.hlc.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === hlc) {\n    // code specific to the hlc series\n}\n```\n            ","samples":[{"name":"HLC chart","value":"stock/demo/hlc/"}],"extends":"plotOptions.column","exclude":["borderColor","borderRadius","borderWidth","crisp","stacking","stack"],"products":["highstock"]},"meta":{"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js","name":"hlc","fullname":"plotOptions.hlc","line":12,"lineEnd":16,"column":0},"children":{"colorKey":{"doclet":{"defaultvalue":"close","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.hlc.colorKey","name":"colorKey","line":51,"lineEnd":54,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js"},"children":{}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"approximation":{"doclet":{"type":{"names":["Highcharts.DataGroupingApproximationValue","function"]},"defaultvalue":"hlc","products":["highstock"]},"meta":{"fullname":"plotOptions.hlc.dataGrouping.approximation","name":"approximation","line":45,"lineEnd":50,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js"},"children":{}},"groupPixelWidth":{"doclet":{"description":"The approximate pixel width of each group. If for example a series\nwith 30 points is displayed over a 600 pixel wide plot area, no\ngrouping is performed. If however the series contains so many points\nthat the spacing is less than the groupPixelWidth, Highcharts will\ntry to group it into appropriate groups so that each is more or less\ntwo pixels wide. Defaults to `5`.","type":{"names":["number"]},"defaultvalue":"5","products":["highstock"]},"meta":{"fullname":"plotOptions.hlc.dataGrouping.groupPixelWidth","name":"groupPixelWidth","line":32,"lineEnd":44,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js"},"children":{}}}},"lineWidth":{"doclet":{"description":"The pixel width of the line/border. Defaults to `1`.","samples":[{"name":"A greater line width","value":"stock/plotoptions/hlc-linewidth/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"1","products":["highstock"],"access":"public"},"meta":{"fullname":"plotOptions.hlc.lineWidth","name":"lineWidth","line":32,"lineEnd":44,"column":4,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js","default":1},"children":{}},"pointValKey":{"doclet":{"description":"Determines which one of  `high`, `low`, `close` values should\nbe represented as `point.y`, which is later used to set dataLabel\nposition and [compare](#plotOptions.series.compare).","samples":[{"name":"Possible values","value":"stock/plotoptions/hlc-pointvalkey/","products":["highstock"]}],"declare":"Highcharts.OptionsHLCPointValKeyValue","type":{"names":["\"high\"","\"low\"","\"close\""]},"defaultvalue":"close","products":["highstock"]},"meta":{"fullname":"plotOptions.hlc.pointValKey","name":"pointValKey","line":95,"lineEnd":109,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.hlc.states","name":"states","line":79,"lineEnd":79,"column":4,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js"},"children":{"hover":{"doclet":{"extends":"plotOptions.column.states.hover","products":["highstock"]},"meta":{"fullname":"plotOptions.hlc.states.hover","name":"hover","line":80,"lineEnd":83,"column":8,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js"},"children":{"lineWidth":{"doclet":{"description":"The pixel width of the line representing the HLC point.","type":{"names":["number"]},"defaultvalue":"3","products":["highstock"]},"meta":{"fullname":"plotOptions.hlc.states.hover.lineWidth","name":"lineWidth","line":85,"lineEnd":91,"column":12,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js","default":3},"children":{}}}}}},"stickyTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.hlc.stickyTracking","name":"stickyTracking","line":95,"lineEnd":109,"column":4,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js","default":true},"children":{}},"threshold":{"doclet":{"type":{"names":["number","null"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.hlc.threshold","name":"threshold","line":75,"lineEnd":77,"column":4,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js","default":null},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.hlc.tooltip","name":"tooltip","line":68,"lineEnd":68,"column":4,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> <b> {series.name}</b><br/>{series.chart.options.lang.stockHigh}: {point.high}<br/>{series.chart.options.lang.stockLow}: {point.low}<br/>{series.chart.options.lang.stockClose}: {point.close}<br/>"},"meta":{"fullname":"plotOptions.hlc.tooltip.pointFormat","name":"pointFormat","line":69,"lineEnd":69,"column":8,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> <b> {series.name}</b><br/>{series.chart.options.lang.stockHigh}: {point.high}<br/>{series.chart.options.lang.stockLow}: {point.low}<br/>{series.chart.options.lang.stockClose}: {point.close}<br/>"},"children":{}}}}}},"hollowcandlestick":{"doclet":{"description":"A hollow candlestick chart is a style of financial chart used to\ndescribe price movements over time.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `hollowcandlestick` series are defined in\n   [plotOptions.hollowcandlestick](plotOptions.hollowcandlestick).\n3. Options for one single series are given in\n   [the series instance array](series.hollowcandlestick).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        hollowcandlestick: {\n            // shared options for all hollowcandlestick series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'hollowcandlestick'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.hollowcandlestick.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === hollowcandlestick) {\n    // code specific to the hollowcandlestick series\n}\n```\n            ","samples":[{"name":"Hollow Candlestick chart","value":"stock/demo/hollow-candlestick/"}],"extends":"plotOptions.candlestick","products":["highstock"],"requires":["module:modules/hollowcandlestick"]},"meta":{"filename":"code/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js","name":"hollowcandlestick","fullname":"plotOptions.hollowcandlestick","line":173,"lineEnd":184,"column":0},"children":{"color":{"doclet":{"description":"The fill color of the candlestick when the current\nclose is lower than the previous one.","samples":[{"name":"Custom colors","value":"stock/plotoptions/hollow-candlestick-color/"},{"name":"Colors in styled mode","value":"highcharts/css/hollow-candlestick/","products":["highstock"]}],"type":{"names":["ColorType"]},"products":["highstock"],"defaultvalue":"#f21313"},"meta":{"fullname":"plotOptions.hollowcandlestick.color","name":"color","line":186,"lineEnd":197,"column":4,"filename":"code/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js","default":"#f21313"},"children":{}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.hollowcandlestick.dataGrouping","name":"dataGrouping","line":199,"lineEnd":199,"column":4,"filename":"code/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js"},"children":{"groupAll":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.hollowcandlestick.dataGrouping.groupAll","name":"groupAll","line":200,"lineEnd":200,"column":8,"filename":"code/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js","default":true},"children":{}},"groupPixelWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.hollowcandlestick.dataGrouping.groupPixelWidth","name":"groupPixelWidth","line":201,"lineEnd":201,"column":8,"filename":"code/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js","default":10},"children":{}}}},"lineColor":{"doclet":{"description":"The color of the line/border of the hollow candlestick when\nthe current close is lower than the previous one.","samples":[{"name":"Custom colors","value":"stock/plotoptions/hollow-candlestick-color/"},{"name":"Colors in styled mode","value":"highcharts/css/hollow-candlestick/","products":["highstock"]}],"type":{"names":["ColorType"]},"products":["highstock"],"defaultvalue":"#f21313"},"meta":{"fullname":"plotOptions.hollowcandlestick.lineColor","name":"lineColor","line":203,"lineEnd":214,"column":4,"filename":"code/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js","default":"#f21313"},"children":{}},"upColor":{"doclet":{"description":"The fill color of the candlestick when the current\nclose is higher than the previous one.","samples":[{"name":"Custom colors","value":"stock/plotoptions/hollow-candlestick-color/"},{"name":"Colors in styled mode","value":"highcharts/css/hollow-candlestick/","products":["highstock"]}],"type":{"names":["ColorType"]},"products":["highstock"],"defaultvalue":"#06b535"},"meta":{"fullname":"plotOptions.hollowcandlestick.upColor","name":"upColor","line":216,"lineEnd":227,"column":4,"filename":"code/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js","default":"#06b535"},"children":{}},"upLineColor":{"doclet":{"description":"The color of the line/border of the hollow candlestick when\nthe current close is higher than the previous one.","samples":[{"name":"Custom colors","value":"stock/plotoptions/hollow-candlestick-color/"},{"name":"Colors in styled mode","value":"highcharts/css/hollow-candlestick/","products":["highstock"]}],"type":{"names":["ColorType"]},"products":["highstock"],"defaultvalue":"#06b535"},"meta":{"fullname":"plotOptions.hollowcandlestick.upLineColor","name":"upLineColor","line":229,"lineEnd":240,"column":4,"filename":"code/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js","default":"#06b535"},"children":{}}}},"ikh":{"doclet":{"description":"Ichimoku Kinko Hyo (IKH). This series requires `linkedTo` option to be\nset.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ikh` series are defined in\n   [plotOptions.ikh](plotOptions.ikh).\n3. Options for one single series are given in\n   [the series instance array](series.ikh).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ikh: {\n            // shared options for all ikh series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ikh'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ikh.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ikh) {\n    // code specific to the ikh series\n}\n```\n            ","samples":[{"name":"Ichimoku Kinko Hyo indicator","value":"stock/indicators/ichimoku-kinko-hyo"}],"extends":"plotOptions.sma","since":"6.0.0","exclude":["allAreas","colorAxis","compare","compareBase","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/ichimoku-kinko-hyo"]},"meta":{"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","name":"ikh","fullname":"plotOptions.ikh","line":476,"lineEnd":493,"column":0},"children":{"chikouLine":{"doclet":{"description":"The styles for Chikou line","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.chikouLine","name":"chikouLine","line":555,"lineEnd":557,"column":4,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.chikouLine.styles","name":"styles","line":559,"lineEnd":559,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.ikh.chikouLine.styles.lineColor","name":"lineColor","line":564,"lineEnd":568,"column":12,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.ikh.chikouLine.styles.lineWidth","name":"lineWidth","line":560,"lineEnd":562,"column":12,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":1},"children":{}}}}}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.dataGrouping","name":"dataGrouping","line":646,"lineEnd":646,"column":4,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"ichimoku-averages"},"meta":{"fullname":"plotOptions.ikh.dataGrouping.approximation","name":"approximation","line":647,"lineEnd":647,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":"ichimoku-averages"},"children":{}}}},"kijunLine":{"doclet":{"description":"The styles for Kijun line","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.kijunLine","name":"kijunLine","line":538,"lineEnd":540,"column":4,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.kijunLine.styles","name":"styles","line":542,"lineEnd":542,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.ikh.kijunLine.styles.lineColor","name":"lineColor","line":547,"lineEnd":551,"column":12,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.ikh.kijunLine.styles.lineWidth","name":"lineWidth","line":543,"lineEnd":545,"column":12,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":1},"children":{}}}}}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.marker","name":"marker","line":510,"lineEnd":510,"column":4,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.ikh.marker.enabled","name":"enabled","line":511,"lineEnd":511,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":false},"children":{}}}},"params":{"doclet":{"exclude":["index"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.params","name":"params","line":495,"lineEnd":497,"column":4,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.ikh.params.index","name":"index","line":499,"lineEnd":499,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":26},"meta":{"fullname":"plotOptions.ikh.params.period","name":"period","line":499,"lineEnd":499,"column":23,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":26},"children":{}},"periodSenkouSpanB":{"doclet":{"description":"The base period for Senkou Span B calculations","type":{"names":["number"]},"defaultvalue":52},"meta":{"fullname":"plotOptions.ikh.params.periodSenkouSpanB","name":"periodSenkouSpanB","line":505,"lineEnd":507,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":52},"children":{}},"periodTenkan":{"doclet":{"description":"The base period for Tenkan calculations.","type":{"names":["number"]},"defaultvalue":9},"meta":{"fullname":"plotOptions.ikh.params.periodTenkan","name":"periodTenkan","line":501,"lineEnd":503,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":9},"children":{}}}},"senkouSpan":{"doclet":{"description":"The styles for area between Senkou Span A and B.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.senkouSpan","name":"senkouSpan","line":606,"lineEnd":608,"column":4,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"color":{"doclet":{"description":"Color of the area between Senkou Span A and B,\nwhen Senkou Span A is above Senkou Span B. Note that if\na `style.fill` is defined, the `color` takes precedence and\nthe `style.fill` is ignored.","see":["[senkouSpan.styles.fill](#series.ikh.senkouSpan.styles.fill)"],"samples":[{"name":"Ichimoku Kinko Hyo color","value":"stock/indicators/ichimoku-kinko-hyo"}],"type":{"names":["Highcharts.ColorType"]},"since":"7.0.0"},"meta":{"fullname":"plotOptions.ikh.senkouSpan.color","name":"color","line":610,"lineEnd":624,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{}},"negativeColor":{"doclet":{"description":"Color of the area between Senkou Span A and B,\nwhen Senkou Span A is under Senkou Span B.","samples":[{"name":"Ichimoku Kinko Hyo negativeColor","value":"stock/indicators/ikh-negative-color"}],"type":{"names":["Highcharts.ColorType"]},"since":"7.0.0"},"meta":{"fullname":"plotOptions.ikh.senkouSpan.negativeColor","name":"negativeColor","line":625,"lineEnd":635,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{}}}},"senkouSpanA":{"doclet":{"description":"The styles for Senkou Span A line","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.senkouSpanA","name":"senkouSpanA","line":572,"lineEnd":574,"column":4,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.senkouSpanA.styles","name":"styles","line":576,"lineEnd":576,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.ikh.senkouSpanA.styles.lineColor","name":"lineColor","line":581,"lineEnd":585,"column":12,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.ikh.senkouSpanA.styles.lineWidth","name":"lineWidth","line":577,"lineEnd":579,"column":12,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":1},"children":{}}}}}},"senkouSpanB":{"doclet":{"description":"The styles for Senkou Span B line","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.senkouSpanB","name":"senkouSpanB","line":589,"lineEnd":591,"column":4,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.senkouSpanB.styles","name":"styles","line":593,"lineEnd":593,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.ikh.senkouSpanB.styles.lineColor","name":"lineColor","line":598,"lineEnd":602,"column":12,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.ikh.senkouSpanB.styles.lineWidth","name":"lineWidth","line":594,"lineEnd":596,"column":12,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":1},"children":{}}}}}},"tenkanLine":{"doclet":{"description":"The styles for Tenkan line","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.tenkanLine","name":"tenkanLine","line":521,"lineEnd":523,"column":4,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.tenkanLine.styles","name":"styles","line":525,"lineEnd":525,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.ikh.tenkanLine.styles.lineColor","name":"lineColor","line":530,"lineEnd":534,"column":12,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.ikh.tenkanLine.styles.lineWidth","name":"lineWidth","line":526,"lineEnd":528,"column":12,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":1},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ikh.tooltip","name":"tooltip","line":513,"lineEnd":513,"column":4,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> <b> {series.name}</b><br/>TENKAN SEN: {point.tenkanSen:.3f}<br/>KIJUN SEN: {point.kijunSen:.3f}<br/>CHIKOU SPAN: {point.chikouSpan:.3f}<br/>SENKOU SPAN A: {point.senkouSpanA:.3f}<br/>SENKOU SPAN B: {point.senkouSpanB:.3f}<br/>"},"meta":{"fullname":"plotOptions.ikh.tooltip.pointFormat","name":"pointFormat","line":514,"lineEnd":514,"column":8,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js","default":"<span style=\"color:{point.color}\">●</span> <b> {series.name}</b><br/>TENKAN SEN: {point.tenkanSen:.3f}<br/>KIJUN SEN: {point.kijunSen:.3f}<br/>CHIKOU SPAN: {point.chikouSpan:.3f}<br/>SENKOU SPAN A: {point.senkouSpanA:.3f}<br/>SENKOU SPAN B: {point.senkouSpanB:.3f}<br/>"},"children":{}}}}}},"item":{"doclet":{"description":"An item chart is an infographic chart where a number of items are laid\nout in either a rectangular or circular pattern. It can be used to\nvisualize counts within a group, or for the circular pattern, typically\na parliament.\n\nThe circular layout has much in common with a pie chart. Many of the item\nseries options, like `center`, `size` and data label positioning, are\ninherited from the pie series and don't apply for rectangular layouts.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `item` series are defined in\n   [plotOptions.item](plotOptions.item).\n3. Options for one single series are given in\n   [the series instance array](series.item).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        item: {\n            // shared options for all item series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'item'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.item.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === item) {\n    // code specific to the item series\n}\n```\n            ","samples":[{"name":"Parliament chart (circular item chart)","value":"highcharts/demo/parliament-chart"},{"name":"Rectangular item chart","value":"highcharts/series-item/rectangular"},{"name":"Infographic with symbols","value":"highcharts/series-item/symbols"}],"extends":"plotOptions.pie","since":"7.1.0","products":["highcharts"],"exclude":["borderColor","borderWidth","depth","linecap","shadow","slicedOffset"],"requires":["module:modules/item-series"]},"meta":{"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js","name":"item","fullname":"plotOptions.item","line":16,"lineEnd":20,"column":0},"children":{"crisp":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.item.crisp","name":"crisp","line":97,"lineEnd":97,"column":4,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js","default":false},"children":{}},"endAngle":{"doclet":{"description":"In circular view, the end angle of the item layout, in degrees where\n0 is up.","samples":[{"name":"Parliament chart","value":"highcharts/demo/parliament-chart"}],"type":{"names":["undefined","number"]},"since":"7.1.0","defaultvalue":null},"meta":{"fullname":"plotOptions.item.endAngle","name":"endAngle","line":47,"lineEnd":54,"column":4,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js","default":"undefined"},"children":{}},"innerSize":{"doclet":{"description":"In circular view, the size of the inner diameter of the circle. Can\nbe a percentage or pixel value. Percentages are relative to the outer\nperimeter. Pixel values are given as integers.\n\nIf the `rows` option is set, it overrides the `innerSize` setting.","samples":[{"name":"Parliament chart","value":"highcharts/demo/parliament-chart"}],"type":{"names":["string","number"]},"since":"7.1.0","defaultvalue":"40%"},"meta":{"fullname":"plotOptions.item.innerSize","name":"innerSize","line":56,"lineEnd":66,"column":4,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js","default":"40%"},"children":{}},"itemPadding":{"doclet":{"description":"The padding between the items, given in relative size where the size\nof the item is 1.","type":{"names":["number"]},"since":"7.1.0","defaultvalue":0.1},"meta":{"fullname":"plotOptions.item.itemPadding","name":"itemPadding","line":68,"lineEnd":72,"column":4,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js","default":0.1},"children":{}},"layout":{"doclet":{"description":"The layout of the items in rectangular view. Can be either\n`horizontal` or `vertical`.","samples":[{"name":"Horizontal layout","value":"highcharts/series-item/symbols"}],"type":{"names":["string"]},"since":"7.1.0","defaultvalue":"vertical"},"meta":{"fullname":"plotOptions.item.layout","name":"layout","line":74,"lineEnd":80,"column":4,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js","default":"vertical"},"children":{}},"marker":{"doclet":{"extends":"plotOptions.series.marker"},"meta":{"fullname":"plotOptions.item.marker","name":"marker","line":82,"lineEnd":84,"column":4,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js"},"children":{}},"rows":{"doclet":{"description":"The number of rows to display in the rectangular or circular view. If\nthe `innerSize` is set, it will be overridden by the `rows` setting.","samples":[{"name":"Fixed row count","value":"highcharts/series-item/rows-columns"}],"type":{"names":["number"]},"since":"7.1.0","defaultvalue":null},"meta":{"fullname":"plotOptions.item.rows","name":"rows","line":88,"lineEnd":95,"column":4,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js","default":"undefined"},"children":{}},"showInLegend":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.item.showInLegend","name":"showInLegend","line":98,"lineEnd":98,"column":4,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js","default":true},"children":{}},"startAngle":{"doclet":{"description":"In circular view, the start angle of the item layout, in degrees\nwhere 0 is up.","samples":[{"name":"Parliament chart","value":"highcharts/demo/parliament-chart"}],"type":{"names":["undefined","number"]},"since":"7.1.0","defaultvalue":null},"meta":{"fullname":"plotOptions.item.startAngle","name":"startAngle","line":99,"lineEnd":106,"column":4,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js","default":"undefined"},"children":{}}}},"keltnerchannels":{"doclet":{"description":"Keltner Channels. This series requires the `linkedTo` option to be set\nand should be loaded after the `stock/indicators/indicators.js`,\n`stock/indicators/atr.js`, and `stock/ema/.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `keltnerchannels` series are defined in\n   [plotOptions.keltnerchannels](plotOptions.keltnerchannels).\n3. Options for one single series are given in\n   [the series instance array](series.keltnerchannels).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        keltnerchannels: {\n            // shared options for all keltnerchannels series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'keltnerchannels'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.keltnerchannels.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === keltnerchannels) {\n    // code specific to the keltnerchannels series\n}\n```\n            ","samples":[{"name":"Keltner Channels","value":"stock/indicators/keltner-channels","products":["highstock"]}],"extends":"plotOptions.sma","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/keltner-channels"]},"meta":{"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js","name":"keltnerchannels","fullname":"plotOptions.keltnerchannels","line":82,"lineEnd":86,"column":0},"children":{"bottomLine":{"doclet":{"description":"Bottom line options.","since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.keltnerchannels.bottomLine","name":"bottomLine","line":135,"lineEnd":138,"column":4,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js"},"children":{"styles":{"doclet":{"description":"Styles for a bottom line.","since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.keltnerchannels.bottomLine.styles","name":"styles","line":140,"lineEnd":143,"column":8,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line. If not set, it's inherited from\n`plotOptions.keltnerchannels.color`","since":"7.0.0","type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.keltnerchannels.bottomLine.styles.lineColor","name":"lineColor","line":149,"lineEnd":152,"column":12,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.keltnerchannels.bottomLine.styles.lineWidth","name":"lineWidth","line":145,"lineEnd":147,"column":12,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js","default":1},"children":{}}}}}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.keltnerchannels.dataGrouping","name":"dataGrouping","line":173,"lineEnd":173,"column":4,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.keltnerchannels.dataGrouping.approximation","name":"approximation","line":174,"lineEnd":174,"column":8,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js","default":"averages"},"children":{}}}},"fillColor":{"doclet":{"description":"Option for fill color between lines in Keltner Channels Indicator.","samples":[{"name":"Background fill between lines.","value":"stock/indicators/indicator-area-fill","products":["highstock"]}],"type":{"names":["Highcharts.Color"]},"since":"9.3.2"},"meta":{"fullname":"plotOptions.keltnerchannels.fillColor","name":"fillColor","line":107,"lineEnd":117,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js"},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.keltnerchannels.lineWidth","name":"lineWidth","line":176,"lineEnd":176,"column":4,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js","default":1},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.keltnerchannels.marker","name":"marker","line":170,"lineEnd":170,"column":4,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.keltnerchannels.marker.enabled","name":"enabled","line":171,"lineEnd":171,"column":8,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js","default":false},"children":{}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.keltnerchannels.tooltip","name":"tooltip","line":167,"lineEnd":167,"column":4,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b><br/>Upper Channel: {point.top}<br/>EMA({series.options.params.period}): {point.middle}<br/>Lower Channel: {point.bottom}<br/>"},"meta":{"fullname":"plotOptions.keltnerchannels.tooltip.pointFormat","name":"pointFormat","line":168,"lineEnd":168,"column":8,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js","default":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b><br/>Upper Channel: {point.top}<br/>EMA({series.options.params.period}): {point.middle}<br/>Lower Channel: {point.bottom}<br/>"},"children":{}}}},"topLine":{"doclet":{"description":"Top line options.","extends":"plotOptions.keltnerchannels.bottomLine","since":"7.0.0"},"meta":{"fullname":"plotOptions.keltnerchannels.topLine","name":"topLine","line":156,"lineEnd":160,"column":4,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.keltnerchannels.topLine.styles","name":"styles","line":162,"lineEnd":162,"column":8,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js"},"children":{"lineColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.keltnerchannels.topLine.styles.lineColor","name":"lineColor","line":164,"lineEnd":164,"column":12,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.keltnerchannels.topLine.styles.lineWidth","name":"lineWidth","line":163,"lineEnd":163,"column":12,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js","default":1},"children":{}}}}}}}},"klinger":{"doclet":{"description":"Klinger oscillator. This series requires the `linkedTo` option to be set\nand should be loaded after the `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `klinger` series are defined in\n   [plotOptions.klinger](plotOptions.klinger).\n3. Options for one single series are given in\n   [the series instance array](series.klinger).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        klinger: {\n            // shared options for all klinger series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'klinger'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.klinger.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === klinger) {\n    // code specific to the klinger series\n}\n```\n            ","samples":[{"name":"Klinger oscillator","value":"stock/indicators/klinger"}],"extends":"plotOptions.sma","since":"9.1.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/klinger"]},"meta":{"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js","name":"klinger","fullname":"plotOptions.klinger","line":138,"lineEnd":142,"column":0},"children":{"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.klinger.dataGrouping","name":"dataGrouping","line":201,"lineEnd":201,"column":4,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.klinger.dataGrouping.approximation","name":"approximation","line":202,"lineEnd":202,"column":8,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js","default":"averages"},"children":{}}}},"params":{"doclet":{"description":"Parameters used in calculation of Klinger Oscillator.","exclude":["index","period"],"since":"9.1.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.klinger.params","name":"params","line":158,"lineEnd":162,"column":4,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js"},"children":{"fastAvgPeriod":{"doclet":{"description":"The fast period for indicator calculations.","since":"9.1.0","type":{"names":["number"]},"defaultvalue":34},"meta":{"fullname":"plotOptions.klinger.params.fastAvgPeriod","name":"fastAvgPeriod","line":164,"lineEnd":166,"column":8,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js","default":34},"children":{}},"signalPeriod":{"doclet":{"description":"The base period for signal calculations.","since":"9.1.0","type":{"names":["number"]},"defaultvalue":13},"meta":{"fullname":"plotOptions.klinger.params.signalPeriod","name":"signalPeriod","line":172,"lineEnd":174,"column":8,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js","default":13},"children":{}},"slowAvgPeriod":{"doclet":{"description":"The slow period for indicator calculations.","since":"9.1.0","type":{"names":["number"]},"defaultvalue":55},"meta":{"fullname":"plotOptions.klinger.params.slowAvgPeriod","name":"slowAvgPeriod","line":168,"lineEnd":170,"column":8,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js","default":55},"children":{}},"volumeSeriesID":{"doclet":{"description":"The id of another series to use its data as volume data for the\nindiator calculation.","since":"9.1.0","type":{"names":["string"]},"defaultvalue":"volume"},"meta":{"fullname":"plotOptions.klinger.params.volumeSeriesID","name":"volumeSeriesID","line":176,"lineEnd":179,"column":8,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js","default":"volume"},"children":{}}}},"signalLine":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.klinger.signalLine","name":"signalLine","line":182,"lineEnd":182,"column":4,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js"},"children":{"styles":{"doclet":{"description":"Styles for a signal line.","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.klinger.signalLine.styles","name":"styles","line":183,"lineEnd":185,"column":8,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line. If not set, it's inherited from\n[plotOptions.klinger.color](#plotOptions.klinger.color).","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"#ff0000"},"meta":{"fullname":"plotOptions.klinger.signalLine.styles.lineColor","name":"lineColor","line":191,"lineEnd":197,"column":12,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js","default":"#ff0000"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.klinger.signalLine.styles.lineWidth","name":"lineWidth","line":187,"lineEnd":189,"column":12,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js","default":1},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.klinger.tooltip","name":"tooltip","line":204,"lineEnd":204,"column":4,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color: {point.color}\">●</span><b> {series.name}</b><br/><span style=\"color: {point.color}\">Klinger</span>: {point.y}<br/><span style=\"color: {point.series.options.signalLine.styles.lineColor}\">Signal</span>: {point.signal}<br/>"},"meta":{"fullname":"plotOptions.klinger.tooltip.pointFormat","name":"pointFormat","line":205,"lineEnd":205,"column":8,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js","default":"<span style=\"color: {point.color}\">●</span><b> {series.name}</b><br/><span style=\"color: {point.color}\">Klinger</span>: {point.y}<br/><span style=\"color: {point.series.options.signalLine.styles.lineColor}\">Signal</span>: {point.signal}<br/>"},"children":{}}}}}},"line":{"doclet":{"description":"A line series displays information as a series of data points connected by\nstraight line segments.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `line` series are defined in\n   [plotOptions.line](plotOptions.line).\n3. Options for one single series are given in\n   [the series instance array](series.line).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        line: {\n            // shared options for all line series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'line'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.line.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === line) {\n    // code specific to the line series\n}\n```\n            ","samples":[{"name":"Line chart","value":"highcharts/demo/line-chart/","products":["highcharts"]},{"name":"Line chart","value":"stock/demo/basic-line/","products":["highstock"]}],"extends":"plotOptions.series","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.line","name":"line","line":260,"lineEnd":272,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{"legendSymbol":{"doclet":{"description":"What type of legend symbol to render for this series. Can be one\nof `areaMarker`, `lineMarker` or `rectangle`.","samples":[{"name":"Change the legend symbol","value":"highcharts/series/legend-symbol/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"lineMarker","since":"11.0.1"},"meta":{"fullname":"plotOptions.line.legendSymbol","name":"legendSymbol","line":233,"lineEnd":244,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"useOhlcData":{"doclet":{"description":"The parameter allows setting line series type and use OHLC indicators.\nData in OHLC format is required.","samples":[{"name":"Use OHLC data format to plot line chart","value":"stock/indicators/use-ohlc-data","products":["highstock"]}],"type":{"names":["boolean"]},"products":["highstock"]},"meta":{"fullname":"plotOptions.line.useOhlcData","name":"useOhlcData","line":63,"lineEnd":73,"filename":"code/es-modules/Series/OHLC/OHLCSeriesDefaults.js"},"children":{}}}},"linearregression":{"doclet":{"description":"Linear regression indicator. This series requires `linkedTo` option to be\nset.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `linearregression` series are defined in\n   [plotOptions.linearregression](plotOptions.linearregression).\n3. Options for one single series are given in\n   [the series instance array](series.linearregression).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        linearregression: {\n            // shared options for all linearregression series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'linearregression'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.linearregression.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === linearregression) {\n    // code specific to the linearregression series\n}\n```\n            ","samples":[{"name":"Linear regression indicator","value":"stock/indicators/linear-regression","products":["highstock"]}],"extends":"plotOptions.sma","since":"7.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/regressions"]},"meta":{"filename":"code/es-modules/Stock/Indicators/LinearRegression/LinearRegressionIndicator.js","name":"linearregression","fullname":"plotOptions.linearregression","line":170,"lineEnd":174,"column":0},"children":{"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.linearregression.params","name":"params","line":190,"lineEnd":190,"column":4,"filename":"code/es-modules/Stock/Indicators/LinearRegression/LinearRegressionIndicator.js"},"children":{"xAxisUnit":{"doclet":{"description":"Unit (in milliseconds) for the x axis distances used to\ncompute the regression line parameters (slope & intercept)\nfor every range. In Highcharts Stock the x axis values are\nalways represented in milliseconds which may cause that\ndistances between points are \"big\" integer numbers.\n\nHighcharts Stock's linear regression algorithm (least squares\nmethod) will utilize these \"big\" integers for finding the\nslope and the intercept of the regression line for each\nperiod. In consequence, this value may be a very \"small\"\ndecimal number that's hard to interpret by a human.\n\nFor instance: `xAxisUnit` equaled to `86400000` ms (1 day)\nforces the algorithm to treat `86400000` as `1` while\ncomputing the slope and the intercept. This may enhance the\nlegibility of the indicator's values.\n\nDefault value is the closest distance between two data\npoints.\n\nIn `v9.0.2`, the default value has been changed\nfrom `undefined` to `null`.","samples":[{"name":"xAxisUnit set to 1 minute ```js\n// In Liniear Regression Slope Indicator series `xAxisUnit`is\n// `86400000` (1 day) and period is `3`. There're 3 points in\n// the base series: data: [ [Date.UTC(2020, 0, 1), 1], [Date.UTC(2020, 0, 2), 3], [Date.UTC(2020, 0, 3), 5]\n] // This will produce one point in the indicator series that\n// has a `y` value of `2` (slope of the regression line). If\n// we change the `xAxisUnit` to `1` (ms) the value of the\n// indicator's point will be `2.3148148148148148e-8` which is\n// harder to interpret for a human.\n```","value":"stock/plotoptions/linear-regression-xaxisunit","products":["highstock"]}],"type":{"names":["null","number"]},"products":["highstock"],"defaultvalue":null},"meta":{"fullname":"plotOptions.linearregression.params.xAxisUnit","name":"xAxisUnit","line":191,"lineEnd":238,"column":8,"filename":"code/es-modules/Stock/Indicators/LinearRegression/LinearRegressionIndicator.js","default":null},"children":{}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.linearregression.tooltip","name":"tooltip","line":241,"lineEnd":241,"column":4,"filename":"code/es-modules/Stock/Indicators/LinearRegression/LinearRegressionIndicator.js"},"children":{"valueDecimals":{"doclet":{"type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"plotOptions.linearregression.tooltip.valueDecimals","name":"valueDecimals","line":242,"lineEnd":242,"column":8,"filename":"code/es-modules/Stock/Indicators/LinearRegression/LinearRegressionIndicator.js","default":4},"children":{}}}}}},"linearregressionangle":{"doclet":{"description":"Linear regression angle indicator. This series requires `linkedTo`\noption to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `linearregressionangle` series are defined in\n   [plotOptions.linearregressionangle](plotOptions.linearregressionangle).\n3. Options for one single series are given in\n   [the series instance array](series.linearregressionangle).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        linearregressionangle: {\n            // shared options for all linearregressionangle series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'linearregressionangle'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.linearregressionangle.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === linearregressionangle) {\n    // code specific to the linearregressionangle series\n}\n```\n            ","samples":[{"name":"Linear intercept angle indicator","value":"stock/indicators/linear-regression-angle","products":["highstock"]}],"extends":"plotOptions.linearregression","since":"7.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/regressions"]},"meta":{"filename":"code/es-modules/Stock/Indicators/LinearRegressionAngle/LinearRegressionAngleIndicator.js","name":"linearregressionangle","fullname":"plotOptions.linearregressionangle","line":50,"lineEnd":54,"column":0},"children":{"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.linearregressionangle.tooltip","name":"tooltip","line":70,"lineEnd":70,"column":4,"filename":"code/es-modules/Stock/Indicators/LinearRegressionAngle/LinearRegressionAngleIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span>{series.name}: <b>{point.y}°</b><br/>"},"meta":{"fullname":"plotOptions.linearregressionangle.tooltip.pointFormat","name":"pointFormat","line":71,"lineEnd":71,"column":8,"filename":"code/es-modules/Stock/Indicators/LinearRegressionAngle/LinearRegressionAngleIndicator.js","default":"<span style=\"color:{point.color}\">●</span>{series.name}: <b>{point.y}°</b><br/>"},"children":{}}}}}},"linearregressionintercept":{"doclet":{"description":"Linear regression intercept indicator. This series requires `linkedTo`\noption to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `linearregressionintercept` series are defined in\n   [plotOptions.linearregressionintercept](plotOptions.linearregressionintercept).\n3. Options for one single series are given in\n   [the series instance array](series.linearregressionintercept).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        linearregressionintercept: {\n            // shared options for all linearregressionintercept series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'linearregressionintercept'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.linearregressionintercept.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === linearregressionintercept) {\n    // code specific to the linearregressionintercept series\n}\n```\n            ","samples":[{"name":"Linear intercept slope indicator","value":"stock/indicators/linear-regression-intercept","products":["highstock"]}],"extends":"plotOptions.linearregression","since":"7.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/regressions"]},"meta":{"filename":"code/es-modules/Stock/Indicators/LinearRegressionIntercept/LinearRegressionInterceptIndicator.js","name":"linearregressionintercept","fullname":"plotOptions.linearregressionintercept","line":40,"lineEnd":44,"column":0},"children":{}},"linearregressionslope":{"doclet":{"description":"Linear regression slope indicator. This series requires `linkedTo`\noption to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `linearregressionslope` series are defined in\n   [plotOptions.linearregressionslope](plotOptions.linearregressionslope).\n3. Options for one single series are given in\n   [the series instance array](series.linearregressionslope).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        linearregressionslope: {\n            // shared options for all linearregressionslope series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'linearregressionslope'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.linearregressionslope.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === linearregressionslope) {\n    // code specific to the linearregressionslope series\n}\n```\n            ","samples":[{"name":"Linear regression slope indicator","value":"stock/indicators/linear-regression-slope","products":["highstock"]}],"extends":"plotOptions.linearregression","since":"7.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/regressions"]},"meta":{"filename":"code/es-modules/Stock/Indicators/LinearRegressionSlopes/LinearRegressionSlopesIndicator.js","name":"linearregressionslope","fullname":"plotOptions.linearregressionslope","line":40,"lineEnd":44,"column":0},"children":{}},"lollipop":{"doclet":{"description":"The lollipop series is a cartesian series with a line anchored from\nthe x axis and a dot at the end to mark the value.\nRequires `highcharts-more.js`, `modules/dumbbell.js` and\n`modules/lollipop.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `lollipop` series are defined in\n   [plotOptions.lollipop](plotOptions.lollipop).\n3. Options for one single series are given in\n   [the series instance array](series.lollipop).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        lollipop: {\n            // shared options for all lollipop series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'lollipop'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.lollipop.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === lollipop) {\n    // code specific to the lollipop series\n}\n```\n            ","samples":[{"name":"Lollipop chart","value":"highcharts/demo/lollipop/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/series-dumbbell/styled-mode-dumbbell/","products":["highcharts"]}],"extends":"plotOptions.dumbbell","products":["highcharts","highstock"],"exclude":["fillColor","fillOpacity","lineWidth","stack","stacking","lowColor","stickyTracking","trackByArea"],"since":"8.0.0"},"meta":{"filename":"code/es-modules/Series/Lollipop/LollipopSeries.js","name":"lollipop","fullname":"plotOptions.lollipop","line":73,"lineEnd":77,"column":0},"children":{"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.lollipop.dataLabels","name":"dataLabels","line":134,"lineEnd":134,"column":4,"filename":"code/es-modules/Series/Lollipop/LollipopSeries.js"},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.lollipop.dataLabels.align","name":"align","line":135,"lineEnd":135,"column":8,"filename":"code/es-modules/Series/Lollipop/LollipopSeries.js","default":"undefined"},"children":{}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.lollipop.dataLabels.verticalAlign","name":"verticalAlign","line":136,"lineEnd":136,"column":8,"filename":"code/es-modules/Series/Lollipop/LollipopSeries.js","default":"undefined"},"children":{}}}},"grouping":{"doclet":{"description":"Whether to group non-stacked lollipop points or to let them\nrender independent of each other. Non-grouped lollipop points\nwill be laid out individually and overlap each other.","samples":[{"name":"Multiple lollipop series with grouping","value":"highcharts/series-lollipop/enabled-grouping/"},{"name":"Multiple lollipop series with disabled grouping","value":"highcharts/series-lollipop/disabled-grouping/"}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"8.0.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.lollipop.grouping","name":"grouping","line":103,"lineEnd":118,"filename":"code/es-modules/Series/Lollipop/LollipopSeries.js"},"children":{}},"pointRange":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.lollipop.pointRange","name":"pointRange","line":138,"lineEnd":138,"column":4,"filename":"code/es-modules/Series/Lollipop/LollipopSeries.js","default":1},"children":{}}}},"macd":{"doclet":{"description":"Moving Average Convergence Divergence (MACD). This series requires\n`linkedTo` option to be set and should be loaded after the\n`stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `macd` series are defined in\n   [plotOptions.macd](plotOptions.macd).\n3. Options for one single series are given in\n   [the series instance array](series.macd).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        macd: {\n            // shared options for all macd series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'macd'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.macd.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === macd) {\n    // code specific to the macd series\n}\n```\n            ","samples":[{"name":"MACD indicator","value":"stock/indicators/macd"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/macd"]},"meta":{"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","name":"macd","fullname":"plotOptions.macd","line":225,"lineEnd":229,"column":0},"children":{"crisp":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.macd.crisp","name":"crisp","line":315,"lineEnd":315,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":false},"children":{}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.macd.dataGrouping","name":"dataGrouping","line":329,"lineEnd":329,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.macd.dataGrouping.approximation","name":"approximation","line":330,"lineEnd":330,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":"averages"},"children":{}}}},"groupPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.macd.groupPadding","name":"groupPadding","line":313,"lineEnd":313,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":0.1},"children":{}},"macdLine":{"doclet":{"description":"The styles for macd line","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.macd.macdLine","name":"macdLine","line":285,"lineEnd":287,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.macd.macdLine.styles","name":"styles","line":296,"lineEnd":296,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.macd.macdLine.styles.lineColor","name":"lineColor","line":301,"lineEnd":305,"column":12,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.macd.macdLine.styles.lineWidth","name":"lineWidth","line":297,"lineEnd":299,"column":12,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":1},"children":{}}}},"zones":{"doclet":{"samples":[{"name":"Zones in MACD","value":"stock/indicators/macd-zones"}],"extends":"plotOptions.macd.zones"},"meta":{"fullname":"plotOptions.macd.macdLine.zones","name":"zones","line":289,"lineEnd":294,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{}}}},"minPointLength":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.macd.minPointLength","name":"minPointLength","line":332,"lineEnd":332,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":0},"children":{}},"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.macd.params","name":"params","line":246,"lineEnd":246,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{"longPeriod":{"doclet":{"description":"The long period for indicator calculations.","type":{"names":["number"]},"defaultvalue":26},"meta":{"fullname":"plotOptions.macd.params.longPeriod","name":"longPeriod","line":251,"lineEnd":253,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":26},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":26},"meta":{"fullname":"plotOptions.macd.params.period","name":"period","line":259,"lineEnd":259,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":26},"children":{}},"shortPeriod":{"doclet":{"description":"The short period for indicator calculations.","type":{"names":["number"]},"defaultvalue":12},"meta":{"fullname":"plotOptions.macd.params.shortPeriod","name":"shortPeriod","line":247,"lineEnd":249,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":12},"children":{}},"signalPeriod":{"doclet":{"description":"The base period for signal calculations.","type":{"names":["number"]},"defaultvalue":9},"meta":{"fullname":"plotOptions.macd.params.signalPeriod","name":"signalPeriod","line":255,"lineEnd":257,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":9},"children":{}}}},"pointPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.macd.pointPadding","name":"pointPadding","line":314,"lineEnd":314,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":0.1},"children":{}},"signalLine":{"doclet":{"description":"The styles for signal line","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.macd.signalLine","name":"signalLine","line":261,"lineEnd":263,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.macd.signalLine.styles","name":"styles","line":272,"lineEnd":272,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.macd.signalLine.styles.lineColor","name":"lineColor","line":277,"lineEnd":281,"column":12,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.macd.signalLine.styles.lineWidth","name":"lineWidth","line":273,"lineEnd":275,"column":12,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":1},"children":{}}}},"zones":{"doclet":{"samples":[{"name":"Zones in MACD","value":"stock/indicators/macd-zones"}],"extends":"plotOptions.macd.zones"},"meta":{"fullname":"plotOptions.macd.signalLine.zones","name":"zones","line":265,"lineEnd":270,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{}}}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.macd.states","name":"states","line":316,"lineEnd":316,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.macd.states.hover","name":"hover","line":317,"lineEnd":317,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{"halo":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.macd.states.hover.halo","name":"halo","line":318,"lineEnd":318,"column":12,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{"size":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.macd.states.hover.halo.size","name":"size","line":319,"lineEnd":319,"column":16,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":0},"children":{}}}}}}}},"threshold":{"doclet":{"type":{"names":["number","null"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.macd.threshold","name":"threshold","line":309,"lineEnd":311,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":0},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.macd.tooltip","name":"tooltip","line":323,"lineEnd":323,"column":4,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> <b> {series.name}</b><br/>Value: {point.MACD}<br/>Signal: {point.signal}<br/>Histogram: {point.y}<br/>"},"meta":{"fullname":"plotOptions.macd.tooltip.pointFormat","name":"pointFormat","line":324,"lineEnd":324,"column":8,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js","default":"<span style=\"color:{point.color}\">●</span> <b> {series.name}</b><br/>Value: {point.MACD}<br/>Signal: {point.signal}<br/>Histogram: {point.y}<br/>"},"children":{}}}}}},"map":{"doclet":{"description":"The map series is used for basic choropleth maps, where each map area has\na color based on its value.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `map` series are defined in\n   [plotOptions.map](plotOptions.map).\n3. Options for one single series are given in\n   [the series instance array](series.map).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        map: {\n            // shared options for all map series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'map'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.map.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === map) {\n    // code specific to the map series\n}\n```\n            ","samples":[{"name":"Choropleth map","value":"maps/demo/all-maps/"}],"extends":"plotOptions.scatter","exclude":["boostBlending","boostThreshold","dragDrop","cluster","marker"],"products":["highmaps"]},"meta":{"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","name":"map","fullname":"plotOptions.map","line":13,"lineEnd":17,"column":0},"children":{"affectsMapView":{"doclet":{"description":"Whether the MapView takes this series into account when computing the\ndefault zoom and center of the map.","samples":[{"name":"US map with world map backdrop","value":"maps/series/affectsmapview/"}],"since":"10.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.map.affectsMapView","name":"affectsMapView","line":33,"lineEnd":43,"column":4,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":true},"children":{}},"allAreas":{"doclet":{"description":"Whether all areas of the map defined in `mapData` should be rendered.\nIf `true`, areas which don't correspond to a data point, are rendered\nas `null` points. If `false`, those areas are skipped.","samples":[{"name":"All areas set to false","value":"maps/plotoptions/series-allareas-false/"}],"type":{"names":["boolean"]},"defaultvalue":"true","products":["highmaps"]},"meta":{"fullname":"plotOptions.map.allAreas","name":"allAreas","line":113,"lineEnd":126,"column":4,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":true},"children":{}},"animation":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.map.animation","name":"animation","line":45,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":false},"children":{}},"colorByPoint":{"doclet":{"description":"When using automatic point colors pulled from the global\n[colors](colors) or series-specific\n[plotOptions.map.colors](series.colors) collections, this option\ndetermines whether the chart should receive one color per series or\none color per point.\n\nIn styled mode, the `colors` or `series.colors` arrays are not\nsupported, and instead this option gives the points individual color\nclass names on the form `highcharts-color-{n}`.","see":["[series colors](#plotOptions.map.colors)"],"samples":[{"name":"Mapline colorByPoint set to false by default","value":"maps/plotoptions/mapline-colorbypoint-false/","products":["highmaps"]},{"name":"Mapline colorByPoint set to true","value":"maps/plotoptions/mapline-colorbypoint-true/","products":["highmaps"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"2.0.0","products":["highmaps"]},"meta":{"fullname":"plotOptions.map.colorByPoint","name":"colorByPoint","line":351,"lineEnd":374,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"colorKey":{"doclet":{"type":{"names":["string"]},"defaultvalue":"value"},"meta":{"fullname":"plotOptions.map.colorKey","name":"colorKey","line":162,"lineEnd":166,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"colors":{"doclet":{"description":"A series specific or series type specific color set to apply instead\nof the global [colors](#colors) when [colorByPoint](#plotOptions.map.colorByPoint) is true.","type":{"names":["Array.<Highcharts.ColorType>"]},"since":"3.0.0","products":["highmaps"]},"meta":{"fullname":"plotOptions.map.colors","name":"colors","line":375,"lineEnd":384,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.map.dataLabels","name":"dataLabels","line":45,"lineEnd":45,"column":22,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{"crop":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.map.dataLabels.crop","name":"crop","line":47,"lineEnd":47,"column":8,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":false},"children":{}},"inside":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.map.dataLabels.inside","name":"inside","line":55,"lineEnd":55,"column":8,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":true},"children":{}},"overflow":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.map.dataLabels.overflow","name":"overflow","line":55,"lineEnd":55,"column":22,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":false},"children":{}},"padding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.map.dataLabels.padding","name":"padding","line":57,"lineEnd":57,"column":8,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":0},"children":{}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"middle"},"meta":{"fullname":"plotOptions.map.dataLabels.verticalAlign","name":"verticalAlign","line":58,"lineEnd":58,"column":8,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":"middle"},"children":{}}}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rectangle"},"meta":{"fullname":"plotOptions.map.legendSymbol","name":"legendSymbol","line":283,"lineEnd":283,"column":4,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":"rectangle"},"children":{}},"linecap":{"doclet":{"productdesc":[{"value":"The SVG value used for the `stroke-linecap` and `stroke-linejoin` of\nthe map borders. Round means that borders are rounded in the ends and\nbends.","products":["highmaps"]}],"samples":[{"name":"Backdrop coastline with round linecap","value":"maps/demo/mappoint-mapmarker/","products":["highmaps"]}],"since":"10.3.3","type":{"names":["string"]},"defaultvalue":"round"},"meta":{"fullname":"plotOptions.map.linecap","name":"linecap","line":60,"lineEnd":70,"column":4,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":"round"},"children":{}},"nullColor":{"doclet":{"description":"The color to apply to null points.\n\nIn styled mode, the null point fill is set in the\n`.highcharts-null-point` class.","samples":[{"name":"Null color","value":"maps/demo/all-areas-as-null/"}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#f7f7f7"},"meta":{"fullname":"plotOptions.map.nullColor","name":"nullColor","line":78,"lineEnd":90,"column":4,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":"#f7f7f7"},"children":{}},"nullInteraction":{"doclet":{"description":"Whether to allow pointer interaction like tooltips and mouse events\non null points.","type":{"names":["boolean"]},"since":"4.2.7"},"meta":{"fullname":"plotOptions.map.nullInteraction","name":"nullInteraction","line":92,"lineEnd":101,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.map.states","name":"states","line":198,"lineEnd":204,"column":4,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{"normal":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.map.states.normal","name":"normal","line":253,"lineEnd":255,"column":8,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{"animation":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.map.states.normal.animation","name":"animation","line":257,"lineEnd":267,"column":12,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":true},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.map.tooltip","name":"tooltip","line":103,"lineEnd":103,"column":4,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{"followPointer":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.map.tooltip.followPointer","name":"followPointer","line":104,"lineEnd":104,"column":8,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":true},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{point.name}: {point.value}<br/>"},"meta":{"fullname":"plotOptions.map.tooltip.pointFormat","name":"pointFormat","line":105,"lineEnd":105,"column":8,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js","default":"{point.name}: {point.value}<br/>"},"children":{}}}}}},"mapbubble":{"doclet":{"description":"A map bubble series is a bubble series laid out on top of a map\nseries, where each bubble is tied to a specific map area.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `mapbubble` series are defined in\n   [plotOptions.mapbubble](plotOptions.mapbubble).\n3. Options for one single series are given in\n   [the series instance array](series.mapbubble).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        mapbubble: {\n            // shared options for all mapbubble series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'mapbubble'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.mapbubble.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === mapbubble) {\n    // code specific to the mapbubble series\n}\n```\n            ","samples":[{"name":"Map bubble chart","value":"maps/demo/map-bubble/"}],"extends":"plotOptions.bubble","products":["highmaps"]},"meta":{"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js","name":"mapbubble","fullname":"plotOptions.mapbubble","line":54,"lineEnd":64,"column":0},"children":{"animationLimit":{"doclet":{"defaultvalue":"500","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.mapbubble.animationLimit","name":"animationLimit","line":117,"lineEnd":130,"column":4,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js","default":500},"children":{}},"color":{"doclet":{"description":"The main color of the series. This color affects both the fill\nand the stroke of the bubble. For enhanced control, use `marker`\noptions.","samples":[{"name":"Pink bubbles","value":"maps/plotoptions/mapbubble-color/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.mapbubble.color","name":"color","line":66,"lineEnd":76,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}},"displayNegative":{"doclet":{"description":"Whether to display negative sized bubbles. The threshold is\ngiven by the [zThreshold](#plotOptions.mapbubble.zThreshold)\noption, and negative bubbles can be visualized by setting\n[negativeColor](#plotOptions.bubble.negativeColor).","type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"plotOptions.mapbubble.displayNegative","name":"displayNegative","line":77,"lineEnd":86,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}},"joinBy":{"doclet":{"type":{"names":["string","Array.<string>"]},"defaultvalue":"hc-key"},"meta":{"fullname":"plotOptions.mapbubble.joinBy","name":"joinBy","line":224,"lineEnd":226,"column":4,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js","default":"hc-key"},"children":{}},"lineColor":{"doclet":{"description":"Color of the line connecting bubbles. The default value is the same\nas series' color.\n\nIn styled mode, the color can be defined by the\n[colorIndex](#plotOptions.series.colorIndex) option. Also, the series\ncolor can be set with the `.highcharts-series`,\n`.highcharts-color-{n}`, `.highcharts-{type}-series` or\n`.highcharts-series-{n}` class, or individual classes given by the\n`className` option.","samples":[{"name":"Spider map","value":"maps/demo/spider-map/","products":["highmaps"]},{"name":"Different line color","value":"maps/plotoptions/spider-map-line-color/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.mapbubble.lineColor","name":"lineColor","line":87,"lineEnd":106,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line connecting bubbles.","samples":[{"name":"Spider map","value":"maps/demo/spider-map/","products":["highmaps"]}],"products":["highmaps"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.mapbubble.lineWidth","name":"lineWidth","line":66,"lineEnd":76,"column":4,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js","default":0},"children":{}},"maxSize":{"doclet":{"description":"Maximum bubble size. Bubbles will automatically size between the\n`minSize` and `maxSize` to reflect the `z` value of each bubble.\nCan be either pixels (when no unit is given), or a percentage of\nthe smallest one of the plot width and height.","samples":[{"name":"Bubble size","value":"highcharts/plotoptions/bubble-size/","products":["highmaps"]},{"name":"Spider map","value":"maps/demo/spider-map/","products":["highmaps"]}],"products":["highmaps"]},"meta":{"fullname":"plotOptions.mapbubble.maxSize","name":"maxSize","line":117,"lineEnd":130,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}},"minSize":{"doclet":{"description":"Minimum bubble size. Bubbles will automatically size between the\n`minSize` and `maxSize` to reflect the `z` value of each bubble.\nCan be either pixels (when no unit is given), or a percentage of\nthe smallest one of the plot width and height.","samples":[{"name":"Bubble size","value":"maps/demo/map-bubble/","products":["highmaps"]},{"name":"Spider map","value":"maps/demo/spider-map/","products":["highmaps"]}],"products":["highmaps"]},"meta":{"fullname":"plotOptions.mapbubble.minSize","name":"minSize","line":131,"lineEnd":144,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}},"negativeColor":{"doclet":{"description":"When a point's Z value is below the\n[zThreshold](#plotOptions.mapbubble.zThreshold) setting, this\ncolor is used.","samples":[{"name":"Negative color below a threshold","value":"maps/plotoptions/mapbubble-negativecolor/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.mapbubble.negativeColor","name":"negativeColor","line":145,"lineEnd":155,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}},"sizeBy":{"doclet":{"description":"Whether the bubble's value should be represented by the area or\nthe width of the bubble. The default, `area`, corresponds best to\nthe human perception of the size of each bubble.","type":{"names":["Highcharts.BubbleSizeByValue"]},"defaultvalue":"area"},"meta":{"fullname":"plotOptions.mapbubble.sizeBy","name":"sizeBy","line":156,"lineEnd":164,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}},"sizeByAbsoluteValue":{"doclet":{"description":"When this is true, the absolute value of z determines the size\nof the bubble. This means that with the default `zThreshold` of\n0, a bubble of value -1 will have the same size as a bubble of\nvalue 1, while a bubble of value 0 will have a smaller size\naccording to `minSize`.","samples":[{"name":"Size by absolute value, various thresholds","value":"highcharts/plotoptions/bubble-sizebyabsolutevalue/","products":["highmaps"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"1.1.9"},"meta":{"fullname":"plotOptions.mapbubble.sizeByAbsoluteValue","name":"sizeByAbsoluteValue","line":165,"lineEnd":179,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}},"stickyTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.mapbubble.stickyTracking","name":"stickyTracking","line":231,"lineEnd":231,"column":4,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js","default":true},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.mapbubble.tooltip","name":"tooltip","line":228,"lineEnd":228,"column":4,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{point.name}: {point.z}"},"meta":{"fullname":"plotOptions.mapbubble.tooltip.pointFormat","name":"pointFormat","line":229,"lineEnd":229,"column":8,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js","default":"{point.name}: {point.z}"},"children":{}}}},"zMax":{"doclet":{"description":"The maximum for the Z value range. Defaults to the highest Z value in\nthe data.","see":["[zMin](#plotOptions.mapbubble.zMin)"],"samples":[{"name":"Z has a possible range of 0-100","value":"highcharts/plotoptions/bubble-zmin-zmax/","products":["highmaps"]}],"type":{"names":["number"]},"since":"1.0.3"},"meta":{"fullname":"plotOptions.mapbubble.zMax","name":"zMax","line":180,"lineEnd":192,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}},"zMin":{"doclet":{"description":"The minimum for the Z value range. Defaults to the lowest Z value\nin the data.","see":["[zMax](#plotOptions.mapbubble.zMax)"],"samples":[{"name":"Z has a possible range of 0-100","value":"highcharts/plotoptions/bubble-zmin-zmax/","products":["highmaps"]}],"type":{"names":["number"]},"since":"1.0.3"},"meta":{"fullname":"plotOptions.mapbubble.zMin","name":"zMin","line":193,"lineEnd":205,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}},"zThreshold":{"doclet":{"description":"When [displayNegative](#plotOptions.mapbubble.displayNegative)\nis `false`, bubbles with lower Z values are skipped. When\n`displayNegative` is `true` and a\n[negativeColor](#plotOptions.mapbubble.negativeColor) is given,\npoints with lower Z is colored.","samples":[{"name":"Negative color below a threshold","value":"maps/plotoptions/mapbubble-negativecolor/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"plotOptions.mapbubble.zThreshold","name":"zThreshold","line":206,"lineEnd":219,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}}}},"mapline":{"doclet":{"description":"A mapline series is a special case of the map series where the value\ncolors are applied to the strokes rather than the fills. It can also be\nused for freeform drawing, like dividers, in the map.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `mapline` series are defined in\n   [plotOptions.mapline](plotOptions.mapline).\n3. Options for one single series are given in\n   [the series instance array](series.mapline).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        mapline: {\n            // shared options for all mapline series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'mapline'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.mapline.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === mapline) {\n    // code specific to the mapline series\n}\n```\n            ","samples":[{"name":"Mapline and map-point chart","value":"maps/demo/mapline-mappoint/"},{"name":"Mapline with CSS keyframe animation","value":"maps/demo/animated-mapline/"},{"name":"Flight routes","value":"maps/demo/flight-routes"}],"extends":"plotOptions.map","exclude":["dragDrop"],"products":["highmaps"]},"meta":{"filename":"code/es-modules/Series/MapLine/MapLineSeriesDefaults.js","name":"mapline","fullname":"plotOptions.mapline","line":12,"lineEnd":16,"column":0},"children":{"fillColor":{"doclet":{"description":"Fill color for the map line shapes","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"none"},"meta":{"fullname":"plotOptions.mapline.fillColor","name":"fillColor","line":45,"lineEnd":49,"column":4,"filename":"code/es-modules/Series/MapLine/MapLineSeriesDefaults.js","default":"none"},"children":{}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"lineMarker"},"meta":{"fullname":"plotOptions.mapline.legendSymbol","name":"legendSymbol","line":51,"lineEnd":51,"column":4,"filename":"code/es-modules/Series/MapLine/MapLineSeriesDefaults.js","default":"lineMarker"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the mapline line.","type":{"names":["number"]},"since":"10.3.3","products":["highmaps"],"defaultvalue":"1"},"meta":{"fullname":"plotOptions.mapline.lineWidth","name":"lineWidth","line":35,"lineEnd":43,"filename":"code/es-modules/Series/MapLine/MapLineSeriesDefaults.js"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"hover":{"doclet":{"type":{"names":["number"]},"products":["highmaps"],"exclude":["borderWidth"]},"meta":{"fullname":"plotOptions.mapline.states.hover","name":"hover","line":130,"lineEnd":136,"filename":"code/es-modules/Series/MapLine/MapLineSeriesDefaults.js"},"children":{"lineWidth":{"doclet":{"description":"Pixel width of the mapline line.","type":{"names":["number"]},"since":"10.2.0","products":["highmaps"]},"meta":{"fullname":"plotOptions.mapline.states.hover.lineWidth","name":"lineWidth","line":114,"lineEnd":121,"filename":"code/es-modules/Series/MapLine/MapLineSeriesDefaults.js"},"children":{}}}}}}}},"mappoint":{"doclet":{"description":"A mappoint series is a special form of scatter series where the points\ncan be laid out in map coordinates on top of a map.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `mappoint` series are defined in\n   [plotOptions.mappoint](plotOptions.mappoint).\n3. Options for one single series are given in\n   [the series instance array](series.mappoint).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        mappoint: {\n            // shared options for all mappoint series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'mappoint'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.mappoint.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === mappoint) {\n    // code specific to the mappoint series\n}\n```\n            ","samples":[{"name":"Map-line and map-point series.","value":"maps/demo/mapline-mappoint/"},{"name":"Using the mapmarker symbol for points","value":"maps/demo/mappoint-mapmarker"},{"name":"Using the mapmarker shape for data labels","value":"maps/demo/mappoint-datalabels-mapmarker"}],"extends":"plotOptions.scatter","products":["highmaps"],"type":{"names":["number"]},"exclude":["borderColor","borderWidth"]},"meta":{"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js","name":"mappoint","fullname":"plotOptions.mappoint","line":12,"lineEnd":16,"column":0},"children":{"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.mappoint.dataLabels","name":"dataLabels","line":33,"lineEnd":33,"column":4,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{"crop":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.mappoint.dataLabels.crop","name":"crop","line":34,"lineEnd":34,"column":8,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js","default":false},"children":{}},"defer":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.mappoint.dataLabels.defer","name":"defer","line":35,"lineEnd":35,"column":8,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js","default":false},"children":{}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.mappoint.dataLabels.enabled","name":"enabled","line":36,"lineEnd":36,"column":8,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js","default":true},"children":{}},"overflow":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.mappoint.dataLabels.overflow","name":"overflow","line":40,"lineEnd":40,"column":8,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js","default":false},"children":{}}}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"lineMarker"},"meta":{"fullname":"plotOptions.mappoint.legendSymbol","name":"legendSymbol","line":46,"lineEnd":46,"column":4,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js","default":"lineMarker"},"children":{}},"stickyTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.mappoint.stickyTracking","name":"stickyTracking","line":47,"lineEnd":47,"column":4,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js","default":true},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.mappoint.tooltip","name":"tooltip","line":48,"lineEnd":48,"column":4,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{#if point.name}{point.name}{else}Lat: {point.lat}, Lon: {point.lon}{/if}"},"meta":{"fullname":"plotOptions.mappoint.tooltip.pointFormat","name":"pointFormat","line":49,"lineEnd":49,"column":8,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js","default":"{#if point.name}{point.name}{else}Lat: {point.lat}, Lon: {point.lon}{/if}"},"children":{}}}}}},"mfi":{"doclet":{"description":"Money Flow Index. This series requires `linkedTo` option to be set and\nshould be loaded after the `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `mfi` series are defined in\n   [plotOptions.mfi](plotOptions.mfi).\n3. Options for one single series are given in\n   [the series instance array](series.mfi).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        mfi: {\n            // shared options for all mfi series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'mfi'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.mfi.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === mfi) {\n    // code specific to the mfi series\n}\n```\n            ","samples":[{"name":"Money Flow Index Indicator","value":"stock/indicators/mfi"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/mfi"]},"meta":{"filename":"code/es-modules/Stock/Indicators/MFI/MFIIndicator.js","name":"mfi","fullname":"plotOptions.mfi","line":134,"lineEnd":138,"column":0},"children":{"params":{"doclet":{"exclude":["index"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.mfi.params","name":"params","line":154,"lineEnd":156,"column":4,"filename":"code/es-modules/Stock/Indicators/MFI/MFIIndicator.js"},"children":{"decimals":{"doclet":{"description":"Number of maximum decimals that are used in MFI calculations.","type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"plotOptions.mfi.params.decimals","name":"decimals","line":165,"lineEnd":167,"column":8,"filename":"code/es-modules/Stock/Indicators/MFI/MFIIndicator.js","default":4},"children":{}},"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.mfi.params.index","name":"index","line":158,"lineEnd":158,"column":8,"filename":"code/es-modules/Stock/Indicators/MFI/MFIIndicator.js","default":"undefined"},"children":{}},"volumeSeriesID":{"doclet":{"description":"The id of volume series which is mandatory.\nFor example using OHLC data, volumeSeriesID='volume' means\nthe indicator will be calculated using OHLC and volume values.","type":{"names":["string"]},"defaultvalue":"volume"},"meta":{"fullname":"plotOptions.mfi.params.volumeSeriesID","name":"volumeSeriesID","line":158,"lineEnd":158,"column":23,"filename":"code/es-modules/Stock/Indicators/MFI/MFIIndicator.js","default":"volume"},"children":{}}}}}},"momentum":{"doclet":{"description":"Momentum. This series requires `linkedTo` option to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `momentum` series are defined in\n   [plotOptions.momentum](plotOptions.momentum).\n3. Options for one single series are given in\n   [the series instance array](series.momentum).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        momentum: {\n            // shared options for all momentum series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'momentum'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.momentum.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === momentum) {\n    // code specific to the momentum series\n}\n```\n            ","samples":[{"name":"Momentum indicator","value":"stock/indicators/momentum"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/momentum"]},"meta":{"filename":"code/es-modules/Stock/Indicators/Momentum/MomentumIndicator.js","name":"momentum","fullname":"plotOptions.momentum","line":72,"lineEnd":76,"column":0},"children":{"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.momentum.params","name":"params","line":91,"lineEnd":91,"column":4,"filename":"code/es-modules/Stock/Indicators/Momentum/MomentumIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.momentum.params.index","name":"index","line":92,"lineEnd":92,"column":8,"filename":"code/es-modules/Stock/Indicators/Momentum/MomentumIndicator.js","default":3},"children":{}}}}}},"natr":{"doclet":{"description":"Normalized average true range indicator (NATR). This series requires\n`linkedTo` option to be set and should be loaded after the\n`stock/indicators/indicators.js` and `stock/indicators/atr.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `natr` series are defined in\n   [plotOptions.natr](plotOptions.natr).\n3. Options for one single series are given in\n   [the series instance array](series.natr).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        natr: {\n            // shared options for all natr series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'natr'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.natr.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === natr) {\n    // code specific to the natr series\n}\n```\n            ","samples":[{"name":"NATR indicator","value":"stock/indicators/natr","products":["highstock"]}],"extends":"plotOptions.atr","since":"7.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/natr"]},"meta":{"filename":"code/es-modules/Stock/Indicators/NATR/NATRIndicator.js","name":"natr","fullname":"plotOptions.natr","line":46,"lineEnd":50,"column":0},"children":{"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.natr.tooltip","name":"tooltip","line":67,"lineEnd":67,"column":4,"filename":"code/es-modules/Stock/Indicators/NATR/NATRIndicator.js"},"children":{"valueSuffix":{"doclet":{"type":{"names":["string"]},"defaultvalue":"%"},"meta":{"fullname":"plotOptions.natr.tooltip.valueSuffix","name":"valueSuffix","line":68,"lineEnd":68,"column":8,"filename":"code/es-modules/Stock/Indicators/NATR/NATRIndicator.js","default":"%"},"children":{}}}}}},"networkgraph":{"doclet":{"description":"A networkgraph is a type of relationship chart, where connections\n(links) attracts nodes (points) and other nodes repulse each other.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `networkgraph` series are defined in\n   [plotOptions.networkgraph](plotOptions.networkgraph).\n3. Options for one single series are given in\n   [the series instance array](series.networkgraph).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        networkgraph: {\n            // shared options for all networkgraph series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'networkgraph'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.networkgraph.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === networkgraph) {\n    // code specific to the networkgraph series\n}\n```\n            ","extends":"plotOptions.line","products":["highcharts"],"samples":[{"name":"Networkgraph","value":"highcharts/demo/network-graph/"}],"since":"7.0.0","exclude":["boostThreshold","animation","animationLimit","connectEnds","colorAxis","colorKey","connectNulls","cropThreshold","dragDrop","getExtremesFromAll","label","linecap","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointStart","softThreshold","stack","stacking","step","threshold","xAxis","yAxis","zoneAxis","dataSorting","boostBlending"],"requires":["module:modules/networkgraph"]},"meta":{"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","name":"networkgraph","fullname":"plotOptions.networkgraph","line":14,"lineEnd":18,"column":0},"children":{"dataLabels":{"doclet":{"samples":[{"name":"Networkgraph with labels on links","value":"highcharts/series-networkgraph/link-datalabels"},{"name":"Networkgraph with labels around nodes","value":"highcharts/series-networkgraph/textpath-datalabels"},{"name":"Data labels moved into the nodes","value":"highcharts/series-networkgraph/link-datalabels"},{"name":"Data labels moved under the links","value":"highcharts/series-networkgraph/link-datalabels"}],"declare":"Highcharts.SeriesNetworkgraphDataLabelsOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.dataLabels","name":"dataLabels","line":97,"lineEnd":110,"column":4,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"animation":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.animation","name":"animation","line":178,"lineEnd":178,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"defer":{"doclet":{"type":{"names":["number"]},"defaultvalue":1000},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.animation.defer","name":"defer","line":179,"lineEnd":179,"column":12,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":1000},"children":{}}}},"defer":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.defer","name":"defer","line":177,"lineEnd":177,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":true},"children":{}},"format":{"doclet":{"description":"The\n[format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nspecifying what to show for _node_ in the networkgraph. In v7.0\ndefaults to `{key}`, since v7.1 defaults to `undefined` and\n`formatter` is used instead.","type":{"names":["string"]},"since":"7.0.0"},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.format","name":"format","line":112,"lineEnd":122,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"formatter":{"doclet":{"description":"Callback JavaScript function to format the data label for a node.\nNote that if a `format` is defined, the format takes precedence\nand the formatter is ignored.","since":"7.0.0"},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.formatter","name":"formatter","line":112,"lineEnd":122,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"linkFormat":{"doclet":{"description":"The\n[format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nspecifying what to show for _links_ in the networkgraph.\n(Default: `undefined`)","type":{"names":["string"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.linkFormat","name":"linkFormat","line":134,"lineEnd":143,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"linkFormatter":{"doclet":{"description":"Callback to format data labels for _links_ in the sankey diagram.\nThe `linkFormat` option takes precedence over the\n`linkFormatter`.","since":"7.1.0"},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.linkFormatter","name":"linkFormatter","line":134,"lineEnd":143,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"linkTextPath":{"doclet":{"description":"Options for a _link_ label text which should follow link\nconnection. Border and background are disabled for a label that\nfollows a path.\n\n**Note:** Only SVG-based renderer supports this option. Setting\n`useHTML` to true will disable this option.","extends":"plotOptions.networkgraph.dataLabels.textPath","since":"7.1.0"},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.linkTextPath","name":"linkTextPath","line":157,"lineEnd":167,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.linkTextPath.enabled","name":"enabled","line":169,"lineEnd":169,"column":12,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":true},"children":{}}}},"style":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.style","name":"style","line":174,"lineEnd":174,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"transition":{"doclet":{"type":{"names":["string"]},"defaultvalue":"opacity 2000ms"},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.style.transition","name":"transition","line":175,"lineEnd":175,"column":12,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":"opacity 2000ms"},"children":{}}}},"textPath":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.textPath","name":"textPath","line":171,"lineEnd":171,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.networkgraph.dataLabels.textPath.enabled","name":"enabled","line":172,"lineEnd":172,"column":12,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":false},"children":{}}}}}},"draggable":{"doclet":{"description":"Flag to determine if nodes are draggable or not.","since":"7.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.networkgraph.draggable","name":"draggable","line":209,"lineEnd":212,"column":4,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":true},"children":{}},"inactiveOtherPoints":{"doclet":{"defaultvalue":"true","extends":"plotOptions.series.inactiveOtherPoints"},"meta":{"fullname":"plotOptions.networkgraph.inactiveOtherPoints","name":"inactiveOtherPoints","line":42,"lineEnd":46,"column":4,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":true},"children":{}},"layoutAlgorithm":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm","name":"layoutAlgorithm","line":214,"lineEnd":214,"column":4,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"approximation":{"doclet":{"description":"Approximation used to calculate repulsive forces affecting nodes.\nBy default, when calculating net force, nodes are compared\nagainst each other, which gives O(N^2) complexity. Using\nBarnes-Hut approximation, we decrease this to O(N log N), but the\nresulting graph will have different layout. Barnes-Hut\napproximation divides space into rectangles via quad tree, where\nforces exerted on nodes are calculated directly for nearby cells,\nand for all others, cells are treated as a separate node with\ncenter of mass.","see":["[layoutAlgorithm.theta](#series.networkgraph.layoutAlgorithm.theta)"],"samples":[{"name":"A graph with Barnes-Hut approximation","value":"highcharts/series-networkgraph/barnes-hut-approximation/"}],"type":{"names":["\"barnes-hut\"","\"none\""]},"since":"7.1.0","defaultvalue":"none"},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.approximation","name":"approximation","line":326,"lineEnd":345,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":"none"},"children":{}},"attractiveForce":{"doclet":{"description":"Attraction force applied on a node which is connected to another\nnode by a link. Passed are two arguments:\n- `d` - which is current distance between two nodes\n- `k` - which is desired distance between two nodes\n\nIn `verlet` integration, defaults to:\n`function (d, k) { return (k - d) / d; }`","see":["[layoutAlgorithm.integration](#series.networkgraph.layoutAlgorithm.integration)"],"samples":[{"name":"Custom forces with Euler integration","value":"highcharts/series-networkgraph/forces/"},{"name":"Custom forces with Verlet integration","value":"highcharts/series-networkgraph/cuboids/"}],"type":{"names":["function"]},"defaultvalue":"function (d, k) { return k * k / d; }"},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.attractiveForce","name":"attractiveForce","line":234,"lineEnd":253,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"enableSimulation":{"doclet":{"description":"Experimental. Enables live simulation of the algorithm\nimplementation. All nodes are animated as the forces applies on\nthem.","samples":[{"name":"Live simulation enabled","value":"highcharts/demo/network-graph/"}],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.enableSimulation","name":"enableSimulation","line":290,"lineEnd":297,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":false},"children":{}},"friction":{"doclet":{"description":"Friction applied on forces to prevent nodes rushing to fast to\nthe desired positions.","type":{"names":["number"]},"defaultvalue":-0.981},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.friction","name":"friction","line":391,"lineEnd":394,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":-0.981},"children":{}},"gravitationalConstant":{"doclet":{"description":"Gravitational const used in the barycenter force of the\nalgorithm.","samples":[{"name":"Custom forces with Euler integration","value":"highcharts/series-networkgraph/forces/"}],"type":{"names":["number"]},"defaultvalue":0.0625},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.gravitationalConstant","name":"gravitationalConstant","line":383,"lineEnd":389,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":0.0625},"children":{}},"initialPositionRadius":{"doclet":{"description":"When `initialPositions` are set to 'circle',\n`initialPositionRadius` is a distance from the center of circle,\nin which nodes are created.","type":{"names":["number"]},"defaultvalue":"1","since":"7.1.0"},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.initialPositionRadius","name":"initialPositionRadius","line":280,"lineEnd":288,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":1},"children":{}},"initialPositions":{"doclet":{"description":"Initial layout algorithm for positioning nodes. Can be one of\nbuilt-in options (\"circle\", \"random\") or a function where\npositions should be set on each node (`this.nodes`) as\n`node.plotX` and `node.plotY`","samples":[{"name":"Initial positions with callback","value":"highcharts/series-networkgraph/initial-positions/"}],"type":{"names":["\"circle\"","\"random\"","function"]},"defaultvalue":"circle"},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.initialPositions","name":"initialPositions","line":215,"lineEnd":233,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":"circle"},"children":{}},"integration":{"doclet":{"description":"Integration type. Available options are `'euler'` and `'verlet'`.\nIntegration determines how forces are applied on particles. In\nEuler integration, force is applied direct as\n`newPosition += velocity;`.\nIn Verlet integration, new position is based on a previous\nposition without velocity:\n`newPosition += previousPosition - newPosition`.\n\nNote that different integrations give different results as forces\nare different.\n\nIn Highcharts v7.0.x only `'euler'` integration was supported.","samples":[{"name":"Comparison of Verlet and Euler integrations","value":"highcharts/series-networkgraph/integration-comparison/"}],"type":{"names":["\"euler\"","\"verlet\""]},"since":"7.1.0","defaultvalue":"euler"},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.integration","name":"integration","line":354,"lineEnd":374,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":"euler"},"children":{}},"linkLength":{"doclet":{"description":"Ideal length (px) of the link between two nodes. When not\ndefined, length is calculated as:\n`Math.pow(availableWidth * availableHeight / nodesLength, 0.4);`\n\nNote: Because of the algorithm specification, length of each link\nmight be not exactly as specified.","samples":[{"name":"Numerical values","value":"highcharts/series-networkgraph/styled-links/"}],"type":{"names":["number"]}},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.linkLength","name":"linkLength","line":254,"lineEnd":267,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"maxIterations":{"doclet":{"description":"Max number of iterations before algorithm will stop. In general,\nalgorithm should find positions sooner, but when rendering huge\nnumber of nodes, it is recommended to increase this value as\nfinding perfect graph positions can require more time.","type":{"names":["number"]},"defaultvalue":1000},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.maxIterations","name":"maxIterations","line":376,"lineEnd":381,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":1000},"children":{}},"maxSpeed":{"doclet":{"description":"Verlet integration only.\nMax speed that node can get in one iteration. In terms of\nsimulation, it's a maximum translation (in pixels) that node can\nmove (in both, x and y, dimensions). While `friction` is applied\non all nodes, max speed is applied only for nodes that move very\nfast, for example small or disconnected ones.","see":["[layoutAlgorithm.integration](#series.networkgraph.layoutAlgorithm.integration)","[layoutAlgorithm.friction](#series.networkgraph.layoutAlgorithm.friction)"],"since":"7.1.0","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.maxSpeed","name":"maxSpeed","line":312,"lineEnd":324,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":10},"children":{}},"repulsiveForce":{"doclet":{"description":"Repulsive force applied on a node. Passed are two arguments:\n- `d` - which is current distance between two nodes\n- `k` - which is desired distance between two nodes\n\nIn `verlet` integration, defaults to:\n`function (d, k) { return (k - d) / d * (k > d ? 1 : 0) }`","see":["[layoutAlgorithm.integration](#series.networkgraph.layoutAlgorithm.integration)"],"samples":[{"name":"Custom forces with Euler integration","value":"highcharts/series-networkgraph/forces/"},{"name":"Custom forces with Verlet integration","value":"highcharts/series-networkgraph/cuboids/"}],"type":{"names":["function"]},"defaultvalue":"function (d, k) { return k * k / d; }"},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.repulsiveForce","name":"repulsiveForce","line":215,"lineEnd":233,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"theta":{"doclet":{"description":"Barnes-Hut approximation only.\nDetermines when distance between cell and node is small enough\nto calculate forces. Value of `theta` is compared directly with\nquotient `s / d`, where `s` is the size of the cell, and `d` is\ndistance between center of cell's mass and currently compared\nnode.","see":["[layoutAlgorithm.approximation](#series.networkgraph.layoutAlgorithm.approximation)"],"since":"7.1.0","type":{"names":["number"]},"defaultvalue":0.5},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.theta","name":"theta","line":299,"lineEnd":310,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":0.5},"children":{}},"type":{"doclet":{"description":"Type of the algorithm used when positioning nodes.","type":{"names":["\"reingold-fruchterman\""]},"defaultvalue":"reingold-fruchterman"},"meta":{"fullname":"plotOptions.networkgraph.layoutAlgorithm.type","name":"type","line":347,"lineEnd":352,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":"reingold-fruchterman"},"children":{}}}},"link":{"doclet":{"description":"Link style options","since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.link","name":"link","line":182,"lineEnd":185,"column":4,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"color":{"doclet":{"description":"Color of the link between two nodes.","since":"7.0.0","type":{"names":["string"]},"defaultvalue":"rgba(100, 100, 100, 0.5)"},"meta":{"fullname":"plotOptions.networkgraph.link.color","name":"color","line":187,"lineEnd":192,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":"rgba(100, 100, 100, 0.5)"},"children":{}},"dashStyle":{"doclet":{"description":"A name for the dash style to use for links.","type":{"names":["string"]},"since":"7.0.0"},"meta":{"fullname":"plotOptions.networkgraph.link.dashStyle","name":"dashStyle","line":187,"lineEnd":192,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"opacity":{"doclet":{"description":"Opacity of the link between two nodes.","type":{"names":["number"]},"defaultvalue":"1","since":"7.0.0"},"meta":{"fullname":"plotOptions.networkgraph.link.opacity","name":"opacity","line":193,"lineEnd":199,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"width":{"doclet":{"description":"Width (px) of the link between two nodes.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.networkgraph.link.width","name":"width","line":204,"lineEnd":206,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":1},"children":{}}}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.marker","name":"marker","line":48,"lineEnd":48,"column":4,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.networkgraph.marker.enabled","name":"enabled","line":49,"lineEnd":49,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":true},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.marker.states","name":"states","line":50,"lineEnd":50,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"inactive":{"doclet":{"description":"The opposite state of a hover for a single point node.\nApplied to all not connected nodes to the hovered one.","declare":"Highcharts.PointStatesInactiveOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.marker.states.inactive","name":"inactive","line":51,"lineEnd":56,"column":12,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"animation":{"doclet":{"description":"Animation when not hovering over the node.","type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]}},"meta":{"fullname":"plotOptions.networkgraph.marker.states.inactive.animation","name":"animation","line":62,"lineEnd":66,"column":16,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"opacity":{"doclet":{"description":"Opacity of inactive markers.","type":{"names":["number"]},"defaultvalue":0.3},"meta":{"fullname":"plotOptions.networkgraph.marker.states.inactive.opacity","name":"opacity","line":58,"lineEnd":60,"column":16,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":0.3},"children":{}}}}}}}},"showInLegend":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.networkgraph.showInLegend","name":"showInLegend","line":397,"lineEnd":397,"column":4,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":false},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.states","name":"states","line":74,"lineEnd":74,"column":4,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"inactive":{"doclet":{"description":"The opposite state of a hover for a single point link. Applied\nto all links that are not coming from the hovered node.","declare":"Highcharts.SeriesStatesInactiveOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.networkgraph.states.inactive","name":"inactive","line":75,"lineEnd":80,"column":8,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"animation":{"doclet":{"description":"Animation when not hovering over the node.","type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]}},"meta":{"fullname":"plotOptions.networkgraph.states.inactive.animation","name":"animation","line":86,"lineEnd":90,"column":12,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"linkOpacity":{"doclet":{"description":"Opacity of inactive links.","type":{"names":["number"]},"defaultvalue":0.3},"meta":{"fullname":"plotOptions.networkgraph.states.inactive.linkOpacity","name":"linkOpacity","line":82,"lineEnd":84,"column":12,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":0.3},"children":{}}}}}},"stickyTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.networkgraph.stickyTracking","name":"stickyTracking","line":41,"lineEnd":41,"column":4,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js","default":false},"children":{}}}},"obv":{"doclet":{"description":"On-Balance Volume (OBV) technical indicator. This series\nrequires the `linkedTo` option to be set and should be loaded after\nthe `stock/indicators/indicators.js` file. Through the `volumeSeriesID`\nthere also should be linked the volume series.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `obv` series are defined in\n   [plotOptions.obv](plotOptions.obv).\n3. Options for one single series are given in\n   [the series instance array](series.obv).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        obv: {\n            // shared options for all obv series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'obv'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.obv.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === obv) {\n    // code specific to the obv series\n}\n```\n            ","samples":[{"name":"OBV indicator","value":"stock/indicators/obv"}],"extends":"plotOptions.sma","since":"9.1.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/obv"],"exclude":["allAreas","colorAxis","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"]},"meta":{"filename":"code/es-modules/Stock/Indicators/OBV/OBVIndicator.js","name":"obv","fullname":"plotOptions.obv","line":81,"lineEnd":85,"column":0},"children":{"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.obv.marker","name":"marker","line":106,"lineEnd":106,"column":4,"filename":"code/es-modules/Stock/Indicators/OBV/OBVIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.obv.marker.enabled","name":"enabled","line":107,"lineEnd":107,"column":8,"filename":"code/es-modules/Stock/Indicators/OBV/OBVIndicator.js","default":false},"children":{}}}},"params":{"doclet":{"exclude":["index","period"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.obv.params","name":"params","line":109,"lineEnd":111,"column":4,"filename":"code/es-modules/Stock/Indicators/OBV/OBVIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.obv.params.index","name":"index","line":113,"lineEnd":113,"column":8,"filename":"code/es-modules/Stock/Indicators/OBV/OBVIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.obv.params.period","name":"period","line":115,"lineEnd":115,"column":8,"filename":"code/es-modules/Stock/Indicators/OBV/OBVIndicator.js","default":"undefined"},"children":{}},"volumeSeriesID":{"doclet":{"description":"The id of another series to use its data as volume data for the\nindicator calculation.","type":{"names":["string"]},"defaultvalue":"volume"},"meta":{"fullname":"plotOptions.obv.params.volumeSeriesID","name":"volumeSeriesID","line":116,"lineEnd":119,"column":8,"filename":"code/es-modules/Stock/Indicators/OBV/OBVIndicator.js","default":"volume"},"children":{}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.obv.tooltip","name":"tooltip","line":122,"lineEnd":122,"column":4,"filename":"code/es-modules/Stock/Indicators/OBV/OBVIndicator.js"},"children":{"valueDecimals":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.obv.tooltip.valueDecimals","name":"valueDecimals","line":123,"lineEnd":123,"column":8,"filename":"code/es-modules/Stock/Indicators/OBV/OBVIndicator.js","default":0},"children":{}}}}}},"ohlc":{"doclet":{"description":"An OHLC chart is a style of financial chart used to describe price\nmovements over time. It displays open, high, low and close values per\ndata point.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ohlc` series are defined in\n   [plotOptions.ohlc](plotOptions.ohlc).\n3. Options for one single series are given in\n   [the series instance array](series.ohlc).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ohlc: {\n            // shared options for all ohlc series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ohlc'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ohlc.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ohlc) {\n    // code specific to the ohlc series\n}\n```\n            ","samples":[{"name":"OHLC chart","value":"stock/demo/ohlc"}],"extends":"plotOptions.hlc","products":["highstock"]},"meta":{"filename":"code/es-modules/Series/OHLC/OHLCSeriesDefaults.js","name":"ohlc","fullname":"plotOptions.ohlc","line":12,"lineEnd":16,"column":0},"children":{"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"approximation":{"doclet":{"type":{"names":["Highcharts.DataGroupingApproximationValue","function"]},"defaultvalue":"ohlc","products":["highstock"]},"meta":{"fullname":"plotOptions.ohlc.dataGrouping.approximation","name":"approximation","line":30,"lineEnd":35,"filename":"code/es-modules/Series/OHLC/OHLCSeriesDefaults.js"},"children":{}}}},"dragDrop":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"draggableClose":{"doclet":{"description":"Allow close value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.ohlc.dragDrop.draggableClose","name":"draggableClose","line":314,"lineEnd":321,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}},"draggableHigh":{"doclet":{"description":"Allow high value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.ohlc.dragDrop.draggableHigh","name":"draggableHigh","line":272,"lineEnd":279,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}},"draggableLow":{"doclet":{"description":"Allow low value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.ohlc.dragDrop.draggableLow","name":"draggableLow","line":251,"lineEnd":258,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}},"draggableOpen":{"doclet":{"description":"Allow open value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.ohlc.dragDrop.draggableOpen","name":"draggableOpen","line":293,"lineEnd":300,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}}}},"pointValKey":{"doclet":{"description":"Determines which one of  `open`, `high`, `low`, `close` values should\nbe represented as `point.y`, which is later used to set dataLabel\nposition and [compare](#plotOptions.series.compare).","declare":"Highcharts.OptionsPointValKeyValue","defaultvalue":"close","values":"[\"open\", \"high\", \"low\", \"close\"]","products":["highstock"],"type":{"names":["string"]}},"meta":{"fullname":"plotOptions.ohlc.pointValKey","name":"pointValKey","line":36,"lineEnd":46,"filename":"code/es-modules/Series/OHLC/OHLCSeriesDefaults.js"},"children":{}},"upColor":{"doclet":{"description":"Line color for up points.","type":{"names":["Highcharts.ColorType"]},"products":["highstock"]},"meta":{"fullname":"plotOptions.ohlc.upColor","name":"upColor","line":47,"lineEnd":53,"filename":"code/es-modules/Series/OHLC/OHLCSeriesDefaults.js"},"children":{}}}},"organization":{"doclet":{"description":"An organization chart is a diagram that shows the structure of an\norganization and the relationships and relative ranks of its parts and\npositions.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `organization` series are defined in\n   [plotOptions.organization](plotOptions.organization).\n3. Options for one single series are given in\n   [the series instance array](series.organization).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        organization: {\n            // shared options for all organization series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'organization'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.organization.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === organization) {\n    // code specific to the organization series\n}\n```\n            ","samples":[{"name":"Organization chart","value":"highcharts/demo/organization-chart/"},{"name":"Horizontal organization chart","value":"highcharts/series-organization/horizontal/"},{"name":"Borderless design","value":"highcharts/series-organization/borderless"},{"name":"Centered layout","value":"highcharts/series-organization/center-layout"}],"extends":"plotOptions.sankey","exclude":["allowPointSelect","curveFactor","dataSorting"],"since":"7.1.0","products":["highcharts"],"requires":["module:modules/organization"]},"meta":{"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","name":"organization","fullname":"plotOptions.organization","line":14,"lineEnd":18,"column":0},"children":{"borderColor":{"doclet":{"description":"The border color of the node cards.","type":{"names":["Highcharts.ColorString"]},"since":"7.1.0","defaultvalue":"#666666"},"meta":{"fullname":"plotOptions.organization.borderColor","name":"borderColor","line":41,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":"#666666"},"children":{}},"borderRadius":{"doclet":{"description":"The border radius of the node cards.","since":"7.1.0","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.organization.borderRadius","name":"borderRadius","line":47,"lineEnd":51,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":3},"children":{}},"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.organization.borderWidth","name":"borderWidth","line":115,"lineEnd":115,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":1},"children":{}},"dataLabels":{"doclet":{"declare":"Highcharts.SeriesOrganizationDataLabelsOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.organization.dataLabels","name":"dataLabels","line":116,"lineEnd":120,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{"linkTextPath":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.organization.dataLabels.linkTextPath","name":"linkTextPath","line":216,"lineEnd":216,"column":8,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{"attributes":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.organization.dataLabels.linkTextPath.attributes","name":"attributes","line":217,"lineEnd":217,"column":12,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{"startOffset":{"doclet":{"type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.organization.dataLabels.linkTextPath.attributes.startOffset","name":"startOffset","line":218,"lineEnd":218,"column":16,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":"95%"},"children":{}},"textAnchor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"end"},"meta":{"fullname":"plotOptions.organization.dataLabels.linkTextPath.attributes.textAnchor","name":"textAnchor","line":219,"lineEnd":219,"column":16,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":"end"},"children":{}}}}}},"nodeFormatter":{"doclet":{"description":"A callback for defining the format for _nodes_ in the\norganization chart. The `nodeFormat` option takes precedence\nover `nodeFormatter`.\n\nIn an organization chart, the `nodeFormatter` is a quite complex\nfunction of the available options, striving for a good default\nlayout of cards with or without images. In organization chart,\nthe data labels come with `useHTML` set to true, meaning they\nwill be rendered as true HTML above the SVG.","samples":[{"name":"Modify the default label format output","value":"highcharts/series-organization/datalabels-nodeformatter"}],"type":{"names":["Highcharts.SeriesSankeyDataLabelsFormatterCallbackFunction"]},"since":"6.0.2"},"meta":{"fullname":"plotOptions.organization.dataLabels.nodeFormatter","name":"nodeFormatter","line":122,"lineEnd":138,"column":8,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}},"useHTML":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.organization.dataLabels.useHTML","name":"useHTML","line":215,"lineEnd":215,"column":8,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":true},"children":{}}}},"hangingIndent":{"doclet":{"description":"The indentation in pixels of hanging nodes, nodes which parent has\n[layout](#series.organization.nodes.layout) set to `hanging`.","since":"7.1.0","type":{"names":["number"]},"defaultvalue":20},"meta":{"fullname":"plotOptions.organization.hangingIndent","name":"hangingIndent","line":223,"lineEnd":228,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":20},"children":{}},"hangingIndentTranslation":{"doclet":{"description":"Defines the indentation of a `hanging` layout parent's children.\nPossible options:\n\n- `inherit` (default): Only the first child adds the indentation,\nchildren of a child with indentation inherit the indentation.\n- `cumulative`: All children of a child with indentation add its\nown indent. The option may cause overlapping of nodes.\nThen use `shrink` option:\n- `shrink`: Nodes shrink by the\n[hangingIndent](#plotOptions.organization.hangingIndent)\nvalue until they reach the\n[minNodeLength](#plotOptions.organization.minNodeLength).","samples":[{"name":"Every indent increases the indentation","value":"highcharts/series-organization/hanging-cumulative"},{"name":"Every indent decreases the nodes' width","value":"highcharts/series-organization/hanging-shrink"}],"type":{"names":["Highcharts.OrganizationHangingIndentTranslationValue"]},"since":"10.0.0","defaultvalue":"inherit"},"meta":{"fullname":"plotOptions.organization.hangingIndentTranslation","name":"hangingIndentTranslation","line":230,"lineEnd":255,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":"inherit"},"children":{}},"hangingSide":{"doclet":{"description":"Whether links connecting hanging nodes should be drawn on the left\nor right side. Useful for RTL layouts.\n**Note:** Only effects inverted charts (vertical layout).","samples":[{"name":"Nodes hanging from right side.","value":"highcharts/series-organization/hanging-side"}],"type":{"names":["'left'","'right'"]},"since":"11.3.0","defaultvalue":"'left'"},"meta":{"fullname":"plotOptions.organization.hangingSide","name":"hangingSide","line":257,"lineEnd":268,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":"left"},"children":{}},"link":{"doclet":{"description":"Link Styling options","since":"10.3.0","products":["highcharts"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.organization.link","name":"link","line":53,"lineEnd":63,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{"color":{"doclet":{"description":"The color of the links between nodes.","type":{"names":["Highcharts.ColorString"]},"since":"10.3.0","defaultvalue":"#666666"},"meta":{"fullname":"plotOptions.organization.link.color","name":"color","line":70,"lineEnd":80,"column":8,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":"#666666"},"children":{}},"lineWidth":{"doclet":{"description":"The line width of the links connecting nodes, in pixels.","samples":[{"name":"Square links","value":"highcharts/series-organization/link-options"}],"since":"10.3.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.organization.link.lineWidth","name":"lineWidth","line":87,"lineEnd":92,"column":8,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":1},"children":{}},"radius":{"doclet":{"description":"Radius for the rounded corners of the links between nodes.\nWorks for the `orthogonal` link type.","samples":[{"name":"Square links","value":"highcharts/series-organization/link-options"}],"since":"10.3.0","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.organization.link.radius","name":"radius","line":94,"lineEnd":100,"column":8,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":10},"children":{}},"type":{"doclet":{"description":"Type of the link shape.","samples":[{"name":"Different link types","value":"highcharts/series-organization/different-link-types"}],"declare":"Highcharts.OrganizationLinkTypeValue","type":{"names":["'orthogonal'","'curved'","'straight'"]},"defaultvalue":"'orthogonal'","products":["highcharts"],"since":"10.3.0"},"meta":{"fullname":"plotOptions.organization.link.type","name":"type","line":102,"lineEnd":112,"column":8,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":"orthogonal"},"children":{}}}},"minNodeLength":{"doclet":{"description":"In a horizontal chart, the minimum width of the **hanging** nodes\nonly, in pixels. In a vertical chart, the minimum height of the\n**hanging** nodes only, in pixels too.\n\nNote: Used only when\n[hangingIndentTranslation](#plotOptions.organization.hangingIndentTranslation)\nis set to `shrink`.","see":["[nodeWidth](#plotOptions.organization.nodeWidth)"],"since":"7.1.0","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.organization.minNodeLength","name":"minNodeLength","line":270,"lineEnd":279,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":10},"children":{}},"nodeWidth":{"doclet":{"description":"In a horizontal chart, the width of the nodes in pixels. Note that\nmost organization charts are inverted (vertical), so the name of this\noption is counterintuitive.","see":["[minNodeLength](#plotOptions.organization.minNodeLength)"],"since":"7.1.0","type":{"names":["number"]},"defaultvalue":50},"meta":{"fullname":"plotOptions.organization.nodeWidth","name":"nodeWidth","line":306,"lineEnd":314,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":50},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.organization.tooltip","name":"tooltip","line":316,"lineEnd":316,"column":4,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{"nodeFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{point.name}<br>{point.title}<br>{point.description}"},"meta":{"fullname":"plotOptions.organization.tooltip.nodeFormat","name":"nodeFormat","line":317,"lineEnd":317,"column":8,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js","default":"{point.name}<br>{point.title}<br>{point.description}"},"children":{}}}}}},"packedbubble":{"doclet":{"description":"A packed bubble series is a two dimensional series type, where each point\nrenders a value in X, Y position. Each point is drawn as a bubble\nwhere the bubbles don't overlap with each other and the radius\nof the bubble relates to the value.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `packedbubble` series are defined in\n   [plotOptions.packedbubble](plotOptions.packedbubble).\n3. Options for one single series are given in\n   [the series instance array](series.packedbubble).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        packedbubble: {\n            // shared options for all packedbubble series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'packedbubble'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.packedbubble.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === packedbubble) {\n    // code specific to the packedbubble series\n}\n```\n            ","samples":[{"name":"Packed bubble chart","value":"highcharts/demo/packed-bubble/"},{"name":"Split packed bubble chart","value":"highcharts/demo/packed-bubble-split/"}],"extends":"plotOptions.bubble","exclude":["boostThreshold","boostBlending","connectEnds","connectNulls","cropThreshold","dataSorting","dragDrop","jitter","legendSymbolColor","keys","pointPlacement","sizeByAbsoluteValue","step","xAxis","yAxis"],"products":["highcharts"],"since":"7.0.0","requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","name":"packedbubble","fullname":"plotOptions.packedbubble","line":7,"lineEnd":11,"column":0},"children":{"crisp":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.packedbubble.crisp","name":"crisp","line":68,"lineEnd":68,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":false},"children":{}},"dataLabels":{"doclet":{"declare":"Highcharts.SeriesPackedBubbleDataLabelsOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.packedbubble.dataLabels","name":"dataLabels","line":113,"lineEnd":118,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{"attributes":{"doclet":{"description":"Presentation attributes for the text path.","type":{"names":["Highcharts.SVGAttributes"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.attributes","name":"attributes","line":164,"lineEnd":170,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{}},"format":{"doclet":{"description":"The\n[format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nspecifying what to show for _node_ in the networkgraph. In v7.0\ndefaults to `{key}`, since v7.1 defaults to `undefined` and\n`formatter` is used instead.","type":{"names":["string"]},"since":"7.0.0"},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.format","name":"format","line":120,"lineEnd":130,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{}},"formatter":{"doclet":{"description":"Callback JavaScript function to format the data label for a node.\nNote that if a `format` is defined, the format takes precedence\nand the formatter is ignored.","since":"7.0.0"},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.formatter","name":"formatter","line":120,"lineEnd":130,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{}},"padding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.padding","name":"padding","line":179,"lineEnd":187,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":0},"children":{}},"parentNodeFormat":{"doclet":{"type":{"names":["string"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.parentNodeFormat","name":"parentNodeFormat","line":144,"lineEnd":148,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{}},"parentNodeFormatter":{"doclet":{"since":"7.1.0"},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.parentNodeFormatter","name":"parentNodeFormatter","line":144,"lineEnd":148,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{}},"parentNodeTextPath":{"doclet":{"samples":[{"name":"Dashboard with dataLabels on parentNodes","value":"highcharts/demo/packed-bubble-project-status/","products":["highcharts"]}],"declare":"Highcharts.SeriesPackedBubbleDataLabelsTextPathOptionsObject","since":"7.1.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.parentNodeTextPath","name":"parentNodeTextPath","line":156,"lineEnd":162,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable or disable `textPath` option for link's or marker's\ndata labels.","since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.parentNodeTextPath.enabled","name":"enabled","line":164,"lineEnd":170,"column":12,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":true},"children":{}}}},"style":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.style","name":"style","line":189,"lineEnd":189,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{"transition":{"doclet":{"type":{"names":["string"]},"defaultvalue":"opacity 2000ms"},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.style.transition","name":"transition","line":190,"lineEnd":190,"column":12,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":"opacity 2000ms"},"children":{}}}},"textPath":{"doclet":{"description":"Options for a _node_ label text which should follow marker's\nshape.\n\n**Note:** Only SVG-based renderer supports this option.","extends":"plotOptions.series.dataLabels.textPath"},"meta":{"fullname":"plotOptions.packedbubble.dataLabels.textPath","name":"textPath","line":179,"lineEnd":187,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{}}}},"draggable":{"doclet":{"description":"Flag to determine if nodes are draggable or not. Available for\ngraph with useSimulation set to true only.","since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.packedbubble.draggable","name":"draggable","line":72,"lineEnd":79,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":true},"children":{}},"layoutAlgorithm":{"doclet":{"description":"Options for layout algorithm when simulation is enabled. Inside there\nare options to change the speed, padding, initial bubbles positions\nand more.","extends":"plotOptions.networkgraph.layoutAlgorithm","exclude":["approximation","attractiveForce","repulsiveForce","theta"],"since":"7.1.0"},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm","name":"layoutAlgorithm","line":193,"lineEnd":203,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{"bubblePadding":{"doclet":{"description":"The distance between two bubbles, when the algorithm starts to\ntreat two bubbles as overlapping. The `bubblePadding` is also the\nexpected distance between all the bubbles on simulation end.","since":"7.1.0","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.bubblePadding","name":"bubblePadding","line":225,"lineEnd":229,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":5},"children":{}},"dragBetweenSeries":{"doclet":{"description":"In case of split series, this option allows user to drag and\ndrop points between series, for changing point related series.","samples":[{"name":"Example of drag'n drop bubbles for bubble kanban","value":"highcharts/demo/packed-bubble-project-status/"}],"since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.dragBetweenSeries","name":"dragBetweenSeries","line":242,"lineEnd":248,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":false},"children":{}},"enableSimulation":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.enableSimulation","name":"enableSimulation","line":281,"lineEnd":281,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":true},"children":{}},"friction":{"doclet":{"type":{"names":["number"]},"defaultvalue":-0.981},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.friction","name":"friction","line":321,"lineEnd":321,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":-0.981},"children":{}},"gravitationalConstant":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.01},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.gravitationalConstant","name":"gravitationalConstant","line":320,"lineEnd":320,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":0.01},"children":{}},"initialPositionRadius":{"doclet":{"samples":[{"name":"Initial radius set to 200","value":"highcharts/series-packedbubble/initial-radius/"}],"extends":"plotOptions.networkgraph.layoutAlgorithm.initialPositionRadius","exclude":["states"]},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.initialPositionRadius","name":"initialPositionRadius","line":217,"lineEnd":223,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":20},"children":{}},"initialPositions":{"doclet":{"description":"Initial layout algorithm for positioning nodes. Can be one of\nthe built-in options (\"circle\", \"random\") or a function where\npositions should be set on each node (`this.nodes`) as\n`node.plotX` and `node.plotY`.","samples":[{"name":"Initial positions with callback","value":"highcharts/series-networkgraph/initial-positions/"}],"type":{"names":["\"circle\"","\"random\"","function"]},"since":"7.1.0","defaultvalue":"circle"},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.initialPositions","name":"initialPositions","line":205,"lineEnd":215,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":"circle"},"children":{}},"maxIterations":{"doclet":{"type":{"names":["number"]},"defaultvalue":1000},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.maxIterations","name":"maxIterations","line":299,"lineEnd":299,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":1000},"children":{}},"maxSpeed":{"doclet":{"description":"Max speed that node can get in one iteration. In terms of\nsimulation, it's a maximum translation (in pixels) that a node\ncan move (in both, x and y, dimensions). While `friction` is\napplied on all nodes, max speed is applied only for nodes that\nmove very fast, for example small or disconnected ones.","see":["[layoutAlgorithm.integration](#series.networkgraph.layoutAlgorithm.integration)","[layoutAlgorithm.friction](#series.networkgraph.layoutAlgorithm.friction)"],"since":"7.1.0","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.maxSpeed","name":"maxSpeed","line":308,"lineEnd":318,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":5},"children":{}},"parentNodeLimit":{"doclet":{"description":"Whether bubbles should interact with their parentNode to keep\nthem inside.","since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeLimit","name":"parentNodeLimit","line":231,"lineEnd":234,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":false},"children":{}},"parentNodeOptions":{"doclet":{"description":"Layout algorithm options for parent nodes.","extends":"plotOptions.networkgraph.layoutAlgorithm","exclude":["approximation","attractiveForce","enableSimulation","repulsiveForce","theta"],"since":"7.1.0"},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions","name":"parentNodeOptions","line":250,"lineEnd":256,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{"gravitationalConstant":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.03},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.gravitationalConstant","name":"gravitationalConstant","line":259,"lineEnd":259,"column":12,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":0.03},"children":{}},"initialPositionRadius":{"doclet":{"type":{"names":["number"]},"defaultvalue":100},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.initialPositionRadius","name":"initialPositionRadius","line":261,"lineEnd":261,"column":12,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":100},"children":{}},"marker":{"doclet":{"description":"Styling options for parentNodes markers. Similar to\nline.marker options.","samples":[{"name":"Bubble size","value":"highcharts/series-packedbubble/parentnode-style/"}],"extends":"plotOptions.series.marker","exclude":["states"],"since":"7.1.0"},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.marker","name":"marker","line":263,"lineEnd":272,"column":12,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{"fillColor":{"doclet":{"type":{"names":["*"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.marker.fillColor","name":"fillColor","line":274,"lineEnd":274,"column":16,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":null},"children":{}},"fillOpacity":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.marker.fillOpacity","name":"fillOpacity","line":275,"lineEnd":275,"column":16,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":1},"children":{}},"lineColor":{"doclet":{"type":{"names":["*"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.marker.lineColor","name":"lineColor","line":277,"lineEnd":277,"column":16,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":null},"children":{}},"lineWidth":{"doclet":{"type":{"names":["*"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.marker.lineWidth","name":"lineWidth","line":276,"lineEnd":276,"column":16,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":null},"children":{}},"symbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"circle"},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.marker.symbol","name":"symbol","line":278,"lineEnd":278,"column":16,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":"circle"},"children":{}}}},"maxIterations":{"doclet":{"type":{"names":["number"]},"defaultvalue":400},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.maxIterations","name":"maxIterations","line":258,"lineEnd":258,"column":12,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":400},"children":{}},"maxSpeed":{"doclet":{"type":{"names":["number"]},"defaultvalue":50},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.maxSpeed","name":"maxSpeed","line":260,"lineEnd":260,"column":12,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":50},"children":{}},"seriesInteraction":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.parentNodeOptions.seriesInteraction","name":"seriesInteraction","line":262,"lineEnd":262,"column":12,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":true},"children":{}}}},"seriesInteraction":{"doclet":{"description":"Whether series should interact with each other or not. When\n`parentNodeLimit` is set to true, thi option should be set to\nfalse to avoid sticking points in wrong series parentNode.","since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.seriesInteraction","name":"seriesInteraction","line":236,"lineEnd":240,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":true},"children":{}},"splitSeries":{"doclet":{"description":"Whether to split series into individual groups or to mix all\nseries together.","since":"7.1.0","defaultvalue":"false","type":{"names":["boolean"]}},"meta":{"fullname":"plotOptions.packedbubble.layoutAlgorithm.splitSeries","name":"splitSeries","line":300,"lineEnd":306,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":false},"children":{}}}},"maxSize":{"doclet":{"description":"Maximum bubble size. Bubbles will automatically size between the\n`minSize` and `maxSize` to reflect the value of each bubble.\nCan be either pixels (when no unit is given), or a percentage of\nthe smallest one of the plot width and height, divided by the square\nroot of total number of points.","samples":[{"name":"Bubble size","value":"highcharts/plotoptions/bubble-size/"}],"type":{"names":["number","string"]},"since":"7.0.0","defaultvalue":"50%"},"meta":{"fullname":"plotOptions.packedbubble.maxSize","name":"maxSize","line":51,"lineEnd":64,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":"50%"},"children":{}},"minSize":{"doclet":{"description":"Minimum bubble size. Bubbles will automatically size between the\n`minSize` and `maxSize` to reflect the value of each bubble.\nCan be either pixels (when no unit is given), or a percentage of\nthe smallest one of the plot width and height, divided by the square\nroot of total number of points.","samples":[{"name":"Bubble size","value":"highcharts/plotoptions/bubble-size/"}],"type":{"names":["number","string"]},"since":"7.0.0","defaultvalue":"10%"},"meta":{"fullname":"plotOptions.packedbubble.minSize","name":"minSize","line":36,"lineEnd":49,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":"10%"},"children":{}},"parentNode":{"doclet":{"description":"Series options for parent nodes.","since":"8.1.1","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.packedbubble.parentNode","name":"parentNode","line":97,"lineEnd":103,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{"allowPointSelect":{"doclet":{"description":"Allow this series' parent nodes to be selected\nby clicking on the graph.","since":"8.1.1","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.packedbubble.parentNode.allowPointSelect","name":"allowPointSelect","line":105,"lineEnd":110,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":false},"children":{}}}},"sizeBy":{"doclet":{"type":{"names":["string"]},"defaultvalue":"area"},"meta":{"fullname":"plotOptions.packedbubble.sizeBy","name":"sizeBy","line":66,"lineEnd":66,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":"area"},"children":{}},"stickyTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.packedbubble.stickyTracking","name":"stickyTracking","line":323,"lineEnd":323,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":false},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.packedbubble.tooltip","name":"tooltip","line":69,"lineEnd":69,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"Value: {point.value}"},"meta":{"fullname":"plotOptions.packedbubble.tooltip.pointFormat","name":"pointFormat","line":70,"lineEnd":70,"column":8,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":"Value: {point.value}"},"children":{}}}},"useSimulation":{"doclet":{"description":"An option is giving a possibility to choose between using simulation\nfor calculating bubble positions. These reflects in both animation\nand final position of bubbles. Simulation is also adding options to\nthe series graph based on used layout. In case of big data sets, with\nany performance issues, it is possible to disable animation and pack\nbubble in a simple circular way.","samples":[{"name":"useSimulation set to false","value":"highcharts/series-packedbubble/spiral/"}],"since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.packedbubble.useSimulation","name":"useSimulation","line":81,"lineEnd":95,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":true},"children":{}},"zoneAxis":{"doclet":{"type":{"names":["string"]},"defaultvalue":"y"},"meta":{"fullname":"plotOptions.packedbubble.zoneAxis","name":"zoneAxis","line":67,"lineEnd":67,"column":4,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js","default":"y"},"children":{}}}},"pareto":{"doclet":{"description":"A pareto diagram is a type of chart that contains both bars and a line\ngraph, where individual values are represented in descending order by\nbars, and the cumulative total is represented by the line.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pareto` series are defined in\n   [plotOptions.pareto](plotOptions.pareto).\n3. Options for one single series are given in\n   [the series instance array](series.pareto).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pareto: {\n            // shared options for all pareto series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pareto'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pareto.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pareto) {\n    // code specific to the pareto series\n}\n```\n            ","samples":[{"name":"Pareto diagram","value":"highcharts/demo/pareto/","products":["highcharts"]}],"extends":"plotOptions.line","since":"6.0.0","products":["highcharts"],"exclude":["allAreas","boostThreshold","borderColor","borderRadius","borderWidth","crisp","colorAxis","depth","data","dragDrop","edgeColor","edgeWidth","findNearestPointBy","gapSize","gapUnit","grouping","groupPadding","groupZPadding","maxPointWidth","keys","negativeColor","pointInterval","pointIntervalUnit","pointPadding","pointPlacement","pointRange","pointStart","pointWidth","shadow","step","softThreshold","stacking","threshold","zoneAxis","zones","boostBlending"],"requires":["module:modules/pareto"]},"meta":{"filename":"code/es-modules/Series/ParetoSeries/ParetoSeriesDefaults.js","name":"pareto","fullname":"plotOptions.pareto","line":12,"lineEnd":16,"column":0},"children":{"zIndex":{"doclet":{"description":"Higher zIndex than column series to draw line above shapes.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.pareto.zIndex","name":"zIndex","line":40,"lineEnd":42,"column":4,"filename":"code/es-modules/Series/ParetoSeries/ParetoSeriesDefaults.js","default":3},"children":{}}}},"pc":{"doclet":{"description":"Price channel (PC). This series requires the `linkedTo` option to be\nset and should be loaded after the `stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pc` series are defined in\n   [plotOptions.pc](plotOptions.pc).\n3. Options for one single series are given in\n   [the series instance array](series.pc).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pc: {\n            // shared options for all pc series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pc'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pc.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pc) {\n    // code specific to the pc series\n}\n```\n            ","samples":[{"name":"Price Channel","value":"stock/indicators/price-channel","products":["highstock"]}],"extends":"plotOptions.sma","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/price-channel"]},"meta":{"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js","name":"pc","fullname":"plotOptions.pc","line":63,"lineEnd":67,"column":0},"children":{"bottomLine":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pc.bottomLine","name":"bottomLine","line":120,"lineEnd":120,"column":4,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pc.bottomLine.styles","name":"styles","line":121,"lineEnd":121,"column":8,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the bottom line. If not set, it's inherited from\n[plotOptions.pc.color](#plotOptions.pc.color).","type":{"names":["Highcharts.ColorString"]}},"meta":{"fullname":"plotOptions.pc.bottomLine.styles.lineColor","name":"lineColor","line":122,"lineEnd":127,"column":12,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.pc.bottomLine.styles.lineWidth","name":"lineWidth","line":129,"lineEnd":131,"column":12,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js","default":1},"children":{}}}}}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pc.dataGrouping","name":"dataGrouping","line":135,"lineEnd":135,"column":4,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.pc.dataGrouping.approximation","name":"approximation","line":136,"lineEnd":136,"column":8,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js","default":"averages"},"children":{}}}},"fillColor":{"doclet":{"description":"Option for fill color between lines in Price channel Indicator.","samples":[{"name":"background fill between lines","value":"stock/indicators/indicator-area-fill","products":["highstock"]}],"type":{"names":["Highcharts.Color"]},"since":"7.0.0"},"meta":{"fullname":"plotOptions.pc.fillColor","name":"fillColor","line":87,"lineEnd":96,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js"},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.pc.lineWidth","name":"lineWidth","line":104,"lineEnd":104,"column":4,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js","default":1},"children":{}},"params":{"doclet":{"exclude":["index"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pc.params","name":"params","line":87,"lineEnd":96,"column":4,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.pc.params.index","name":"index","line":101,"lineEnd":101,"column":8,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":20},"meta":{"fullname":"plotOptions.pc.params.period","name":"period","line":101,"lineEnd":101,"column":23,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js","default":20},"children":{}}}},"topLine":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pc.topLine","name":"topLine","line":105,"lineEnd":105,"column":4,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pc.topLine.styles","name":"styles","line":106,"lineEnd":106,"column":8,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the top line. If not set, it's inherited from\n[plotOptions.pc.color](#plotOptions.pc.color).","type":{"names":["Highcharts.ColorString"]}},"meta":{"fullname":"plotOptions.pc.topLine.styles.lineColor","name":"lineColor","line":107,"lineEnd":112,"column":12,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.pc.topLine.styles.lineWidth","name":"lineWidth","line":114,"lineEnd":116,"column":12,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js","default":1},"children":{}}}}}}}},"pictorial":{"doclet":{"description":"A pictorial chart uses vector images to represents the data.\nThe shape of the data point is taken from the path parameter.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pictorial` series are defined in\n   [plotOptions.pictorial](plotOptions.pictorial).\n3. Options for one single series are given in\n   [the series instance array](series.pictorial).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pictorial: {\n            // shared options for all pictorial series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pictorial'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pictorial.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pictorial) {\n    // code specific to the pictorial series\n}\n```\n            ","samples":[{"name":"Pictorial chart","value":"highcharts/demo/pictorial/","products":["highcharts"]}],"extends":"plotOptions.column","since":"11.0.0","products":["highcharts"],"exclude":["allAreas","borderRadius","centerInCategory","colorAxis","colorKey","connectEnds","connectNulls","crisp","compare","compareBase","dataSorting","dashStyle","dataAsColumns","linecap","lineWidth","shadow","onPoint"],"requires":["module:modules/pictorial"]},"meta":{"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js","name":"pictorial","fullname":"plotOptions.pictorial","line":153,"lineEnd":170,"column":0},"children":{"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.pictorial.borderWidth","name":"borderWidth","line":172,"lineEnd":172,"column":4,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js","default":0},"children":{}}}},"pie":{"doclet":{"description":"A pie chart is a circular graphic which is divided into slices to\nillustrate numerical proportion.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pie` series are defined in\n   [plotOptions.pie](plotOptions.pie).\n3. Options for one single series are given in\n   [the series instance array](series.pie).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pie: {\n            // shared options for all pie series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pie'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pie.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pie) {\n    // code specific to the pie series\n}\n```\n            ","samples":[{"name":"Pie chart","value":"highcharts/demo/pie-chart/"}],"extends":"plotOptions.line","exclude":["animationLimit","boostThreshold","connectEnds","connectNulls","cropThreshold","dashStyle","dataSorting","dragDrop","findNearestPointBy","getExtremesFromAll","label","lineWidth","linkedTo","marker","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointStart","softThreshold","stacking","step","threshold","turboThreshold","zoneAxis","zones","dataSorting","boostBlending"],"products":["highcharts","highmaps"]},"meta":{"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","name":"pie","fullname":"plotOptions.pie","line":12,"lineEnd":16,"column":0},"children":{"borderColor":{"doclet":{"description":"The color of the border surrounding each slice. When `null`, the\nborder takes the same color as the slice fill. This can be used\ntogether with a `borderWidth` to fill drawing gaps created by\nantialiasing artifacts in border-less pies.\n\nIn styled mode, the border stroke is given in the `.highcharts-point`\nclass.","samples":[{"name":"Black border","value":"highcharts/plotoptions/pie-bordercolor-black/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#ffffff","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.borderColor","name":"borderColor","line":496,"lineEnd":511,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":"#ffffff"},"children":{}},"borderRadius":{"doclet":{"description":"The corner radius of the border surrounding each slice. A number\nsignifies pixels. A percentage string, like for example `50%`, signifies\na size relative to the radius and the inner radius.","samples":[{"name":"Column and pie with rounded border","value":"highcharts/plotoptions/series-border-radius"}],"since":"11.0.0","type":{"names":["number","string","Highcharts.BorderRadiusOptionsObject"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.pie.borderRadius","name":"borderRadius","line":36,"lineEnd":47,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":3},"children":{}},"borderWidth":{"doclet":{"description":"The width of the border surrounding each slice.\n\nWhen setting the border width to 0, there may be small gaps between\nthe slices due to SVG antialiasing artifacts. To work around this,\nkeep the border width at 0.5 or 1, but set the `borderColor` to\n`null` instead.\n\nIn styled mode, the border stroke width is given in the\n`.highcharts-point` class.","samples":[{"name":"3px border","value":"highcharts/plotoptions/pie-borderwidth/","products":["highcharts"]}],"products":["highcharts","highmaps"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.pie.borderWidth","name":"borderWidth","line":513,"lineEnd":528,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":1},"children":{}},"center":{"doclet":{"description":"The center of the pie chart relative to the plot area. Can be\npercentages or pixel values. The default behavior (as of 3.0) is to\ncenter the pie so that all slices and data labels are within the plot\narea. As a consequence, the pie may actually jump around in a chart\nwith dynamic values, as the data labels move. In that case, the\ncenter should be explicitly set, for example to `[\"50%\", \"50%\"]`.","samples":[{"name":"Centered at 100, 100","value":"highcharts/plotoptions/pie-center/","products":["highcharts"]}],"type":{"names":["Array.<(number|string|null), (number|string|null)>"]},"defaultvalue":"[null, null]","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.center","name":"center","line":49,"lineEnd":52,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"clip":{"doclet":{"products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.pie.clip","name":"clip","line":101,"lineEnd":119,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":false},"children":{}},"color":{"doclet":{"description":"The color of the pie series. A pie series is represented as an empty\ncircle if the total sum of its values is 0. Use this property to\ndefine the color of its border.\n\nIn styled mode, the color can be defined by the\n[colorIndex](#plotOptions.series.colorIndex) option. Also, the series\ncolor can be set with the `.highcharts-series`,\n`.highcharts-color-{n}`, `.highcharts-{type}-series` or\n`.highcharts-series-{n}` class, or individual classes given by the\n`className` option.","samples":[{"name":"Empty pie series","value":"highcharts/plotoptions/pie-emptyseries/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"plotOptions.pie.color","name":"color","line":101,"lineEnd":119,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"colors":{"doclet":{"description":"A series specific or series type specific color set to use instead\nof the global [colors](#colors).","samples":[{"name":"Set default colors for all pies","value":"highcharts/demo/pie-monochrome/","products":["highcharts"]}],"type":{"names":["Array.<Highcharts.ColorType>"]},"since":"3.0.0","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.colors","name":"colors","line":130,"lineEnd":141,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"dataLabels":{"doclet":{"declare":"Highcharts.SeriesPieDataLabelsOptionsObject","extends":"plotOptions.series.dataLabels","exclude":["align","allowOverlap","inside","staggerLines","step"]},"meta":{"fullname":"plotOptions.pie.dataLabels","name":"dataLabels","line":129,"lineEnd":129,"column":24,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{"alignTo":{"doclet":{"description":"Alignment method for data labels. Possible values are:\n\n- `plotEdges`: Each label touches the nearest vertical edge of\n  the plot area.\n\n- `connectors`: Connectors have the same x position and the\n  widest label of each half (left & right) touches the nearest\n  vertical edge of the plot area.","samples":[{"name":"alignTo: connectors","value":"highcharts/plotoptions/pie-datalabels-alignto-connectors/","products":["highcharts"]},{"name":"alignTo: plotEdges","value":"highcharts/plotoptions/pie-datalabels-alignto-plotedges/","products":["highcharts"]}],"type":{"names":["string"]},"since":"7.0.0","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.dataLabels.alignTo","name":"alignTo","line":148,"lineEnd":167,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"connectorColor":{"doclet":{"description":"The color of the line connecting the data label to the pie slice.\nThe default color is the same as the point's color.\n\nIn styled mode, the connector stroke is given in the\n`.highcharts-data-label-connector` class.","samples":[{"name":"Blue connectors","value":"highcharts/plotoptions/pie-datalabels-connectorcolor/","products":["highcharts"]},{"name":"Styled connectors","value":"highcharts/css/pie-point/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"since":"2.1.0","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.dataLabels.connectorColor","name":"connectorColor","line":168,"lineEnd":184,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"connectorPadding":{"doclet":{"description":"The distance from the data label to the connector. Note that\ndata labels also have a default `padding`, so in order for the\nconnector to touch the text, the `padding` must also be 0.","samples":[{"name":"No padding","value":"highcharts/plotoptions/pie-datalabels-connectorpadding/","products":["highcharts"]}],"since":"2.1.0","products":["highcharts","highmaps"],"type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"plotOptions.pie.dataLabels.connectorPadding","name":"connectorPadding","line":148,"lineEnd":167,"column":8,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":5},"children":{}},"connectorShape":{"doclet":{"description":"Specifies the method that is used to generate the connector path.\nHighcharts provides 3 built-in connector shapes: `'crookedLine'`\n(default since v11), `'fixedOffset'` and `'straight'`.\n\nUsers can provide their own method by passing a function instead of a\nstring. Three arguments are passed to the callback:\n\n- An object that holds the information about the coordinates of the\n  label (`x` & `y` properties) and how the label is located in\n  relation to the pie (`alignment` property). `alignment` can by one\n  of the following: `'left'` (pie on the left side of the data\n  label), `'right'` (pie on the right side of the data label) or\n  `'center'` (data label overlaps the pie).\n\n- An object that holds the information about the position of the\n  connector. Its `touchingSliceAt` property tells the position of\n  the place where the connector touches the slice.\n\n- Data label options\n\nThe function has to return an SVG path definition in array form (see\nthe example).","samples":[{"name":"connectorShape is a String","value":"highcharts/plotoptions/pie-datalabels-connectorshape-string/","products":["highcharts"]},{"name":"connectorShape is a function","value":"highcharts/plotoptions/pie-datalabels-connectorshape-function/","products":["highcharts"]}],"type":{"names":["string","function"]},"since":"7.0.0","products":["highcharts","highmaps"],"defaultvalue":"crookedLine"},"meta":{"fullname":"plotOptions.pie.dataLabels.connectorShape","name":"connectorShape","line":197,"lineEnd":231,"column":8,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":"crookedLine"},"children":{}},"connectorWidth":{"doclet":{"description":"The width of the line connecting the data label to the pie slice.\n\nIn styled mode, the connector stroke width is given in the\n`.highcharts-data-label-connector` class.","samples":[{"name":"Disable the connector","value":"highcharts/plotoptions/pie-datalabels-connectorwidth-disabled/","products":["highcharts"]},{"name":"Styled connectors","value":"highcharts/css/pie-point/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"1","since":"2.1.0","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.dataLabels.connectorWidth","name":"connectorWidth","line":233,"lineEnd":249,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"crookDistance":{"doclet":{"description":"Works only if `connectorShape` is `'crookedLine'`. It defines how\nfar from the vertical plot edge the connector path should be\ncrooked. With the default, `undefined`, the crook is placed so that\nthe horizontal line from the label intersects with the radial line\nextending through the center of the pie slice.","samples":[{"name":"crookDistance set to 90%","value":"highcharts/plotoptions/pie-datalabels-crookdistance/","products":["highcharts"]}],"since":"7.0.0","products":["highcharts","highmaps"],"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.pie.dataLabels.crookDistance","name":"crookDistance","line":233,"lineEnd":249,"column":8,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":"undefined"},"children":{}},"distance":{"doclet":{"description":"The distance of the data label from the pie's edge. Negative\nnumbers put the data label on top of the pie slices. Can also be\ndefined as a percentage of pie's radius. Connectors are only\nshown for data labels outside the pie.","samples":[{"name":"Data labels on top of the pie","value":"highcharts/plotoptions/pie-datalabels-distance/","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"2.1.0","products":["highcharts","highmaps"],"defaultvalue":30},"meta":{"fullname":"plotOptions.pie.dataLabels.distance","name":"distance","line":264,"lineEnd":276,"column":8,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":30},"children":{}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.pie.dataLabels.enabled","name":"enabled","line":278,"lineEnd":278,"column":8,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":true},"children":{}},"format":{"doclet":{"description":"A\n[format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nfor the data label. Available variables are the same as for\n`formatter`.","samples":[{"name":"Add a unit","value":"highcharts/plotoptions/series-datalabels-format/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"undefined","since":"3.0.0"},"meta":{"fullname":"plotOptions.pie.dataLabels.format","name":"format","line":279,"lineEnd":292,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"formatter":{"doclet":{"description":"Callback JavaScript function to format the data label. Note that\nif a `format` is defined, the format takes precedence and the\nformatter is ignored.","type":{"names":["Highcharts.DataLabelsFormatterCallbackFunction"]},"defaultvalue":"function () { return this.point.isNull ? void 0 : this.point.name; }"},"meta":{"fullname":"plotOptions.pie.dataLabels.formatter","name":"formatter","line":279,"lineEnd":292,"column":8,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"softConnector":{"doclet":{"description":"Whether to render the connector as a soft arc or a line with a sharp\nbreak. Works only if `connectorShape` equals to `fixedOffset`.","samples":[{"name":"Soft","value":"highcharts/plotoptions/pie-datalabels-softconnector-true/","products":["highcharts"]},{"name":"Non soft","value":"highcharts/plotoptions/pie-datalabels-softconnector-false/","products":["highcharts"]}],"since":"2.1.7","products":["highcharts","highmaps"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.pie.dataLabels.softConnector","name":"softConnector","line":305,"lineEnd":318,"column":8,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":true},"children":{}},"style":{"doclet":{"samples":[{"name":"Long labels truncated with an ellipsis","value":"highcharts/plotoptions/pie-datalabels-overflow","products":["highcharts"]},{"name":"Long labels are wrapped","value":"highcharts/plotoptions/pie-datalabels-overflow-wrap","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]}},"meta":{"fullname":"plotOptions.pie.dataLabels.style","name":"style","line":320,"lineEnd":328,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}}}},"depth":{"doclet":{"description":"The thickness of a 3D pie.","type":{"names":["number"]},"defaultvalue":"0","since":"4.0.0","products":["highcharts"],"requires":["module:highcharts-3d"]},"meta":{"fullname":"plotOptions.pie.depth","name":"depth","line":200,"lineEnd":209,"filename":"code/es-modules/Series/Pie3D/Pie3DSeries.js"},"children":{}},"endAngle":{"doclet":{"description":"The end angle of the pie in degrees where 0 is top and 90 is right.\nDefaults to `startAngle` plus 360.","samples":[{"name":"Semi-circle donut","value":"highcharts/demo/pie-semi-circle/","products":["highcharts"]}],"type":{"names":["number"]},"since":"1.3.6","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.endAngle","name":"endAngle","line":343,"lineEnd":354,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"events":{"doclet":{"exclude":["legendItemClick"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pie.events","name":"events","line":49,"lineEnd":52,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{"checkboxClick":{"doclet":{"description":"Fires when the checkbox next to the point name in the legend is\nclicked. One parameter, event, is passed to the function. The state\nof the checkbox is found by event.checked. The checked item is found\nby event.item. Return false to prevent the default action which is to\ntoggle the select state of the series.","samples":[{"name":"Alert checkbox status","value":"highcharts/plotoptions/series-events-checkboxclick/","products":["highcharts"]}],"type":{"names":["function"]},"since":"1.2.0","products":["highcharts","highmaps"],"context":"Highcharts.Point"},"meta":{"fullname":"plotOptions.pie.events.checkboxClick","name":"checkboxClick","line":53,"lineEnd":68,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}}}},"fillColor":{"doclet":{"description":"If the total sum of the pie's values is 0, the series is represented\nas an empty circle . The `fillColor` option defines the color of that\ncircle. Use [pie.borderWidth](#plotOptions.pie.borderWidth) to set\nthe border thickness.","samples":[{"name":"Empty pie series","value":"highcharts/plotoptions/pie-emptyseries/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.pie.fillColor","name":"fillColor","line":331,"lineEnd":341,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":"undefined"},"children":{}},"ignoreHiddenPoint":{"doclet":{"description":"Equivalent to [chart.ignoreHiddenSeries](#chart.ignoreHiddenSeries),\nthis option tells whether the series shall be redrawn as if the\nhidden point were `null`.\n\nThe default value changed from `false` to `true` with Highcharts\n3.0.","samples":[{"name":"True, the hidden point is ignored","value":"highcharts/plotoptions/pie-ignorehiddenpoint/","products":["highcharts"]}],"since":"2.3.0","products":["highcharts","highmaps"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.pie.ignoreHiddenPoint","name":"ignoreHiddenPoint","line":343,"lineEnd":354,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":true},"children":{}},"inactiveOtherPoints":{"doclet":{"defaultvalue":"true","extends":"plotOptions.series.inactiveOtherPoints"},"meta":{"fullname":"plotOptions.pie.inactiveOtherPoints","name":"inactiveOtherPoints","line":380,"lineEnd":383,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":true},"children":{}},"innerSize":{"doclet":{"description":"The size of the inner diameter for the pie. A size greater than 0\nrenders a donut chart. Can be a percentage or pixel value.\nPercentages are relative to the pie size. Pixel values are given as\nintegers. Setting overridden by thickness.\n\n\nNote: in Highcharts < 4.1.2, the percentage was relative to the plot\narea, not the pie size.","samples":[{"name":"80px inner size","value":"highcharts/plotoptions/pie-innersize-80px/","products":["highcharts"]},{"name":"50% of the plot area","value":"highcharts/plotoptions/pie-innersize-50percent/","products":["highcharts"]},{"name":"3D donut","value":"highcharts/demo/3d-pie-donut/","products":["highcharts"]}],"type":{"names":["number","string"]},"defaultvalue":"0","since":"2.0.0","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.innerSize","name":"innerSize","line":385,"lineEnd":407,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"minSize":{"doclet":{"description":"The minimum size for a pie in response to auto margins. The pie will\ntry to shrink to make room for data labels in side the plot area,\n but only to this size.","type":{"names":["number","string"]},"defaultvalue":"80","since":"3.0.0","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.minSize","name":"minSize","line":420,"lineEnd":430,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"point":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"events":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"legendItemClick":{"doclet":{"description":"Fires when the legend item belonging to the pie point (slice) is\nclicked. The `this` keyword refers to the point itself. One\nparameter, `event`, is passed to the function, containing common\nevent information. The default action is to toggle the visibility of\nthe point. This can be prevented by calling `event.preventDefault()`.\n\n **Note:** This option is deprecated in favor of\n[legend.events.itemClick](#legend.events.itemClick).","deprecated":"11.4.4","type":{"names":["Highcharts.PointLegendItemClickCallbackFunction"]},"since":"1.2.0","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.point.events.legendItemClick","name":"legendItemClick","line":69,"lineEnd":84,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}}}}}},"showInLegend":{"doclet":{"description":"Whether to display this particular series or series type in the\nlegend. Since 2.1, pies are not shown in the legend by default.","samples":[{"name":"One series in the legend, one hidden","value":"highcharts/plotoptions/series-showinlegend/","products":["highcharts"]}],"products":["highcharts","highmaps"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.pie.showInLegend","name":"showInLegend","line":448,"lineEnd":456,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":false},"children":{}},"size":{"doclet":{"description":"The diameter of the pie relative to the plot area. Can be a\npercentage or pixel value. Pixel values are given as integers. The\ndefault behavior (as of 3.0) is to scale to the plot area and give\nroom for data labels within the plot area.\n[slicedOffset](#plotOptions.pie.slicedOffset) is also included in the\ndefault size calculation. As a consequence, the size of the pie may\nvary when points are updated and data labels more around. In that\ncase it is best to set a fixed value, for example `\"75%\"`.","samples":[{"name":"Smaller pie","value":"highcharts/plotoptions/pie-size/","products":["highcharts"]}],"type":{"names":["number","string","null"]},"products":["highcharts","highmaps"],"defaultvalue":null},"meta":{"fullname":"plotOptions.pie.size","name":"size","line":419,"lineEnd":419,"column":18,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":null},"children":{}},"slicedOffset":{"doclet":{"description":"If a point is sliced, moved out from the center, how many pixels\nshould it be moved?.","samples":[{"name":"20px offset","value":"highcharts/plotoptions/pie-slicedoffset-20/","products":["highcharts"]}],"products":["highcharts","highmaps"],"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.pie.slicedOffset","name":"slicedOffset","line":458,"lineEnd":466,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":10},"children":{}},"startAngle":{"doclet":{"description":"The start angle of the pie slices in degrees where 0 is top and 90\nright.","samples":[{"name":"Start from right","value":"highcharts/plotoptions/pie-startangle-90/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"2.3.4","products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.startAngle","name":"startAngle","line":468,"lineEnd":480,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pie.states","name":"states","line":534,"lineEnd":534,"column":23,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{"hover":{"doclet":{"extends":"plotOptions.series.states.hover","exclude":["marker","lineWidth","lineWidthPlus"],"products":["highcharts","highmaps"]},"meta":{"fullname":"plotOptions.pie.states.hover","name":"hover","line":536,"lineEnd":540,"column":8,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{"brightness":{"doclet":{"description":"How much to brighten the point on interaction.\n\nIn styled mode, the hover brightness is by default replaced\nby a fill-opacity given in the `.highcharts-point-hover`\nclass.","samples":[{"name":"Brightened by 0.5","value":"highcharts/plotoptions/pie-states-hover-brightness/","products":["highcharts"]}],"products":["highcharts","highmaps"],"type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.pie.states.hover.brightness","name":"brightness","line":542,"lineEnd":553,"column":12,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":0.1},"children":{}}}}}},"stickyTracking":{"doclet":{"description":"Sticky tracking of mouse events. When true, the `mouseOut` event\non a series isn't triggered until the mouse moves over another\nseries, or out of the plot area. When false, the `mouseOut` event on\na series is triggered when the mouse leaves the area around the\nseries'  graph or markers. This also implies the tooltip. When\n`stickyTracking` is false and `tooltip.shared` is false, the tooltip\nwill be hidden when moving the mouse between series.","products":["highcharts","highmaps"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.pie.stickyTracking","name":"stickyTracking","line":468,"lineEnd":480,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":false},"children":{}},"thickness":{"doclet":{"description":"Thickness describing the ring size for a donut type chart,\noverriding [innerSize](#plotOptions.pie.innerSize).","type":{"names":["number"]},"defaultvalue":"undefined","products":["highcharts"],"since":"10.1.0"},"meta":{"fullname":"plotOptions.pie.thickness","name":"thickness","line":355,"lineEnd":364,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pie.tooltip","name":"tooltip","line":493,"lineEnd":493,"column":4,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{"followPointer":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.pie.tooltip.followPointer","name":"followPointer","line":494,"lineEnd":494,"column":8,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js","default":true},"children":{}}}}}},"pivotpoints":{"doclet":{"description":"Pivot points indicator. This series requires the `linkedTo` option to be\nset and should be loaded after `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pivotpoints` series are defined in\n   [plotOptions.pivotpoints](plotOptions.pivotpoints).\n3. Options for one single series are given in\n   [the series instance array](series.pivotpoints).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pivotpoints: {\n            // shared options for all pivotpoints series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pivotpoints'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pivotpoints.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pivotpoints) {\n    // code specific to the pivotpoints series\n}\n```\n            ","samples":[{"name":"Pivot points","value":"stock/indicators/pivot-points"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/pivot-points"]},"meta":{"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js","name":"pivotpoints","fullname":"plotOptions.pivotpoints","line":214,"lineEnd":218,"column":0},"children":{"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pivotpoints.dataGrouping","name":"dataGrouping","line":255,"lineEnd":255,"column":4,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.pivotpoints.dataGrouping.approximation","name":"approximation","line":256,"lineEnd":256,"column":8,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js","default":"averages"},"children":{}}}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pivotpoints.dataLabels","name":"dataLabels","line":251,"lineEnd":251,"column":4,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.pivotpoints.dataLabels.enabled","name":"enabled","line":252,"lineEnd":252,"column":8,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js","default":true},"children":{}},"format":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{point.pivotLine}"},"meta":{"fullname":"plotOptions.pivotpoints.dataLabels.format","name":"format","line":253,"lineEnd":253,"column":8,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js","default":"{point.pivotLine}"},"children":{}}}},"enableMouseTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.pivotpoints.enableMouseTracking","name":"enableMouseTracking","line":250,"lineEnd":250,"column":4,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js","default":false},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pivotpoints.marker","name":"marker","line":247,"lineEnd":247,"column":4,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.pivotpoints.marker.enabled","name":"enabled","line":248,"lineEnd":248,"column":8,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js","default":false},"children":{}}}},"params":{"doclet":{"exclude":["index"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pivotpoints.params","name":"params","line":234,"lineEnd":236,"column":4,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js"},"children":{"algorithm":{"doclet":{"description":"Algorithm used to calculate resistance and support lines based\non pivot points. Implemented algorithms: `'standard'`,\n`'fibonacci'` and `'camarilla'`","type":{"names":["string"]},"defaultvalue":"standard"},"meta":{"fullname":"plotOptions.pivotpoints.params.algorithm","name":"algorithm","line":240,"lineEnd":244,"column":8,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js","default":"standard"},"children":{}},"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.pivotpoints.params.index","name":"index","line":238,"lineEnd":238,"column":8,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":28},"meta":{"fullname":"plotOptions.pivotpoints.params.period","name":"period","line":238,"lineEnd":238,"column":23,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js","default":28},"children":{}}}}}},"pointandfigure":{"doclet":{"description":"The Point and Figure series represents changes in stock price movements,\nwithout focusing on the time and volume. Each data point is created when the\n`boxSize` criteria is met. Opposite column of points gets created only when\nthe `reversalAmount` threshold is met.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pointandfigure` series are defined in\n   [plotOptions.pointandfigure](plotOptions.pointandfigure).\n3. Options for one single series are given in\n   [the series instance array](series.pointandfigure).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pointandfigure: {\n            // shared options for all pointandfigure series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pointandfigure'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pointandfigure.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pointandfigure) {\n    // code specific to the pointandfigure series\n}\n```\n            ","samples":[{"name":"Point and Figure series","value":"stock/demo/pointandfigure/"}],"extends":"plotOptions.scatter","products":["highstock"],"exclude":["boostBlending","boostThreshold","compare","compareBase","compareStart","cumulative","cumulativeStart","dataGrouping","dataGrouping","dragDrop"],"requires":["module:modules/pointandfigure"]},"meta":{"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","name":"pointandfigure","fullname":"plotOptions.pointandfigure","line":12,"lineEnd":16,"column":0},"children":{"boxSize":{"doclet":{"description":"Price increment that determines if a new point should be added to the column.","type":{"names":["string","number"]},"since":"12.0.0","products":["highstock"],"defaultvalue":"1%"},"meta":{"fullname":"plotOptions.pointandfigure.boxSize","name":"boxSize","line":35,"lineEnd":35,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":"1%"},"children":{}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pointandfigure.dataGrouping","name":"dataGrouping","line":47,"lineEnd":47,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.pointandfigure.dataGrouping.enabled","name":"enabled","line":48,"lineEnd":48,"column":8,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":false},"children":{}}}},"groupPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.2},"meta":{"fullname":"plotOptions.pointandfigure.groupPadding","name":"groupPadding","line":44,"lineEnd":44,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":0.2},"children":{}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"lineMarker"},"meta":{"fullname":"plotOptions.pointandfigure.legendSymbol","name":"legendSymbol","line":61,"lineEnd":61,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":"lineMarker"},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pointandfigure.marker","name":"marker","line":55,"lineEnd":55,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js"},"children":{"fillColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"transparent"},"meta":{"fullname":"plotOptions.pointandfigure.marker.fillColor","name":"fillColor","line":57,"lineEnd":57,"column":8,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":"transparent"},"children":{}},"lineColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#FF0000"},"meta":{"fullname":"plotOptions.pointandfigure.marker.lineColor","name":"lineColor","line":58,"lineEnd":58,"column":8,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":"#FF0000"},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.pointandfigure.marker.lineWidth","name":"lineWidth","line":59,"lineEnd":59,"column":8,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":2},"children":{}},"symbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"circle"},"meta":{"fullname":"plotOptions.pointandfigure.marker.symbol","name":"symbol","line":56,"lineEnd":56,"column":8,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":"circle"},"children":{}}}},"markerUp":{"doclet":{"description":"Marker options for the up direction column, inherited from `series.marker`\noptions.","extends":"plotOptions.series.marker","products":["highstock"]},"meta":{"fullname":"plotOptions.pointandfigure.markerUp","name":"markerUp","line":50,"lineEnd":50,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js"},"children":{"lineColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#00FF00"},"meta":{"fullname":"plotOptions.pointandfigure.markerUp.lineColor","name":"lineColor","line":52,"lineEnd":52,"column":8,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":"#00FF00"},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.pointandfigure.markerUp.lineWidth","name":"lineWidth","line":53,"lineEnd":53,"column":8,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":2},"children":{}},"symbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"cross"},"meta":{"fullname":"plotOptions.pointandfigure.markerUp.symbol","name":"symbol","line":51,"lineEnd":51,"column":8,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":"cross"},"children":{}}}},"pointPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.pointandfigure.pointPadding","name":"pointPadding","line":45,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":0.1},"children":{}},"pointRange":{"doclet":{"type":{"names":["*"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.pointandfigure.pointRange","name":"pointRange","line":46,"lineEnd":46,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":null},"children":{}},"reversalAmount":{"doclet":{"description":"Threshold that should be met to create a new column in opposite direction.","type":{"names":["number"]},"since":"12.0.0","products":["highstock"],"defaultvalue":3},"meta":{"fullname":"plotOptions.pointandfigure.reversalAmount","name":"reversalAmount","line":36,"lineEnd":36,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":3},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pointandfigure.tooltip","name":"tooltip","line":37,"lineEnd":37,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js"},"children":{"headerFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"plotOptions.pointandfigure.tooltip.headerFormat","name":"headerFormat","line":41,"lineEnd":41,"column":8,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":""},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> <b> {series.name}</b><br/>Close: {point.y:.2f}<br/>"},"meta":{"fullname":"plotOptions.pointandfigure.tooltip.pointFormat","name":"pointFormat","line":38,"lineEnd":38,"column":8,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> <b> {series.name}</b><br/>Close: {point.y:.2f}<br/>"},"children":{}}}},"turboThreshold":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.pointandfigure.turboThreshold","name":"turboThreshold","line":43,"lineEnd":43,"column":4,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js","default":0},"children":{}}}},"polygon":{"doclet":{"description":"A polygon series can be used to draw any freeform shape in the cartesian\ncoordinate system. A fill is applied with the `color` option, and\nstroke is applied through `lineWidth` and `lineColor` options.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `polygon` series are defined in\n   [plotOptions.polygon](plotOptions.polygon).\n3. Options for one single series are given in\n   [the series instance array](series.polygon).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        polygon: {\n            // shared options for all polygon series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'polygon'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.polygon.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === polygon) {\n    // code specific to the polygon series\n}\n```\n            ","samples":[{"name":"Polygon","value":"highcharts/demo/polygon/","products":["highcharts"]},{"name":"Polygon","value":"highcharts/demo/polygon/","products":["highstock"]}],"extends":"plotOptions.scatter","since":"4.1.0","exclude":["jitter","softThreshold","threshold","cluster","boostThreshold","boostBlending"],"products":["highcharts","highstock"],"requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js","name":"polygon","fullname":"plotOptions.polygon","line":12,"lineEnd":16,"column":0},"children":{"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rectangle"},"meta":{"fullname":"plotOptions.polygon.legendSymbol","name":"legendSymbol","line":50,"lineEnd":50,"column":4,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js","default":"rectangle"},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.polygon.marker","name":"marker","line":36,"lineEnd":36,"column":4,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.polygon.marker.enabled","name":"enabled","line":37,"lineEnd":37,"column":8,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js","default":false},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.polygon.marker.states","name":"states","line":38,"lineEnd":38,"column":8,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.polygon.marker.states.hover","name":"hover","line":39,"lineEnd":39,"column":12,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.polygon.marker.states.hover.enabled","name":"enabled","line":40,"lineEnd":40,"column":16,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js","default":false},"children":{}}}}}}}},"stickyTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.polygon.stickyTracking","name":"stickyTracking","line":44,"lineEnd":44,"column":4,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js","default":false},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.polygon.tooltip","name":"tooltip","line":45,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js"},"children":{"followPointer":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.polygon.tooltip.followPointer","name":"followPointer","line":46,"lineEnd":46,"column":8,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js","default":true},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"plotOptions.polygon.tooltip.pointFormat","name":"pointFormat","line":47,"lineEnd":47,"column":8,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js","default":""},"children":{}}}},"trackByArea":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.polygon.trackByArea","name":"trackByArea","line":49,"lineEnd":49,"column":4,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js","default":true},"children":{}}}},"ppo":{"doclet":{"description":"Percentage Price Oscillator. This series requires the\n`linkedTo` option to be set and should be loaded after the\n`stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ppo` series are defined in\n   [plotOptions.ppo](plotOptions.ppo).\n3. Options for one single series are given in\n   [the series instance array](series.ppo).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ppo: {\n            // shared options for all ppo series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ppo'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ppo.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ppo) {\n    // code specific to the ppo series\n}\n```\n            ","samples":[{"name":"Percentage Price Oscillator","value":"stock/indicators/ppo","products":["highstock"]}],"extends":"plotOptions.ema","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/ppo"]},"meta":{"filename":"code/es-modules/Stock/Indicators/PPO/PPOIndicator.js","name":"ppo","fullname":"plotOptions.ppo","line":75,"lineEnd":79,"column":0},"children":{"params":{"doclet":{"description":"Parameters used in calculation of Percentage Price Oscillator series\npoints.","exclude":["period"],"since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.ppo.params","name":"params","line":99,"lineEnd":104,"column":4,"filename":"code/es-modules/Stock/Indicators/PPO/PPOIndicator.js"},"children":{"period":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.ppo.params.period","name":"period","line":106,"lineEnd":106,"column":8,"filename":"code/es-modules/Stock/Indicators/PPO/PPOIndicator.js","default":"undefined"},"children":{}},"periods":{"doclet":{"description":"Periods for Percentage Price Oscillator calculations.","type":{"names":["Array.<number>"]},"defaultvalue":"[12, 26]","since":"7.0.0"},"meta":{"fullname":"plotOptions.ppo.params.periods","name":"periods","line":106,"lineEnd":106,"column":24,"filename":"code/es-modules/Stock/Indicators/PPO/PPOIndicator.js"},"children":{}}}}}},"priceenvelopes":{"doclet":{"description":"Price envelopes indicator based on [SMA](#plotOptions.sma) calculations.\nThis series requires the `linkedTo` option to be set and should be loaded\nafter the `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `priceenvelopes` series are defined in\n   [plotOptions.priceenvelopes](plotOptions.priceenvelopes).\n3. Options for one single series are given in\n   [the series instance array](series.priceenvelopes).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        priceenvelopes: {\n            // shared options for all priceenvelopes series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'priceenvelopes'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.priceenvelopes.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === priceenvelopes) {\n    // code specific to the priceenvelopes series\n}\n```\n            ","samples":[{"name":"Price envelopes","value":"stock/indicators/price-envelopes"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/price-envelopes"]},"meta":{"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js","name":"priceenvelopes","fullname":"plotOptions.priceenvelopes","line":84,"lineEnd":88,"column":0},"children":{"bottomLine":{"doclet":{"description":"Bottom line options.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.priceenvelopes.bottomLine","name":"bottomLine","line":124,"lineEnd":126,"column":4,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.priceenvelopes.bottomLine.styles","name":"styles","line":128,"lineEnd":128,"column":8,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line. If not set, it's inherited from\n[plotOptions.priceenvelopes.color](#plotOptions.priceenvelopes.color).","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.priceenvelopes.bottomLine.styles.lineColor","name":"lineColor","line":133,"lineEnd":139,"column":12,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.priceenvelopes.bottomLine.styles.lineWidth","name":"lineWidth","line":129,"lineEnd":131,"column":12,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js","default":1},"children":{}}}}}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.priceenvelopes.dataGrouping","name":"dataGrouping","line":153,"lineEnd":153,"column":4,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.priceenvelopes.dataGrouping.approximation","name":"approximation","line":154,"lineEnd":154,"column":8,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js","default":"averages"},"children":{}}}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.priceenvelopes.marker","name":"marker","line":105,"lineEnd":105,"column":4,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.priceenvelopes.marker.enabled","name":"enabled","line":106,"lineEnd":106,"column":8,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js","default":false},"children":{}}}},"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.priceenvelopes.params","name":"params","line":111,"lineEnd":111,"column":4,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js"},"children":{"bottomBand":{"doclet":{"description":"Percentage below the moving average that should be displayed.\n0.1 means 90%. Relative to the calculated value.","type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.priceenvelopes.params.bottomBand","name":"bottomBand","line":118,"lineEnd":121,"column":8,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js","default":0.1},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":20},"meta":{"fullname":"plotOptions.priceenvelopes.params.period","name":"period","line":112,"lineEnd":112,"column":8,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js","default":20},"children":{}},"topBand":{"doclet":{"description":"Percentage above the moving average that should be displayed.\n0.1 means 110%. Relative to the calculated value.","type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.priceenvelopes.params.topBand","name":"topBand","line":113,"lineEnd":116,"column":8,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js","default":0.1},"children":{}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.priceenvelopes.tooltip","name":"tooltip","line":108,"lineEnd":108,"column":4,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b><br/>Top: {point.top}<br/>Middle: {point.middle}<br/>Bottom: {point.bottom}<br/>"},"meta":{"fullname":"plotOptions.priceenvelopes.tooltip.pointFormat","name":"pointFormat","line":109,"lineEnd":109,"column":8,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js","default":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b><br/>Top: {point.top}<br/>Middle: {point.middle}<br/>Bottom: {point.bottom}<br/>"},"children":{}}}},"topLine":{"doclet":{"description":"Top line options.","extends":"plotOptions.priceenvelopes.bottomLine","since":"6.0.0"},"meta":{"fullname":"plotOptions.priceenvelopes.topLine","name":"topLine","line":143,"lineEnd":147,"column":4,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.priceenvelopes.topLine.styles","name":"styles","line":149,"lineEnd":149,"column":8,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js"},"children":{"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.priceenvelopes.topLine.styles.lineWidth","name":"lineWidth","line":150,"lineEnd":150,"column":12,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js","default":1},"children":{}}}}}}}},"psar":{"doclet":{"description":"Parabolic SAR. This series requires `linkedTo`\noption to be set and should be loaded\nafter `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `psar` series are defined in\n   [plotOptions.psar](plotOptions.psar).\n3. Options for one single series are given in\n   [the series instance array](series.psar).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        psar: {\n            // shared options for all psar series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'psar'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.psar.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === psar) {\n    // code specific to the psar series\n}\n```\n            ","samples":[{"name":"Parabolic SAR Indicator","value":"stock/indicators/psar"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/psar"]},"meta":{"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js","name":"psar","fullname":"plotOptions.psar","line":199,"lineEnd":213,"column":0},"children":{"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.psar.lineWidth","name":"lineWidth","line":215,"lineEnd":215,"column":4,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js","default":0},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.psar.marker","name":"marker","line":216,"lineEnd":216,"column":4,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.psar.marker.enabled","name":"enabled","line":217,"lineEnd":217,"column":8,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js","default":true},"children":{}}}},"params":{"doclet":{"exclude":["period"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.psar.params","name":"params","line":224,"lineEnd":226,"column":4,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js"},"children":{"decimals":{"doclet":{"description":"Number of maximum decimals that are used in PSAR calculations.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"plotOptions.psar.params.decimals","name":"decimals","line":257,"lineEnd":261,"column":8,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js","default":4},"children":{}},"increment":{"doclet":{"description":"Acceleration factor increases by increment each time\nthe extreme point makes a new high.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0.02},"meta":{"fullname":"plotOptions.psar.params.increment","name":"increment","line":244,"lineEnd":249,"column":8,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js","default":0.02},"children":{}},"index":{"doclet":{"description":"Index from which PSAR is starting calculation","since":"6.0.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.psar.params.index","name":"index","line":251,"lineEnd":255,"column":8,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js","default":2},"children":{}},"initialAccelerationFactor":{"doclet":{"description":"The initial value for acceleration factor.\nAcceleration factor is starting with this value\nand increases by specified increment each time\nthe extreme point makes a new high.\nAF can reach a maximum of maxAccelerationFactor,\nno matter how long the uptrend extends.","type":{"names":["number"]},"defaultvalue":0.02},"meta":{"fullname":"plotOptions.psar.params.initialAccelerationFactor","name":"initialAccelerationFactor","line":228,"lineEnd":228,"column":24,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js","default":0.02},"children":{}},"maxAccelerationFactor":{"doclet":{"description":"The Maximum value for acceleration factor.\nAF can reach a maximum of maxAccelerationFactor,\nno matter how long the uptrend extends.","type":{"names":["number"]},"defaultvalue":0.2},"meta":{"fullname":"plotOptions.psar.params.maxAccelerationFactor","name":"maxAccelerationFactor","line":238,"lineEnd":242,"column":8,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js","default":0.2},"children":{}},"period":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.psar.params.period","name":"period","line":228,"lineEnd":228,"column":8,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js","default":"undefined"},"children":{}}}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.psar.states","name":"states","line":219,"lineEnd":219,"column":4,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.psar.states.hover","name":"hover","line":220,"lineEnd":220,"column":8,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js"},"children":{"lineWidthPlus":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.psar.states.hover.lineWidthPlus","name":"lineWidthPlus","line":221,"lineEnd":221,"column":12,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js","default":0},"children":{}}}}}}}},"pyramid":{"doclet":{"description":"A pyramid series is a special type of funnel, without neck and reversed\nby default.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pyramid` series are defined in\n   [plotOptions.pyramid](plotOptions.pyramid).\n3. Options for one single series are given in\n   [the series instance array](series.pyramid).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pyramid: {\n            // shared options for all pyramid series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pyramid'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pyramid.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pyramid) {\n    // code specific to the pyramid series\n}\n```\n            ","samples":[{"name":"Pyramid chart","value":"highcharts/demo/pyramid/"}],"extends":"plotOptions.funnel","products":["highcharts"],"requires":["module:modules/funnel"]},"meta":{"filename":"code/es-modules/Series/Pyramid/PyramidSeries.js","name":"pyramid","fullname":"plotOptions.pyramid","line":34,"lineEnd":38,"column":0},"children":{}},"pyramid3d":{"doclet":{"description":"A pyramid3d is a 3d version of pyramid series type. Pyramid charts are\na type of chart often used to visualize stages in a sales project,\nwhere the top are the initial stages with the most clients.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pyramid3d` series are defined in\n   [plotOptions.pyramid3d](plotOptions.pyramid3d).\n3. Options for one single series are given in\n   [the series instance array](series.pyramid3d).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pyramid3d: {\n            // shared options for all pyramid3d series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pyramid3d'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pyramid3d.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pyramid3d) {\n    // code specific to the pyramid3d series\n}\n```\n            ","samples":[{"name":"Pyramid3d","value":"highcharts/demo/pyramid3d/"}],"extends":"plotOptions.funnel3d","exclude":["dataSorting","legendSymbolColor","neckHeight","neckWidth",""],"products":["highcharts"],"since":"7.1.0","requires":["module:highcharts-3d","module:modules/cylinder","module:modules/funnel3d","module:modules/pyramid3d"]},"meta":{"filename":"code/es-modules/Series/Pyramid3D/Pyramid3DSeriesDefaults.js","name":"pyramid3d","fullname":"plotOptions.pyramid3d","line":14,"lineEnd":18,"column":0},"children":{"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.pyramid3d.dataLabels","name":"dataLabels","line":47,"lineEnd":47,"column":4,"filename":"code/es-modules/Series/Pyramid3D/Pyramid3DSeriesDefaults.js"},"children":{"verticalAlign":{"doclet":{"defaultvalue":"top","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.pyramid3d.dataLabels.verticalAlign","name":"verticalAlign","line":48,"lineEnd":50,"column":8,"filename":"code/es-modules/Series/Pyramid3D/Pyramid3DSeriesDefaults.js","default":"top"},"children":{}}}},"neckHeight":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.pyramid3d.neckHeight","name":"neckHeight","line":45,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/Pyramid3D/Pyramid3DSeriesDefaults.js","default":0},"children":{}},"neckWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.pyramid3d.neckWidth","name":"neckWidth","line":46,"lineEnd":46,"column":4,"filename":"code/es-modules/Series/Pyramid3D/Pyramid3DSeriesDefaults.js","default":0},"children":{}},"reversed":{"doclet":{"description":"A reversed pyramid3d is funnel3d, but the latter supports neck\nrelated options: neckHeight and neckWidth","products":["highcharts"],"since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.pyramid3d.reversed","name":"reversed","line":38,"lineEnd":43,"column":4,"filename":"code/es-modules/Series/Pyramid3D/Pyramid3DSeriesDefaults.js","default":true},"children":{}}}},"renko":{"doclet":{"description":"A Renko series is a style of financial chart used to describe price\nmovements over time. It displays open, high, low and close values per\ndata point.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `renko` series are defined in\n   [plotOptions.renko](plotOptions.renko).\n3. Options for one single series are given in\n   [the series instance array](series.renko).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        renko: {\n            // shared options for all renko series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'renko'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.renko.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === renko) {\n    // code specific to the renko series\n}\n```\n            ","samples":[{"name":"Renko series","value":"stock/demo/renko/"},{"name":"Renko series","value":"stock/series-renko/renko-vs-heikinashi-vs-candlestick"}],"extends":"plotOptions.column","exclude":["boost","boostBlending","boostThreshold","centerInCategory","cumulative","cumulativeStart","dashStyle","dragDrop","dataSorting","edgeColor","stacking","getExtremesFromAll","clip","colorByPoint","compare","compareBase","compareStart","compareTo","dataGrouping","edgeWidth","lineColor","linkedTo","pointPadding","pointPlacement","pointRange","pointStart","pointWidth"],"products":["highstock"],"requires":["module:modules/renko"]},"meta":{"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","name":"renko","fullname":"plotOptions.renko","line":12,"lineEnd":16,"column":0},"children":{"borderRadius":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.renko.borderRadius","name":"borderRadius","line":57,"lineEnd":57,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js"},"children":{"where":{"doclet":{"type":{"names":["string"]},"defaultvalue":"all"},"meta":{"fullname":"plotOptions.renko.borderRadius.where","name":"where","line":58,"lineEnd":58,"column":8,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":"all"},"children":{}}}},"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.renko.borderWidth","name":"borderWidth","line":54,"lineEnd":54,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":2},"children":{}},"boxSize":{"doclet":{"description":"The size of the individual box, representing a point. Can be set in yAxis\nvalue, or percent value of the first point e.g. if first point's value is\n200, and box size is set to `20%`, the box will be 40, so the new point\nwill be drawn when the next value changes for more than 40.","type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"plotOptions.renko.boxSize","name":"boxSize","line":40,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":4},"children":{}},"downColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#ff0000"},"meta":{"fullname":"plotOptions.renko.downColor","name":"downColor","line":49,"lineEnd":49,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":"#ff0000"},"children":{}},"fillColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"transparent"},"meta":{"fullname":"plotOptions.renko.fillColor","name":"fillColor","line":53,"lineEnd":53,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":"transparent"},"children":{}},"groupPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.renko.groupPadding","name":"groupPadding","line":47,"lineEnd":47,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":0},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.renko.lineWidth","name":"lineWidth","line":55,"lineEnd":55,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":0},"children":{}},"navigatorOptions":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.renko.navigatorOptions","name":"navigatorOptions","line":50,"lineEnd":50,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js"},"children":{"type":{"doclet":{"type":{"names":["string"]},"defaultvalue":"renko"},"meta":{"fullname":"plotOptions.renko.navigatorOptions.type","name":"type","line":51,"lineEnd":51,"column":8,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":"renko"},"children":{}}}},"pointPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.renko.pointPadding","name":"pointPadding","line":48,"lineEnd":48,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":0},"children":{}},"stickyTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.renko.stickyTracking","name":"stickyTracking","line":56,"lineEnd":56,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":true},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.renko.tooltip","name":"tooltip","line":60,"lineEnd":60,"column":4,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> {series.name}: <b>{point.low:.2f} - {point.y:.2f}</b><br/>"},"meta":{"fullname":"plotOptions.renko.tooltip.pointFormat","name":"pointFormat","line":61,"lineEnd":61,"column":8,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> {series.name}: <b>{point.low:.2f} - {point.y:.2f}</b><br/>"},"children":{}}}}}},"roc":{"doclet":{"description":"Rate of change indicator (ROC). The indicator value for each point\nis defined as:\n\n`(C - Cn) / Cn * 100`\n\nwhere: `C` is the close value of the point of the same x in the\nlinked series and `Cn` is the close value of the point `n` periods\nago. `n` is set through [period](#plotOptions.roc.params.period).\n\nThis series requires `linkedTo` option to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `roc` series are defined in\n   [plotOptions.roc](plotOptions.roc).\n3. Options for one single series are given in\n   [the series instance array](series.roc).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        roc: {\n            // shared options for all roc series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'roc'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.roc.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === roc) {\n    // code specific to the roc series\n}\n```\n            ","samples":[{"name":"Rate of change indicator","value":"stock/indicators/roc"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/roc"]},"meta":{"filename":"code/es-modules/Stock/Indicators/ROC/ROCIndicator.js","name":"roc","fullname":"plotOptions.roc","line":95,"lineEnd":99,"column":0},"children":{"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.roc.params","name":"params","line":123,"lineEnd":123,"column":4,"filename":"code/es-modules/Stock/Indicators/ROC/ROCIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.roc.params.index","name":"index","line":124,"lineEnd":124,"column":8,"filename":"code/es-modules/Stock/Indicators/ROC/ROCIndicator.js","default":3},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":9},"meta":{"fullname":"plotOptions.roc.params.period","name":"period","line":125,"lineEnd":125,"column":8,"filename":"code/es-modules/Stock/Indicators/ROC/ROCIndicator.js","default":9},"children":{}}}}}},"rsi":{"doclet":{"description":"Relative strength index (RSI) technical indicator. This series\nrequires the `linkedTo` option to be set and should be loaded after\nthe `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `rsi` series are defined in\n   [plotOptions.rsi](plotOptions.rsi).\n3. Options for one single series are given in\n   [the series instance array](series.rsi).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        rsi: {\n            // shared options for all rsi series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'rsi'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.rsi.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === rsi) {\n    // code specific to the rsi series\n}\n```\n            ","samples":[{"name":"RSI indicator","value":"stock/indicators/rsi"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/rsi"]},"meta":{"filename":"code/es-modules/Stock/Indicators/RSI/RSIIndicator.js","name":"rsi","fullname":"plotOptions.rsi","line":115,"lineEnd":119,"column":0},"children":{"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.rsi.params","name":"params","line":136,"lineEnd":136,"column":4,"filename":"code/es-modules/Stock/Indicators/RSI/RSIIndicator.js"},"children":{"decimals":{"doclet":{"type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"plotOptions.rsi.params.decimals","name":"decimals","line":137,"lineEnd":137,"column":8,"filename":"code/es-modules/Stock/Indicators/RSI/RSIIndicator.js","default":4},"children":{}},"index":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.rsi.params.index","name":"index","line":138,"lineEnd":138,"column":8,"filename":"code/es-modules/Stock/Indicators/RSI/RSIIndicator.js","default":3},"children":{}}}}}},"sankey":{"doclet":{"description":"A sankey diagram is a type of flow diagram, in which the width of the\nlink between two nodes is shown proportionally to the flow quantity.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `sankey` series are defined in\n   [plotOptions.sankey](plotOptions.sankey).\n3. Options for one single series are given in\n   [the series instance array](series.sankey).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        sankey: {\n            // shared options for all sankey series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'sankey'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.sankey.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === sankey) {\n    // code specific to the sankey series\n}\n```\n            ","samples":[{"name":"Sankey diagram","value":"highcharts/demo/sankey-diagram/"},{"name":"Inverted sankey diagram","value":"highcharts/plotoptions/sankey-inverted/"},{"name":"Sankey diagram with outgoing links","value":"highcharts/plotoptions/sankey-outgoing"}],"extends":"plotOptions.column","since":"6.0.0","products":["highcharts"],"exclude":["animationLimit","boostBlending","boostThreshold","borderRadius","crisp","cropThreshold","colorAxis","colorKey","dataSorting","depth","dragDrop","edgeColor","edgeWidth","findNearestPointBy","grouping","groupPadding","groupZPadding","legendSymbolColor","maxPointWidth","minPointLength","negativeColor","pointInterval","pointIntervalUnit","pointPadding","pointPlacement","pointRange","pointStart","pointWidth","shadow","softThreshold","stacking","threshold","zoneAxis","zones"],"requires":["module:modules/sankey"]},"meta":{"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","name":"sankey","fullname":"plotOptions.sankey","line":14,"lineEnd":18,"column":0},"children":{"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.sankey.borderWidth","name":"borderWidth","line":47,"lineEnd":47,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":0},"children":{}},"colorByPoint":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.sankey.colorByPoint","name":"colorByPoint","line":48,"lineEnd":48,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":true},"children":{}},"curveFactor":{"doclet":{"description":"Higher numbers makes the links in a sankey diagram or dependency\nwheel render more curved. A `curveFactor` of 0 makes the lines\nstraight.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0.33},"meta":{"fullname":"plotOptions.sankey.curveFactor","name":"curveFactor","line":49,"lineEnd":55,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":0.33},"children":{}},"dataLabels":{"doclet":{"description":"Options for the data labels appearing on top of the nodes and links.\nFor sankey charts, data labels are visible for the nodes by default,\nbut hidden for links. This is controlled by modifying the\n`nodeFormat`, and the `format` that applies to links and is an empty\nstring by default.","declare":"Highcharts.SeriesSankeyDataLabelsOptionsObject","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.sankey.dataLabels","name":"dataLabels","line":57,"lineEnd":67,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{"backgroundColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"none"},"meta":{"fullname":"plotOptions.sankey.dataLabels.backgroundColor","name":"backgroundColor","line":70,"lineEnd":70,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":"none"},"children":{}},"crop":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.sankey.dataLabels.crop","name":"crop","line":70,"lineEnd":70,"column":33,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":false},"children":{}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.sankey.dataLabels.enabled","name":"enabled","line":69,"lineEnd":69,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":true},"children":{}},"format":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.sankey.dataLabels.format","name":"format","line":95,"lineEnd":95,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":"undefined"},"children":{}},"formatter":{"doclet":{"type":{"names":["Highcharts.SeriesSankeyDataLabelsFormatterCallbackFunction"]}},"meta":{"fullname":"plotOptions.sankey.dataLabels.formatter","name":"formatter","line":96,"lineEnd":98,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"inside":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.sankey.dataLabels.inside","name":"inside","line":102,"lineEnd":102,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":true},"children":{}},"nodeFormat":{"doclet":{"description":"The\n[format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nspecifying what to show for _nodes_ in the sankey diagram. By\ndefault the `nodeFormatter` returns `{point.name}`.","samples":[{"name":"Node and link data labels","value":"highcharts/plotoptions/sankey-link-datalabels/"}],"type":{"names":["string"]},"since":"6.0.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.sankey.dataLabels.nodeFormat","name":"nodeFormat","line":72,"lineEnd":82,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":"undefined"},"children":{}},"nodeFormatter":{"doclet":{"description":"Callback to format data labels for _nodes_ in the sankey diagram.\nThe `nodeFormat` option takes precedence over the\n`nodeFormatter`.","type":{"names":["Highcharts.SeriesSankeyDataLabelsFormatterCallbackFunction"]},"since":"6.0.2"},"meta":{"fullname":"plotOptions.sankey.dataLabels.nodeFormatter","name":"nodeFormatter","line":84,"lineEnd":91,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}}}},"inactiveOtherPoints":{"doclet":{"defaultvalue":"true","extends":"plotOptions.series.inactiveOtherPoints"},"meta":{"fullname":"plotOptions.sankey.inactiveOtherPoints","name":"inactiveOtherPoints","line":104,"lineEnd":108,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":true},"children":{}},"levels":{"doclet":{"description":"Set options on specific levels. Takes precedence over series options,\nbut not node and link options.","samples":[{"name":"Sunburst chart","value":"highcharts/demo/sunburst"}],"type":{"names":["Array.<*>"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.sankey.levels","name":"levels","line":110,"lineEnd":120,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{"borderColor":{"doclet":{"description":"Can set `borderColor` on all nodes which lay on the same level.","type":{"names":["Highcharts.ColorString"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.sankey.levels.borderColor","name":"borderColor","line":121,"lineEnd":126,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"borderWidth":{"doclet":{"description":"Can set `borderWidth` on all nodes which lay on the same level.","type":{"names":["number"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.sankey.levels.borderWidth","name":"borderWidth","line":127,"lineEnd":132,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"color":{"doclet":{"description":"Can set `color` on all nodes which lay on the same level.","type":{"names":["Highcharts.ColorType"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.sankey.levels.color","name":"color","line":133,"lineEnd":138,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"colorByPoint":{"doclet":{"description":"Can set `colorByPoint` on all nodes which lay on the same level.","type":{"names":["boolean"]},"defaultvalue":"true","since":"7.1.0"},"meta":{"fullname":"plotOptions.sankey.levels.colorByPoint","name":"colorByPoint","line":139,"lineEnd":145,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"dataLabels":{"doclet":{"description":"Can set `dataLabels` on all points which lay on the same level.","extends":"plotOptions.sankey.dataLabels","since":"7.1.0"},"meta":{"fullname":"plotOptions.sankey.levels.dataLabels","name":"dataLabels","line":146,"lineEnd":151,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"level":{"doclet":{"description":"Decides which level takes effect from the options set in the levels\nobject.","type":{"names":["number"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.sankey.levels.level","name":"level","line":152,"lineEnd":158,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"linkOpacity":{"doclet":{"description":"Can set `linkOpacity` on all points which lay on the same level.","type":{"names":["number"]},"defaultvalue":"0.5","since":"7.1.0"},"meta":{"fullname":"plotOptions.sankey.levels.linkOpacity","name":"linkOpacity","line":159,"lineEnd":165,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"states":{"doclet":{"description":"Can set `states` on all nodes and points which lay on the same level.","extends":"plotOptions.sankey.states","since":"7.1.0"},"meta":{"fullname":"plotOptions.sankey.levels.states","name":"states","line":166,"lineEnd":171,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}}}},"linkColorMode":{"doclet":{"description":"Determines color mode for sankey links. Available options:\n\n- `from` color of the sankey link will be the same as the 'from node'\n\n- `gradient` color of the sankey link will be set to gradient between\ncolors of 'from node' and 'to node'\n\n- `to` color of the sankey link will be same as the 'to node'.","samples":[{"name":"Vertical sankey diagram with gradients","value":"highcharts/demo/vertical-sankey"},{"name":"Sankey diagram with gradients and explanation","value":"highcharts/series-sankey/link-color-mode"}],"type":{"names":["'from'","'gradient'","'to'"]},"since":"11.2.0","defaultvalue":"from"},"meta":{"fullname":"plotOptions.sankey.linkColorMode","name":"linkColorMode","line":110,"lineEnd":120,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":"from"},"children":{}},"linkOpacity":{"doclet":{"description":"Opacity for the links between nodes in the sankey diagram.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0.5},"meta":{"fullname":"plotOptions.sankey.linkOpacity","name":"linkOpacity","line":191,"lineEnd":195,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":0.5},"children":{}},"minLinkWidth":{"doclet":{"description":"The minimal width for a line of a sankey. By default,\n0 values are not shown.","samples":[{"name":"Sankey diagram with minimal link height","value":"highcharts/plotoptions/sankey-minlinkwidth"}],"type":{"names":["number"]},"since":"7.1.3","defaultvalue":"0"},"meta":{"fullname":"plotOptions.sankey.minLinkWidth","name":"minLinkWidth","line":203,"lineEnd":216,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"nodeAlignment":{"doclet":{"description":"Determines which side of the chart the nodes are to be aligned to. When\nthe chart is inverted, `top` aligns to the left and `bottom` to the\nright.","samples":[{"name":"Node alignment demonstrated","value":"highcharts/plotoptions/sankey-nodealignment"}],"type":{"names":["'top'","'center'","'bottom'"]},"since":"6.0.0"},"meta":{"fullname":"plotOptions.sankey.nodeAlignment","name":"nodeAlignment","line":218,"lineEnd":228,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"nodeDistance":{"doclet":{"description":"The distance between nodes in a sankey diagram in the longitudinal\ndirection. The longitudinal direction means the direction that the chart\nflows - in a horizontal chart the distance is horizontal, in an inverted\nchart (vertical), the distance is vertical.\n\nIf a number is given, it denotes pixels. If a percentage string is given,\nthe distance is a percentage of the rendered node width. A `nodeDistance`\nof `100%` will render equal widths for the nodes and the gaps between\nthem.\n\nThis option applies only when the `nodeWidth` option is `auto`, making\nthe node width respond to the number of columns.","since":"11.4.0","samples":[{"name":"Sankey with dnode distance of 100% means equal to node width","value":"highcharts/series-sankey/node-distance"},{"name":"Organization chart with node distance of 50%","value":"highcharts/series-organization/node-distance"}],"type":{"names":["number","string"]},"defaultvalue":30},"meta":{"fullname":"plotOptions.sankey.nodeDistance","name":"nodeDistance","line":260,"lineEnd":280,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":30},"children":{}},"nodePadding":{"doclet":{"description":"The padding between nodes in a sankey diagram or dependency wheel, in\npixels. For sankey charts, this applies to the nodes of the same column,\nso vertical distance by default, or horizontal distance in an inverted\n(vertical) sankey.\n\nIf the number of nodes is so great that it is impossible to lay them out\nwithin the plot area with the given `nodePadding`, they will be rendered\nwith a smaller padding as a strategy to avoid overflow.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.sankey.nodePadding","name":"nodePadding","line":249,"lineEnd":258,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":10},"children":{}},"nodeWidth":{"doclet":{"description":"The pixel width of each node in a sankey diagram or dependency wheel, or\nthe height in case the chart is inverted.\n\nCan be a number or a percentage string.\n\nSankey series also support setting it to `auto`. With this setting, the\nnodes are sized to fill up the plot area in the longitudinal direction,\nregardless of the number of levels.","see":["[sankey.nodeDistance](#nodeDistance)"],"samples":[{"name":"Sankey with auto node width combined with node distance","value":"highcharts/series-sankey/node-distance"},{"name":"Organization chart with node distance of 50%","value":"highcharts/series-organization/node-distance"}],"type":{"names":["number","string"]},"since":"6.0.0","defaultvalue":20},"meta":{"fullname":"plotOptions.sankey.nodeWidth","name":"nodeWidth","line":230,"lineEnd":247,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":20},"children":{}},"opacity":{"doclet":{"description":"Opacity for the nodes in the sankey diagram.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.sankey.opacity","name":"opacity","line":197,"lineEnd":201,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":1},"children":{}},"showInLegend":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.sankey.showInLegend","name":"showInLegend","line":282,"lineEnd":282,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":false},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.sankey.states","name":"states","line":283,"lineEnd":283,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.sankey.states.hover","name":"hover","line":284,"lineEnd":284,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{"linkOpacity":{"doclet":{"description":"Opacity for the links between nodes in the sankey diagram in\nhover mode.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.sankey.states.hover.linkOpacity","name":"linkOpacity","line":285,"lineEnd":288,"column":12,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":1},"children":{}},"opacity":{"doclet":{"description":"Opacity for the nodes in the sankey diagram in hover mode.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.sankey.states.hover.opacity","name":"opacity","line":290,"lineEnd":292,"column":12,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":1},"children":{}}}},"inactive":{"doclet":{"description":"The opposite state of a hover for a single point node/link.","declare":"Highcharts.SeriesStatesInactiveOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.sankey.states.inactive","name":"inactive","line":295,"lineEnd":299,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{"linkOpacity":{"doclet":{"description":"Opacity for the links between nodes in the sankey diagram in\ninactive mode.","type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.sankey.states.inactive.linkOpacity","name":"linkOpacity","line":301,"lineEnd":304,"column":12,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":0.1},"children":{}},"opacity":{"doclet":{"description":"Opacity of the nodes in the sankey diagram in inactive mode.","type":{"names":["number"]},"defaultvalue":0.1},"meta":{"fullname":"plotOptions.sankey.states.inactive.opacity","name":"opacity","line":306,"lineEnd":308,"column":12,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":0.1},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.sankey.tooltip","name":"tooltip","line":322,"lineEnd":322,"column":4,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{"followPointer":{"doclet":{"description":"Whether the tooltip should follow the pointer or stay fixed on\nthe item.","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.sankey.tooltip.followPointer","name":"followPointer","line":323,"lineEnd":330,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":true},"children":{}},"headerFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"font-size: 0.8em\">{series.name}</span><br/>"},"meta":{"fullname":"plotOptions.sankey.tooltip.headerFormat","name":"headerFormat","line":336,"lineEnd":336,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":"<span style=\"font-size: 0.8em\">{series.name}</span><br/>"},"children":{}},"nodeFormat":{"doclet":{"description":"The\n[format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nspecifying what to show for _nodes_ in tooltip of a diagram\nseries, as opposed to links.","type":{"names":["string"]},"defaultvalue":"{point.name}: <b>{point.sum}</b><br/>"},"meta":{"fullname":"plotOptions.sankey.tooltip.nodeFormat","name":"nodeFormat","line":338,"lineEnd":343,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":"{point.name}: <b>{point.sum}</b><br/>"},"children":{}},"nodeFormatter":{"doclet":{"description":"A callback for defining the format for _nodes_ in the chart's\ntooltip, as opposed to links.","type":{"names":["Highcharts.FormatterCallbackFunction.<Highcharts.SankeyNodeObject>"]},"since":"6.0.2"},"meta":{"fullname":"plotOptions.sankey.tooltip.nodeFormatter","name":"nodeFormatter","line":323,"lineEnd":330,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{point.fromNode.name} → {point.toNode.name}: <b>{point.weight}</b><br/>"},"meta":{"fullname":"plotOptions.sankey.tooltip.pointFormat","name":"pointFormat","line":337,"lineEnd":337,"column":8,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js","default":"{point.fromNode.name} → {point.toNode.name}: <b>{point.weight}</b><br/>"},"children":{}}}}}},"scatter":{"doclet":{"description":"A scatter plot uses cartesian coordinates to display values for two\nvariables for a set of data.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `scatter` series are defined in\n   [plotOptions.scatter](plotOptions.scatter).\n3. Options for one single series are given in\n   [the series instance array](series.scatter).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        scatter: {\n            // shared options for all scatter series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'scatter'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.scatter.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === scatter) {\n    // code specific to the scatter series\n}\n```\n            ","samples":[{"name":"Scatter plot","value":"highcharts/demo/scatter/","products":["highcharts"]}],"extends":"plotOptions.line","exclude":["cropThreshold","legendSymbolColor","pointPlacement","shadow","useOhlcData"],"products":["highcharts","highstock"]},"meta":{"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js","name":"scatter","fullname":"plotOptions.scatter","line":12,"lineEnd":16,"column":0},"children":{"cluster":{"doclet":{"description":"Options for marker clusters, the concept of sampling the data\nvalues into larger blocks in order to ease readability and\nincrease performance of the JavaScript charts.\n\nNote: marker clusters module is not working with `boost`\nand `draggable-points` modules.\n\nThe marker clusters feature requires the marker-clusters.js\nfile to be loaded, found in the modules directory of the download\npackage, or online at [code.highcharts.com/modules/marker-clusters.js](code.highcharts.com/modules/marker-clusters.js).","samples":[{"name":"Maps marker clusters","value":"maps/marker-clusters/europe"},{"name":"Scatter marker clusters","value":"highcharts/marker-clusters/basic"},{"name":"Marker clusters with colorAxis","value":"maps/marker-clusters/optimized-kmeans"}],"products":["highcharts","highmaps"],"since":"8.0.0","requires":["module:modules/marker-clusters"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js","name":"cluster","fullname":"plotOptions.scatter.cluster","line":15,"lineEnd":19,"column":0},"children":{"allowOverlap":{"doclet":{"description":"When set to `false` prevent cluster overlapping - this option\nworks only when `layoutAlgorithm.type = \"grid\"`.","samples":[{"name":"Prevent overlapping","value":"highcharts/marker-clusters/grid"}],"requires":["module:modules/marker-clusters"],"since":"8.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.scatter.cluster.allowOverlap","name":"allowOverlap","line":57,"lineEnd":65,"column":4,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js","default":true},"children":{}},"animation":{"doclet":{"description":"Options for the cluster marker animation.","type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"defaultvalue":"{ \"duration\": 500 }","requires":["module:modules/marker-clusters"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.scatter.cluster.animation","name":"animation","line":67,"lineEnd":72,"column":4,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}},"dataLabels":{"doclet":{"description":"Options for the cluster data labels.","type":{"names":["Highcharts.DataLabelsOptions"]},"requires":["module:modules/marker-clusters"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.scatter.cluster.dataLabels","name":"dataLabels","line":235,"lineEnd":246,"column":4,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{"style":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{}}}},"drillToCluster":{"doclet":{"description":"Zoom the plot area to the cluster points range when a cluster is clicked.","requires":["module:modules/marker-clusters"],"since":"8.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.scatter.cluster.drillToCluster","name":"drillToCluster","line":77,"lineEnd":81,"column":4,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js","default":true},"children":{}},"enabled":{"doclet":{"description":"Whether to enable the marker-clusters module.","samples":[{"name":"Maps marker clusters","value":"maps/marker-clusters/basic"},{"name":"Scatter marker clusters","value":"highcharts/marker-clusters/basic"}],"requires":["module:modules/marker-clusters"],"since":"8.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.scatter.cluster.enabled","name":"enabled","line":46,"lineEnd":55,"column":4,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js","default":false},"children":{}},"events":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"drillToCluster":{"doclet":{"description":"Fires when the cluster point is clicked and `drillToCluster` is enabled.\nOne parameter, `event`, is passed to the function. The default action\nis to zoom to the cluster points range. This can be prevented\nby calling `event.preventDefault()`.","type":{"names":["Highcharts.MarkerClusterDrillCallbackFunction"]},"products":["highcharts","highmaps"],"see":["[cluster.drillToCluster](#plotOptions.scatter.cluster.drillToCluster)"],"requires":["module:modules/marker-clusters"]},"meta":{"fullname":"plotOptions.scatter.cluster.events.drillToCluster","name":"drillToCluster","line":235,"lineEnd":246,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}}}},"layoutAlgorithm":{"doclet":{"description":"Options for layout algorithm. Inside there\nare options to change the type of the algorithm, gridSize,\ndistance or iterations.","requires":["module:modules/marker-clusters"],"since":"8.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.scatter.cluster.layoutAlgorithm","name":"layoutAlgorithm","line":93,"lineEnd":99,"column":4,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{"distance":{"doclet":{"description":"When `type` is set to `kmeans`,\n`distance` is a maximum distance between point and cluster center\nso that this point will be inside the cluster. The distance\nis either a number defining pixels or a percentage\ndefining a percentage of the plot area width.","type":{"names":["number","string"]},"requires":["module:modules/marker-clusters"],"since":"8.0.0","defaultvalue":40},"meta":{"fullname":"plotOptions.scatter.cluster.layoutAlgorithm.distance","name":"distance","line":188,"lineEnd":196,"column":8,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js","default":40},"children":{}},"gridSize":{"doclet":{"description":"When `type` is set to the `grid`,\n`gridSize` is a size of a grid square element either as a number\ndefining pixels, or a percentage defining a percentage\nof the plot area width.","type":{"names":["number","string"]},"requires":["module:modules/marker-clusters"],"since":"8.0.0","defaultvalue":50},"meta":{"fullname":"plotOptions.scatter.cluster.layoutAlgorithm.gridSize","name":"gridSize","line":101,"lineEnd":177,"column":8,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js","default":50},"children":{}},"iterations":{"doclet":{"description":"When `type` is set to `kmeans`,\n`iterations` are the number of iterations that this algorithm will be\nrepeated to find clusters positions.","type":{"names":["number"]},"requires":["module:modules/marker-clusters"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.scatter.cluster.layoutAlgorithm.iterations","name":"iterations","line":188,"lineEnd":196,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}},"kmeansThreshold":{"doclet":{"description":"When `type` is set to `undefined` and there are more visible points\nthan the kmeansThreshold the `grid` algorithm is used to find\nclusters, otherwise `kmeans`. It ensures good performance on\nlarge datasets and better clusters arrangement after the zoom.","requires":["module:modules/marker-clusters"],"since":"8.0.0","type":{"names":["number"]},"defaultvalue":100},"meta":{"fullname":"plotOptions.scatter.cluster.layoutAlgorithm.kmeansThreshold","name":"kmeansThreshold","line":208,"lineEnd":215,"column":8,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js","default":100},"children":{}},"type":{"doclet":{"description":"Type of the algorithm used to combine points into a cluster.\nThere are three available algorithms:\n\n1) `grid` - grid-based clustering technique. Points are assigned\nto squares of set size depending on their position on the plot\narea. Points inside the grid square are combined into a cluster.\nThe grid size can be controlled by `gridSize` property\n(grid size changes at certain zoom levels).\n\n2) `kmeans` - based on K-Means clustering technique. In the\nfirst step, points are divided using the grid method (distance\nproperty is a grid size) to find the initial amount of clusters.\nNext, each point is classified by computing the distance between\neach cluster center and that point. When the closest cluster\ndistance is lower than distance property set by a user the point\nis added to this cluster otherwise is classified as `noise`. The\nalgorithm is repeated until each cluster center not change its\nprevious position more than one pixel. This technique is more\naccurate but also more time consuming than the `grid` algorithm,\nespecially for big datasets.\n\n3) `optimizedKmeans` - based on K-Means clustering technique. This\nalgorithm uses k-means algorithm only on the chart initialization\nor when chart extremes have greater range than on initialization.\nWhen a chart is redrawn the algorithm checks only clustered points\ndistance from the cluster center and rebuild it when the point is\nspaced enough to be outside the cluster. It provides performance\nimprovement and more stable clusters position yet can be used rather\non small and sparse datasets.\n\nBy default, the algorithm depends on visible quantity of points\nand `kmeansThreshold`. When there are more visible points than the\n`kmeansThreshold` the `grid` algorithm is used, otherwise `kmeans`.\n\nThe custom clustering algorithm can be added by assigning a callback\nfunction as the type property. This function takes an array of\n`processedXData`, `processedYData`, `processedXData` indexes and\n`layoutAlgorithm` options as arguments and should return an object\nwith grouped data.\n\nThe algorithm should return an object like that:\n<pre>{\n clusterId1: [{\n     x: 573,\n     y: 285,\n     index: 1 // point index in the data array\n }, {\n     x: 521,\n     y: 197,\n     index: 2\n }],\n clusterId2: [{\n     ...\n }]\n ...\n}</pre>\n\n`clusterId` (example above - unique id of a cluster or noise)\nis an array of points belonging to a cluster. If the\narray has only one point or fewer points than set in\n`cluster.minimumClusterSize` it won't be combined into a cluster.","samples":[{"name":"Optimized K-Means algorithm","value":"maps/marker-clusters/optimized-kmeans"},{"name":"K-Means algorithm","value":"highcharts/marker-clusters/kmeans"},{"name":"Grid algorithm","value":"highcharts/marker-clusters/grid"},{"name":"Custom algorithm","value":"maps/marker-clusters/custom-alg"}],"type":{"names":["string","function"]},"see":["[cluster.minimumClusterSize](#plotOptions.scatter.cluster.minimumClusterSize)"],"requires":["module:modules/marker-clusters"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.scatter.cluster.layoutAlgorithm.type","name":"type","line":101,"lineEnd":177,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}}}},"marker":{"doclet":{"description":"Options for the cluster marker.","type":{"names":["Highcharts.PointMarkerOptionsObject"]},"extends":"plotOptions.series.marker","exclude":["enabledThreshold","states"],"requires":["module:modules/marker-clusters"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.scatter.cluster.marker","name":"marker","line":218,"lineEnd":224,"column":4,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}},"minimumClusterSize":{"doclet":{"description":"The minimum amount of points to be combined into a cluster.\nThis value has to be greater or equal to 2.","samples":[{"name":"At least three points in the cluster","value":"highcharts/marker-clusters/basic"}],"requires":["module:modules/marker-clusters"],"since":"8.0.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.scatter.cluster.minimumClusterSize","name":"minimumClusterSize","line":83,"lineEnd":91,"column":4,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js","default":2},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"fillColor":{"doclet":{"description":"The fill color of the cluster marker in hover state. When\n`undefined`, the series' or point's fillColor for normal\nstate is used.","type":{"names":["Highcharts.ColorType"]},"requires":["module:modules/marker-clusters"]},"meta":{"fullname":"plotOptions.scatter.cluster.states.hover.fillColor","name":"fillColor","line":300,"lineEnd":308,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}}}}}},"zones":{"doclet":{"description":"An array defining zones within marker clusters.\n\nIn styled mode, the color zones are styled with the\n`.highcharts-cluster-zone-{n}` class, or custom\nclassed from the `className`\noption.","samples":[{"name":"Marker clusters zones","value":"highcharts/marker-clusters/basic"},{"name":"Zones on maps","value":"maps/marker-clusters/custom-alg"}],"type":{"names":["Array.<*>"]},"products":["highcharts","highmaps"],"requires":["module:modules/marker-clusters"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.scatter.cluster.zones","name":"zones","line":247,"lineEnd":264,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{"className":{"doclet":{"description":"Styled mode only. A custom class name for the zone.","samples":[{"name":"Zones styled by class name","value":"highcharts/css/color-zones/"}],"type":{"names":["string"]},"requires":["module:modules/marker-clusters"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.scatter.cluster.zones.className","name":"className","line":265,"lineEnd":274,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}},"from":{"doclet":{"description":"The value where the zone starts.","type":{"names":["number"]},"products":["highcharts","highmaps"],"requires":["module:modules/marker-clusters"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.scatter.cluster.zones.from","name":"from","line":284,"lineEnd":291,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}},"marker":{"doclet":{"description":"Settings for the cluster marker belonging to the zone.","see":["[cluster.marker](#plotOptions.scatter.cluster.marker)"],"extends":"plotOptions.scatter.cluster.marker","products":["highcharts","highmaps"],"requires":["module:modules/marker-clusters"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.scatter.cluster.zones.marker","name":"marker","line":275,"lineEnd":283,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}},"to":{"doclet":{"description":"The value where the zone ends.","type":{"names":["number"]},"products":["highcharts","highmaps"],"requires":["module:modules/marker-clusters"],"since":"8.0.0"},"meta":{"fullname":"plotOptions.scatter.cluster.zones.to","name":"to","line":292,"lineEnd":299,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}}}}}},"findNearestPointBy":{"doclet":{"type":{"names":["string"]},"defaultvalue":"xy"},"meta":{"fullname":"plotOptions.scatter.findNearestPointBy","name":"findNearestPointBy","line":42,"lineEnd":42,"column":4,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js","default":"xy"},"children":{}},"jitter":{"doclet":{"description":"Apply a jitter effect for the rendered markers. When plotting\ndiscrete values, a little random noise may help telling the points\napart. The jitter setting applies a random displacement of up to `n`\naxis units in either direction. So for example on a horizontal X\naxis, setting the `jitter.x` to 0.24 will render the point in a\nrandom position between 0.24 units to the left and 0.24 units to the\nright of the true axis position. On a category axis, setting it to\n0.5 will fill up the bin and make the data appear continuous.\n\nWhen rendered on top of a box plot or a column series, a jitter value\nof 0.24 will correspond to the underlying series' default\n[groupPadding](https://api.highcharts.com/highcharts/plotOptions.column.groupPadding)\nand [pointPadding](https://api.highcharts.com/highcharts/plotOptions.column.pointPadding)\nsettings.\n\n**Note:** With boost mode enabled, the jitter effect is not supported.","samples":[{"name":"Jitter on a scatter plot","value":"highcharts/demo/scatter-jitter","products":["highcharts"]},{"name":"Jittered scatter plot on top of a box plot","value":"highcharts/series-scatter/jitter-boxplot","products":["highcharts"]}],"products":["highcharts","highstock"],"since":"7.0.2","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.scatter.jitter","name":"jitter","line":43,"lineEnd":71,"column":4,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js"},"children":{"x":{"doclet":{"description":"The maximal X offset for the random jitter effect.","since":"7.0.2","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.scatter.jitter.x","name":"x","line":73,"lineEnd":75,"column":8,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"The maximal Y offset for the random jitter effect.","since":"7.0.2","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.scatter.jitter.y","name":"y","line":77,"lineEnd":79,"column":8,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js","default":0},"children":{}}}},"lineWidth":{"doclet":{"description":"The width of the line connecting the data points.","samples":[{"name":"0 by default","value":"highcharts/plotoptions/scatter-linewidth-none/","products":["highcharts"]},{"name":"1px","value":"highcharts/plotoptions/scatter-linewidth-1/","products":["highcharts"]}],"products":["highcharts","highstock"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.scatter.lineWidth","name":"lineWidth","line":31,"lineEnd":40,"column":4,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js","default":0},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.scatter.marker","name":"marker","line":82,"lineEnd":82,"column":4,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.scatter.marker.enabled","name":"enabled","line":83,"lineEnd":83,"column":8,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js","default":true},"children":{}}}},"stickyTracking":{"doclet":{"description":"Sticky tracking of mouse events. When true, the `mouseOut` event\non a series isn't triggered until the mouse moves over another\nseries, or out of the plot area. When false, the `mouseOut` event on\na series is triggered when the mouse leaves the area around the\nseries' graph or markers. This also implies the tooltip. When\n`stickyTracking` is false and `tooltip.shared` is false, the tooltip\nwill be hidden when moving the mouse between series.","type":{"names":["boolean"]},"defaultvalue":"false","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"plotOptions.scatter.stickyTracking","name":"stickyTracking","line":85,"lineEnd":98,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js"},"children":{}},"tooltip":{"doclet":{"description":"A configuration object for the tooltip rendering of each single\nseries. Properties are inherited from [tooltip](#tooltip).\nOverridable properties are `headerFormat`, `pointFormat`,\n`yDecimals`, `xDateFormat`, `yPrefix` and `ySuffix`. Unlike other\nseries, in a scatter plot the series.name by default shows in the\nheaderFormat and point.x and point.y in the pointFormat.","products":["highcharts","highstock","highmaps"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.scatter.tooltip","name":"tooltip","line":85,"lineEnd":98,"column":4,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js"},"children":{"headerFormat":{"doclet":{"products":["highcharts","highstock"],"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> <span style=\"font-size: 0.8em\"> {series.name}</span><br/>"},"meta":{"fullname":"plotOptions.scatter.tooltip.headerFormat","name":"headerFormat","line":110,"lineEnd":112,"column":8,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> <span style=\"font-size: 0.8em\"> {series.name}</span><br/>"},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"x: <b>{point.x}</b><br/>y: <b>{point.y}</b><br/>"},"meta":{"fullname":"plotOptions.scatter.tooltip.pointFormat","name":"pointFormat","line":115,"lineEnd":115,"column":8,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js","default":"x: <b>{point.x}</b><br/>y: <b>{point.y}</b><br/>"},"children":{}}}}}},"scatter3d":{"doclet":{"description":"A 3D scatter plot uses x, y and z coordinates to display values for three\nvariables for a set of data.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `scatter3d` series are defined in\n   [plotOptions.scatter3d](plotOptions.scatter3d).\n3. Options for one single series are given in\n   [the series instance array](series.scatter3d).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        scatter3d: {\n            // shared options for all scatter3d series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'scatter3d'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.scatter3d.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === scatter3d) {\n    // code specific to the scatter3d series\n}\n```\n            ","samples":[{"name":"Simple 3D scatter","value":"highcharts/3d/scatter/","products":["highcharts"]},{"name":"Draggable 3d scatter","value":"highcharts/demo/3d-scatter-draggable","products":["highcharts"]}],"extends":"plotOptions.scatter","exclude":["boostThreshold","boostBlending","cluster","dragDrop","legendSymbolColor"],"products":["highcharts"],"requires":["module:highcharts-3d"]},"meta":{"filename":"code/es-modules/Series/Scatter3D/Scatter3DSeriesDefaults.js","name":"scatter3d","fullname":"plotOptions.scatter3d","line":14,"lineEnd":18,"column":0},"children":{"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.scatter3d.tooltip","name":"tooltip","line":36,"lineEnd":36,"column":4,"filename":"code/es-modules/Series/Scatter3D/Scatter3DSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"x: <b>{point.x}</b><br/>y: <b>{point.y}</b><br/>z: <b>{point.z}</b><br/>"},"meta":{"fullname":"plotOptions.scatter3d.tooltip.pointFormat","name":"pointFormat","line":37,"lineEnd":37,"column":8,"filename":"code/es-modules/Series/Scatter3D/Scatter3DSeriesDefaults.js","default":"x: <b>{point.x}</b><br/>y: <b>{point.y}</b><br/>z: <b>{point.z}</b><br/>"},"children":{}}}}}},"series":{"doclet":{"description":"General options for all series types.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `line` series are defined in\n   [plotOptions.line](plotOptions.line).\n3. Options for one single series are given in\n   [the series instance array](series.line).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        line: {\n            // shared options for all line series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'line'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.line.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === line) {\n    // code specific to the line series\n}\n```\n            ","type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","name":"series","fullname":"plotOptions.series","line":12,"lineEnd":16,"column":0},"children":{"accessibility":{"doclet":{"description":"Accessibility options for a series.","declare":"Highcharts.SeriesAccessibilityOptionsObject","since":"7.1.0","requires":["module:modules/accessibility"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.accessibility","name":"accessibility","line":780,"lineEnd":787,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"description":{"doclet":{"description":"Provide a description of the series, announced to screen readers.","type":{"names":["string"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.series.accessibility.description","name":"description","line":795,"lineEnd":801,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"descriptionFormat":{"doclet":{"description":"Format to use for describing the data series group to assistive\ntechnology - including screen readers.","see":["[series.descriptionFormat](#accessibility.series.descriptionFormat)"],"type":{"names":["string"]},"since":"11.0.0"},"meta":{"fullname":"plotOptions.series.accessibility.descriptionFormat","name":"descriptionFormat","line":802,"lineEnd":810,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Enable/disable accessibility functionality for a specific series.","type":{"names":["boolean"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.series.accessibility.enabled","name":"enabled","line":788,"lineEnd":794,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"exposeAsGroupOnly":{"doclet":{"description":"Expose only the series element to screen readers, not its points.","type":{"names":["boolean"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.series.accessibility.exposeAsGroupOnly","name":"exposeAsGroupOnly","line":811,"lineEnd":817,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"keyboardNavigation":{"doclet":{"description":"Keyboard navigation for a series","declare":"Highcharts.SeriesAccessibilityKeyboardNavigationOptionsObject","since":"7.1.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.accessibility.keyboardNavigation","name":"keyboardNavigation","line":843,"lineEnd":849,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable/disable keyboard navigation support for a specific series.","type":{"names":["boolean"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.series.accessibility.keyboardNavigation.enabled","name":"enabled","line":850,"lineEnd":856,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}}}},"point":{"doclet":{"description":"Point accessibility options for a series.","extends":"accessibility.point","since":"9.3.0","requires":["module:modules/accessibility"]},"meta":{"fullname":"plotOptions.series.accessibility.point","name":"point","line":818,"lineEnd":825,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"descriptionFormatter":{"doclet":{"description":"Formatter function to use instead of the default for point\ndescriptions. Same as `accessibility.point.descriptionFormatter`, but\napplies to a series instead of the whole chart.\n\nNote: Prefer using [accessibility.point.valueDescriptionFormat](#plotOptions.series.accessibility.point.valueDescriptionFormat)\ninstead if possible, as default functionality such as describing\nannotations will be preserved.","see":["[accessibility.point.valueDescriptionFormat](#plotOptions.series.accessibility.point.valueDescriptionFormat)","[point.accessibility.description](#series.line.data.accessibility.description)","[accessibility.point.descriptionFormatter](#accessibility.point.descriptionFormatter)"],"type":{"names":["Highcharts.ScreenReaderFormatterCallbackFunction.<Highcharts.Point>"]},"since":"9.3.0"},"meta":{"fullname":"plotOptions.series.accessibility.point.descriptionFormatter","name":"descriptionFormatter","line":826,"lineEnd":842,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}}}}}},"allowPointSelect":{"doclet":{"description":"Allow this series' points to be selected by clicking on the graphic\n(columns, point markers, pie slices, map areas etc).\n\nThe selected points can be handled by point select and unselect\nevents, or collectively by the [getSelectedPoints](/class-reference/Highcharts.Chart#getSelectedPoints) function.\n\nAnd alternative way of selecting points is through dragging.","samples":[{"name":"Line","value":"highcharts/plotoptions/series-allowpointselect-line/","products":["highcharts"]},{"name":"Column","value":"highcharts/plotoptions/series-allowpointselect-column/","products":["highcharts"]},{"name":"Pie","value":"highcharts/plotoptions/series-allowpointselect-pie/","products":["highcharts"]},{"name":"Select a range of points through a drag selection","value":"highcharts/chart/events-selection-points/","products":["highcharts"]},{"name":"Map area","value":"maps/plotoptions/series-allowpointselect/","products":["highmaps"]},{"name":"Map bubble","value":"maps/plotoptions/mapbubble-allowpointselect/","products":["highmaps"]}],"since":"1.2.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.series.allowPointSelect","name":"allowPointSelect","line":38,"lineEnd":52,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":false},"children":{}},"animation":{"doclet":{"description":"Enable or disable the initial animation when a series is displayed.\nThe animation can also be set as a configuration object. Please\nnote that this option only applies to the initial animation of the\nseries itself. For other animations, see [chart.animation](#chart.animation) and the animation parameter under the API methods.\nThe following properties are supported:\n\n- `defer`: The animation delay time in milliseconds.\n\n- `duration`: The duration of the animation in milliseconds. (Defaults to\n  `1000`)\n\n- `easing`: Can be a string reference to an easing function set on\n  the `Math` object or a function. See the _Custom easing function_\n  demo below. (Defaults to `easeInOutSine`)\n\nDue to poor performance, animation is disabled in old IE browsers\nfor several chart types.","samples":[{"name":"Animation disabled","value":"highcharts/plotoptions/series-animation-disabled/","products":["highcharts"]},{"name":"Slower animation","value":"highcharts/plotoptions/series-animation-slower/","products":["highcharts"]},{"name":"Custom easing function","value":"highcharts/plotoptions/series-animation-easing/","products":["highcharts"]},{"name":"Slower animation","value":"stock/plotoptions/animation-slower/","products":["highstock"]},{"name":"Custom easing function","value":"stock/plotoptions/animation-easing/","products":["highstock"]},{"name":"Animation enabled on map series","value":"maps/plotoptions/series-animation-true/","products":["highmaps"]},{"name":"Disabled on mapbubble series","value":"maps/plotoptions/mapbubble-animation-false/","products":["highmaps"]}],"type":{"names":["boolean","Highcharts.AnimationOptionsObject"]},"defaultByProduct":{"highcharts":true,"highstock":true,"highmaps":false}},"meta":{"fullname":"plotOptions.series.animation","name":"animation","line":109,"lineEnd":148,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"animationLimit":{"doclet":{"description":"For some series, there is a limit that shuts down animation\nby default when the total number of points in the chart is too high.\nFor example, for a column chart and its derivatives, animation does\nnot run if there is more than 250 points totally. To disable this\ncap, set `animationLimit` to `Infinity`. This option works if animation\nis fired on individual points, not on a group of points like e.g. during\nthe initial animation.","samples":[{"name":"Animation limit on updating individual points","value":"highcharts/plotoptions/series-animationlimit/","products":["highcharts"]}],"type":{"names":["number"]}},"meta":{"fullname":"plotOptions.series.animationLimit","name":"animationLimit","line":38,"lineEnd":52,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"boostBlending":{"doclet":{"description":"Sets the color blending in the boost module.","type":{"names":["\"add\"","\"multiply\"","\"darken\""]},"defaultvalue":"undefined","requires":["module:modules/boost"]},"meta":{"fullname":"plotOptions.series.boostBlending","name":"boostBlending","line":369,"lineEnd":377,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"boostThreshold":{"doclet":{"description":"Set the point threshold for when a series should enter boost mode.\n\nSetting it to e.g. 2000 will cause the series to enter boost mode when there\nare 2000 or more points in the series.\n\nTo disable boosting on the series, set the `boostThreshold` to 0. Setting it\nto 1 will force boosting.\n\nNote that the [cropThreshold](plotOptions.series.cropThreshold) also affects\nthis setting. When zooming in on a series that has fewer points than the\n`cropThreshold`, all points are rendered although outside the visible plot\narea, and the `boostThreshold` won't take effect.","type":{"names":["number"]},"defaultvalue":"5000","requires":["module:modules/boost"]},"meta":{"fullname":"plotOptions.series.boostThreshold","name":"boostThreshold","line":350,"lineEnd":368,"filename":"code/es-modules/Extensions/Boost/Boost.js"},"children":{}},"borderColor":{"doclet":{"description":"The border color of the map areas.\n\nIn styled mode, the border stroke is given in the `.highcharts-point`\nclass.","samples":[{"name":"Borders demo","value":"maps/plotoptions/series-border/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc","products":["highmaps"]},"meta":{"fullname":"plotOptions.series.borderColor","name":"borderColor","line":128,"lineEnd":143,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"borderWidth":{"doclet":{"description":"The border width of each map area.\n\nIn styled mode, the border stroke width is given in the\n`.highcharts-point` class.","samples":[{"name":"Borders demo","value":"maps/plotoptions/series-border/"}],"type":{"names":["number"]},"defaultvalue":"1","products":["highmaps"]},"meta":{"fullname":"plotOptions.series.borderWidth","name":"borderWidth","line":145,"lineEnd":160,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"className":{"doclet":{"description":"An additional class name to apply to the series' graphical elements.\nThis option does not replace default class names of the graphical\nelement. Changes to the series' color will also be reflected in a\nchart's legend and tooltip.","samples":[{"name":"Series and point class name","value":"highcharts/css/point-series-classname","products":["highcharts"]}],"type":{"names":["string"]},"since":"5.0.0"},"meta":{"fullname":"plotOptions.series.className","name":"className","line":153,"lineEnd":165,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"clip":{"doclet":{"description":"Disable this option to allow series rendering in the whole plotting\narea.\n\n**Note:** Clipping should be always enabled when\n[chart.zoomType](#chart.zoomType) is set","samples":[{"name":"Disabled clipping","value":"highcharts/plotoptions/series-clip/","products":["highcharts"]}],"defaultvalue":"true","type":{"names":["boolean"]},"since":"3.0.0"},"meta":{"fullname":"plotOptions.series.clip","name":"clip","line":166,"lineEnd":180,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"color":{"doclet":{"description":"The main color of the series. In line type series it applies to the\nline and the point markers unless otherwise specified. In bar type\nseries it applies to the bars unless a color is specified per point.\nThe default value is pulled from the `options.colors` array.\n\nIn styled mode, the color can be defined by the\n[colorIndex](#plotOptions.series.colorIndex) option. Also, the series\ncolor can be set with the `.highcharts-series`,\n`.highcharts-color-{n}`, `.highcharts-{type}-series` or\n`.highcharts-series-{n}` class, or individual classes given by the\n`className` option.","productdesc":[{"value":"In maps, the series color is rarely used, as most choropleth maps use\nthe color to denote the value of each point. The series color can\nhowever be used in a map with multiple series holding categorized\ndata.","products":["highmaps"]}],"samples":[{"name":"General plot option","value":"highcharts/plotoptions/series-color-general/","products":["highcharts"]},{"name":"One specific series","value":"highcharts/plotoptions/series-color-specific/","products":["highcharts"]},{"name":"Area color","value":"highcharts/plotoptions/series-color-area/","products":["highcharts"]},{"name":"Pattern fill","value":"highcharts/series/infographic/","products":["highcharts"]},{"name":"Category map by multiple series","value":"maps/demo/category-map/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.series.color","name":"color","line":181,"lineEnd":213,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"colorAxis":{"doclet":{"description":"When using dual or multiple color axes, this number defines which\ncolorAxis the particular series is connected to. It refers to\neither the\n{@link #colorAxis.id|axis id}\nor the index of the axis in the colorAxis array, with 0 being the\nfirst. Set this option to false to prevent a series from connecting\nto the default color axis.\n\nSince v7.2.0 the option can also be an axis id or an axis index\ninstead of a boolean flag.","samples":[{"name":"Color axis with pie series","value":"highcharts/coloraxis/coloraxis-with-pie/"},{"name":"Multiple color axis","value":"highcharts/coloraxis/multiple-coloraxis/"}],"type":{"names":["number","string","boolean"]},"defaultvalue":"0","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"plotOptions.series.colorAxis","name":"colorAxis","line":2360,"lineEnd":2381,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"colorIndex":{"doclet":{"description":"Styled mode only. A specific color index to use for the series, so its\ngraphic representations are given the class name `highcharts-color-{n}`.\n\nSince v11, CSS variables on the form `--highcharts-color-{n}` make\nchanging the color scheme very convenient.","samples":[{"name":"Series and point color index","value":"highcharts/css/colorindex/","products":["highcharts"]}],"type":{"names":["number"]},"since":"5.0.0"},"meta":{"fullname":"plotOptions.series.colorIndex","name":"colorIndex","line":214,"lineEnd":227,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"colorKey":{"doclet":{"description":"Determines what data value should be used to calculate point color\nif `colorAxis` is used. Requires to set `min` and `max` if some\ncustom point property is used or if approximation for data grouping\nis set to `'sum'`.","samples":[{"name":"Custom color key","value":"highcharts/coloraxis/custom-color-key/"},{"name":"Custom colorKey with color axis stops","value":"highcharts/coloraxis/color-key-with-stops/"},{"name":"Changed default color key","value":"highcharts/coloraxis/changed-default-color-key/"}],"type":{"names":["string"]},"defaultvalue":"y","since":"7.2.0","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"plotOptions.series.colorKey","name":"colorKey","line":2382,"lineEnd":2400,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"compare":{"doclet":{"description":"Compare the values of the series against the first non-null, non-\nzero value in the visible range. The y axis will show percentage\nor absolute change depending on whether `compare` is set to `\"percent\"`\nor `\"value\"`. When this is applied to multiple series, it allows\ncomparing the development of the series against each other. Adds\na `change` field to every point object. If a `compare` value is not set on a\nlinked series, it will be inherited from the parent series.","see":["[compareBase](#plotOptions.series.compareBase)","[Axis.setCompare()](/class-reference/Highcharts.Axis#setCompare)","[Series.setCompare()](/class-reference/Highcharts.Series#setCompare)"],"samples":[{"name":"Percent","value":"stock/plotoptions/series-compare-percent/","products":["highstock"]},{"name":"Value","value":"stock/plotoptions/series-compare-value/","products":["highstock"]}],"type":{"names":["\"percent\"","\"value\""]},"since":"1.0.1","products":["highstock"]},"meta":{"fullname":"plotOptions.series.compare","name":"compare","line":457,"lineEnd":480,"filename":"code/es-modules/Series/DataModifyComposition.js"},"children":{}},"compareBase":{"doclet":{"description":"When [compare](#plotOptions.series.compare) is `percent`, this option\ndictates whether to use 0 or 100 as the base of comparison.","samples":[{"name":"Compare base is 100","value":"stock/plotoptions/series-comparebase/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"5.0.6","products":["highstock"],"values":"[0, 100]"},"meta":{"fullname":"plotOptions.series.compareBase","name":"compareBase","line":498,"lineEnd":511,"filename":"code/es-modules/Series/DataModifyComposition.js"},"children":{}},"compareStart":{"doclet":{"description":"Defines if comparison should start from the first point within the visible\nrange or should start from the last point **before** the range.\n\nIn other words, this flag determines if first point within the visible range\nwill have 0% (`compareStart=true`) or should have been already calculated\naccording to the previous point (`compareStart=false`).","samples":[{"name":"Calculate compare within visible range","value":"stock/plotoptions/series-comparestart/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"6.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.compareStart","name":"compareStart","line":481,"lineEnd":497,"filename":"code/es-modules/Series/DataModifyComposition.js"},"children":{}},"connectEnds":{"doclet":{"description":"Polar charts only. Whether to connect the ends of a line series\nplot across the extremes.","samples":[{"name":"Do not connect","value":"highcharts/plotoptions/line-connectends-false/","products":["highcharts"]}],"type":{"names":["boolean"]},"since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.series.connectEnds","name":"connectEnds","line":710,"lineEnd":721,"filename":"code/es-modules/Series/PolarComposition.js"},"children":{}},"connectNulls":{"doclet":{"description":"Whether to connect a graph line across null points, or render a gap\nbetween the two points on either side of the null.\n\nIn stacked area chart, if `connectNulls` is set to true,\nnull points are interpreted as 0.","samples":[{"name":"False by default","value":"highcharts/plotoptions/series-connectnulls-false/","products":["highcharts"]},{"name":"True","value":"highcharts/plotoptions/series-connectnulls-true/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.connectNulls","name":"connectNulls","line":228,"lineEnd":244,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"connectors":{"doclet":{"description":"Override Pathfinder connector options for a series. Requires Highcharts Gantt\nto be loaded.","declare":"Highcharts.SeriesConnectorsOptionsObject","extends":"connectors","since":"6.2.0","exclude":["enabled","algorithmMargin"],"products":["gantt"]},"meta":{"fullname":"plotOptions.series.connectors","name":"connectors","line":248,"lineEnd":258,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}},"crisp":{"doclet":{"description":"When true, each point or column edge is rounded to its nearest pixel\nin order to render sharp on screen. In some cases, when there are a\nlot of densely packed columns, this leads to visible difference\nin column widths or distance between columns. In these cases,\nsetting `crisp` to `false` may look better, even though each column\nis rendered blurry.","samples":[{"name":"Crisp is false","value":"highcharts/plotoptions/column-crisp-false/","products":["highcharts"]}],"since":"5.0.10","products":["highcharts","highstock","gantt"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.series.crisp","name":"crisp","line":79,"lineEnd":92,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":true},"children":{}},"cropThreshold":{"doclet":{"description":"When the series contains less points than the crop threshold, all\npoints are drawn, even if the points fall outside the visible plot\narea at the current zoom. The advantage of drawing all points\n(including markers and columns), is that animation is performed on\nupdates. On the other hand, when the series contains more points than\nthe crop threshold, the series data is cropped to only contain points\nthat fall within the plot area. The advantage of cropping away\ninvisible points is to increase performance on large series.","since":"2.2.0","products":["highcharts","highstock"],"type":{"names":["number"]},"defaultvalue":300},"meta":{"fullname":"plotOptions.series.cropThreshold","name":"cropThreshold","line":1976,"lineEnd":1988,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":300},"children":{}},"cumulative":{"doclet":{"description":"Cumulative Sum feature replaces points' values with the following formula:\n`sum of all previous points' values + current point's value`.\nWorks only for points in a visible range.\nAdds the `cumulativeSum` field to each point object that can be accessed\ne.g. in the [tooltip.pointFormat](https://api.highcharts.com/highstock/tooltip.pointFormat).\n\nWith `dataGrouping` enabled, default grouping approximation is set to `sum`.","see":["[Axis.setCumulative()](/class-reference/Highcharts.Axis#setCumulative)","[Series.setCumulative()](/class-reference/Highcharts.Series#setCumulative)"],"samples":[{"name":"Cumulative Sum","value":"stock/plotoptions/series-cumulative-sum/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"9.3.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.cumulative","name":"cumulative","line":512,"lineEnd":532,"filename":"code/es-modules/Series/DataModifyComposition.js"},"children":{}},"cumulativeStart":{"doclet":{"description":"Defines if cumulation should start from the first point within the visible\nrange or should start from the last point **before** the range.\n\nIn other words, this flag determines if first point within the visible range\nwill start at 0 (`cumulativeStart=true`) or should have been already calculated\naccording to the previous point (`cumulativeStart=false`).","samples":[{"name":"Cumulative Start","value":"stock/plotoptions/series-cumulativestart/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"11.4.2","products":["highstock"]},"meta":{"fullname":"plotOptions.series.cumulativeStart","name":"cumulativeStart","line":533,"lineEnd":549,"filename":"code/es-modules/Series/DataModifyComposition.js"},"children":{}},"cursor":{"doclet":{"description":"You can set the cursor to \"pointer\" if you have click events attached\nto the series, to signal to the user that the points and lines can\nbe clicked.\n\nIn styled mode, the series cursor can be set with the same classes\nas listed under [series.color](#plotOptions.series.color).","samples":[{"name":"On line graph","value":"highcharts/plotoptions/series-cursor-line/","products":["highcharts"]},{"name":"On columns","value":"highcharts/plotoptions/series-cursor-column/","products":["highcharts"]},{"name":"On scatter markers","value":"highcharts/plotoptions/series-cursor-scatter/","products":["highcharts"]},{"name":"Pointer on a line graph","value":"stock/plotoptions/cursor/","products":["highstock"]},{"name":"Map area","value":"maps/plotoptions/series-allowpointselect/","products":["highmaps"]},{"name":"Map bubble","value":"maps/plotoptions/mapbubble-allowpointselect/","products":["highmaps"]}],"type":{"names":["string","Highcharts.CursorValue"]}},"meta":{"fullname":"plotOptions.series.cursor","name":"cursor","line":245,"lineEnd":268,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"custom":{"doclet":{"description":"A reserved subspace to store options and values for customized\nfunctionality. Here you can add additional data for your own event\ncallbacks and formatter callbacks.","samples":[{"name":"Point and series with custom data","value":"highcharts/point/custom/","products":["highcharts"]}],"type":{"names":["Highcharts.Dictionary.<*>"]}},"meta":{"fullname":"plotOptions.series.custom","name":"custom","line":269,"lineEnd":279,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"dashStyle":{"doclet":{"description":"Name of the dash style to use for the graph, or for some series types\nthe outline of each shape.\n\nIn styled mode, the\n[stroke dash-array](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/css/series-dashstyle/)\ncan be set with the same classes as listed under\n[series.color](#plotOptions.series.color).","samples":[{"name":"Possible values demonstrated","value":"highcharts/plotoptions/series-dashstyle-all/","products":["highcharts"]},{"name":"Chart suitable for printing in black and white","value":"highcharts/plotoptions/series-dashstyle/","products":["highcharts"]},{"name":"Possible values demonstrated","value":"highcharts/plotoptions/series-dashstyle-all/","products":["highstock"]},{"name":"Possible values demonstrated","value":"highcharts/plotoptions/series-dashstyle-all/","products":["highmaps"]},{"name":"Dotted borders on a map","value":"maps/plotoptions/series-dashstyle/","products":["highmaps"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"2.1.0"},"meta":{"fullname":"plotOptions.series.dashStyle","name":"dashStyle","line":280,"lineEnd":304,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"dataGrouping":{"doclet":{"description":"Data grouping is the concept of sampling the data values into larger\nblocks in order to ease readability and increase performance of the\nJavaScript charts. Highcharts Stock by default applies data grouping when\nthe points become closer than a certain pixel value, determined by\nthe `groupPixelWidth` option.\n\nIf data grouping is applied, the grouping information of grouped\npoints can be read from the [Point.dataGroup](/class-reference/Highcharts.Point#dataGroup). If point options other than\nthe data itself are set, for example `name` or `color` or custom properties,\nthe grouping logic doesn't know how to group it. In this case the options of\nthe first point instance are copied over to the group point. This can be\naltered through a custom `approximation` callback function.","declare":"Highcharts.DataGroupingOptionsObject","products":["highstock"],"requires":["module:modules/stock"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.dataGrouping","name":"dataGrouping","line":169,"lineEnd":188,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{"anchor":{"doclet":{"description":"Specifies how the points should be located on the X axis inside the group.\nPoints that are extremes can be set separately. Available options:\n\n- `start` places the point at the beginning of the group\n(e.g. range 00:00:00 - 23:59:59 -> 00:00:00)\n\n- `middle` places the point in the middle of the group\n(e.g. range 00:00:00 - 23:59:59 -> 12:00:00)\n\n- `end` places the point at the end of the group\n(e.g. range 00:00:00 - 23:59:59 -> 23:59:59)","samples":[{"name":"Changing the point x-coordinate inside the group.","value":"stock/plotoptions/series-datagrouping-anchor","products":["highstock"]}],"see":["[dataGrouping.firstAnchor](#plotOptions.series.dataGrouping.firstAnchor)","[dataGrouping.lastAnchor](#plotOptions.series.dataGrouping.lastAnchor)"],"type":{"names":["Highcharts.DataGroupingAnchor"]},"since":"9.1.0","defaultvalue":"start"},"meta":{"fullname":"plotOptions.series.dataGrouping.anchor","name":"anchor","line":189,"lineEnd":212,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}},"approximation":{"doclet":{"description":"The method of approximation inside a group. When for example 30 days\nare grouped into one month, this determines what value should represent\nthe group. Possible values are \"average\", \"averages\", \"open\", \"high\",\n\"low\", \"close\" and \"sum\". For OHLC and candlestick series the approximation\nis \"ohlc\" by default, which finds the open, high, low and close values\nwithin all the grouped data. For ranges, the approximation is \"range\",\nwhich finds the low and high values. For multi-dimensional data,\nlike ranges and OHLC, \"averages\" will compute the average for each\ndimension.\n\nCustom aggregate methods can be added by assigning a callback function\nas the approximation. This function takes a numeric array as the\nargument and should return a single numeric value or `null`. Note\nthat the numeric array will never contain null values, only true\nnumbers. Instead, if null values are present in the raw data, the\nnumeric array will have an `.hasNulls` property set to `true`. For\nsingle-value data sets the data is available in the first argument\nof the callback function. For OHLC data sets, all the open values\nare in the first argument, all high values in the second etc.\n\nSince v4.2.7, grouping meta data is available in the approximation\ncallback from `this.dataGroupInfo`. It can be used to extract information\nfrom the raw data.\n\nDefaults to `average` for line-type series, `sum` for columns, `range`\nfor range series, `hlc` for HLC, and `ohlc` for OHLC and candlestick.","samples":[{"name":"Approximation callback with custom data","value":"stock/plotoptions/series-datagrouping-approximation","products":["highstock"]},{"name":"Simple approximation demo","value":"stock/plotoptions/series-datagrouping-simple-approximation","products":["highstock"]}],"type":{"names":["Highcharts.DataGroupingApproximationValue","function"]}},"meta":{"fullname":"plotOptions.series.dataGrouping.approximation","name":"approximation","line":213,"lineEnd":248,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}},"dateTimeLabelFormats":{"doclet":{"description":"Datetime formats for the header of the tooltip in a stock chart.\nThe format can vary within a chart depending on the currently selected\ntime range and the current data grouping.\n\nThe default formats are:\n```js\n{\n    millisecond: [\n        '%A, %e %b, %H:%M:%S.%L', '%A, %e %b, %H:%M:%S.%L', '-%H:%M:%S.%L'\n    ],\n    second: ['%A, %e %b, %H:%M:%S', '%A, %e %b, %H:%M:%S', '-%H:%M:%S'],\n    minute: ['%A, %e %b, %H:%M', '%A, %e %b, %H:%M', '-%H:%M'],\n    hour: ['%A, %e %b, %H:%M', '%A, %e %b, %H:%M', '-%H:%M'],\n    day: ['%A, %e %b %Y', '%A, %e %b', '-%A, %e %b %Y'],\n    week: ['%v %A, %e %b %Y', '%A, %e %b', '-%A, %e %b %Y'],\n    month: ['%B %Y', '%B', '-%B %Y'],\n    year: ['%Y', '%Y', '-%Y']\n}\n```\n\nFor each of these array definitions, the first item is the format\nused when the active time span is one unit. For instance, if the\ncurrent data applies to one week, the first item of the week array\nis used. The second and third items are used when the active time\nspan is more than two units. For instance, if the current data applies\nto two weeks, the second and third item of the week array are used,\n and applied to the start and end date of the time span.","type":{"names":["Object"]}},"meta":{"fullname":"plotOptions.series.dataGrouping.dateTimeLabelFormats","name":"dateTimeLabelFormats","line":249,"lineEnd":280,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable data grouping.","type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"plotOptions.series.dataGrouping.enabled","name":"enabled","line":281,"lineEnd":287,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}},"firstAnchor":{"doclet":{"description":"Specifies how the first grouped point is positioned on the xAxis.\nIf firstAnchor and/or lastAnchor are defined, then those options take\nprecedence over anchor for the first and/or last grouped points.\nAvailable options:\n\n-`start` places the point at the beginning of the group\n(e.g. range 00:00:00 - 23:59:59 -> 00:00:00)\n\n-`middle` places the point in the middle of the group\n(e.g. range 00:00:00 - 23:59:59 -> 12:00:00)\n\n-`end` places the point at the end of the group\n(e.g. range 00:00:00 - 23:59:59 -> 23:59:59)\n\n-`firstPoint` the first point in the group\n(e.g. points at 00:13, 00:35, 00:59 -> 00:13)\n\n-`lastPoint` the last point in the group\n(e.g. points at 00:13, 00:35, 00:59 -> 00:59)","samples":[{"name":"Applying first and last anchor.","value":"stock/plotoptions/series-datagrouping-first-anchor","products":["highstock"]}],"see":["[dataGrouping.anchor](#plotOptions.series.dataGrouping.anchor)"],"type":{"names":["Highcharts.DataGroupingAnchorExtremes"]},"since":"9.1.0","defaultvalue":"start"},"meta":{"fullname":"plotOptions.series.dataGrouping.firstAnchor","name":"firstAnchor","line":288,"lineEnd":318,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}},"forced":{"doclet":{"description":"When data grouping is forced, it runs no matter how small the intervals\nare. This can be handy for example when the sum should be calculated\nfor values appearing at random times within each hour.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"plotOptions.series.dataGrouping.forced","name":"forced","line":319,"lineEnd":327,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}},"groupAll":{"doclet":{"description":"By default only points within the visible range are grouped. Enabling this\noption will force data grouping to calculate all grouped points for a given\ndataset. That option prevents for example a column series from calculating\na grouped point partially. The effect is similar to\n[Series.getExtremesFromAll](#plotOptions.series.getExtremesFromAll) but does\nnot affect yAxis extremes.","samples":[{"name":"Two series with the same data but different groupAll setting","value":"stock/plotoptions/series-datagrouping-groupall/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"6.1.0"},"meta":{"fullname":"plotOptions.series.dataGrouping.groupAll","name":"groupAll","line":328,"lineEnd":343,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}},"groupPixelWidth":{"doclet":{"description":"The approximate pixel width of each group. If for example a series\nwith 30 points is displayed over a 600 pixel wide plot area, no grouping\nis performed. If however the series contains so many points that\nthe spacing is less than the groupPixelWidth, Highcharts will try\nto group it into appropriate groups so that each is more or less\ntwo pixels wide. If multiple series with different group pixel widths\nare drawn on the same x axis, all series will take the greatest width.\nFor example, line series have 2px default group width, while column\nseries have 10px. If combined, both the line and the column will\nhave 10px by default.","type":{"names":["number"]},"defaultvalue":"2"},"meta":{"fullname":"plotOptions.series.dataGrouping.groupPixelWidth","name":"groupPixelWidth","line":344,"lineEnd":359,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}},"lastAnchor":{"doclet":{"description":"Specifies how the last grouped point is positioned on the xAxis.\nIf firstAnchor and/or lastAnchor are defined, then those options take\nprecedence over anchor for the first and/or last grouped points.\nAvailable options:\n\n-`start` places the point at the beginning of the group\n(e.g. range 00:00:00 - 23:59:59 -> 00:00:00)\n\n-`middle` places the point in the middle of the group\n(e.g. range 00:00:00 - 23:59:59 -> 12:00:00)\n\n-`end` places the point at the end of the group\n(e.g. range 00:00:00 - 23:59:59 -> 23:59:59)\n\n-`firstPoint` the first point in the group\n(e.g. points at 00:13, 00:35, 00:59 -> 00:13)\n\n-`lastPoint` the last point in the group\n(e.g. points at 00:13, 00:35, 00:59 -> 00:59)","samples":[{"name":"Applying first and last anchor.","value":"stock/plotoptions/series-datagrouping-first-anchor","products":["highstock"]},{"name":"Applying the last anchor in the chart with live data.","value":"stock/plotoptions/series-datagrouping-last-anchor","products":["highstock"]}],"see":["[dataGrouping.anchor](#plotOptions.series.dataGrouping.anchor)"],"type":{"names":["Highcharts.DataGroupingAnchorExtremes"]},"since":"9.1.0","defaultvalue":"start"},"meta":{"fullname":"plotOptions.series.dataGrouping.lastAnchor","name":"lastAnchor","line":360,"lineEnd":393,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}},"smoothed":{"doclet":{"description":"Normally, a group is indexed by the start of that group, so for example\nwhen 30 daily values are grouped into one month, that month's x value\nwill be the 1st of the month. This apparently shifts the data to\nthe left. When the smoothed option is true, this is compensated for.\nThe data is shifted to the middle of the group, and min and max\nvalues are preserved. Internally, this is used in the Navigator series.","type":{"names":["boolean"]},"defaultvalue":"false","deprecated":true},"meta":{"fullname":"plotOptions.series.dataGrouping.smoothed","name":"smoothed","line":394,"lineEnd":406,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}},"units":{"doclet":{"description":"An array determining what time intervals the data is allowed to be\ngrouped to. Each array item is an array where the first value is\nthe time unit and the second value another array of allowed multiples.\n\nDefaults to:\n```js\nunits: [[\n    'millisecond', // unit name\n    [1, 2, 5, 10, 20, 25, 50, 100, 200, 500] // allowed multiples\n], [\n    'second',\n    [1, 2, 5, 10, 15, 30]\n], [\n    'minute',\n    [1, 2, 5, 10, 15, 30]\n], [\n    'hour',\n    [1, 2, 3, 4, 6, 8, 12]\n], [\n    'day',\n    [1]\n], [\n    'week',\n    [1]\n], [\n    'month',\n    [1, 3, 6]\n], [\n    'year',\n    null\n]]\n```","type":{"names":["Array.<Array.<string, (Array.<number>|null)>>"]}},"meta":{"fullname":"plotOptions.series.dataGrouping.units","name":"units","line":407,"lineEnd":443,"filename":"code/es-modules/Extensions/DataGrouping/DataGrouping.js"},"children":{}}}},"dataLabels":{"doclet":{"description":"Options for the series data labels, appearing next to each data\npoint.\n\nSince v6.2.0, multiple data labels can be applied to each single\npoint by defining them as an array of configs.\n\nIn styled mode, the data labels can be styled with the\n`.highcharts-data-label-box` and `.highcharts-data-label` class names\n([see example](https://www.highcharts.com/samples/highcharts/css/series-datalabels)).","samples":[{"name":"Data labels enabled","value":"highcharts/plotoptions/series-datalabels-enabled","products":["highcharts"]},{"name":"Multiple data labels on a bar series","value":"highcharts/plotoptions/series-datalabels-multiple","products":["highcharts"]},{"name":"Styled mode example","value":"highcharts/css/series-datalabels","products":["highcharts"]},{"name":"Choropleth map with data labels","value":"maps/demo/color-axis","products":["highmaps"]},{"name":"Using data labels as map markers","value":"maps/demo/mappoint-datalabels-mapmarker","products":["highmaps"]}],"type":{"names":["*","Array.<*>"]},"products":["highcharts","highstock","highmaps","gantt"]},"meta":{"fullname":"plotOptions.series.dataLabels","name":"dataLabels","line":1420,"lineEnd":1444,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"align":{"doclet":{"description":"The alignment of the data label compared to the point. If `right`,\nthe right side of the label should be touching the point. For points\nwith an extent, like columns, the alignments also dictates how to\nalign it inside the box, as given with the\n[inside](#plotOptions.column.dataLabels.inside) option. Can be one of\n`left`, `center` or `right`.","samples":[{"name":"Left aligned","value":"highcharts/plotoptions/series-datalabels-align-left/","products":["highcharts"]},{"name":"Data labels inside the bar","value":"highcharts/plotoptions/bar-datalabels-align-inside-bar/","products":["highcharts"]}],"type":{"names":["Highcharts.AlignValue","null"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.series.dataLabels.align","name":"align","line":1466,"lineEnd":1474,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":"center"},"children":{}},"alignTo":{"doclet":{"description":"Alignment method for data labels. If set to `plotEdges`, the labels\nare aligned within the plot area in the direction of the y-axis. So\nin a regular column chart, the labels are aligned vertically\naccording to the `verticalAlign` setting. In a bar chart, which is\ninverted, the labels are aligned horizontally according to the\n`align` setting. Applies to cartesian series only.","samples":[{"name":"Align to plot edges","value":"highcharts/series-bar/datalabels-alignto/","products":["highcharts"]}],"type":{"names":["string"]},"since":"11.4.2"},"meta":{"fullname":"plotOptions.series.dataLabels.alignTo","name":"alignTo","line":1493,"lineEnd":1507,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"allowOverlap":{"doclet":{"description":"Whether to allow data labels to overlap. To make the labels less\nsensitive for overlapping, the\n[dataLabels.padding](#plotOptions.series.dataLabels.padding)\ncan be set to 0.","samples":[{"name":"Don't allow overlap","value":"highcharts/plotoptions/series-datalabels-allowoverlap-false/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"4.1.0"},"meta":{"fullname":"plotOptions.series.dataLabels.allowOverlap","name":"allowOverlap","line":1508,"lineEnd":1521,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"animation":{"doclet":{"description":"Enable or disable the initial animation when a series is displayed\nfor the `dataLabels`. The animation can also be set as a\nconfiguration object. Please note that this option only applies to\nthe initial animation.\n\nFor other animations, see [chart.animation](#chart.animation) and the\nanimation parameter under the API methods. The following properties\nare supported:\n\n- `defer`: The animation delay time in milliseconds.","samples":[{"name":"Animation defer settings","value":"highcharts/plotoptions/animation-defer/","products":["highcharts"]}],"type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"since":"8.2.0"},"meta":{"fullname":"plotOptions.series.dataLabels.animation","name":"animation","line":1446,"lineEnd":1464,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"defer":{"doclet":{"description":"The animation delay time in milliseconds. Set to `0` to render the\ndata labels immediately. As `undefined` inherits defer time from the\n[series.animation.defer](#plotOptions.series.animation.defer).","type":{"names":["number"]},"since":"8.2.0"},"meta":{"fullname":"plotOptions.series.dataLabels.animation.defer","name":"defer","line":1466,"lineEnd":1474,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}}}},"backgroundColor":{"doclet":{"description":"The background color or gradient for the data label. Setting it to\n`auto` will use the point's color.","samples":[{"name":"Data labels box options","value":"highcharts/plotoptions/series-datalabels-box/","products":["highcharts"]},{"name":"Data labels box options","value":"maps/plotoptions/series-datalabels-box/","products":["highmaps"]},{"name":"Data labels as map markers","value":"maps/demo/mappoint-datalabels-mapmarker","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"since":"2.2.1"},"meta":{"fullname":"plotOptions.series.dataLabels.backgroundColor","name":"backgroundColor","line":1522,"lineEnd":1536,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"borderColor":{"doclet":{"description":"The border color for the data label. Setting it to `auto` will use\nthe point's color. Defaults to `undefined`.","samples":[{"name":"Data labels box options","value":"highcharts/plotoptions/series-datalabels-box/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"since":"2.2.1"},"meta":{"fullname":"plotOptions.series.dataLabels.borderColor","name":"borderColor","line":1537,"lineEnd":1547,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"borderRadius":{"doclet":{"description":"The border radius in pixels for the data label.","samples":[{"name":"Data labels box options","value":"highcharts/plotoptions/series-datalabels-box/","products":["highcharts"]},{"name":"Data labels box options","value":"maps/plotoptions/series-datalabels-box/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"2.2.1"},"meta":{"fullname":"plotOptions.series.dataLabels.borderRadius","name":"borderRadius","line":1548,"lineEnd":1560,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"borderWidth":{"doclet":{"description":"The border width in pixels for the data label.","samples":[{"name":"Data labels box options","value":"highcharts/plotoptions/series-datalabels-box/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"2.2.1"},"meta":{"fullname":"plotOptions.series.dataLabels.borderWidth","name":"borderWidth","line":1561,"lineEnd":1571,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"className":{"doclet":{"description":"A class name for the data label. Particularly in styled mode,\nthis can be used to give each series' or point's data label\nunique styling. In addition to this option, a default color class\nname is added so that we can give the labels a contrast text\nshadow.","samples":[{"name":"Contrast text shadow","value":"highcharts/css/data-label-contrast/","products":["highcharts"]},{"name":"Styling by CSS","value":"highcharts/css/series-datalabels/","products":["highcharts"]}],"type":{"names":["string"]},"since":"5.0.0"},"meta":{"fullname":"plotOptions.series.dataLabels.className","name":"className","line":1573,"lineEnd":1588,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"color":{"doclet":{"description":"This options is deprecated.\nUse [style.color](#plotOptions.series.dataLabels.style) instead.\n\nThe text color for the data labels. Defaults to `undefined`. For\ncertain series types, like column or map, the data labels can be\ndrawn inside the points. In this case the data label will be\ndrawn with maximum contrast by default. Additionally, it will be\ngiven a `text-outline` style with the opposite color, to further\nincrease the contrast. This can be overridden by setting the\n`text-outline` style to `none` in the `dataLabels.style` option.","samples":[{"name":"Red data labels","value":"highcharts/plotoptions/series-datalabels-color/","products":["highcharts"]},{"name":"White data labels","value":"maps/demo/color-axis/","products":["highmaps"]}],"see":["[style.color](#plotOptions.series.dataLabels.style)"],"type":{"names":["Highcharts.ColorType"]},"deprecated":"10.3.0"},"meta":{"fullname":"plotOptions.series.dataLabels.color","name":"color","line":1589,"lineEnd":1611,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"crop":{"doclet":{"description":"Whether to hide data labels that are outside the plot area. By\ndefault, the data label is moved inside the plot area according\nto the\n[overflow](#plotOptions.series.dataLabels.overflow)\noption.","type":{"names":["boolean"]},"defaultvalue":"true","since":"2.3.3"},"meta":{"fullname":"plotOptions.series.dataLabels.crop","name":"crop","line":1612,"lineEnd":1623,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"defer":{"doclet":{"description":"Whether to defer displaying the data labels until the initial\nseries animation has finished. Setting to `false` renders the\ndata label immediately. If set to `true` inherits the defer\ntime set in [plotOptions.series.animation](#plotOptions.series.animation).","since":"4.0.0","type":{"names":["boolean"]},"products":["highcharts","highstock","gantt"],"defaultvalue":true},"meta":{"fullname":"plotOptions.series.dataLabels.defer","name":"defer","line":1573,"lineEnd":1588,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":true},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the data labels.","samples":[{"name":"Data labels enabled","value":"highcharts/plotoptions/series-datalabels-enabled/","products":["highcharts"]},{"name":"Data labels enabled","value":"maps/demo/color-axis/","products":["highmaps"]}],"type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"plotOptions.series.dataLabels.enabled","name":"enabled","line":1635,"lineEnd":1646,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"filter":{"doclet":{"description":"A declarative filter to control of which data labels to display.\nThe declarative filter is designed for use when callback\nfunctions are not available, like when the chart options require\na pure JSON structure or for use with graphical editors. For\nprogrammatic control, use the `formatter` instead, and return\n`undefined` to disable a single data label.\n\n```js\nfilter: {\n    property: 'percentage',\n    operator: '>',\n    value: 4\n}\n```","samples":[{"name":"Data labels filtered by percentage","value":"highcharts/demo/pie-monochrome","products":["highcharts"]}],"declare":"Highcharts.DataLabelsFilterOptionsObject","since":"6.0.3","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.dataLabels.filter","name":"filter","line":1647,"lineEnd":1669,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"operator":{"doclet":{"description":"The operator to compare by. Can be one of `>`, `<`, `>=`, `<=`,\n`==`, `===`, `!=` and `!==`.","type":{"names":["\">\"","\"<\"","\">=\"","\"<=\"","\"==\"","\"===\"","\"!=\"","\"!==\""]},"since":"6.0.3"},"meta":{"fullname":"plotOptions.series.dataLabels.filter.operator","name":"operator","line":1670,"lineEnd":1677,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"property":{"doclet":{"description":"The point property to filter by. Point options are passed\ndirectly to properties, additionally there are `y` value,\n`percentage` and others listed under {@link Highcharts.Point}\nmembers.","type":{"names":["string"]},"since":"6.0.3"},"meta":{"fullname":"plotOptions.series.dataLabels.filter.property","name":"property","line":1678,"lineEnd":1686,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"value":{"doclet":{"description":"The value to compare against.","type":{"names":["number"]},"since":"6.0.3"},"meta":{"fullname":"plotOptions.series.dataLabels.filter.value","name":"value","line":1687,"lineEnd":1692,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}}}},"format":{"doclet":{"description":"A\n[format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nfor the data label. Available variables are the same as for\n`formatter`.","samples":[{"name":"Add a unit","value":"highcharts/plotoptions/series-datalabels-format/","products":["highcharts"]},{"name":"Complex logic in the format string","value":"highcharts/plotoptions/series-datalabels-format-subexpression/","products":["highcharts"]},{"name":"Formatted value in the data label","value":"maps/plotoptions/series-datalabels-format/","products":["highmaps"]}],"type":{"names":["string"]},"defaultvalue":"point.value","since":"3.0.0"},"meta":{"fullname":"plotOptions.series.dataLabels.format","name":"format","line":1693,"lineEnd":1711,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"formatter":{"doclet":{"description":"Callback JavaScript function to format the data label. Note that if a\n`format` is defined, the format takes precedence and the formatter is\nignored.","samples":[{"name":"Formatted value","value":"maps/plotoptions/series-datalabels-format/","products":["highmaps"]}],"type":{"names":["Highcharts.DataLabelsFormatterCallbackFunction"]}},"meta":{"fullname":"plotOptions.series.dataLabels.formatter","name":"formatter","line":1635,"lineEnd":1646,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"inside":{"doclet":{"description":"For points with an extent, like columns or map areas, whether to\nalign the data label inside the box or to the actual value point.\nDefaults to `false` in most cases, `true` in stacked columns.","type":{"names":["boolean"]},"since":"3.0.0"},"meta":{"fullname":"plotOptions.series.dataLabels.inside","name":"inside","line":1727,"lineEnd":1735,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"labelrank":{"doclet":{"description":"The rank for this point's data label in case of collision. If two\ndata labels are about to overlap, only the one with the highest\n`labelrank` will be drawn.","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.series.dataLabels.labelrank","name":"labelrank","line":1736,"lineEnd":1743,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"nullFormat":{"doclet":{"description":"Format for points with the value of null. Works analogously to\n[format](#plotOptions.series.dataLabels.format). `nullFormat` can\nbe applied only to series which support displaying null points.\n`heatmap` and `tilemap` supports `nullFormat` by default while the\nfollowing series requires [#series.nullInteraction] set to `true`:\n`line`, `spline`, `area`, `area-spline`, `column`, `bar`, and\n`timeline`. Does not work with series that don't display null\npoints, like `pie`.","samples":[{"name":"Line chart with null interaction","value":"highcharts/series/null-interaction/","products":["highcharts"]},{"name":"Heatmap with null interaction","value":"highcharts/plotoptions/series-datalabels-nullformat/","products":["highcharts"]}],"type":{"names":["boolean","string"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.series.dataLabels.nullFormat","name":"nullFormat","line":1744,"lineEnd":1762,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"nullFormatter":{"doclet":{"description":"Callback JavaScript function that defines formatting for points\nwith the value of null. Works analogously to\n[formatter](#plotOptions.series.dataLabels.formatter).\n`nullFormatter` can be applied only to series which support\ndisplaying null points. `heatmap` and `tilemap` supports\n`nullFormatter` by default while the following series requires\n(series.nullInteraction)[#series.nullInteraction]\nset to `true`: `line`, `spline`, `area`, `area-spline`, `column`,\n`bar`, and `timeline`. Does not work with series that don't display\nnull points, like `pie`.","samples":[{"name":"Format data label for null points in heat map","value":"highcharts/plotoptions/series-datalabels-nullformat/","products":["highcharts"]}],"type":{"names":["Highcharts.DataLabelsFormatterCallbackFunction"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.series.dataLabels.nullFormatter","name":"nullFormatter","line":1763,"lineEnd":1781,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"overflow":{"doclet":{"description":"How to handle data labels that flow outside the plot area. The\ndefault is `\"justify\"`, which aligns them inside the plot area.\nFor columns and bars, this means it will be moved inside the bar.\nTo display data labels outside the plot area, set `crop` to\n`false` and `overflow` to `\"allow\"`.","type":{"names":["Highcharts.DataLabelsOverflowValue"]},"defaultvalue":"justify","since":"3.0.6"},"meta":{"fullname":"plotOptions.series.dataLabels.overflow","name":"overflow","line":1782,"lineEnd":1793,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"padding":{"doclet":{"description":"When either the `borderWidth` or the `backgroundColor` is set,\nthis is the padding within the box.","samples":[{"name":"Data labels box options","value":"highcharts/plotoptions/series-datalabels-box/","products":["highcharts"]},{"name":"Data labels box options","value":"maps/plotoptions/series-datalabels-box/","products":["highmaps"]}],"since":"2.2.1","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"plotOptions.series.dataLabels.padding","name":"padding","line":1727,"lineEnd":1735,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":5},"children":{}},"position":{"doclet":{"description":"Aligns data labels relative to points. If `center` alignment is\nnot possible, it defaults to `right`.","type":{"names":["Highcharts.AlignValue"]},"defaultvalue":"center"},"meta":{"fullname":"plotOptions.series.dataLabels.position","name":"position","line":1806,"lineEnd":1813,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"rotation":{"doclet":{"description":"Text rotation in degrees. Note that due to a more complex\nstructure, backgrounds, borders and padding will be lost on a\nrotated data label.","samples":[{"name":"Vertical labels","value":"highcharts/plotoptions/series-datalabels-rotation/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"plotOptions.series.dataLabels.rotation","name":"rotation","line":1814,"lineEnd":1825,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"shadow":{"doclet":{"description":"The shadow of the box. Works best with `borderWidth` or\n`backgroundColor`. Since 2.3 the shadow can be an object\nconfiguration containing `color`, `offsetX`, `offsetY`, `opacity`\nand `width`.","samples":[{"name":"Data labels box options","value":"highcharts/plotoptions/series-datalabels-box/","products":["highcharts"]}],"type":{"names":["boolean","Highcharts.ShadowOptionsObject"]},"defaultvalue":"false","since":"2.2.1"},"meta":{"fullname":"plotOptions.series.dataLabels.shadow","name":"shadow","line":1826,"lineEnd":1839,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"shape":{"doclet":{"description":"The name of a symbol to use for the border around the label.\nSymbols are predefined functions on the Renderer object.","samples":[{"name":"A callout for annotations","value":"highcharts/plotoptions/series-datalabels-shape/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"square","since":"4.1.2"},"meta":{"fullname":"plotOptions.series.dataLabels.shape","name":"shape","line":1840,"lineEnd":1851,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"style":{"doclet":{"description":"Styles for the label. The default `color` setting is\n`\"contrast\"`, which is a pseudo color that Highcharts picks up\nand applies the maximum contrast to the underlying point item,\nfor example the bar in a bar chart.\n\nThe `textOutline` is a pseudo property that applies an outline of\nthe given width with the given color, which by default is the\nmaximum contrast to the text. So a bright text color will result\nin a black text outline for maximum readability on a mixed\nbackground. In some cases, especially with grayscale text, the\ntext outline doesn't work well, in which cases it can be disabled\nby setting it to `\"none\"`. When `useHTML` is true, the\n`textOutline` will not be picked up. In this, case, the same\neffect can be achieved through the `text-shadow` CSS property.\n\nFor some series types, where each point has an extent, like for\nexample tree maps, the data label may overflow the point. There\nare two strategies for handling overflow. By default, the text\nwill wrap to multiple lines. The other strategy is to set\n`style.textOverflow` to `ellipsis`, which will keep the text on\none line plus it will break inside long words.","samples":[{"name":"Bold labels","value":"highcharts/plotoptions/series-datalabels-style/","products":["highcharts"]},{"name":"Long labels truncated with an ellipsis in a pie","value":"highcharts/plotoptions/pie-datalabels-overflow/","products":["highcharts"]},{"name":"Long labels are wrapped in a pie","value":"highcharts/plotoptions/pie-datalabels-overflow-wrap/","products":["highcharts"]},{"name":"Bold labels","value":"maps/demo/color-axis/","products":["highmaps"]}],"type":{"names":["Highcharts.CSSObject"]},"since":"4.1.0","defaultvalue":"{ fontSize: '0.7em', fontWeight: 'bold', color: 'contrast', textOutline: '1px contrast' }"},"meta":{"fullname":"plotOptions.series.dataLabels.style","name":"style","line":1852,"lineEnd":1888,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"textPath":{"doclet":{"description":"Options for a label text which should follow marker's shape.\nBorder and background are disabled for a label that follows a\npath.\n\n**Note:** Only SVG-based renderer supports this option. Setting\n`useHTML` to true will disable this option.","declare":"Highcharts.DataLabelsTextPathOptionsObject","since":"7.1.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.dataLabels.textPath","name":"textPath","line":1899,"lineEnd":1910,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"attributes":{"doclet":{"description":"Presentation attributes for the text path.","type":{"names":["Highcharts.SVGAttributes"]},"since":"7.1.0"},"meta":{"fullname":"plotOptions.series.dataLabels.textPath.attributes","name":"attributes","line":1911,"lineEnd":1917,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable `textPath` option for link's or marker's data\nlabels.","type":{"names":["boolean"]},"since":"7.1.0","defaultvalue":"false"},"meta":{"fullname":"plotOptions.series.dataLabels.textPath.enabled","name":"enabled","line":1918,"lineEnd":1925,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}}}},"useHTML":{"doclet":{"description":"Whether to\n[use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the labels.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"plotOptions.series.dataLabels.useHTML","name":"useHTML","line":1926,"lineEnd":1934,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of a data label. Can be one of `top`,\n`middle` or `bottom`. The default value depends on the data, for\ninstance in a column chart, the label is above positive values\nand below negative values.","type":{"names":["Highcharts.VerticalAlignValue","null"]},"since":"2.3.3","defaultvalue":null},"meta":{"fullname":"plotOptions.series.dataLabels.verticalAlign","name":"verticalAlign","line":1899,"lineEnd":1910,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":"bottom"},"children":{}},"x":{"doclet":{"description":"The x position offset of the label relative to the point in\npixels.","samples":[{"name":"Vertical and positioned","value":"highcharts/plotoptions/series-datalabels-rotation/","products":["highcharts"]},{"name":"Data labels inside the bar","value":"highcharts/plotoptions/bar-datalabels-align-inside-bar/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.series.dataLabels.x","name":"x","line":1945,"lineEnd":1953,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"The y position offset of the label relative to the point in\npixels.","samples":[{"name":"Vertical and positioned","value":"highcharts/plotoptions/series-datalabels-rotation/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.series.dataLabels.y","name":"y","line":1955,"lineEnd":1961,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":0},"children":{}}}},"dataSorting":{"doclet":{"description":"Options for the series data sorting.","type":{"names":["Highcharts.DataSortingOptionsObject"]},"since":"8.0.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.dataSorting","name":"dataSorting","line":319,"lineEnd":326,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable or disable data sorting for the series. Use [xAxis.reversed](#xAxis.reversed) to change the sorting order.","samples":[{"name":"Data sorting in scatter-3d","value":"highcharts/datasorting/animation/","products":["highcharts"]},{"name":"Axis labels animation","value":"highcharts/datasorting/labels-animation/","products":["highcharts"]},{"name":"Dependent series sorting","value":"highcharts/datasorting/dependent-sorting/","products":["highcharts"]},{"name":"Independent series sorting","value":"highcharts/datasorting/independent-sorting/","products":["highcharts"]}],"type":{"names":["boolean"]},"since":"8.0.0"},"meta":{"fullname":"plotOptions.series.dataSorting.enabled","name":"enabled","line":327,"lineEnd":343,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"matchByName":{"doclet":{"description":"Whether to allow matching points by name in an update. If this option\nis disabled, points will be matched by order.","samples":[{"name":"Enabled match by name","value":"highcharts/datasorting/match-by-name/","products":["highcharts"]}],"type":{"names":["boolean"]},"since":"8.0.0"},"meta":{"fullname":"plotOptions.series.dataSorting.matchByName","name":"matchByName","line":344,"lineEnd":354,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"sortKey":{"doclet":{"description":"Determines what data value should be used to sort by.","samples":[{"name":"Sort key as `z` value","value":"highcharts/datasorting/sort-key/","products":["highcharts"]}],"type":{"names":["string"]},"since":"8.0.0","defaultvalue":"y"},"meta":{"fullname":"plotOptions.series.dataSorting.sortKey","name":"sortKey","line":355,"lineEnd":365,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}}}},"description":{"doclet":{"description":"Deprecated. Use\n[plotOptions.series.accessibility.description](#plotOptions.series.accessibility.description)\ninstead.\n\nA description of the series to add to the screen reader information\nabout the series.","deprecated":"8.0.0","type":{"names":["string"]},"since":"5.0.0","requires":["module:modules/accessibility"]},"meta":{"fullname":"plotOptions.series.description","name":"description","line":305,"lineEnd":318,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"dragDrop":{"doclet":{"description":"The draggable-points module allows points to be moved around or modified in\nthe chart. In addition to the options mentioned under the `dragDrop` API\nstructure, the module fires three events,\n[point.dragStart](plotOptions.series.point.events.dragStart),\n[point.drag](plotOptions.series.point.events.drag) and\n[point.drop](plotOptions.series.point.events.drop).","samples":[{"name":"Draggable column and line series","value":"highcharts/dragdrop/resize-column","products":["highcharts","highstock"]},{"name":"Draggable bar","value":"highcharts/dragdrop/bar-series","products":["highcharts","highstock"]},{"name":"Draggable bubbles","value":"highcharts/dragdrop/drag-bubble","products":["highcharts","highstock"]},{"name":"Draggable X range series","value":"highcharts/dragdrop/drag-xrange","products":["highcharts","highstock"]},{"name":"Dragging disabled for specific points","value":"highcharts/dragdrop/undraggable-points","products":["highcharts","highstock"]},{"name":"Draggable Map Point series","value":"maps/series/draggable-mappoint","products":["highmaps"]}],"declare":"Highcharts.SeriesDragDropOptionsObject","since":"6.2.0","requires":["module:modules/draggable-points"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","name":"dragDrop","fullname":"plotOptions.series.dragDrop","line":13,"lineEnd":17,"column":0},"children":{"dragHandle":{"doclet":{"description":"Options for the drag handles available in column series.","declare":"Highcharts.DragDropHandleOptionsObject","since":"6.2.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.dragDrop.dragHandle","name":"dragHandle","line":243,"lineEnd":249,"column":4,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{"className":{"doclet":{"description":"The class name of the drag handles. Defaults to `highcharts-drag-handle`.","since":"6.2.0","type":{"names":["string"]},"defaultvalue":"highcharts-drag-handle"},"meta":{"fullname":"plotOptions.series.dragDrop.dragHandle.className","name":"className","line":251,"lineEnd":259,"column":8,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":"highcharts-drag-handle"},"children":{}},"color":{"doclet":{"description":"The fill color of the drag handles.","type":{"names":["Highcharts.ColorType"]},"since":"6.2.0","defaultvalue":"#fff"},"meta":{"fullname":"plotOptions.series.dragDrop.dragHandle.color","name":"color","line":277,"lineEnd":282,"column":8,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":"#fff"},"children":{}},"lineColor":{"doclet":{"description":"The line color of the drag handles.","type":{"names":["Highcharts.ColorString"]},"since":"6.2.0","defaultvalue":"rgba(0, 0, 0, 0.6)"},"meta":{"fullname":"plotOptions.series.dragDrop.dragHandle.lineColor","name":"lineColor","line":284,"lineEnd":289,"column":8,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":"rgba(0, 0, 0, 0.6)"},"children":{}},"lineWidth":{"doclet":{"description":"The line width for the drag handles.","since":"6.2.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.series.dragDrop.dragHandle.lineWidth","name":"lineWidth","line":291,"lineEnd":295,"column":8,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":1},"children":{}},"zIndex":{"doclet":{"description":"The z index for the drag handles.","since":"6.2.0","type":{"names":["number"]},"defaultvalue":901},"meta":{"fullname":"plotOptions.series.dragDrop.dragHandle.zIndex","name":"zIndex","line":297,"lineEnd":301,"column":8,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":901},"children":{}}}},"dragMaxX":{"doclet":{"description":"Set the maximum X value the points can be moved to.","samples":[{"name":"Limit dragging","value":"gantt/dragdrop/drag-gantt","products":["gantt"]},{"name":"Limit dragging","value":"highcharts/dragdrop/drag-xrange","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.dragMaxX","name":"dragMaxX","line":64,"lineEnd":75,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"dragMaxY":{"doclet":{"description":"Set the maximum Y value the points can be moved to.","samples":[{"name":"Limit dragging","value":"gantt/dragdrop/drag-gantt","products":["gantt"]},{"name":"Limit dragging","value":"highcharts/dragdrop/drag-xrange","products":["highcharts"]}],"type":{"names":["number"]},"since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.dragMaxY","name":"dragMaxY","line":88,"lineEnd":99,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"dragMinX":{"doclet":{"description":"Set the minimum X value the points can be moved to.","samples":[{"name":"Limit dragging","value":"gantt/dragdrop/drag-gantt","products":["gantt"]},{"name":"Limit dragging","value":"highcharts/dragdrop/drag-xrange","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.dragMinX","name":"dragMinX","line":52,"lineEnd":63,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"dragMinY":{"doclet":{"description":"Set the minimum Y value the points can be moved to.","samples":[{"name":"Limit dragging","value":"gantt/dragdrop/drag-gantt","products":["gantt"]},{"name":"Limit dragging","value":"highcharts/dragdrop/drag-xrange","products":["highcharts"]}],"type":{"names":["number"]},"since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.dragMinY","name":"dragMinY","line":76,"lineEnd":87,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"dragPrecisionX":{"doclet":{"description":"The X precision value to drag to for this series. Set to 0 to disable. By\ndefault this is disabled, except for category axes, where the default is\n`1`.","type":{"names":["number"]},"defaultvalue":"0","since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.dragPrecisionX","name":"dragPrecisionX","line":100,"lineEnd":109,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"dragPrecisionY":{"doclet":{"description":"The Y precision value to drag to for this series. Set to 0 to disable. By\ndefault this is disabled, except for category axes, where the default is\n`1`.","type":{"names":["number"]},"defaultvalue":"0","since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.dragPrecisionY","name":"dragPrecisionY","line":110,"lineEnd":119,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"dragSensitivity":{"doclet":{"description":"The amount of pixels to drag the pointer before it counts as a drag\noperation. This prevents drag/drop to fire when just clicking or\nselecting points.","type":{"names":["number"]},"defaultvalue":"2","since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.dragSensitivity","name":"dragSensitivity","line":52,"lineEnd":63,"column":4,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":2},"children":{}},"draggableX":{"doclet":{"description":"Enable dragging in the X dimension.","type":{"names":["boolean"]},"since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.draggableX","name":"draggableX","line":120,"lineEnd":126,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"draggableY":{"doclet":{"description":"Enable dragging in the Y dimension. Note that this is not supported for\nTreeGrid axes (the default axis type in Gantt charts).","type":{"names":["boolean"]},"since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.draggableY","name":"draggableY","line":127,"lineEnd":134,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"groupBy":{"doclet":{"description":"Group the points by a property. Points with the same property value will\nbe grouped together when moving.","samples":[{"name":"Drag grouped points","value":"gantt/dragdrop/drag-gantt","products":["gantt"]},{"name":"Drag grouped points","value":"highcharts/dragdrop/drag-xrange","products":["highcharts"]}],"type":{"names":["string"]},"since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.groupBy","name":"groupBy","line":135,"lineEnd":147,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"guideBox":{"doclet":{"description":"Style options for the guide box. The guide box has one state by default,\nthe `default` state.","declare":"Highcharts.PlotOptionsSeriesDragDropGuideBoxOptions","since":"6.2.0","type":{"names":["Highcharts.Dictionary.<Highcharts.DragDropGuideBoxOptionsObject>"]}},"meta":{"fullname":"plotOptions.series.dragDrop.guideBox","name":"guideBox","line":304,"lineEnd":311,"column":4,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{"default":{"doclet":{"description":"Style options for the guide box default state.","declare":"Highcharts.DragDropGuideBoxOptionsObject","since":"6.2.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.dragDrop.guideBox.default","name":"default","line":313,"lineEnd":318,"column":8,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{"className":{"doclet":{"description":"CSS class name of the guide box in this state. Defaults to\n`highcharts-drag-box-default`.","since":"6.2.0","type":{"names":["string"]},"defaultvalue":"highcharts-drag-box-default"},"meta":{"fullname":"plotOptions.series.dragDrop.guideBox.default.className","name":"className","line":320,"lineEnd":325,"column":12,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":"highcharts-drag-box-default"},"children":{}},"color":{"doclet":{"description":"Guide box fill color.","type":{"names":["Highcharts.ColorType"]},"since":"6.2.0","defaultvalue":"rgba(0, 0, 0, 0.1)"},"meta":{"fullname":"plotOptions.series.dragDrop.guideBox.default.color","name":"color","line":340,"lineEnd":345,"column":12,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":"rgba(0, 0, 0, 0.1)"},"children":{}},"cursor":{"doclet":{"description":"Guide box cursor.","since":"6.2.0","type":{"names":["string"]},"defaultvalue":"move"},"meta":{"fullname":"plotOptions.series.dragDrop.guideBox.default.cursor","name":"cursor","line":347,"lineEnd":351,"column":12,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":"move"},"children":{}},"lineColor":{"doclet":{"description":"Color of the border around the guide box.","type":{"names":["Highcharts.ColorString"]},"since":"6.2.0","defaultvalue":"#888"},"meta":{"fullname":"plotOptions.series.dragDrop.guideBox.default.lineColor","name":"lineColor","line":333,"lineEnd":338,"column":12,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":"#888"},"children":{}},"lineWidth":{"doclet":{"description":"Width of the line around the guide box.","since":"6.2.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.series.dragDrop.guideBox.default.lineWidth","name":"lineWidth","line":327,"lineEnd":331,"column":12,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":1},"children":{}},"zIndex":{"doclet":{"description":"Guide box zIndex.","since":"6.2.0","type":{"names":["number"]},"defaultvalue":900},"meta":{"fullname":"plotOptions.series.dragDrop.guideBox.default.zIndex","name":"zIndex","line":353,"lineEnd":357,"column":12,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js","default":900},"children":{}}}}}},"liveRedraw":{"doclet":{"description":"Update points as they are dragged. If false, a guide box is drawn to\nillustrate the new point size.","samples":[{"name":"liveRedraw disabled","value":"gantt/dragdrop/drag-gantt","products":["gantt"]},{"name":"liveRedraw disabled","value":"highcharts/dragdrop/drag-xrange","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"6.2.0"},"meta":{"fullname":"plotOptions.series.dragDrop.liveRedraw","name":"liveRedraw","line":148,"lineEnd":161,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}}}},"enableMouseTracking":{"doclet":{"description":"Enable or disable the mouse tracking for a specific series. This\nincludes point tooltips and click events on graphs and points. For\nlarge datasets it improves performance.","samples":[{"name":"No mouse tracking","value":"highcharts/plotoptions/series-enablemousetracking-false/","products":["highcharts"]},{"name":"No mouse tracking","value":"maps/plotoptions/series-enablemousetracking-false/","products":["highmaps"]}],"type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"plotOptions.series.enableMouseTracking","name":"enableMouseTracking","line":366,"lineEnd":379,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"events":{"doclet":{"description":"General event handlers for the series items. These event hooks can\nalso be attached to the series at run time using the\n`Highcharts.addEvent` function.","declare":"Highcharts.SeriesEventsOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.events","name":"events","line":381,"lineEnd":392,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"afterAnimate":{"doclet":{"description":"Fires after the series has finished its initial animation, or in case\nanimation is disabled, immediately as the series is displayed.","samples":[{"name":"Show label after animate","value":"highcharts/plotoptions/series-events-afteranimate/","products":["highcharts"]},{"name":"Show label after animate","value":"highcharts/plotoptions/series-events-afteranimate/","products":["highstock"]}],"type":{"names":["Highcharts.SeriesAfterAnimateCallbackFunction"]},"since":"4.0.0","products":["highcharts","highstock","gantt"],"context":"Highcharts.Series"},"meta":{"fullname":"plotOptions.series.events.afterAnimate","name":"afterAnimate","line":885,"lineEnd":899,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"checkboxClick":{"doclet":{"description":"Fires when the checkbox next to the series' name in the legend is\nclicked. One parameter, `event`, is passed to the function. The state\nof the checkbox is found by `event.checked`. The checked item is\nfound by `event.item`. Return `false` to prevent the default action\nwhich is to toggle the select state of the series.","samples":[{"name":"Alert checkbox status","value":"highcharts/plotoptions/series-events-checkboxclick/","products":["highcharts"]}],"type":{"names":["Highcharts.SeriesCheckboxClickCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Series"},"meta":{"fullname":"plotOptions.series.events.checkboxClick","name":"checkboxClick","line":900,"lineEnd":914,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"click":{"doclet":{"description":"Fires when the series is clicked. One parameter, `event`, is passed\nto the function, containing common event information. Additionally,\n`event.point` holds a pointer to the nearest point on the graph.","samples":[{"name":"Alert click info","value":"highcharts/plotoptions/series-events-click/","products":["highcharts"]},{"name":"Alert click info","value":"stock/plotoptions/series-events-click/","products":["highstock"]},{"name":"Display click info in subtitle","value":"maps/plotoptions/series-events-click/","products":["highmaps"]}],"type":{"names":["Highcharts.SeriesClickCallbackFunction"]},"context":"Highcharts.Series"},"meta":{"fullname":"plotOptions.series.events.click","name":"click","line":915,"lineEnd":930,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"hide":{"doclet":{"description":"Fires when the series is hidden after chart generation time, either\nby clicking the legend item or by calling `.hide()`.","samples":[{"name":"Alert when the series is hidden by clicking the legend item","value":"highcharts/plotoptions/series-events-hide/","products":["highcharts"]}],"type":{"names":["Highcharts.SeriesHideCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Series"},"meta":{"fullname":"plotOptions.series.events.hide","name":"hide","line":931,"lineEnd":942,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"legendItemClick":{"doclet":{"description":"Fires when the legend item belonging to the series is clicked. One\nparameter, `event`, is passed to the function. The default action\nis to toggle the visibility of the series. This can be prevented\nby returning `false` or calling `event.preventDefault()`.\n\n**Note:** This option is deprecated in favor of\n[legend.events.itemClick](#legend.events.itemClick).","type":{"names":["Highcharts.SeriesLegendItemClickCallbackFunction"]},"deprecated":"11.4.4","context":"Highcharts.Series"},"meta":{"fullname":"plotOptions.series.events.legendItemClick","name":"legendItemClick","line":943,"lineEnd":956,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"mouseOut":{"doclet":{"description":"Fires when the mouse leaves the graph. One parameter, `event`, is\npassed to the function, containing common event information. If the\n[stickyTracking](#plotOptions.series) option is true, `mouseOut`\ndoesn't happen before the mouse enters another graph or leaves the\nplot area.","samples":[{"name":"With sticky tracking by default","value":"highcharts/plotoptions/series-events-mouseover-sticky/","products":["highcharts"]},{"name":"Without sticky tracking","value":"highcharts/plotoptions/series-events-mouseover-no-sticky/","products":["highcharts"]}],"type":{"names":["Highcharts.SeriesMouseOutCallbackFunction"]},"context":"Highcharts.Series"},"meta":{"fullname":"plotOptions.series.events.mouseOut","name":"mouseOut","line":957,"lineEnd":972,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"mouseOver":{"doclet":{"description":"Fires when the mouse enters the graph. One parameter, `event`, is\npassed to the function, containing common event information.","samples":[{"name":"With sticky tracking by default","value":"highcharts/plotoptions/series-events-mouseover-sticky/","products":["highcharts"]},{"name":"Without sticky tracking","value":"highcharts/plotoptions/series-events-mouseover-no-sticky/","products":["highcharts"]}],"type":{"names":["Highcharts.SeriesMouseOverCallbackFunction"]},"context":"Highcharts.Series"},"meta":{"fullname":"plotOptions.series.events.mouseOver","name":"mouseOver","line":973,"lineEnd":985,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"show":{"doclet":{"description":"Fires when the series is shown after chart generation time, either\nby clicking the legend item or by calling `.show()`.","samples":[{"name":"Alert when the series is shown by clicking the legend item.","value":"highcharts/plotoptions/series-events-show/","products":["highcharts"]}],"type":{"names":["Highcharts.SeriesShowCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Series"},"meta":{"fullname":"plotOptions.series.events.show","name":"show","line":986,"lineEnd":997,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}}}},"findNearestPointBy":{"doclet":{"description":"Determines whether the series should look for the nearest point\nin both dimensions or just the x-dimension when hovering the series.\nDefaults to `'xy'` for scatter series and `'x'` for most other\nseries. If the data has duplicate x-values, it is recommended to\nset this to `'xy'` to allow hovering over all points.\n\nApplies only to series types using nearest neighbor search (not\ndirect hover) for tooltip.","samples":[{"name":"Different hover behaviors","value":"highcharts/series/findnearestpointby/","products":["highcharts"]},{"name":"Different hover behaviors","value":"highcharts/series/findnearestpointby/","products":["highstock"]},{"name":"Different hover behaviors","value":"highcharts/series/findnearestpointby/","products":["highmaps"]}],"since":"5.0.10","values":"[\"x\", \"xy\"]","type":{"names":["string"]},"defaultvalue":"x"},"meta":{"fullname":"plotOptions.series.findNearestPointBy","name":"findNearestPointBy","line":2284,"lineEnd":2307,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":"x"},"children":{}},"gapSize":{"doclet":{"description":"Defines when to display a gap in the graph, together with the\n[gapUnit](plotOptions.series.gapUnit) option.\n\nIn case when `dataGrouping` is enabled, points can be grouped\ninto a larger time span. This can make the grouped points to\nhave a greater distance than the absolute value of `gapSize`\nproperty, which will result in disappearing graph completely.\nTo prevent this situation the mentioned distance between\ngrouped points is used instead of previously defined\n`gapSize`.\n\nIn practice, this option is most often used to visualize gaps\nin time series. In a stock chart, intraday data is available\nfor daytime hours, while gaps will appear in nights and\nweekends.","see":["[gapUnit](plotOptions.series.gapUnit)","[xAxis.breaks](#xAxis.breaks)"],"samples":[{"name":"Setting the gap size to 2 introduces gaps for weekends in\ndaily datasets.","value":"stock/plotoptions/series-gapsize/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"0","products":["highcharts","highstock"],"requires":["module:modules/broken-axis"]},"meta":{"fullname":"plotOptions.series.gapSize","name":"gapSize","line":170,"lineEnd":199,"filename":"code/es-modules/Core/Axis/BrokenAxis.js"},"children":{}},"gapUnit":{"doclet":{"description":"Together with [gapSize](plotOptions.series.gapSize), this\noption defines where to draw gaps in the graph.\n\nWhen the `gapUnit` is `\"relative\"` (default), a gap size of 5\nmeans that if the distance between two points is greater than\n5 times that of the two closest points, the graph will be\nbroken.\n\nWhen the `gapUnit` is `\"value\"`, the gap is based on absolute\naxis values, which on a datetime axis is milliseconds. This\nalso applies to the navigator series that inherits gap\noptions from the base series.","see":["[gapSize](plotOptions.series.gapSize)"],"type":{"names":["\"relative\"","\"value\""]},"defaultvalue":"relative","since":"5.0.13","products":["highcharts","highstock"],"requires":["module:modules/broken-axis"]},"meta":{"fullname":"plotOptions.series.gapUnit","name":"gapUnit","line":200,"lineEnd":223,"filename":"code/es-modules/Core/Axis/BrokenAxis.js"},"children":{}},"getExtremesFromAll":{"doclet":{"description":"Whether to use the Y extremes of the total chart width or only the\nzoomed area when zooming in on parts of the X axis. By default, the\nY axis adjusts to the min and max of the visible data. Cartesian\nseries only.","type":{"names":["boolean"]},"defaultvalue":"false","since":"4.1.6","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.series.getExtremesFromAll","name":"getExtremesFromAll","line":381,"lineEnd":392,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"inactiveOtherPoints":{"doclet":{"description":"Highlight only the hovered point and fade the remaining points.\n\nScatter-type series require enabling the 'inactive' marker state and\nadjusting opacity. Note that this approach could affect performance\nwith large datasets.","samples":[{"name":"Chart with inactiveOtherPoints option enabled.","value":"highcharts/plotoptions/series-inactiveotherpoints-enabled/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"plotOptions.series.inactiveOtherPoints","name":"inactiveOtherPoints","line":393,"lineEnd":406,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"includeInDataExport":{"doclet":{"description":"When set to `false` will prevent the series data from being included in\nany form of data export.\n\nSince version 6.0.0 until 7.1.0 the option was existing undocumented\nas `includeInCSVExport`.","type":{"names":["boolean"]},"since":"7.1.0","requires":["module:modules/export-data"]},"meta":{"fullname":"plotOptions.series.includeInDataExport","name":"includeInDataExport","line":322,"lineEnd":333,"filename":"code/es-modules/Extensions/ExportData/ExportDataDefaults.js"},"children":{}},"joinBy":{"doclet":{"description":"What property to join the `mapData` to the value data. For example,\nif joinBy is \"code\", the mapData items with a specific code is merged\ninto the data with the same code. For maps loaded from GeoJSON, the\nkeys may be held in each point's `properties` object.\n\nThe joinBy option can also be an array of two values, where the first\npoints to a key in the `mapData`, and the second points to another\nkey in the `data`.\n\nWhen joinBy is `null`, the map items are joined by their position in\nthe array, which performs much better in maps with many data points.\nThis is the recommended option if you are printing more than a\nthousand data points and have a backend that can preprocess the data\ninto a parallel array of the mapData.","samples":[{"name":"Joined by \"code\"","value":"maps/plotoptions/series-border/"},{"name":"GeoJSON joined by an array","value":"maps/demo/geojson/"},{"name":"Simple data joined by null","value":"maps/series/joinby-null/"}],"type":{"names":["string","Array.<string>"]},"defaultvalue":"hc-key","products":["highmaps"]},"meta":{"fullname":"plotOptions.series.joinBy","name":"joinBy","line":167,"lineEnd":196,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"keys":{"doclet":{"description":"An array specifying which option maps to which key in the data point\narray. This makes it convenient to work with unstructured data arrays\nfrom different sources.","see":["[series.data](#series.line.data)"],"samples":[{"name":"An extended data array with keys","value":"highcharts/series/data-keys/","products":["highcharts","highstock"]},{"name":"Nested keys used to access object properties","value":"highcharts/series/data-nested-keys/","products":["highcharts","highstock"]}],"type":{"names":["Array.<string>"]},"since":"4.1.6"},"meta":{"fullname":"plotOptions.series.keys","name":"keys","line":407,"lineEnd":422,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"label":{"doclet":{"description":"Series labels are placed as close to the series as possible in a\nnatural way, seeking to avoid other series. The goal of this\nfeature is to make the chart more easily readable, like if a\nhuman designer placed the labels in the optimal position.\n\nThe series labels currently work with series types having a\n`graph` or an `area`.","samples":[{"name":"Line chart","value":"highcharts/series-label/line-chart"},{"name":"Stream graph","value":"highcharts/demo/streamgraph"},{"name":"Stock chart","value":"highcharts/series-label/stock-chart"}],"declare":"Highcharts.SeriesLabelOptionsObject","since":"6.0.0","products":["highcharts","highstock","gantt"],"requires":["module:modules/series-label"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","name":"label","fullname":"plotOptions.series.label","line":12,"lineEnd":16,"column":0},"children":{"boxesToAvoid":{"doclet":{"description":"An array of boxes to avoid when laying out the labels. Each\nitem has a `left`, `right`, `top` and `bottom` property.","type":{"names":["Array.<Highcharts.LabelIntersectBoxObject>"]},"since":"6.0.0"},"meta":{"fullname":"plotOptions.series.label.boxesToAvoid","name":"boxesToAvoid","line":128,"lineEnd":133,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js"},"children":{}},"connectorAllowed":{"doclet":{"description":"Allow labels to be placed distant to the graph if necessary,\nand draw a connector line to the graph. Setting this option\nto true may decrease the performance significantly, since the\nalgorithm with systematically search for open spaces in the\nwhole plot area. Visually, it may also result in a more\ncluttered chart, though more of the series will be labeled.","since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.series.label.connectorAllowed","name":"connectorAllowed","line":44,"lineEnd":51,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","default":false},"children":{}},"connectorNeighbourDistance":{"doclet":{"description":"If the label is closer than this to a neighbor graph, draw a\nconnector.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":24},"meta":{"fullname":"plotOptions.series.label.connectorNeighbourDistance","name":"connectorNeighbourDistance","line":53,"lineEnd":56,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","default":24},"children":{}},"enabled":{"doclet":{"description":"Enable the series label per series.","since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.series.label.enabled","name":"enabled","line":40,"lineEnd":42,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","default":true},"children":{}},"format":{"doclet":{"description":"A format string for the label, with support for a subset of\nHTML. Variables are enclosed by curly brackets. Available\nvariables are `name`, `options.xxx`, `color` and other\nmembers from the `series` object. Use this option also to set\na static text for the label.","type":{"names":["string"]},"since":"8.1.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.series.label.format","name":"format","line":58,"lineEnd":67,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","default":"undefined"},"children":{}},"formatter":{"doclet":{"description":"Callback function to format each of the series' labels. The\n`this` keyword refers to the series object. By default the\n`formatter` is undefined and the `series.name` is rendered.\nSince v12.6.0, the callback also receives `ctx` as the first argument,\nso that arrow functions can access the same context as regular\nfunctions using `this`.","type":{"names":["Highcharts.FormatterCallbackFunction.<Series>"]},"since":"8.1.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.series.label.formatter","name":"formatter","line":69,"lineEnd":79,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","default":"undefined"},"children":{}},"maxFontSize":{"doclet":{"description":"For area-like series, allow the font size to vary so that\nsmall areas get a smaller font size. The default applies this\neffect to area-like series but not line-like series.","samples":[{"name":"Min and max font size on a streamgraph","value":"highcharts/demo/streamgraph"}],"type":{"names":["number","null"]},"since":"6.0.0","defaultvalue":null},"meta":{"fullname":"plotOptions.series.label.maxFontSize","name":"maxFontSize","line":91,"lineEnd":100,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","default":null},"children":{}},"minFontSize":{"doclet":{"description":"For area-like series, allow the font size to vary so that\nsmall areas get a smaller font size. The default applies this\neffect to area-like series but not line-like series.","samples":[{"name":"Min and max font size on a streamgraph","value":"highcharts/demo/streamgraph"}],"type":{"names":["number","null"]},"since":"6.0.0","defaultvalue":null},"meta":{"fullname":"plotOptions.series.label.minFontSize","name":"minFontSize","line":81,"lineEnd":89,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","default":null},"children":{}},"onArea":{"doclet":{"description":"Draw the label on the area of an area series. By default it\nis drawn on the area. Set it to `false` to draw it next to\nthe graph instead.","type":{"names":["boolean","null"]},"since":"6.0.0","defaultvalue":null},"meta":{"fullname":"plotOptions.series.label.onArea","name":"onArea","line":102,"lineEnd":108,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","default":null},"children":{}},"style":{"doclet":{"description":"Styles for the series label. The color defaults to the series\ncolor, or a contrast color if `onArea`.","type":{"names":["Highcharts.CSSObject"]},"since":"6.0.0"},"meta":{"fullname":"plotOptions.series.label.style","name":"style","line":110,"lineEnd":115,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js"},"children":{"fontSize":{"doclet":{"type":{"names":["number","string"]},"defaultvalue":"0.8em"},"meta":{"fullname":"plotOptions.series.label.style.fontSize","name":"fontSize","line":117,"lineEnd":119,"column":8,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","default":"0.8em"},"children":{}}}},"useHTML":{"doclet":{"description":"Whether to use HTML to render the series label.","since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.series.label.useHTML","name":"useHTML","line":124,"lineEnd":126,"column":4,"filename":"code/es-modules/Extensions/SeriesLabel/SeriesLabelDefaults.js","default":false},"children":{}}}},"lastPrice":{"doclet":{"description":"The line marks the last price from all points.","samples":[{"name":"Last price","value":"stock/indicators/last-price","products":["highstock"]}],"declare":"Highcharts.SeriesLastPriceOptionsObject","products":["highstock"],"requires":["module:modules/price-indicator"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.lastPrice","name":"lastPrice","line":267,"lineEnd":277,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{"color":{"doclet":{"description":"The color of the line of last price.\nBy default, the line has the same color as the series.","type":{"names":["string"]},"products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastPrice.color","name":"color","line":368,"lineEnd":376,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"dashStyle":{"doclet":{"description":"Name of the dash style to use for the line of last price.","samples":[{"name":"Possible values demonstrated","value":"highcharts/plotoptions/series-dashstyle-all/","products":["highstock"]}],"type":{"names":["Highcharts.DashStyleValue"]},"products":["highstock"],"defaultvalue":"Solid"},"meta":{"fullname":"plotOptions.series.lastPrice.dashStyle","name":"dashStyle","line":377,"lineEnd":388,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the indicator.","type":{"names":["boolean"]},"products":["highstock"],"defaultvalue":"false"},"meta":{"fullname":"plotOptions.series.lastPrice.enabled","name":"enabled","line":278,"lineEnd":285,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"label":{"doclet":{"declare":"Highcharts.SeriesLastPriceLabelOptionsObject","extends":"yAxis.crosshair.label","since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastPrice.label","name":"label","line":286,"lineEnd":291,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{"align":{"doclet":{"since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastPrice.label.align","name":"align","line":292,"lineEnd":295,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"backgroundColor":{"doclet":{"since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastPrice.label.backgroundColor","name":"backgroundColor","line":296,"lineEnd":299,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"borderColor":{"doclet":{"description":"The border color of `lastPrice` label.","since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastPrice.label.borderColor","name":"borderColor","line":300,"lineEnd":304,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"borderRadius":{"doclet":{"description":"The border radius of `lastPrice` label.","since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastPrice.label.borderRadius","name":"borderRadius","line":305,"lineEnd":309,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"borderWidth":{"doclet":{"description":"The border width for the `lastPrice` label.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":"0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastPrice.label.borderWidth","name":"borderWidth","line":310,"lineEnd":314,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"enabled":{"doclet":{"description":"Flag to enable `lastPrice` label.","since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastPrice.label.enabled","name":"enabled","line":315,"lineEnd":319,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"format":{"doclet":{"description":"A format string for the `lastPrice` label. Defaults to `{value}` for\nnumeric axes and `{value:%b %d, %Y}` for datetime axes.","type":{"names":["string"]},"since":"7.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastPrice.label.format","name":"format","line":320,"lineEnd":328,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"formatter":{"doclet":{"since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastPrice.label.formatter","name":"formatter","line":329,"lineEnd":332,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"padding":{"doclet":{"since":"7.0.0","description":"Padding inside the `lastPrice` label.","type":{"names":["number"]},"defaultvalue":"8","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastPrice.label.padding","name":"padding","line":333,"lineEnd":336,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"shape":{"doclet":{"since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastPrice.label.shape","name":"shape","line":337,"lineEnd":340,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"style":{"doclet":{"description":"Text styles for the `lastPrice` label.","type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"color\": \"white\", \"fontWeight\": \"normal\", \"fontSize\": \"11px\", \"textAlign\": \"center\"}","since":"7.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastPrice.label.style","name":"style","line":341,"lineEnd":349,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}}}},"width":{"doclet":{"description":"Width of the last price line.","type":{"names":["number"]},"products":["highstock"],"defaultvalue":"1"},"meta":{"fullname":"plotOptions.series.lastPrice.width","name":"width","line":389,"lineEnd":397,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}}}},"lastVisiblePrice":{"doclet":{"description":"The line marks the last price from visible range of points.","samples":[{"name":"Last visible price","value":"stock/indicators/last-visible-price","products":["highstock"]}],"declare":"Highcharts.SeriesLastVisiblePriceOptionsObject","products":["highstock"],"requires":["module:modules/price-indicator"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.lastVisiblePrice","name":"lastVisiblePrice","line":129,"lineEnd":139,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{"color":{"doclet":{"description":"The color of the line of last visible price.\nBy default, color is not applied and the line is not visible.","type":{"names":["string"]},"products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.color","name":"color","line":140,"lineEnd":148,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"dashStyle":{"doclet":{"description":"Name of the dash style to use for the line of last visible price.","samples":[{"name":"Possible values demonstrated","value":"highcharts/plotoptions/series-dashstyle-all/","products":["highstock"]}],"type":{"names":["Highcharts.DashStyleValue"]},"products":["highstock"],"defaultvalue":"Solid"},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.dashStyle","name":"dashStyle","line":149,"lineEnd":160,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the indicator.","type":{"names":["boolean"]},"products":["highstock"],"defaultvalue":"false"},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.enabled","name":"enabled","line":170,"lineEnd":177,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"label":{"doclet":{"declare":"Highcharts.SeriesLastVisiblePriceLabelOptionsObject","extends":"yAxis.crosshair.label","since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label","name":"label","line":178,"lineEnd":183,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{"align":{"doclet":{"since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.align","name":"align","line":184,"lineEnd":187,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"backgroundColor":{"doclet":{"since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.backgroundColor","name":"backgroundColor","line":188,"lineEnd":191,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"borderColor":{"doclet":{"description":"The border color for the `lastVisiblePrice` label.","type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.borderColor","name":"borderColor","line":192,"lineEnd":199,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"borderRadius":{"doclet":{"description":"The border corner radius of the `lastVisiblePrice` label.","type":{"names":["number"]},"defaultvalue":"3","since":"7.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.borderRadius","name":"borderRadius","line":200,"lineEnd":208,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"borderWidth":{"doclet":{"description":"The border width for the `lastVisiblePrice` label.","type":{"names":["number"]},"defaultvalue":"0","since":"7.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.borderWidth","name":"borderWidth","line":249,"lineEnd":257,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"enabled":{"doclet":{"description":"Flag to enable `lastVisiblePrice` label.","type":{"names":["boolean"]},"defaultvalue":"false","since":"7.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.enabled","name":"enabled","line":209,"lineEnd":218,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"format":{"doclet":{"description":"A format string for the `lastVisiblePrice` label. Defaults to `{value}` for\nnumeric axes and `{value:%b %d, %Y}` for datetime axes.","type":{"names":["string"]},"since":"7.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.format","name":"format","line":219,"lineEnd":227,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"formatter":{"doclet":{"since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.formatter","name":"formatter","line":228,"lineEnd":231,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"padding":{"doclet":{"since":"7.0.0","description":"Padding inside the `lastVisiblePrice` label.","type":{"names":["number"]},"defaultvalue":"8","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.padding","name":"padding","line":232,"lineEnd":235,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"shape":{"doclet":{"since":"7.0.0"},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.shape","name":"shape","line":236,"lineEnd":239,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}},"style":{"doclet":{"description":"Text styles for the `lastVisiblePrice` label.","type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"color\": \"white\", \"fontWeight\": \"normal\", \"fontSize\": \"11px\", \"textAlign\": \"center\"}","since":"7.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.label.style","name":"style","line":240,"lineEnd":248,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}}}},"width":{"doclet":{"description":"Width of the last visible price line.","type":{"names":["number"]},"products":["highstock"],"defaultvalue":"1"},"meta":{"fullname":"plotOptions.series.lastVisiblePrice.width","name":"width","line":161,"lineEnd":169,"filename":"code/es-modules/Extensions/PriceIndication.js"},"children":{}}}},"legendSymbol":{"doclet":{"description":"What type of legend symbol to render for this series. Can be one of\n`areaMarker`, `lineMarker` or `rectangle`.","values":"[\"areaMarker\", \"lineMarker\", \"rectangle\"]","samples":[{"name":"Change the legend symbol","value":"highcharts/series/legend-symbol/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"rectangle","since":"11.0.1"},"meta":{"fullname":"plotOptions.series.legendSymbol","name":"legendSymbol","line":2401,"lineEnd":2414,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"legendSymbolColor":{"doclet":{"description":"Defines the color of the legend symbol for this series. Defaults to\nundefined, in which case the series color is used. Does not work with\nstyled mode.","samples":[{"name":"Change the legend symbol color","value":"highcharts/series/legend-symbol-color/","products":["highcharts","highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"undefined","since":"12.0.0","products":["highcharts","highstock","highmaps"]},"meta":{"fullname":"plotOptions.series.legendSymbolColor","name":"legendSymbolColor","line":2415,"lineEnd":2428,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the graph line.","see":["In styled mode, the line stroke-width can be set with the\n     `.highcharts-graph` class name."],"samples":[{"name":"On all series","value":"highcharts/plotoptions/series-linewidth-general/","products":["highcharts"]},{"name":"On one single series","value":"highcharts/plotoptions/series-linewidth-specific/","products":["highcharts"]}],"products":["highcharts","highstock"],"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.series.lineWidth","name":"lineWidth","line":23,"lineEnd":23,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":2},"children":{}},"linecap":{"doclet":{"description":"The line cap used for line ends and line joins on the graph.","productdesc":[{"value":"The SVG value used for the `stroke-linecap` and `stroke-linejoin`\nof a line graph. Round means that lines are rounded in the ends and\nbends.","products":["highcharts","highstock"]}],"samples":[{"name":"Line cap comparison","value":"highcharts/series-line/linecap/"}],"type":{"names":["Highcharts.SeriesLinecapValue"]},"defaultvalue":"round","since":"3.0.7"},"meta":{"fullname":"plotOptions.series.linecap","name":"linecap","line":423,"lineEnd":438,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"linkedTo":{"doclet":{"description":"The [id](#series.id) of another series to link to. Additionally,\nthe value can be \":previous\" to link to the previous series. When\ntwo series are linked, only the first one appears in the legend.\nToggling the visibility of this also toggles the linked series.\n\nIf master series uses data sorting and linked series does not have\nits own sorting definition, the linked series will be sorted in the\nsame order as the master one.\n\nIf a `compare` value is not set on a linked series, it will be inherited\nfrom the parent series.","samples":[{"name":"Linked series","value":"highcharts/demo/arearange-line/","products":["highcharts","highstock"]}],"type":{"names":["string"]},"since":"3.0.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.series.linkedTo","name":"linkedTo","line":439,"lineEnd":459,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"marker":{"doclet":{"description":"Options for the point markers of line and scatter-like series. Properties\nlike `fillColor`, `lineColor` and `lineWidth` define the visual\nappearance of the markers. The `symbol` option defines the shape. Other\nseries types, like column series, don't have markers, but have visual\noptions on the series level instead.\n\nIn styled mode, the markers can be styled with the `.highcharts-point`,\n`.highcharts-point-hover` and `.highcharts-point-select` class names.","declare":"Highcharts.PointMarkerOptionsObject","samples":[{"name":"Using the mapmarker symbol for points","value":"maps/demo/mappoint-mapmarker","products":["highmaps"]}],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.marker","name":"marker","line":885,"lineEnd":899,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable or disable the point marker. If `undefined`, the markers\nare hidden when the data is dense, and shown for more widespread\ndata points.","samples":[{"name":"Disabled markers","value":"highcharts/plotoptions/series-marker-enabled/","products":["highcharts"]},{"name":"Disabled in normal state but enabled on hover","value":"highcharts/plotoptions/series-marker-enabled-false/","products":["highcharts"]},{"name":"Enabled markers","value":"stock/plotoptions/series-marker/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultByProduct":{"highcharts":"undefined","highstock":false}},"meta":{"fullname":"plotOptions.series.marker.enabled","name":"enabled","line":1014,"lineEnd":1030,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"enabledThreshold":{"doclet":{"description":"The threshold for how dense the point markers should be before\nthey are hidden, given that `enabled` is not defined. The number\nindicates the horizontal distance between the two closest points\nin the series, as multiples of the `marker.radius`. In other\nwords, the default value of 2 means points are hidden if\noverlapping horizontally.","samples":[{"name":"A higher threshold","value":"highcharts/plotoptions/series-marker-enabledthreshold"}],"since":"6.0.5","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.series.marker.enabledThreshold","name":"enabledThreshold","line":1014,"lineEnd":1030,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":2},"children":{}},"fillColor":{"doclet":{"description":"The fill color of the point marker. When `undefined`, the series'\nor point's color is used.","samples":[{"name":"White fill","value":"highcharts/plotoptions/series-marker-fillcolor/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.series.marker.fillColor","name":"fillColor","line":1045,"lineEnd":1054,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"height":{"doclet":{"description":"Image markers only. Set the image width explicitly. When using\nthis option, a `width` must also be set.","samples":[{"name":"Fixed width and height","value":"highcharts/plotoptions/series-marker-width-height/","products":["highcharts"]},{"name":"Fixed width and height","value":"highcharts/plotoptions/series-marker-width-height/","products":["highstock"]}],"type":{"names":["number"]},"since":"4.0.4"},"meta":{"fullname":"plotOptions.series.marker.height","name":"height","line":1055,"lineEnd":1067,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"lineColor":{"doclet":{"description":"The color of the point marker's outline. When `undefined`, the\nseries' or point's color is used.","samples":[{"name":"Inherit from series color (undefined)","value":"highcharts/plotoptions/series-marker-fillcolor/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#ffffff"},"meta":{"fullname":"plotOptions.series.marker.lineColor","name":"lineColor","line":1045,"lineEnd":1054,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":"#ffffff"},"children":{}},"lineWidth":{"doclet":{"description":"The width of the point marker's outline.","samples":[{"name":"2px blue marker","value":"highcharts/plotoptions/series-marker-fillcolor/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.series.marker.lineWidth","name":"lineWidth","line":1078,"lineEnd":1083,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":0},"children":{}},"radius":{"doclet":{"description":"The radius of the point marker.","samples":[{"name":"Bigger markers","value":"highcharts/plotoptions/series-marker-radius/","products":["highcharts"]}],"defaultByProduct":{"highstock":2,"highcharts":4},"type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"plotOptions.series.marker.radius","name":"radius","line":1085,"lineEnd":1094,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":4},"children":{}},"states":{"doclet":{"description":"States for a single point marker.","declare":"Highcharts.PointStatesOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.marker.states","name":"states","line":1096,"lineEnd":1120,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"hover":{"doclet":{"description":"The hover state for a single point marker.","declare":"Highcharts.PointStatesHoverOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.marker.states.hover","name":"hover","line":1155,"lineEnd":1159,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"animation":{"doclet":{"description":"Animation when hovering over the marker.","type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]}},"meta":{"fullname":"plotOptions.series.marker.states.hover.animation","name":"animation","line":1161,"lineEnd":1165,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"duration":{"doclet":{"type":{"names":["number"]},"defaultvalue":150},"meta":{"fullname":"plotOptions.series.marker.states.hover.animation.duration","name":"duration","line":1167,"lineEnd":1167,"column":20,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":150},"children":{}}}},"enabled":{"doclet":{"description":"Enable or disable the point marker.","samples":[{"name":"Disabled hover state","value":"highcharts/plotoptions/series-marker-states-hover-enabled/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.series.marker.states.hover.enabled","name":"enabled","line":1169,"lineEnd":1174,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":true},"children":{}},"fillColor":{"doclet":{"description":"The fill color of the marker in hover state. When\n`undefined`, the series' or point's fillColor for normal\nstate is used.","type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.series.marker.states.hover.fillColor","name":"fillColor","line":1176,"lineEnd":1183,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"lineColor":{"doclet":{"description":"The color of the point marker's outline. When\n`undefined`, the series' or point's lineColor for normal\nstate is used.","samples":[{"name":"White fill color, black line color","value":"highcharts/plotoptions/series-marker-states-hover-linecolor/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.series.marker.states.hover.lineColor","name":"lineColor","line":1184,"lineEnd":1194,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"lineWidth":{"doclet":{"description":"The width of the point marker's outline. When\n`undefined`, the series' or point's lineWidth for normal\nstate is used.","samples":[{"name":"3px line width","value":"highcharts/plotoptions/series-marker-states-hover-linewidth/","products":["highcharts"]}],"type":{"names":["number"]}},"meta":{"fullname":"plotOptions.series.marker.states.hover.lineWidth","name":"lineWidth","line":1195,"lineEnd":1205,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"lineWidthPlus":{"doclet":{"description":"The additional line width for a hovered point.","samples":[{"name":"2 pixels wider on hover","value":"highcharts/plotoptions/series-states-hover-linewidthplus/","products":["highcharts"]},{"name":"2 pixels wider on hover","value":"highcharts/plotoptions/series-states-hover-linewidthplus/","products":["highstock"]}],"since":"4.0.3","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.series.marker.states.hover.lineWidthPlus","name":"lineWidthPlus","line":1230,"lineEnd":1239,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":1},"children":{}},"radius":{"doclet":{"description":"The radius of the point marker. In hover state, it\ndefaults to the normal state's radius + 2 as per the\n[radiusPlus](#plotOptions.series.marker.states.hover.radiusPlus)\noption.","samples":[{"name":"10px radius","value":"highcharts/plotoptions/series-marker-states-hover-radius/","products":["highcharts"]}],"type":{"names":["number"]}},"meta":{"fullname":"plotOptions.series.marker.states.hover.radius","name":"radius","line":1206,"lineEnd":1217,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"radiusPlus":{"doclet":{"description":"The number of pixels to increase the radius of the\nhovered point.","samples":[{"name":"5 pixels greater radius on hover","value":"highcharts/plotoptions/series-states-hover-linewidthplus/","products":["highcharts"]},{"name":"5 pixels greater radius on hover","value":"highcharts/plotoptions/series-states-hover-linewidthplus/","products":["highstock"]}],"since":"4.0.3","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.series.marker.states.hover.radiusPlus","name":"radiusPlus","line":1176,"lineEnd":1183,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":2},"children":{}}}},"normal":{"doclet":{"description":"The normal state of a single point marker. Currently only\nused for setting animation when returning to normal state\nfrom hover.","declare":"Highcharts.PointStatesNormalOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.marker.states.normal","name":"normal","line":1140,"lineEnd":1146,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"animation":{"doclet":{"description":"Animation when returning to normal state after hovering.","type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.series.marker.states.normal.animation","name":"animation","line":1148,"lineEnd":1152,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":true},"children":{}}}},"select":{"doclet":{"description":"The appearance of the point marker when selected. In order to\nallow a point to be selected, set the\n`series.allowPointSelect` option to true.","declare":"Highcharts.PointStatesSelectOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.marker.states.select","name":"select","line":1242,"lineEnd":1248,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable or disable visible feedback for selection.","samples":[{"name":"Disabled select state","value":"highcharts/plotoptions/series-marker-states-select-enabled/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"plotOptions.series.marker.states.select.enabled","name":"enabled","line":1250,"lineEnd":1259,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"fillColor":{"doclet":{"description":"The fill color of the point marker.","samples":[{"name":"Solid red discs for selected points","value":"highcharts/plotoptions/series-marker-states-select-fillcolor/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"plotOptions.series.marker.states.select.fillColor","name":"fillColor","line":1250,"lineEnd":1259,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":"#cccccc"},"children":{}},"lineColor":{"doclet":{"description":"The color of the point marker's outline. When\n`undefined`, the series' or point's color is used.","samples":[{"name":"Red line color for selected points","value":"highcharts/plotoptions/series-marker-states-select-linecolor/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#000000"},"meta":{"fullname":"plotOptions.series.marker.states.select.lineColor","name":"lineColor","line":1279,"lineEnd":1287,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":"#000000"},"children":{}},"lineWidth":{"doclet":{"description":"The width of the point marker's outline.","samples":[{"name":"3px line width for selected points","value":"highcharts/plotoptions/series-marker-states-select-linewidth/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.series.marker.states.select.lineWidth","name":"lineWidth","line":1289,"lineEnd":1294,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":2},"children":{}},"radius":{"doclet":{"description":"The radius of the point marker. In hover state, it\ndefaults to the normal state's radius + 2.","samples":[{"name":"10px radius for selected points","value":"highcharts/plotoptions/series-marker-states-select-radius/","products":["highcharts"]}],"type":{"names":["number"]}},"meta":{"fullname":"plotOptions.series.marker.states.select.radius","name":"radius","line":1260,"lineEnd":1269,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}}}}}},"symbol":{"doclet":{"description":"A predefined shape or symbol for the marker. When undefined, the\nsymbol is pulled from options.symbols. Other possible values are\n`'circle'`, `'square'`,`'diamond'`, `'triangle'` and\n`'triangle-down'`.\n\nAdditionally, the URL to a graphic can be given on this form:\n`'url(graphic.png)'`. Note that for the image to be applied to\nexported charts, its URL needs to be accessible by the export\nserver.\n\nCustom callbacks for symbol path generation can also be added to\n`Highcharts.SVGRenderer.prototype.symbols`. The callback is then\nused by its method name, as shown in the demo.","samples":[{"name":"Predefined, graphic and custom markers","value":"highcharts/plotoptions/series-marker-symbol/","products":["highcharts"]},{"name":"Predefined, graphic and custom markers","value":"highcharts/plotoptions/series-marker-symbol/","products":["highstock"]},{"name":"Using the mapmarker symbol for points","value":"maps/demo/mappoint-mapmarker","products":["highmaps"]}],"type":{"names":["string"]}},"meta":{"fullname":"plotOptions.series.marker.symbol","name":"symbol","line":1096,"lineEnd":1120,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"width":{"doclet":{"description":"Image markers only. Set the image width explicitly. When using\nthis option, a `height` must also be set.","samples":[{"name":"Fixed width and height","value":"highcharts/plotoptions/series-marker-width-height/","products":["highcharts"]},{"name":"Fixed width and height","value":"highcharts/plotoptions/series-marker-width-height/","products":["highstock"]}],"type":{"names":["number"]},"since":"4.0.4"},"meta":{"fullname":"plotOptions.series.marker.width","name":"width","line":1121,"lineEnd":1133,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}}}},"navigatorOptions":{"doclet":{"description":"Options for the corresponding navigator series if `showInNavigator`\nis `true` for this series. Available options are the same as any\nseries, documented at [plotOptions](#plotOptions.series) and\n[series](#series).\n\nThese options are merged with options in [navigator.series](#navigator.series), and will take precedence if the same option is\ndefined both places.","see":["[navigator.series](#navigator.series)"],"type":{"names":["Highcharts.PlotSeriesOptions"]},"since":"5.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.navigatorOptions","name":"navigatorOptions","line":460,"lineEnd":476,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"negativeColor":{"doclet":{"description":"The color for the parts of the graph or points that are below the\n[threshold](#plotOptions.series.threshold). Note that `zones` takes\nprecedence over the negative color. Using `negativeColor` is\nequivalent to applying a zone with value of 0.","see":["In styled mode, a negative color is applied by setting this option\n     to `true` combined with the `.highcharts-negative` class name."],"samples":[{"name":"Spline, area and column","value":"highcharts/plotoptions/series-negative-color/","products":["highcharts"]},{"name":"Arearange","value":"highcharts/plotoptions/arearange-negativecolor/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/css/series-negative-color/","products":["highcharts"]},{"name":"Spline, area and column","value":"highcharts/plotoptions/series-negative-color/","products":["highstock"]},{"name":"Arearange","value":"highcharts/plotoptions/arearange-negativecolor/","products":["highstock"]},{"name":"Spline, area and column","value":"highcharts/plotoptions/series-negative-color/","products":["highmaps"]},{"name":"Arearange","value":"highcharts/plotoptions/arearange-negativecolor/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"since":"3.0.0"},"meta":{"fullname":"plotOptions.series.negativeColor","name":"negativeColor","line":477,"lineEnd":504,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"nullInteraction":{"doclet":{"description":"Whether or not data-points with the value of `null` should be interactive.\nWhen this is set to `true`, tooltips may highlight these points, and this\noption also enables keyboard navigation for such points. Format options\nfor such points include [`nullFormat`](#tooltip.nullFormat) and\n[`nullFormatter`](#tooltip.nullFormatter). Works for these series:\n`line`, `spline`, `area`, `area-spline`, `column`, `bar`, and\n`timeline`.","samples":[{"name":"Chart with interactive `null` points","value":"highcharts/series/null-interaction/","products":["highcharts"]},{"name":"Timeline series with `null` points","value":"highcharts/series-timeline/null-interaction/","products":["highcharts"]}],"type":{"names":["boolean","undefined"]},"products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.nullInteraction","name":"nullInteraction","line":505,"lineEnd":523,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"onPoint":{"doclet":{"description":"Options for the _Series on point_ feature. Only `pie` and `sunburst` series\nare supported at this moment.","samples":[{"name":"Series on point","value":"highcharts/series-on-point/series-on-point","products":["highcharts"]},{"name":"Pies on a map","value":"maps/demo/map-pies","products":["highmaps"]}],"requires":["module:modules/series-on-point"],"since":"10.2.0","type":{"names":["object"]}},"meta":{"fullname":"plotOptions.series.onPoint","name":"onPoint","line":285,"lineEnd":297,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{"connectorOptions":{"doclet":{"description":"Options for the connector in the _Series on point_ feature.\n\nIn styled mode, the connector can be styled with the\n`.highcharts-connector-seriesonpoint` class name.","requires":["module:modules/series-on-point"],"since":"10.2.0","type":{"names":["Highcharts.SVGAttributes"]}},"meta":{"fullname":"plotOptions.series.onPoint.connectorOptions","name":"connectorOptions","line":298,"lineEnd":308,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{"dashstyle":{"doclet":{"description":"A name for the dash style to use for the connector.","requires":["module:modules/series-on-point"],"since":"10.2.0","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.series.onPoint.connectorOptions.dashstyle","name":"dashstyle","line":317,"lineEnd":324,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{}},"stroke":{"doclet":{"description":"Color of the connector line. By default it's the series' color.","requires":["module:modules/series-on-point"],"since":"10.2.0","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.series.onPoint.connectorOptions.stroke","name":"stroke","line":309,"lineEnd":316,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{}},"width":{"doclet":{"description":"Pixel width of the connector line.","defaultvalue":"1","requires":["module:modules/series-on-point"],"type":{"names":["number"]},"since":"10.2.0"},"meta":{"fullname":"plotOptions.series.onPoint.connectorOptions.width","name":"width","line":325,"lineEnd":333,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{}}}},"id":{"doclet":{"description":"The `id` of the point that we connect the series to. Only points with a given\n`plotX` and `plotY` values and map points are valid.","requires":["module:modules/series-on-point"],"since":"10.2.0","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.series.onPoint.id","name":"id","line":334,"lineEnd":342,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{}},"position":{"doclet":{"description":"Options allowing to set a position and an offset of the series in the\n_Series on point_ feature.","requires":["module:modules/series-on-point"],"since":"10.2.0","type":{"names":["object"]}},"meta":{"fullname":"plotOptions.series.onPoint.position","name":"position","line":343,"lineEnd":351,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{"offsetX":{"doclet":{"description":"Series center offset from the original x position. If defined, the connector\nline is drawn connecting original position with new position.","requires":["module:modules/series-on-point"],"since":"10.2.0","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.series.onPoint.position.offsetX","name":"offsetX","line":352,"lineEnd":360,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{}},"offsetY":{"doclet":{"description":"Series center offset from the original y position. If defined, the connector\nline is drawn from original position to a new position.","requires":["module:modules/series-on-point"],"since":"10.2.0","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.series.onPoint.position.offsetY","name":"offsetY","line":361,"lineEnd":369,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{}},"x":{"doclet":{"description":"X position of the series center. By default, the series is displayed on the\npoint that it is connected to.","requires":["module:modules/series-on-point"],"since":"10.2.0","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.series.onPoint.position.x","name":"x","line":370,"lineEnd":378,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{}},"y":{"doclet":{"description":"Y position of the series center. By default, the series is displayed on the\npoint that it is connected to.","requires":["module:modules/series-on-point"],"since":"10.2.0","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.series.onPoint.position.y","name":"y","line":379,"lineEnd":387,"filename":"code/es-modules/Series/SeriesOnPointComposition.js"},"children":{}}}}}},"opacity":{"doclet":{"description":"Opacity of a series parts: line, fill (e.g. area) and dataLabels.","see":["[states.inactive.opacity](#plotOptions.series.states.inactive.opacity)"],"since":"7.1.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.series.opacity","name":"opacity","line":1990,"lineEnd":1996,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":1},"children":{}},"point":{"doclet":{"description":"Properties for each single point.","declare":"Highcharts.PlotSeriesPointOptions","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.point","name":"point","line":1299,"lineEnd":1303,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"events":{"doclet":{"description":"Events for each single point.","declare":"Highcharts.PointEventsOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.point.events","name":"events","line":1305,"lineEnd":1327,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"click":{"doclet":{"description":"Fires when a point is clicked. One parameter, `event`, is passed\nto the function, containing common event information.\n\nIf the `series.allowPointSelect` option is true, the default\naction for the point's click event is to toggle the point's\nselect state. Returning `false` cancels this action.","samples":[{"name":"Click marker to alert values","value":"highcharts/plotoptions/series-point-events-click/","products":["highcharts"]},{"name":"Click column","value":"highcharts/plotoptions/series-point-events-click-column/","products":["highcharts"]},{"name":"Go to URL","value":"highcharts/plotoptions/series-point-events-click-url/","products":["highcharts"]},{"name":"Click marker to display values","value":"maps/plotoptions/series-point-events-click/","products":["highmaps"]},{"name":"Go to URL","value":"maps/plotoptions/series-point-events-click-url/","products":["highmaps"]}],"type":{"names":["Highcharts.PointClickCallbackFunction"]},"context":"Highcharts.Point"},"meta":{"fullname":"plotOptions.series.point.events.click","name":"click","line":1305,"lineEnd":1327,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"drag":{"doclet":{"description":"Callback that fires while dragging a point. The mouse event is passed in\nas parameter. The original data can be accessed from `e.origin`, and the\nnew point values can be accessed from `e.newPoints`. If there is only a\nsingle point being updated, it can be accessed from `e.newPoint` for\nsimplicity, and its ID can be accessed from `e.newPointId`. The `this`\ncontext is the point being dragged. To stop the default drag action,\nreturn false. See [drag and drop options](plotOptions.series.dragDrop).","samples":[{"name":"Drag events","value":"highcharts/dragdrop/drag-xrange","products":["highcharts"]},{"name":"Dragging disabled for specific points","value":"highcharts/dragdrop/undraggable-points","products":["highcharts","highstock"]}],"type":{"names":["Highcharts.PointDragCallbackFunction"]},"since":"6.2.0","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.series.point.events.drag","name":"drag","line":188,"lineEnd":206,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"dragStart":{"doclet":{"description":"Callback that fires when starting to drag a point. The mouse event object\nis passed in as an argument. If a drag handle is used, `e.updateProp` is\nset to the data property being dragged. The `this` context is the point.\nSee [drag and drop options](plotOptions.series.dragDrop).","samples":[{"name":"Drag events","value":"highcharts/dragdrop/drag-xrange","products":["highcharts"]}],"type":{"names":["Highcharts.PointDragStartCallbackFunction"]},"since":"6.2.0","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.series.point.events.dragStart","name":"dragStart","line":174,"lineEnd":187,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"drop":{"doclet":{"description":"Callback that fires when the point is dropped. The parameters passed are\nthe same as for [drag](#plotOptions.series.point.events.drag). To stop\nthe default drop action, return false. See\n[drag and drop options](plotOptions.series.dragDrop).","samples":[{"name":"Drag events","value":"highcharts/dragdrop/drag-xrange","products":["highcharts"]},{"name":"Dragging disabled for specific points","value":"highcharts/dragdrop/undraggable-points","products":["highcharts","highstock"]}],"type":{"names":["Highcharts.PointDropCallbackFunction"]},"since":"6.2.0","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.series.point.events.drop","name":"drop","line":207,"lineEnd":222,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"mouseOut":{"doclet":{"description":"Fires when the mouse leaves the area close to the point. One\nparameter, `event`, is passed to the function, containing common\nevent information.","samples":[{"name":"Show values in the chart's corner on mouse over","value":"highcharts/plotoptions/series-point-events-mouseover/","products":["highcharts"]}],"type":{"names":["Highcharts.PointMouseOutCallbackFunction"]},"context":"Highcharts.Point"},"meta":{"fullname":"plotOptions.series.point.events.mouseOut","name":"mouseOut","line":1328,"lineEnd":1339,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"mouseOver":{"doclet":{"description":"Fires when the mouse enters the area close to the point. One\nparameter, `event`, is passed to the function, containing common\nevent information.\n\nReturning `false` cancels the default behavior, which is to show a\ntooltip for the point.","samples":[{"name":"Show values in the chart's corner on mouse over","value":"highcharts/plotoptions/series-point-events-mouseover/","products":["highcharts"]}],"type":{"names":["Highcharts.PointMouseOverCallbackFunction"]},"context":"Highcharts.Point"},"meta":{"fullname":"plotOptions.series.point.events.mouseOver","name":"mouseOver","line":1340,"lineEnd":1354,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"remove":{"doclet":{"description":"Fires when the point is removed using the `.remove()` method. One\nparameter, `event`, is passed to the function. Returning `false`\ncancels the operation.","samples":[{"name":"Remove point and confirm","value":"highcharts/plotoptions/series-point-events-remove/","products":["highcharts"]}],"type":{"names":["Highcharts.PointRemoveCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Point"},"meta":{"fullname":"plotOptions.series.point.events.remove","name":"remove","line":1355,"lineEnd":1367,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"select":{"doclet":{"description":"Fires when the point is selected either programmatically or\nfollowing a click on the point. One parameter, `event`, is passed\nto the function. Returning `false` cancels the operation.","samples":[{"name":"Report the last selected point","value":"highcharts/plotoptions/series-point-events-select/","products":["highcharts"]},{"name":"Report select and unselect","value":"maps/plotoptions/series-allowpointselect/","products":["highmaps"]}],"type":{"names":["Highcharts.PointSelectCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Point"},"meta":{"fullname":"plotOptions.series.point.events.select","name":"select","line":1368,"lineEnd":1382,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"unselect":{"doclet":{"description":"Fires when the point is unselected either programmatically or\nfollowing a click on the point. One parameter, `event`, is passed\nto the function.\n Returning `false` cancels the operation.","samples":[{"name":"Report the last unselected point","value":"highcharts/plotoptions/series-point-events-unselect/","products":["highcharts"]},{"name":"Report select and unselect","value":"maps/plotoptions/series-allowpointselect/","products":["highmaps"]}],"type":{"names":["Highcharts.PointUnselectCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Point"},"meta":{"fullname":"plotOptions.series.point.events.unselect","name":"unselect","line":1383,"lineEnd":1398,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"update":{"doclet":{"description":"Fires when the point is updated programmatically through the\n`.update()` method. One parameter, `event`, is passed to the\nfunction. The new point options can be accessed through\n`event.options`. Returning `false` cancels the operation.","samples":[{"name":"Confirm point updating","value":"highcharts/plotoptions/series-point-events-update/","products":["highcharts"]}],"type":{"names":["Highcharts.PointUpdateCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Point"},"meta":{"fullname":"plotOptions.series.point.events.update","name":"update","line":1399,"lineEnd":1412,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}}}}}},"pointDescriptionFormat":{"doclet":{"description":"Deprecated. Use\n[series.accessibility.point.descriptionFormat](#plotOptions.series.accessibility.point.descriptionFormat)\ninstead.\n\nSame as\n[accessibility.point.descriptionFormat](#accessibility.point.descriptionFormat),\nbut for an individual series. Overrides the chart wide configuration.","type":{"names":["function"]},"requires":["module:modules/accessibility"],"since":"11.1.0"},"meta":{"fullname":"plotOptions.series.pointDescriptionFormat","name":"pointDescriptionFormat","line":524,"lineEnd":538,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"pointDescriptionFormatter":{"doclet":{"description":"Deprecated. Use\n[series.accessibility.point.descriptionFormatter](#plotOptions.series.accessibility.point.descriptionFormatter)\ninstead.\n\nSame as\n[accessibility.series.descriptionFormatter](#accessibility.series.descriptionFormatter),\nbut for an individual series. Overrides the chart wide configuration.","type":{"names":["function"]},"requires":["module:modules/accessibility"],"since":"5.0.12","deprecated":"8.0.0"},"meta":{"fullname":"plotOptions.series.pointDescriptionFormatter","name":"pointDescriptionFormatter","line":539,"lineEnd":553,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"pointInterval":{"doclet":{"description":"If no x values are given for the points in a series, `pointInterval`\ndefines the interval of the x values. For example, if a series\ncontains one value every decade starting from year 0, set\n`pointInterval` to `10`. In true `datetime` axes, the `pointInterval`\nis set in milliseconds.\n\nIt can be also be combined with `pointIntervalUnit` to draw irregular\ntime intervals.\n\nIf combined with `relativeXValue`, an x value can be set on each\npoint, and the `pointInterval` is added x times to the `pointStart`\nsetting.\n\nPlease note that this options applies to the _series data_, not the\ninterval of the axis ticks, which is independent.","samples":[{"name":"Datetime X axis","value":"highcharts/plotoptions/series-pointstart-datetime/","products":["highcharts"]},{"name":"Relative x value","value":"highcharts/plotoptions/series-relativexvalue/","products":["highcharts"]},{"name":"Using pointStart and pointInterval","value":"stock/plotoptions/pointinterval-pointstart/","products":["highstock"]},{"name":"Relative x value","value":"stock/plotoptions/relativexvalue/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"1","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.series.pointInterval","name":"pointInterval","line":554,"lineEnd":584,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"pointIntervalUnit":{"doclet":{"description":"On datetime series, this allows for setting the\n[pointInterval](#plotOptions.series.pointInterval) to irregular time\nunits, `day`, `month` and `year`. A day is usually the same as 24\nhours, but `pointIntervalUnit` also takes the DST crossover into\nconsideration when dealing with local time. Combine this option with\n`pointInterval` to draw weeks, quarters, 6 months, 10 years etc.\n\nPlease note that this options applies to the _series data_, not the\ninterval of the axis ticks, which is independent.","samples":[{"name":"One point a month","value":"highcharts/plotoptions/series-pointintervalunit/","products":["highcharts"]},{"name":"One point a month","value":"highcharts/plotoptions/series-pointintervalunit/","products":["highstock"]}],"type":{"names":["\"day\"","\"month\"","\"year\""]},"since":"4.1.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.series.pointIntervalUnit","name":"pointIntervalUnit","line":585,"lineEnd":606,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"pointPlacement":{"doclet":{"description":"Possible values: `\"on\"`, `\"between\"`, `number`.\n\nIn a column chart, when pointPlacement is `\"on\"`, the point will not\ncreate any padding of the X axis. In a polar column chart this means\nthat the first column points directly north. If the pointPlacement is\n`\"between\"`, the columns will be laid out between ticks. This is\nuseful for example for visualizing an amount between two points in\ntime or in a certain sector of a polar chart.\n\nSince Highcharts 3.0.2, the point placement can also be numeric,\nwhere 0 is on the axis value, -0.5 is between this value and the\nprevious, and 0.5 is between this value and the next. Unlike the\ntextual options, numeric point placement options won't affect axis\npadding.\n\nNote that pointPlacement needs a [pointRange](#plotOptions.series.pointRange) to work. For column series this is\ncomputed, but for line-type series it needs to be set.\n\nFor the `xrange` series type and gantt charts, if the Y axis is a\ncategory axis, the `pointPlacement` applies to the Y axis rather than\nthe (typically datetime) X axis.\n\nDefaults to `undefined` in cartesian charts, `\"between\"` in polar\ncharts.","see":["[xAxis.tickmarkPlacement](#xAxis.tickmarkPlacement)"],"samples":[{"name":"Between in a column chart","value":"highcharts/plotoptions/series-pointplacement-between/","products":["highcharts","highstock"]},{"name":"Numeric placement for custom layout","value":"highcharts/plotoptions/series-pointplacement-numeric/","products":["highcharts","highstock"]},{"name":"Placement in heatmap","value":"maps/plotoptions/heatmap-pointplacement/","products":["highcharts","highstock"]}],"type":{"names":["string","number"]},"since":"2.3.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.series.pointPlacement","name":"pointPlacement","line":607,"lineEnd":647,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"pointRange":{"doclet":{"description":"The width of each point on the x axis. For example in a column chart\nwith one value each day, the pointRange would be 1 day (= 24 * 3600\n* 1000 milliseconds). This is normally computed automatically, but\nthis option can be used to override the automatic value.","products":["highstock"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.series.pointRange","name":"pointRange","line":1998,"lineEnd":2005,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":0},"children":{}},"pointStart":{"doclet":{"description":"If no x values are given for the points in a series, `pointStart`\ndefines on what value to start. For example, if a series contains one\nyearly value starting from 1945, set `pointStart` to 1945.\n\nThe `pointStart` setting can be a number, or a datetime string that is\nparsed according to the `time.timezone` setting.\n\nIf combined with `relativeXValue`, an x value can be set on each\npoint. The x value from the point options is multiplied by\n`pointInterval` and added to `pointStart` to produce a modified x\nvalue.","samples":[{"name":"Linear","value":"highcharts/plotoptions/series-pointstart-linear/","products":["highcharts"]},{"name":"Datetime","value":"highcharts/plotoptions/series-pointstart-datetime/","products":["highcharts"]},{"name":"Relative x value","value":"highcharts/plotoptions/series-relativexvalue/","products":["highcharts"]},{"name":"Using pointStart and pointInterval","value":"stock/plotoptions/pointinterval-pointstart/","products":["highstock"]},{"name":"Relative x value","value":"stock/plotoptions/relativexvalue/","products":["highstock"]}],"type":{"names":["number","string"]},"defaultvalue":"0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"plotOptions.series.pointStart","name":"pointStart","line":648,"lineEnd":676,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"relativeXValue":{"doclet":{"description":"When true, X values in the data set are relative to the current\n`pointStart`, `pointInterval` and `pointIntervalUnit` settings. This\nallows compression of the data for datasets with irregular X values.\n\nThe real X values are computed on the formula `f(x) = ax + b`, where\n`a` is the `pointInterval` (optionally with a time unit given by\n`pointIntervalUnit`), and `b` is the `pointStart`.","samples":[{"name":"Relative X value","value":"highcharts/plotoptions/series-relativexvalue/","products":["highcharts"]},{"name":"Relative X value","value":"stock/plotoptions/relativexvalue/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.relativeXValue","name":"relativeXValue","line":677,"lineEnd":695,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"selected":{"doclet":{"description":"Whether to select the series initially. If `showCheckbox` is true,\nthe checkbox next to the series name in the legend will be checked\nfor a selected series.","samples":[{"name":"One out of two series selected","value":"highcharts/plotoptions/series-selected/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"1.2.0"},"meta":{"fullname":"plotOptions.series.selected","name":"selected","line":696,"lineEnd":708,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"shadow":{"doclet":{"description":"Whether to apply a drop shadow to the graph line. Since 2.3 the\nshadow can be an object configuration containing `color`, `offsetX`,\n`offsetY`, `opacity` and `width`.\n\nNote that in some cases, like stacked columns or other dense layouts, the\nseries may cast shadows on each other. In that case, the\n`chart.seriesGroupShadow` allows applying a common drop shadow to the\nwhole series group.","samples":[{"name":"Shadow enabled","value":"highcharts/plotoptions/series-shadow/","products":["highcharts"]}],"type":{"names":["boolean","Highcharts.ShadowOptionsObject"]},"defaultvalue":"false"},"meta":{"fullname":"plotOptions.series.shadow","name":"shadow","line":709,"lineEnd":725,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"showCheckbox":{"doclet":{"description":"If true, a checkbox is displayed next to the legend item to allow\nselecting the series. The state of the checkbox is determined by\nthe `selected` option.","productdesc":[{"value":"Note that if a `colorAxis` is defined, the color axis is represented\nin the legend, not the series.","products":["highmaps"]}],"samples":[{"name":"Show select box","value":"highcharts/plotoptions/series-showcheckbox-true/","products":["highcharts"]}],"since":"1.2.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.series.showCheckbox","name":"showCheckbox","line":94,"lineEnd":107,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":false},"children":{}},"showInLegend":{"doclet":{"description":"Whether to display this particular series or series type in the\nlegend. Standalone series are shown in legend by default, and linked\nseries are not. Since v7.2.0 it is possible to show series that use\ncolorAxis by setting this option to `true`.","samples":[{"name":"One series in the legend, one hidden","value":"highcharts/plotoptions/series-showinlegend/","products":["highcharts"]}],"type":{"names":["boolean"]}},"meta":{"fullname":"plotOptions.series.showInLegend","name":"showInLegend","line":726,"lineEnd":737,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"showInNavigator":{"doclet":{"description":"Whether or not to show the series in the navigator. Takes precedence\nover [navigator.baseSeries](#navigator.baseSeries) if defined.","type":{"names":["boolean"]},"since":"5.0.0","products":["highstock"]},"meta":{"fullname":"plotOptions.series.showInNavigator","name":"showInNavigator","line":738,"lineEnd":746,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"skipKeyboardNavigation":{"doclet":{"description":"Deprecated. Use\n[series.accessibility.keyboardNavigation](#plotOptions.series.accessibility.keyboardNavigation)\ninstead.\n\nIf set to `true`, the accessibility module will skip past the points\nin this series for keyboard navigation.","type":{"names":["boolean"]},"since":"5.0.12","deprecated":"8.0.0"},"meta":{"fullname":"plotOptions.series.skipKeyboardNavigation","name":"skipKeyboardNavigation","line":747,"lineEnd":759,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"softThreshold":{"doclet":{"description":"When this is true, the series will not cause the Y axis to cross\nthe zero plane (or [threshold](#plotOptions.series.threshold) option)\nunless the data actually crosses the plane.\n\nFor example, if `softThreshold` is `false`, a series of 0, 1, 2,\n3 will make the Y axis show negative values according to the\n`minPadding` option. If `softThreshold` is `true`, the Y axis starts\nat 0.","since":"4.1.9","products":["highcharts","highstock"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.series.softThreshold","name":"softThreshold","line":2007,"lineEnd":2019,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":true},"children":{}},"sonification":{"doclet":{"description":"Sonification/audio chart options for a series.","declare":"Highcharts.SeriesSonificationOptions","since":"11.0.0","requires":["module:modules/sonification"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.sonification","name":"sonification","line":936,"lineEnd":943,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"contextTracks":{"doclet":{"description":"Context tracks for this series. Context tracks are tracks that are not\ntied to data points.\n\nGiven as an array of instrument tracks, speech tracks, or a mix of both.","declare":"Highcharts.SeriesSonificationContextTracksOptions","type":{"names":["Array.<*>"]},"extends":"sonification.globalContextTracks","since":"11.0.0"},"meta":{"fullname":"plotOptions.series.sonification.contextTracks","name":"contextTracks","line":951,"lineEnd":961,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"defaultInstrumentOptions":{"doclet":{"description":"Default options for all this series' instrument tracks.","declare":"Highcharts.SeriesSonificationInstrumentOptions","extends":"sonification.defaultInstrumentOptions","since":"11.0.0"},"meta":{"fullname":"plotOptions.series.sonification.defaultInstrumentOptions","name":"defaultInstrumentOptions","line":972,"lineEnd":978,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"defaultSpeechOptions":{"doclet":{"description":"Default options for all this series' speech tracks.","declare":"Highcharts.SeriesSonificationSpeechOptions","extends":"sonification.defaultSpeechOptions","since":"11.0.0"},"meta":{"fullname":"plotOptions.series.sonification.defaultSpeechOptions","name":"defaultSpeechOptions","line":979,"lineEnd":985,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"enabled":{"doclet":{"description":"Whether or not sonification is enabled for this series.","type":{"names":["boolean"]},"defaultvalue":"true","since":"11.0.0"},"meta":{"fullname":"plotOptions.series.sonification.enabled","name":"enabled","line":944,"lineEnd":950,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"pointGrouping":{"doclet":{"description":"Sonification point grouping options for this series.","declare":"Highcharts.SeriesSonificationPointGroupingOptions","extends":"sonification.pointGrouping","since":"11.0.0"},"meta":{"fullname":"plotOptions.series.sonification.pointGrouping","name":"pointGrouping","line":986,"lineEnd":992,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"tracks":{"doclet":{"description":"Tracks for this series.\n\nGiven as an array of instrument tracks, speech tracks, or a mix of both.","declare":"Highcharts.SeriesSonificationTracksOptions","type":{"names":["Array.<*>"]},"extends":"sonification.globalTracks","since":"11.0.0"},"meta":{"fullname":"plotOptions.series.sonification.tracks","name":"tracks","line":962,"lineEnd":971,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"stacking":{"doclet":{"description":"Whether to stack the values of each series on top of each other.\nPossible values are null to disable, `\"normal\"` to stack by\nvalue or `\"percent\"`.\n\nWhen stacking is enabled, data must be sorted\nin ascending X order.\n\nSome stacking options are related to specific series types. In the\nstreamgraph series type, the stacking option is set to `\"stream\"`.\nThe second one is `\"overlap\"`, which only applies to waterfall\nseries.","see":["[yAxis.reversedStacks](#yAxis.reversedStacks)"],"samples":[{"name":"Line","value":"highcharts/plotoptions/series-stacking-line/","products":["highcharts"]},{"name":"Column","value":"highcharts/plotoptions/series-stacking-column/","products":["highcharts"]},{"name":"Bar","value":"highcharts/plotoptions/series-stacking-bar/","products":["highcharts"]},{"name":"Area","value":"highcharts/plotoptions/series-stacking-area/","products":["highcharts"]},{"name":"Line","value":"highcharts/plotoptions/series-stacking-percent-line/","products":["highcharts"]},{"name":"Column","value":"highcharts/plotoptions/series-stacking-percent-column/","products":["highcharts"]},{"name":"Bar","value":"highcharts/plotoptions/series-stacking-percent-bar/","products":["highcharts"]},{"name":"Area","value":"highcharts/plotoptions/series-stacking-percent-area/","products":["highcharts"]},{"name":"Waterfall with normal stacking","value":"highcharts/plotoptions/series-waterfall-with-normal-stacking","products":["highcharts"]},{"name":"Waterfall with overlap stacking","value":"highcharts/plotoptions/series-waterfall-with-overlap-stacking","products":["highcharts"]},{"name":"Area","value":"stock/plotoptions/stacking/","products":["highstock"]}],"type":{"names":["\"normal\"","\"overlap\"","\"percent\"","\"stream\"","\"null\""]},"defaultvalue":"null","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.stacking","name":"stacking","line":775,"lineEnd":818,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"states":{"doclet":{"description":"A collection of options for different series states.","declare":"Highcharts.SeriesStatesOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.states","name":"states","line":2021,"lineEnd":2025,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"hover":{"doclet":{"description":"Options for the hovered series. These settings override the\nnormal state options when a series is moused over or touched.","declare":"Highcharts.SeriesStatesHoverOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.states.hover","name":"hover","line":2042,"lineEnd":2047,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"animation":{"doclet":{"description":"Animation setting for hovering the graph in line-type series.","type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"since":"5.0.8","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.states.hover.animation","name":"animation","line":2049,"lineEnd":2064,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"duration":{"doclet":{"description":"The duration of the hover animation in milliseconds. By\ndefault the hover state animates quickly in, and slowly\nback to normal.","since":"5.0.8","type":{"names":["number"]},"defaultvalue":150},"meta":{"fullname":"plotOptions.series.states.hover.animation.duration","name":"duration","line":2073,"lineEnd":2077,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":150},"children":{}}}},"borderColor":{"doclet":{"description":"The border color of the point in this state.","type":{"names":["Highcharts.ColorType"]},"products":["highmaps"]},"meta":{"fullname":"plotOptions.series.states.hover.borderColor","name":"borderColor","line":227,"lineEnd":233,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"borderWidth":{"doclet":{"description":"The border width of the point in this state","type":{"names":["number"]},"products":["highmaps"]},"meta":{"fullname":"plotOptions.series.states.hover.borderWidth","name":"borderWidth","line":235,"lineEnd":241,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"color":{"doclet":{"description":"The color of the shape in this state.","samples":[{"name":"Hover options","value":"maps/plotoptions/series-states-hover/"}],"type":{"names":["Highcharts.ColorType"]},"products":["highmaps"]},"meta":{"fullname":"plotOptions.series.states.hover.color","name":"color","line":217,"lineEnd":226,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Enable separate styles for the hovered series to visualize\nthat the user hovers either the series itself or the legend.","samples":[{"name":"Line","value":"highcharts/plotoptions/series-states-hover-enabled/","products":["highcharts"]},{"name":"Column","value":"highcharts/plotoptions/series-states-hover-enabled-column/","products":["highcharts"]},{"name":"Pie","value":"highcharts/plotoptions/series-states-hover-enabled-pie/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"1.2.0"},"meta":{"fullname":"plotOptions.series.states.hover.enabled","name":"enabled","line":2049,"lineEnd":2064,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"halo":{"doclet":{"description":"Options for the halo appearing around the hovered point in\nline-type series as well as outside the hovered slice in pie\ncharts. By default the halo is filled by the current point or\nseries color with an opacity of 0.25\\. The halo can be\ndisabled by setting the `halo` option to `null`.\n\nIn styled mode, the halo is styled with the\n`.highcharts-halo` class, with colors inherited from\n`.highcharts-color-{n}`.","samples":[{"name":"Halo options","value":"highcharts/plotoptions/halo/","products":["highcharts"]},{"name":"Halo options","value":"highcharts/plotoptions/halo/","products":["highstock"]}],"declare":"Highcharts.SeriesStatesHoverHaloOptionsObject","type":{"names":["null","*"]},"since":"4.0.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.states.hover.halo","name":"halo","line":2120,"lineEnd":2140,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"attributes":{"doclet":{"description":"A collection of SVG attributes to override the appearance\nof the halo, for example `fill`, `stroke` and\n`stroke-width`.","type":{"names":["Highcharts.SVGAttributes"]},"since":"4.0.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.states.hover.halo.attributes","name":"attributes","line":2142,"lineEnd":2151,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"opacity":{"doclet":{"description":"Opacity for the halo unless a specific fill is overridden\nusing the `attributes` setting.","since":"4.0.0","products":["highcharts","highstock"],"type":{"names":["number"]},"defaultvalue":0.25},"meta":{"fullname":"plotOptions.series.states.hover.halo.opacity","name":"opacity","line":2162,"lineEnd":2168,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":0.25},"children":{}},"size":{"doclet":{"description":"The pixel size of the halo. For point markers this is the\nradius of the halo. For pie slices it is the width of the\nhalo outside the slice. For bubbles it defaults to 5 and\nis the width of the halo outside the bubble.","since":"4.0.0","products":["highcharts","highstock"],"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.series.states.hover.halo.size","name":"size","line":2142,"lineEnd":2151,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":10},"children":{}}}},"lineWidth":{"doclet":{"description":"Pixel width of the graph line. By default this property is\nundefined, and the `lineWidthPlus` property dictates how much\nto increase the linewidth from normal state.","samples":[{"name":"5px line on hover","value":"highcharts/plotoptions/series-states-hover-linewidth/","products":["highcharts"]}],"type":{"names":["number"]},"products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.states.hover.lineWidth","name":"lineWidth","line":2080,"lineEnd":2091,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"lineWidthPlus":{"doclet":{"description":"The additional line width for the graph of a hovered series.","samples":[{"name":"5 pixels wider","value":"highcharts/plotoptions/series-states-hover-linewidthplus/","products":["highcharts"]},{"name":"5 pixels wider","value":"highcharts/plotoptions/series-states-hover-linewidthplus/","products":["highstock"]}],"since":"4.0.3","products":["highcharts","highstock"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.series.states.hover.lineWidthPlus","name":"lineWidthPlus","line":2080,"lineEnd":2091,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":1},"children":{}},"marker":{"doclet":{"description":"In Highcharts 1.0, the appearance of all markers belonging\nto the hovered series. For settings on the hover state of the\nindividual point, see\n[marker.states.hover](#plotOptions.series.marker.states.hover).","extends":"plotOptions.series.marker","exclude":["states","symbol"],"products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.states.hover.marker","name":"marker","line":2104,"lineEnd":2115,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}}}},"inactive":{"doclet":{"description":"The opposite state of a hover for series.","samples":[{"name":"Disabled inactive state","value":"highcharts/plotoptions/series-states-inactive-disabled"}],"declare":"Highcharts.SeriesStatesInactiveOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.states.inactive","name":"inactive","line":2190,"lineEnd":2197,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"animation":{"doclet":{"description":"Animation when not hovering over the marker.","type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]}},"meta":{"fullname":"plotOptions.series.states.inactive.animation","name":"animation","line":2199,"lineEnd":2208,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"duration":{"doclet":{"type":{"names":["number"]},"defaultvalue":150},"meta":{"fullname":"plotOptions.series.states.inactive.animation.duration","name":"duration","line":2215,"lineEnd":2215,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":150},"children":{}}}},"enabled":{"doclet":{"description":"Enable or disable the inactive state for a series","samples":[{"name":"Disabled inactive state","value":"highcharts/plotoptions/series-states-inactive-disabled"}],"type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"plotOptions.series.states.inactive.enabled","name":"enabled","line":2199,"lineEnd":2208,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"opacity":{"doclet":{"description":"Opacity of series elements (dataLabels, line, area).","type":{"names":["number"]},"defaultvalue":0.2},"meta":{"fullname":"plotOptions.series.states.inactive.opacity","name":"opacity","line":2217,"lineEnd":2221,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":0.2},"children":{}}}},"normal":{"doclet":{"description":"The normal state of a series, or for point items in column, pie\nand similar series. Currently only used for setting animation\nwhen returning to normal state from hover.","declare":"Highcharts.SeriesStatesNormalOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.states.normal","name":"normal","line":2027,"lineEnd":2033,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"animation":{"doclet":{"description":"Animation when returning to normal state after hovering.","type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"productdesc":[{"value":"The animation adds some latency in order to reduce the effect\nof flickering when hovering in and out of for example an\nuneven coastline.","products":["highmaps"]}],"samples":[{"name":"No animation of fill color","value":"maps/plotoptions/series-states-animation-false/","products":["highmaps"]}],"defaultvalue":true},"meta":{"fullname":"plotOptions.series.states.normal.animation","name":"animation","line":2035,"lineEnd":2039,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":true},"children":{}}}},"select":{"doclet":{"description":"Specific options for point in selected states, after being\nselected by\n[allowPointSelect](#plotOptions.series.allowPointSelect)\nor programmatically.","samples":[{"name":"Allow point select demo","value":"maps/plotoptions/series-allowpointselect/"}],"declare":"Highcharts.SeriesStatesSelectOptionsObject","extends":"plotOptions.series.states.hover","exclude":["brightness"]},"meta":{"fullname":"plotOptions.series.states.select","name":"select","line":2172,"lineEnd":2184,"column":8,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"animation":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.series.states.select.animation","name":"animation","line":2186,"lineEnd":2186,"column":12,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"duration":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.series.states.select.animation.duration","name":"duration","line":2187,"lineEnd":2187,"column":16,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":0},"children":{}}}},"color":{"doclet":{"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc","products":["highmaps"]},"meta":{"fullname":"plotOptions.series.states.select.color","name":"color","line":274,"lineEnd":279,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}}}}}},"step":{"doclet":{"description":"Whether to apply steps to the line. Possible values are `left`,\n`center` and `right`.","samples":[{"name":"Different step line options","value":"highcharts/plotoptions/line-step/","products":["highcharts"]},{"name":"Stepped, stacked area","value":"highcharts/plotoptions/area-step/","products":["highcharts"]},{"name":"Step line","value":"stock/plotoptions/line-step/","products":["highstock"]}],"type":{"names":["\"left\"","\"center\"","\"right\""]},"since":"1.2.5","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.step","name":"step","line":819,"lineEnd":835,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"stickyTracking":{"doclet":{"description":"Sticky tracking of mouse events. When true, the `mouseOut` event on a\nseries isn't triggered until the mouse moves over another series, or\nout of the plot area. When false, the `mouseOut` event on a series is\ntriggered when the mouse leaves the area around the series' graph or\nmarkers. This also implies the tooltip when not shared. When\n`stickyTracking` is false and `tooltip.shared` is false, the tooltip\nwill be hidden when moving the mouse between series. Defaults to true\nfor line and area type series, but to false for columns, pies etc.\n\n**Note:** The boost module will force this option because of\ntechnical limitations.","samples":[{"name":"True by default","value":"highcharts/plotoptions/series-stickytracking-true/","products":["highcharts"]},{"name":"False","value":"highcharts/plotoptions/series-stickytracking-false/","products":["highcharts"]}],"defaultByProduct":{"highcharts":true,"highstock":true,"highmaps":false},"since":"2.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.series.stickyTracking","name":"stickyTracking","line":2225,"lineEnd":2247,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":true},"children":{}},"threshold":{"doclet":{"description":"The threshold, also called zero level or base level. For line type\nseries this is only used in conjunction with\n[negativeColor](#plotOptions.series.negativeColor).","see":["[softThreshold](#plotOptions.series.softThreshold)."],"type":{"names":["number","null"]},"defaultvalue":"0","since":"3.0.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.threshold","name":"threshold","line":836,"lineEnd":848,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"tooltip":{"doclet":{"description":"A configuration object for the tooltip rendering of each single\nseries. Properties are inherited from [tooltip](#tooltip), but only\nthe following properties can be defined on a series level.","declare":"Highcharts.SeriesTooltipOptionsObject","since":"2.3.0","extends":"tooltip","exclude":["animation","backgroundColor","borderColor","borderRadius","borderWidth","className","crosshairs","enabled","fixed","formatter","headerShape","hideDelay","outside","padding","positioner","shadow","shape","shared","snap","split","stickOnContact","style","useHTML"]},"meta":{"fullname":"plotOptions.series.tooltip","name":"tooltip","line":2249,"lineEnd":2263,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"turboThreshold":{"doclet":{"description":"When a series contains a `data` array that is longer than this, the\nSeries class looks for data configurations of plain numbers or arrays of\nnumbers. The first and last valid points are checked. If found, the rest\nof the data is assumed to be the same. This saves expensive data checking\nand indexing in long series, and makes data-heavy charts render faster.\n\nSet it to `0` disable.\n\nNote:\n- In boost mode turbo threshold is forced. Only array of numbers or two\n  dimensional arrays are allowed.\n- In version 11.4.3 and earlier, if object configurations were passed\n  beyond the turbo threshold, a warning was logged in the console and the\n  data series didn't render.","since":"2.2.0","products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":1000},"meta":{"fullname":"plotOptions.series.turboThreshold","name":"turboThreshold","line":2249,"lineEnd":2263,"column":4,"filename":"code/es-modules/Core/Series/SeriesDefaults.js","default":1000},"children":{}},"visible":{"doclet":{"description":"Set the initial visibility of the series.","samples":[{"name":"Two series, one hidden and one visible","value":"highcharts/plotoptions/series-visible/","products":["highcharts"]},{"name":"Hidden series","value":"stock/plotoptions/series-visibility/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"plotOptions.series.visible","name":"visible","line":849,"lineEnd":860,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"zIndex":{"doclet":{"description":"Define the z index of the series.","type":{"names":["number"]},"products":["highmaps"]},"meta":{"fullname":"plotOptions.series.zIndex","name":"zIndex","line":198,"lineEnd":204,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"zoneAxis":{"doclet":{"description":"Defines the Axis on which the zones are applied.","see":["[zones](#plotOptions.series.zones)"],"samples":[{"name":"Zones on the X-Axis","value":"highcharts/series/color-zones-zoneaxis-x/","products":["highcharts"]},{"name":"Zones on the X-Axis","value":"highcharts/series/color-zones-zoneaxis-x/","products":["highstock"]}],"type":{"names":["string"]},"defaultvalue":"y","since":"4.1.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.zoneAxis","name":"zoneAxis","line":861,"lineEnd":876,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"zones":{"doclet":{"description":"An array defining zones within a series. Zones can be applied to the\nX axis, Y axis or Z axis for bubbles, according to the `zoneAxis`\noption. The zone definitions have to be in ascending order regarding\nto the value.\n\nIn styled mode, the color zones are styled with the\n`.highcharts-zone-{n}` class, or custom classed from the `className`\noption\n([view live demo](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/css/color-zones/)).","see":["[zoneAxis](#plotOptions.series.zoneAxis)"],"samples":[{"name":"Color zones","value":"highcharts/series/color-zones-simple/","products":["highcharts"]},{"name":"Color zones","value":"highcharts/series/color-zones-simple/","products":["highstock"]}],"declare":"Highcharts.SeriesZonesOptionsObject","type":{"names":["Array.<*>"]},"since":"4.1.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.zones","name":"zones","line":2284,"lineEnd":2307,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{"className":{"doclet":{"description":"Styled mode only. A custom class name for the zone.","samples":[{"name":"Zones styled by class name","value":"highcharts/css/color-zones/"}],"type":{"names":["string"]},"since":"5.0.0"},"meta":{"fullname":"plotOptions.series.zones.className","name":"className","line":2308,"lineEnd":2317,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"color":{"doclet":{"description":"Defines the color of the series.","see":["[series color](#plotOptions.series.color)"],"type":{"names":["Highcharts.ColorType"]},"since":"4.1.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.zones.color","name":"color","line":2318,"lineEnd":2327,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"dashStyle":{"doclet":{"description":"A name for the dash style to use for the graph.","see":["[plotOptions.series.dashStyle](#plotOptions.series.dashStyle)"],"samples":[{"name":"Dashed line indicates prognosis","value":"highcharts/series/color-zones-dashstyle-dot/","products":["highcharts","highstock"]}],"type":{"names":["Highcharts.DashStyleValue"]},"since":"4.1.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.zones.dashStyle","name":"dashStyle","line":2328,"lineEnd":2340,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"fillColor":{"doclet":{"description":"Defines the fill color for the series (in area type series)","see":["[fillColor](#plotOptions.area.fillColor)"],"type":{"names":["Highcharts.ColorType"]},"since":"4.1.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.zones.fillColor","name":"fillColor","line":2341,"lineEnd":2350,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"value":{"doclet":{"description":"The value up to where the zone extends, if undefined the zones\nstretches to the last value in the series.","type":{"names":["number"]},"since":"4.1.0","products":["highcharts","highstock"]},"meta":{"fullname":"plotOptions.series.zones.value","name":"value","line":2351,"lineEnd":2359,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}}}},"zoomEnabled":{"doclet":{"description":"Whether to zoom non-cartesian series. If `chart.zooming` is set, the option\nallows to disable zooming on an individual non-cartesian series. By default\nzooming is enabled for all series.\n\n**Note**: This option works only for non-cartesian series.","type":{"names":["boolean"]},"defaultvalue":"true","since":"12.3.0","requires":["module:modules/non-cartesian-zoom"]},"meta":{"fullname":"plotOptions.series.zoomEnabled","name":"zoomEnabled","line":304,"lineEnd":316,"filename":"code/es-modules/Extensions/NonCartesianSeriesZoom/NonCartesianSeriesZoom.js"},"children":{}}}},"slowstochastic":{"doclet":{"description":"Slow Stochastic oscillator. This series requires the `linkedTo` option\nto be set and should be loaded after `stock/indicators/indicators.js`\nand `stock/indicators/stochastic.js` files.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `slowstochastic` series are defined in\n   [plotOptions.slowstochastic](plotOptions.slowstochastic).\n3. Options for one single series are given in\n   [the series instance array](series.slowstochastic).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        slowstochastic: {\n            // shared options for all slowstochastic series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'slowstochastic'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.slowstochastic.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === slowstochastic) {\n    // code specific to the slowstochastic series\n}\n```\n            ","samples":[{"name":"Slow Stochastic oscillator","value":"stock/indicators/slow-stochastic"}],"extends":"plotOptions.stochastic","since":"8.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/stochastic","module:stock/indicators/slow-stochastic"]},"meta":{"filename":"code/es-modules/Stock/Indicators/SlowStochastic/SlowStochasticIndicator.js","name":"slowstochastic","fullname":"plotOptions.slowstochastic","line":69,"lineEnd":73,"column":0},"children":{"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.slowstochastic.params","name":"params","line":91,"lineEnd":91,"column":4,"filename":"code/es-modules/Stock/Indicators/SlowStochastic/SlowStochasticIndicator.js"},"children":{"periods":{"doclet":{"description":"Periods for Slow Stochastic oscillator: [%K, %D, SMA(%D)].","type":{"names":["Array.<number, number, number>"]},"defaultvalue":"[14, 3, 3]"},"meta":{"fullname":"plotOptions.slowstochastic.params.periods","name":"periods","line":92,"lineEnd":97,"column":8,"filename":"code/es-modules/Stock/Indicators/SlowStochastic/SlowStochasticIndicator.js"},"children":{}}}}}},"sma":{"doclet":{"description":"Simple moving average indicator (SMA). This series requires `linkedTo`\noption to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `sma` series are defined in\n   [plotOptions.sma](plotOptions.sma).\n3. Options for one single series are given in\n   [the series instance array](series.sma).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        sma: {\n            // shared options for all sma series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'sma'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.sma.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === sma) {\n    // code specific to the sma series\n}\n```\n            ","samples":[{"name":"Simple moving average indicator","value":"stock/indicators/sma"}],"extends":"plotOptions.line","since":"6.0.0","exclude":["allAreas","colorAxis","dragDrop","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking","useOhlcData"],"products":["highstock"],"requires":["module:stock/indicators/indicators"]},"meta":{"filename":"code/es-modules/Stock/Indicators/SMA/SMAIndicator.js","name":"sma","fullname":"plotOptions.sma","line":283,"lineEnd":287,"column":0},"children":{"compareToMain":{"doclet":{"description":"Whether to compare indicator to the main series values\nor indicator values.","samples":[{"name":"Difference between comparing SMA values to the main series and its own values.","value":"stock/plotoptions/series-comparetomain/","products":["highstock"]}],"type":{"names":["boolean"]},"since":"6.0.0","defaultvalue":false},"meta":{"fullname":"plotOptions.sma.compareToMain","name":"compareToMain","line":338,"lineEnd":347,"column":4,"filename":"code/es-modules/Stock/Indicators/SMA/SMAIndicator.js","default":false},"children":{}},"linkedTo":{"doclet":{"description":"The main series ID that indicator will be based on. Required for this\nindicator.","type":{"names":["string"]},"since":"6.0.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.sma.linkedTo","name":"linkedTo","line":331,"lineEnd":336,"column":4,"filename":"code/es-modules/Stock/Indicators/SMA/SMAIndicator.js","default":"undefined"},"children":{}},"name":{"doclet":{"description":"The name of the series as shown in the legend, tooltip etc. If not\nset, it will be based on a technical indicator type and default\nparams.","type":{"names":["string"]},"since":"6.0.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.sma.name","name":"name","line":317,"lineEnd":323,"column":4,"filename":"code/es-modules/Stock/Indicators/SMA/SMAIndicator.js","default":"undefined"},"children":{}},"params":{"doclet":{"description":"Parameters used in calculation of regression series' points.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.sma.params","name":"params","line":349,"lineEnd":351,"column":4,"filename":"code/es-modules/Stock/Indicators/SMA/SMAIndicator.js"},"children":{"index":{"doclet":{"description":"The point index which indicator calculations will base. For\nexample using OHLC data, index=2 means the indicator will be\ncalculated using Low values.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.sma.params.index","name":"index","line":353,"lineEnd":357,"column":8,"filename":"code/es-modules/Stock/Indicators/SMA/SMAIndicator.js","default":3},"children":{}},"period":{"doclet":{"description":"The base period for indicator calculations. This is the number of\ndata points which are taken into account for the indicator\ncalculations.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":14},"meta":{"fullname":"plotOptions.sma.params.period","name":"period","line":359,"lineEnd":363,"column":8,"filename":"code/es-modules/Stock/Indicators/SMA/SMAIndicator.js","default":14},"children":{}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.sma.tooltip","name":"tooltip","line":325,"lineEnd":325,"column":4,"filename":"code/es-modules/Stock/Indicators/SMA/SMAIndicator.js"},"children":{"valueDecimals":{"doclet":{"description":"Number of decimals in indicator series.","type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"plotOptions.sma.tooltip.valueDecimals","name":"valueDecimals","line":326,"lineEnd":328,"column":8,"filename":"code/es-modules/Stock/Indicators/SMA/SMAIndicator.js","default":4},"children":{}}}}}},"solidgauge":{"doclet":{"description":"A solid gauge is a circular gauge where the value is indicated by a filled\narc, and the color of the arc may variate with the value.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `solidgauge` series are defined in\n   [plotOptions.solidgauge](plotOptions.solidgauge).\n3. Options for one single series are given in\n   [the series instance array](series.solidgauge).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        solidgauge: {\n            // shared options for all solidgauge series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'solidgauge'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.solidgauge.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === solidgauge) {\n    // code specific to the solidgauge series\n}\n```\n            ","samples":[{"name":"Solid gauges","value":"highcharts/demo/gauge-solid/"}],"extends":"plotOptions.gauge","exclude":["dial","pivot","wrap"],"products":["highcharts"],"requires":["module:modules/solid-gauge"]},"meta":{"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js","name":"solidgauge","fullname":"plotOptions.solidgauge","line":14,"lineEnd":18,"column":0},"children":{"borderRadius":{"doclet":{"description":"The corner radius of the border surrounding solid gauge. A number\nsignifies pixels and percentage string, like for example `50%`,\nsignifies a relative size.","samples":[{"name":"Solid gauge with rounded border.","value":"highcharts/series-solidgauge/pane-borderradius","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"11.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.solidgauge.borderRadius","name":"borderRadius","line":33,"lineEnd":45,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{}},"colorByPoint":{"doclet":{"description":"Whether to give each point an individual color.","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.solidgauge.colorByPoint","name":"colorByPoint","line":33,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js","default":true},"children":{}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.solidgauge.dataLabels","name":"dataLabels","line":128,"lineEnd":128,"column":4,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{"y":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.solidgauge.dataLabels.y","name":"y","line":129,"lineEnd":129,"column":8,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js","default":0},"children":{}}}},"innerRadius":{"doclet":{"description":"The inner radius for points in a solid gauge. Can be given only in\npercentage, either as a number or a string like `\"50%\"`.","samples":[{"name":"Individual radius and innerRadius","value":"highcharts/plotoptions/solidgauge-radius/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"\"60%\"","since":"4.1.6","products":["highcharts"]},"meta":{"fullname":"plotOptions.solidgauge.innerRadius","name":"innerRadius","line":46,"lineEnd":58,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{}},"linecap":{"doclet":{"description":"Whether the strokes of the solid gauge should be `round` or `square`.","samples":[{"name":"Rounded gauge","value":"highcharts/demo/gauge-multiple-kpi/","products":["highcharts"]}],"type":{"names":["\"square\"","\"round\""]},"defaultvalue":"round","since":"4.2.2","products":["highcharts"]},"meta":{"fullname":"plotOptions.solidgauge.linecap","name":"linecap","line":59,"lineEnd":71,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{}},"overshoot":{"doclet":{"description":"Allow the gauge to overshoot the end of the perimeter axis by this\nmany degrees. Say if the gauge axis goes from 0 to 60, a value of\n100, or 1000, will show 5 degrees beyond the end of the axis when this\noption is set to 5.","type":{"names":["number"]},"defaultvalue":"0","since":"3.0.10","products":["highcharts"]},"meta":{"fullname":"plotOptions.solidgauge.overshoot","name":"overshoot","line":72,"lineEnd":83,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{}},"radius":{"doclet":{"description":"The outer radius for points in a solid gauge. Can be given only in\npercentage, either as a number or a string like `\"100%\"`.","samples":[{"name":"Individual radius and innerRadius","value":"highcharts/plotoptions/solidgauge-radius/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"\"100%\"","since":"4.1.6","products":["highcharts"]},"meta":{"fullname":"plotOptions.solidgauge.radius","name":"radius","line":84,"lineEnd":96,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{}},"rounded":{"doclet":{"description":"Whether to draw rounded edges on the gauge. This options adds the radius\nof the rounding to the ends of the arc, so it extends past the actual\nvalues. When `borderRadius` is set, it takes precedence over `rounded`. A\n`borderRadius` of 50% behaves like `rounded`, except the shape is not\nextended past its value.","samples":[{"name":"Gauge showing multiple KPIs","value":"highcharts/demo/gauge-multiple-kpi/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"5.0.8","products":["highcharts"]},"meta":{"fullname":"plotOptions.solidgauge.rounded","name":"rounded","line":97,"lineEnd":112,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{}},"threshold":{"doclet":{"description":"The threshold or base level for the gauge.","samples":[{"name":"Zero threshold with negative and positive values","value":"highcharts/plotoptions/solidgauge-threshold/","products":["highcharts"]}],"type":{"names":["number","null"]},"since":"5.0.3","products":["highcharts"]},"meta":{"fullname":"plotOptions.solidgauge.threshold","name":"threshold","line":113,"lineEnd":123,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{}}}},"spline":{"doclet":{"description":"A spline series is a special type of line series, where the segments\nbetween the data points are smoothed.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `spline` series are defined in\n   [plotOptions.spline](plotOptions.spline).\n3. Options for one single series are given in\n   [the series instance array](series.spline).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        spline: {\n            // shared options for all spline series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'spline'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.spline.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === spline) {\n    // code specific to the spline series\n}\n```\n            ","samples":[{"name":"Spline chart","value":"highcharts/demo/spline-irregular-time/","products":["highcharts"]},{"name":"Spline chart","value":"stock/demo/spline/","products":["highstock"]}],"extends":"plotOptions.series","exclude":["step","boostThreshold","boostBlending"],"products":["highcharts","highstock"]},"meta":{"filename":"code/es-modules/Series/Spline/SplineSeries.js","name":"spline","fullname":"plotOptions.spline","line":171,"lineEnd":175,"column":0},"children":{}},"stochastic":{"doclet":{"description":"Stochastic oscillator. This series requires the `linkedTo` option to be\nset and should be loaded after the `stock/indicators/indicators.js` file.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `stochastic` series are defined in\n   [plotOptions.stochastic](plotOptions.stochastic).\n3. Options for one single series are given in\n   [the series instance array](series.stochastic).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        stochastic: {\n            // shared options for all stochastic series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'stochastic'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.stochastic.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === stochastic) {\n    // code specific to the stochastic series\n}\n```\n            ","samples":[{"name":"Stochastic oscillator","value":"stock/indicators/stochastic"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/stochastic"]},"meta":{"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js","name":"stochastic","fullname":"plotOptions.stochastic","line":112,"lineEnd":116,"column":0},"children":{"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.stochastic.dataGrouping","name":"dataGrouping","line":178,"lineEnd":178,"column":4,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js"},"children":{"approximation":{"doclet":{"type":{"names":["string"]},"defaultvalue":"averages"},"meta":{"fullname":"plotOptions.stochastic.dataGrouping.approximation","name":"approximation","line":179,"lineEnd":179,"column":8,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js","default":"averages"},"children":{}}}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.stochastic.marker","name":"marker","line":150,"lineEnd":150,"column":4,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.stochastic.marker.enabled","name":"enabled","line":151,"lineEnd":151,"column":8,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js","default":false},"children":{}}}},"params":{"doclet":{"exclude":["index","period"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.stochastic.params","name":"params","line":135,"lineEnd":137,"column":4,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.stochastic.params.index","name":"index","line":139,"lineEnd":139,"column":8,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.stochastic.params.period","name":"period","line":141,"lineEnd":141,"column":8,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js","default":"undefined"},"children":{}},"periods":{"doclet":{"description":"Periods for Stochastic oscillator: [%K, %D].","type":{"names":["Array.<number, number>"]},"defaultvalue":"[14, 3]"},"meta":{"fullname":"plotOptions.stochastic.params.periods","name":"periods","line":142,"lineEnd":147,"column":8,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js"},"children":{}}}},"smoothedLine":{"doclet":{"description":"Smoothed line options.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.stochastic.smoothedLine","name":"smoothedLine","line":156,"lineEnd":158,"column":4,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js"},"children":{"styles":{"doclet":{"description":"Styles for a smoothed line.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.stochastic.smoothedLine.styles","name":"styles","line":160,"lineEnd":162,"column":8,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js"},"children":{"lineColor":{"doclet":{"description":"Color of the line. If not set, it's inherited from\n[plotOptions.stochastic.color](#plotOptions.stochastic.color).","type":{"names":["Highcharts.ColorString"]},"since":"6.0.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.stochastic.smoothedLine.styles.lineColor","name":"lineColor","line":168,"lineEnd":174,"column":12,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js","default":"undefined"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.stochastic.smoothedLine.styles.lineWidth","name":"lineWidth","line":164,"lineEnd":166,"column":12,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js","default":1},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.stochastic.tooltip","name":"tooltip","line":153,"lineEnd":153,"column":4,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b><br/>%K: {point.y}<br/>%D: {point.smoothed}<br/>"},"meta":{"fullname":"plotOptions.stochastic.tooltip.pointFormat","name":"pointFormat","line":154,"lineEnd":154,"column":8,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js","default":"<span style=\"color:{point.color}\">●</span><b> {series.name}</b><br/>%K: {point.y}<br/>%D: {point.smoothed}<br/>"},"children":{}}}}}},"streamgraph":{"doclet":{"description":"A streamgraph is a type of stacked area graph which is displaced around a\ncentral axis, resulting in a flowing, organic shape.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `streamgraph` series are defined in\n   [plotOptions.streamgraph](plotOptions.streamgraph).\n3. Options for one single series are given in\n   [the series instance array](series.streamgraph).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        streamgraph: {\n            // shared options for all streamgraph series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'streamgraph'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.streamgraph.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === streamgraph) {\n    // code specific to the streamgraph series\n}\n```\n            ","samples":[{"name":"Streamgraph","value":"highcharts/demo/streamgraph/","products":["highcharts","highstock"]}],"extends":"plotOptions.areaspline","since":"6.0.0","products":["highcharts","highstock"],"requires":["module:modules/streamgraph"]},"meta":{"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js","name":"streamgraph","fullname":"plotOptions.streamgraph","line":14,"lineEnd":18,"column":0},"children":{"color":{"doclet":{"see":["[fillColor](#plotOptions.streamgraph.fillColor)","[fillOpacity](#plotOptions.streamgraph.fillOpacity)"]},"meta":{"fullname":"plotOptions.streamgraph.color","name":"color","line":33,"lineEnd":38,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js"},"children":{}},"fillColor":{"doclet":{"see":["[color](#plotOptions.streamgraph.color)","[fillOpacity](#plotOptions.streamgraph.fillOpacity)"]},"meta":{"fullname":"plotOptions.streamgraph.fillColor","name":"fillColor","line":39,"lineEnd":44,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#plotOptions.streamgraph.color)","[fillColor](#plotOptions.streamgraph.fillColor)"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.streamgraph.fillOpacity","name":"fillOpacity","line":33,"lineEnd":38,"column":4,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js","default":1},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.streamgraph.lineWidth","name":"lineWidth","line":52,"lineEnd":52,"column":4,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js","default":0},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.streamgraph.marker","name":"marker","line":53,"lineEnd":53,"column":4,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.streamgraph.marker.enabled","name":"enabled","line":54,"lineEnd":54,"column":8,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js","default":false},"children":{}}}},"stacking":{"doclet":{"type":{"names":["string"]},"defaultvalue":"stream"},"meta":{"fullname":"plotOptions.streamgraph.stacking","name":"stacking","line":56,"lineEnd":56,"column":4,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js","default":"stream"},"children":{}}}},"sunburst":{"doclet":{"description":"A Sunburst displays hierarchical data, where a level in the hierarchy is\nrepresented by a circle. The center represents the root node of the tree.\nThe visualization bears a resemblance to both treemap and pie charts.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `sunburst` series are defined in\n   [plotOptions.sunburst](plotOptions.sunburst).\n3. Options for one single series are given in\n   [the series instance array](series.sunburst).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        sunburst: {\n            // shared options for all sunburst series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'sunburst'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.sunburst.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === sunburst) {\n    // code specific to the sunburst series\n}\n```\n            ","samples":[{"name":"Sunburst chart","value":"highcharts/demo/sunburst"}],"extends":"plotOptions.pie","exclude":["allAreas","clip","colorAxis","colorKey","compare","compareBase","dataGrouping","depth","dragDrop","endAngle","gapSize","gapUnit","ignoreHiddenPoint","innerSize","joinBy","legendType","linecap","minSize","navigatorOptions","pointRange"],"products":["highcharts"],"requires":["module:modules/sunburst"]},"meta":{"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","name":"sunburst","fullname":"plotOptions.sunburst","line":15,"lineEnd":19,"column":0},"children":{"allowDrillToNode":{"doclet":{"description":"When enabled the user can click on a point which is a parent and\nzoom in on its children. Deprecated and replaced by\n[allowTraversingTree](#plotOptions.sunburst.allowTraversingTree).","deprecated":true,"type":{"names":["boolean"]},"defaultvalue":"false","since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.sunburst.allowDrillToNode","name":"allowDrillToNode","line":132,"lineEnd":143,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"allowTraversingTree":{"doclet":{"description":"When enabled the user can click on a point which is a parent and\nzoom in on its children.","type":{"names":["boolean"]},"defaultvalue":"false","since":"7.0.3","products":["highcharts"]},"meta":{"fullname":"plotOptions.sunburst.allowTraversingTree","name":"allowTraversingTree","line":144,"lineEnd":153,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"breadcrumbs":{"doclet":{"description":"Options for the breadcrumbs, the navigation at the top leading the\nway up through the traversed levels.","since":"10.0.0","products":["highcharts"],"extends":"navigation.breadcrumbs"},"meta":{"fullname":"plotOptions.sunburst.breadcrumbs","name":"breadcrumbs","line":40,"lineEnd":48,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"center":{"doclet":{"description":"The center of the sunburst chart relative to the plot area. Can be\npercentages or pixel values.","samples":[{"name":"Centered at 100, 100","value":"highcharts/plotoptions/pie-center/","products":["highcharts"]}],"type":{"names":["Array.<(number|string)>"]},"defaultvalue":"[\"50%\", \"50%\"]","products":["highcharts"]},"meta":{"fullname":"plotOptions.sunburst.center","name":"center","line":40,"lineEnd":48,"column":4,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"clip":{"doclet":{"products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.sunburst.clip","name":"clip","line":168,"lineEnd":172,"column":4,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","default":false},"children":{}},"colorByPoint":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.sunburst.colorByPoint","name":"colorByPoint","line":174,"lineEnd":174,"column":4,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","default":false},"children":{}},"dataLabels":{"doclet":{"declare":"Highcharts.SeriesSunburstDataLabelsOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.sunburst.dataLabels","name":"dataLabels","line":183,"lineEnd":187,"column":4,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{"allowOverlap":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.sunburst.dataLabels.allowOverlap","name":"allowOverlap","line":189,"lineEnd":189,"column":8,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","default":true},"children":{}},"defer":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.sunburst.dataLabels.defer","name":"defer","line":190,"lineEnd":190,"column":8,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","default":true},"children":{}},"rotationMode":{"doclet":{"description":"Decides how the data label will be rotated relative to the\nperimeter of the sunburst. Valid values are `circular`, `auto`,\n`parallel` and `perpendicular`. When `circular`, the best fit\nwill be computed for the point, so that the label is curved\naround the center when there is room for it, otherwise\nperpendicular. The legacy `auto` option works similar to\n`circular`, but instead of curving the labels they are tangent to\nthe perimeter.\n\nThe `rotation` option takes precedence over `rotationMode`.","type":{"names":["\"auto\"","\"perpendicular\"","\"parallel\"","\"circular\""]},"samples":[{"name":"Circular rotation mode","value":"highcharts/plotoptions/sunburst-datalabels-rotationmode-circular/","products":["highcharts"]}],"since":"6.0.0","defaultvalue":"circular"},"meta":{"fullname":"plotOptions.sunburst.dataLabels.rotationMode","name":"rotationMode","line":191,"lineEnd":209,"column":8,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","default":"circular"},"children":{}}}},"levelIsConstant":{"doclet":{"description":"Used together with the levels and `allowDrillToNode` options. When\nset to false the first level visible when drilling is considered\nto be level one. Otherwise the level will be the same as the tree\nstructure.","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.sunburst.levelIsConstant","name":"levelIsConstant","line":224,"lineEnd":231,"column":4,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","default":true},"children":{}},"levelSize":{"doclet":{"description":"Determines the width of the ring per level.","samples":[{"name":"Sunburst with various sizes per level","value":"highcharts/plotoptions/sunburst-levelsize/","products":["highcharts"]}],"since":"6.0.5","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.sunburst.levelSize","name":"levelSize","line":233,"lineEnd":242,"column":4,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{"unit":{"doclet":{"description":"How to interpret `levelSize.value`.\n\n- `percentage` gives a width relative to result of outer radius\n  minus inner radius.\n\n- `pixels` gives the ring a fixed width in pixels.\n\n- `weight` takes the remaining width after percentage and pixels,\n  and distributes it across all \"weighted\" levels. The value\n  relative to the sum of all weights determines the width.","samples":[{"name":"Sunburst with various sizes per level","value":"highcharts/plotoptions/sunburst-levelsize/","products":["highcharts"]}],"values":"[\"percentage\", \"pixels\", \"weight\"]","since":"6.0.5","type":{"names":["string"]},"defaultvalue":"weight"},"meta":{"fullname":"plotOptions.sunburst.levelSize.unit","name":"unit","line":252,"lineEnd":268,"column":8,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","default":"weight"},"children":{}},"value":{"doclet":{"description":"The value used for calculating the width of the ring. Its' affect\nis determined by `levelSize.unit`.","samples":[{"name":"Sunburst with various sizes per level","value":"highcharts/plotoptions/sunburst-levelsize/","products":["highcharts"]}],"since":"6.0.5","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.sunburst.levelSize.value","name":"value","line":244,"lineEnd":250,"column":8,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","default":1},"children":{}}}},"levels":{"doclet":{"description":"Set options on specific levels. Takes precedence over series options,\nbut not point options.","samples":[{"name":"Sunburst chart","value":"highcharts/demo/sunburst"}],"type":{"names":["Array.<*>"]}},"meta":{"fullname":"plotOptions.sunburst.levels","name":"levels","line":49,"lineEnd":58,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{"borderColor":{"doclet":{"description":"Can set a `borderColor` on all points which lies on the same level.","type":{"names":["Highcharts.ColorString"]}},"meta":{"fullname":"plotOptions.sunburst.levels.borderColor","name":"borderColor","line":59,"lineEnd":64,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"borderDashStyle":{"doclet":{"description":"Can set a `borderDashStyle` on all points which lies on the same\nlevel.","type":{"names":["Highcharts.DashStyleValue"]}},"meta":{"fullname":"plotOptions.sunburst.levels.borderDashStyle","name":"borderDashStyle","line":71,"lineEnd":77,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"borderWidth":{"doclet":{"description":"Can set a `borderWidth` on all points which lies on the same level.","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.sunburst.levels.borderWidth","name":"borderWidth","line":65,"lineEnd":70,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"color":{"doclet":{"description":"Can set a `color` on all points which lies on the same level.","type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.sunburst.levels.color","name":"color","line":78,"lineEnd":83,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"colorByPoint":{"doclet":{"description":"Determines whether the chart should receive one color per point based\non this level.","type":{"names":["boolean"]}},"meta":{"fullname":"plotOptions.sunburst.levels.colorByPoint","name":"colorByPoint","line":84,"lineEnd":90,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"colorVariation":{"doclet":{"description":"Can set a `colorVariation` on all points which lies on the same\nlevel.","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.sunburst.levels.colorVariation","name":"colorVariation","line":91,"lineEnd":96,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{"key":{"doclet":{"description":"The key of a color variation. Currently supports `brightness` only.","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.sunburst.levels.colorVariation.key","name":"key","line":97,"lineEnd":102,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"to":{"doclet":{"description":"The ending value of a color variation. The last sibling will receive\nthis value.","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.sunburst.levels.colorVariation.to","name":"to","line":103,"lineEnd":109,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}}}},"dataLabels":{"doclet":{"description":"Can set `dataLabels` on all points which lies on the same level.","extends":"plotOptions.sunburst.dataLabels"},"meta":{"fullname":"plotOptions.sunburst.levels.dataLabels","name":"dataLabels","line":110,"lineEnd":115,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"level":{"doclet":{"description":"Decides which level takes effect from the options set in the levels\nobject.","samples":[{"name":"Sunburst chart","value":"highcharts/demo/sunburst"}],"type":{"names":["number"]}},"meta":{"fullname":"plotOptions.sunburst.levels.level","name":"level","line":116,"lineEnd":125,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"levelSize":{"doclet":{"description":"Can set a `levelSize` on all points which lies on the same level.","type":{"names":["Object"]}},"meta":{"fullname":"plotOptions.sunburst.levels.levelSize","name":"levelSize","line":126,"lineEnd":131,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}}}},"rootId":{"doclet":{"description":"Which point to use as a root in the visualization.","type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.sunburst.rootId","name":"rootId","line":216,"lineEnd":222,"column":4,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","default":"undefined"},"children":{}},"slicedOffset":{"doclet":{"description":"If a point is sliced, moved out from the center, how many pixels\nshould it be moved?.","samples":[{"name":"Sliced sunburst","value":"highcharts/plotoptions/sunburst-sliced"}],"since":"6.0.4","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.sunburst.slicedOffset","name":"slicedOffset","line":271,"lineEnd":280,"column":4,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js","default":10},"children":{}},"traverseUpButton":{"doclet":{"description":"Options for the button appearing when traversing down in a sunburst.\nSince v9.3.3 the `traverseUpButton` is replaced by `breadcrumbs`.","extends":"plotOptions.treemap.traverseUpButton","since":"6.0.0","deprecated":true},"meta":{"fullname":"plotOptions.sunburst.traverseUpButton","name":"traverseUpButton","line":271,"lineEnd":280,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}}}},"supertrend":{"doclet":{"description":"Supertrend indicator. This series requires the `linkedTo` option to be\nset and should be loaded after the `stock/indicators/indicators.js` and\n`stock/indicators/sma.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `supertrend` series are defined in\n   [plotOptions.supertrend](plotOptions.supertrend).\n3. Options for one single series are given in\n   [the series instance array](series.supertrend).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        supertrend: {\n            // shared options for all supertrend series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'supertrend'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.supertrend.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === supertrend) {\n    // code specific to the supertrend series\n}\n```\n            ","samples":[{"name":"Supertrend indicator","value":"stock/indicators/supertrend","products":["highstock"]}],"extends":"plotOptions.sma","since":"7.0.0","products":["highstock"],"exclude":["allAreas","cropThreshold","negativeColor","colorAxis","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking","threshold"],"requires":["module:stock/indicators/indicators","module:stock/indicators/supertrend"]},"meta":{"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js","name":"supertrend","fullname":"plotOptions.supertrend","line":347,"lineEnd":351,"column":0},"children":{"changeTrendLine":{"doclet":{"description":"The styles for the Supertrend line that intersect main series.","samples":[{"name":"Example with changeTrendLine","value":"stock/indicators/supertrend/","products":["highstock"]}],"since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.supertrend.changeTrendLine","name":"changeTrendLine","line":408,"lineEnd":413,"column":4,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js"},"children":{"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.supertrend.changeTrendLine.styles","name":"styles","line":415,"lineEnd":415,"column":8,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js"},"children":{"dashStyle":{"doclet":{"description":"The dash or dot style of the grid lines. For possible\nvalues, see\n[this demonstration](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/).","samples":[{"name":"Long dashes","value":"highcharts/yaxis/gridlinedashstyle/","products":["highcharts"]},{"name":"Long dashes","value":"stock/xaxis/gridlinedashstyle/","products":["highstock"]}],"type":{"names":["Highcharts.DashStyleValue"]},"since":"7.0.0","defaultvalue":"LongDash"},"meta":{"fullname":"plotOptions.supertrend.changeTrendLine.styles.dashStyle","name":"dashStyle","line":426,"lineEnd":438,"column":12,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js","default":"LongDash"},"children":{}},"lineColor":{"doclet":{"description":"Color of the line.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"#333333"},"meta":{"fullname":"plotOptions.supertrend.changeTrendLine.styles.lineColor","name":"lineColor","line":420,"lineEnd":424,"column":12,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js","default":"#333333"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the line.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.supertrend.changeTrendLine.styles.lineWidth","name":"lineWidth","line":416,"lineEnd":418,"column":12,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js","default":1},"children":{}}}}}},"fallingTrendColor":{"doclet":{"description":"Color of the Supertrend series line that is above the main series.","samples":[{"name":"Example with fallingTrendColor","value":"stock/indicators/supertrend/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","defaultvalue":"#f21313"},"meta":{"fullname":"plotOptions.supertrend.fallingTrendColor","name":"fallingTrendColor","line":399,"lineEnd":406,"column":4,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js","default":"#f21313"},"children":{}},"params":{"doclet":{"description":"Parameters used in calculation of Supertrend indicator series points.","exclude":["index"],"since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.supertrend.params","name":"params","line":372,"lineEnd":376,"column":4,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.supertrend.params.index","name":"index","line":378,"lineEnd":378,"column":8,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js","default":"undefined"},"children":{}},"multiplier":{"doclet":{"description":"Multiplier for Supertrend Indicator.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.supertrend.params.multiplier","name":"multiplier","line":378,"lineEnd":378,"column":23,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js","default":3},"children":{}},"period":{"doclet":{"description":"The base period for indicator Supertrend Indicator calculations.\nThis is the number of data points which are taken into account\nfor the indicator calculations.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.supertrend.params.period","name":"period","line":383,"lineEnd":387,"column":8,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js","default":10},"children":{}}}},"risingTrendColor":{"doclet":{"description":"Color of the Supertrend series line that is beneath the main series.","samples":[{"name":"Example with risingTrendColor","value":"stock/indicators/supertrend/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"since":"7.0.0","defaultvalue":"#06b535"},"meta":{"fullname":"plotOptions.supertrend.risingTrendColor","name":"risingTrendColor","line":390,"lineEnd":397,"column":4,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js","default":"#06b535"},"children":{}}}},"tema":{"doclet":{"description":"Triple exponential moving average (TEMA) indicator. This series requires\n`linkedTo` option to be set and should be loaded after the\n`stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `tema` series are defined in\n   [plotOptions.tema](plotOptions.tema).\n3. Options for one single series are given in\n   [the series instance array](series.tema).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        tema: {\n            // shared options for all tema series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'tema'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.tema.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === tema) {\n    // code specific to the tema series\n}\n```\n            ","samples":[{"name":"TEMA indicator","value":"stock/indicators/tema","products":["highstock"]}],"extends":"plotOptions.ema","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/tema"]},"meta":{"filename":"code/es-modules/Stock/Indicators/TEMA/TEMAIndicator.js","name":"tema","fullname":"plotOptions.tema","line":128,"lineEnd":132,"column":0},"children":{}},"tiledwebmap":{"doclet":{"description":"A tiledwebmap series allows user to display dynamically joined individual\nimages (tiles) and join them together to create a map.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `tiledwebmap` series are defined in\n   [plotOptions.tiledwebmap](plotOptions.tiledwebmap).\n3. Options for one single series are given in\n   [the series instance array](series.tiledwebmap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        tiledwebmap: {\n            // shared options for all tiledwebmap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'tiledwebmap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.tiledwebmap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === tiledwebmap) {\n    // code specific to the tiledwebmap series\n}\n```\n            ","samples":[{"name":"Simple demo of data for Norway on TiledWebMap","value":"maps/series-tiledwebmap/simple-demo-norway"},{"name":"OpenStreetMap demo","value":"maps/series-tiledwebmap/only-twm"}],"extends":"plotOptions.map","exclude":["affectsMapView","allAreas","allowPointSelect","animation","animationLimit","boostBlending","boostThreshold","borderColor","borderWidth","clip","color","colorAxis","colorByPoint","colorIndex","colorKey","colors","cursor","dashStyle","dataLabels","dataParser","dataURL","dragDrop","enableMouseTracking","findNearestPointBy","joinBy","keys","marker","negativeColor","nullColor","nullInteraction","onPoint","point","pointDescriptionFormatter","selected","shadow","showCheckbox","sonification","stickyTracking","tooltip","type"],"products":["highmaps"]},"meta":{"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js","name":"tiledwebmap","fullname":"plotOptions.tiledwebmap","line":12,"lineEnd":16,"column":0},"children":{"provider":{"doclet":{"description":"Provider options for the series.","samples":[{"name":"Human Anatomy Explorer - Custom TiledWebMap Provider","value":"maps/series-tiledwebmap/human-anatomy"}],"since":"11.1.0","products":["highmaps"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.tiledwebmap.provider","name":"provider","line":70,"lineEnd":79,"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js"},"children":{"apiKey":{"doclet":{"description":"API key for providers that require using one.","type":{"names":["string"]},"since":"11.1.0","products":["highmaps"]},"meta":{"fullname":"plotOptions.tiledwebmap.provider.apiKey","name":"apiKey","line":117,"lineEnd":124,"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js"},"children":{}},"subdomain":{"doclet":{"description":"Subdomain required by each provider. Check the [providers documentation](https://www.highcharts.com/docs/maps/tiledwebmap)\nfor available subdomains.","samples":[{"name":"Basic configuration for TiledWebMap","value":"maps/series-tiledwebmap/basic-configuration"}],"type":{"names":["string"]},"since":"11.1.0","products":["highmaps"]},"meta":{"fullname":"plotOptions.tiledwebmap.provider.subdomain","name":"subdomain","line":105,"lineEnd":116,"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js"},"children":{}},"theme":{"doclet":{"description":"Set a tiles theme. Check the [providers documentation](https://www.highcharts.com/docs/maps/tiledwebmap)\nfor official list of available themes.","samples":[{"name":"Imagery basemap for Europe","value":"maps/series-tiledwebmap/europe-timezones"},{"name":"Topo basemap and MapLine","value":"maps/series-tiledwebmap/hiking-trail"}],"type":{"names":["string"]},"since":"11.1.0","products":["highmaps"]},"meta":{"fullname":"plotOptions.tiledwebmap.provider.theme","name":"theme","line":91,"lineEnd":104,"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js"},"children":{}},"type":{"doclet":{"description":"Provider type to pull data (tiles) from.","samples":[{"name":"Basic configuration for TiledWebMap","value":"maps/series-tiledwebmap/basic-configuration"}],"type":{"names":["string"]},"since":"11.1.0","products":["highmaps"]},"meta":{"fullname":"plotOptions.tiledwebmap.provider.type","name":"type","line":80,"lineEnd":90,"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js"},"children":{}},"url":{"doclet":{"description":"Custom URL for providers not specified in [providers type](#series.tiledwebmap.provider.type). Available variables to use in URL are: `{x}`,\n`{y}`, `{z}` or `{zoom}`. Remember to always specify a projection, when\nusing a custom URL.","samples":[{"name":"Custom URL with projection in TiledWebMap configuration","value":"maps/series-tiledwebmap/custom-url"}],"type":{"names":["string"]},"since":"11.1.0","products":["highmaps"]},"meta":{"fullname":"plotOptions.tiledwebmap.provider.url","name":"url","line":125,"lineEnd":138,"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js"},"children":{}}}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.tiledwebmap.states","name":"states","line":39,"lineEnd":39,"column":4,"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js"},"children":{"inactive":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.tiledwebmap.states.inactive","name":"inactive","line":40,"lineEnd":40,"column":8,"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.tiledwebmap.states.inactive.enabled","name":"enabled","line":41,"lineEnd":41,"column":12,"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js","default":false},"children":{}}}}}}}},"tilemap":{"doclet":{"description":"A tilemap series is a type of heatmap where the tile shapes are\nconfigurable.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `tilemap` series are defined in\n   [plotOptions.tilemap](plotOptions.tilemap).\n3. Options for one single series are given in\n   [the series instance array](series.tilemap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        tilemap: {\n            // shared options for all tilemap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'tilemap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.tilemap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === tilemap) {\n    // code specific to the tilemap series\n}\n```\n            ","samples":[{"name":"Honeycomb tilemap, USA","value":"highcharts/demo/honeycomb-usa/"},{"name":"Honeycomb tilemap, Brazil","value":"maps/plotoptions/honeycomb-brazil/"},{"name":"Honeycomb tilemap, China","value":"maps/plotoptions/honeycomb-china/"},{"name":"Honeycomb tilemap, Europe","value":"maps/plotoptions/honeycomb-europe/"},{"name":"Circlemap tilemap, Africa","value":"maps/demo/circlemap-africa/"},{"name":"Diamondmap tilemap","value":"maps/demo/diamondmap"}],"extends":"plotOptions.heatmap","since":"6.0.0","exclude":["jitter","joinBy","shadow","allAreas","mapData","marker","data","dataSorting","boostThreshold","boostBlending"],"products":["highcharts","highmaps"],"requires":["module:modules/tilemap"]},"meta":{"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js","name":"tilemap","fullname":"plotOptions.tilemap","line":14,"lineEnd":18,"column":0},"children":{"colsize":{"doclet":{"description":"The column size - how many X axis units each column in the tilemap\nshould span. Works as in [Heatmaps](#plotOptions.heatmap.colsize).","samples":[{"name":"One day","value":"maps/demo/heatmap/","products":["highcharts"]},{"name":"One day","value":"maps/demo/heatmap/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"1","products":["highcharts","highmaps"],"since":"6.0.0"},"meta":{"fullname":"plotOptions.tilemap.colsize","name":"colsize","line":67,"lineEnd":80,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{}},"marker":{"doclet":{"type":{"names":["*"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.tilemap.marker","name":"marker","line":45,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js","default":null},"children":{}},"pointPadding":{"doclet":{"description":"The padding between points in the tilemap.","samples":[{"name":"Point padding on tiles","value":"maps/plotoptions/tilemap-pointpadding"}],"since":"6.0.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.tilemap.pointPadding","name":"pointPadding","line":60,"lineEnd":65,"column":4,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js","default":2},"children":{}},"rowsize":{"doclet":{"description":"The row size - how many Y axis units each tilemap row should span.\nAnalogous to [colsize](#plotOptions.tilemap.colsize).","samples":[{"name":"1 by default","value":"maps/demo/heatmap/","products":["highcharts"]},{"name":"1 by default","value":"maps/demo/heatmap/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"1","products":["highcharts","highmaps"],"since":"6.0.0"},"meta":{"fullname":"plotOptions.tilemap.rowsize","name":"rowsize","line":81,"lineEnd":94,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.tilemap.states","name":"states","line":48,"lineEnd":48,"column":4,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.tilemap.states.hover","name":"hover","line":49,"lineEnd":49,"column":8,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{"halo":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.tilemap.states.hover.halo","name":"halo","line":50,"lineEnd":50,"column":12,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{"attributes":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.tilemap.states.hover.halo.attributes","name":"attributes","line":54,"lineEnd":54,"column":16,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{"zIndex":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.tilemap.states.hover.halo.attributes.zIndex","name":"zIndex","line":55,"lineEnd":55,"column":20,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js","default":3},"children":{}}}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.tilemap.states.hover.halo.enabled","name":"enabled","line":51,"lineEnd":51,"column":16,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js","default":true},"children":{}},"opacity":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.5},"meta":{"fullname":"plotOptions.tilemap.states.hover.halo.opacity","name":"opacity","line":53,"lineEnd":53,"column":16,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js","default":0.5},"children":{}},"size":{"doclet":{"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.tilemap.states.hover.halo.size","name":"size","line":52,"lineEnd":52,"column":16,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js","default":2},"children":{}}}}}}}},"tileShape":{"doclet":{"description":"The shape of the tiles in the tilemap. Possible values are `hexagon`,\n`circle`, `diamond`, and `square`.","samples":[{"name":"Circular tile shapes","value":"maps/demo/circlemap-africa"},{"name":"Diamond tile shapes","value":"maps/demo/diamondmap"}],"type":{"names":["Highcharts.TilemapShapeValue"]},"since":"6.0.0","defaultvalue":"hexagon"},"meta":{"fullname":"plotOptions.tilemap.tileShape","name":"tileShape","line":67,"lineEnd":80,"column":4,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js","default":"hexagon"},"children":{}}}},"timeline":{"doclet":{"description":"The timeline series presents given events along a drawn line.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `timeline` series are defined in\n   [plotOptions.timeline](plotOptions.timeline).\n3. Options for one single series are given in\n   [the series instance array](series.timeline).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        timeline: {\n            // shared options for all timeline series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'timeline'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.timeline.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === timeline) {\n    // code specific to the timeline series\n}\n```\n            ","samples":[{"name":"Timeline series","value":"highcharts/series-timeline/alternate-labels"},{"name":"Inverted timeline","value":"highcharts/series-timeline/inverted"},{"name":"With true datetime axis","value":"highcharts/series-timeline/datetime-axis"}],"extends":"plotOptions.line","exclude":["animationLimit","boostThreshold","connectEnds","connectNulls","cropThreshold","dashStyle","findNearestPointBy","getExtremesFromAll","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointStart","softThreshold","stacking","step","threshold","turboThreshold","zoneAxis","zones","dataSorting","boostBlending"],"products":["highcharts"],"since":"7.0.0","requires":["module:modules/timeline"]},"meta":{"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","name":"timeline","fullname":"plotOptions.timeline","line":15,"lineEnd":19,"column":0},"children":{"colorByPoint":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.timeline.colorByPoint","name":"colorByPoint","line":43,"lineEnd":43,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":true},"children":{}},"colorKey":{"doclet":{"type":{"names":["string"]},"defaultvalue":"x"},"meta":{"fullname":"plotOptions.timeline.colorKey","name":"colorKey","line":177,"lineEnd":177,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":"x"},"children":{}},"dataLabels":{"doclet":{"declare":"Highcharts.TimelineDataLabelsOptionsObject","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.timeline.dataLabels","name":"dataLabels","line":64,"lineEnd":66,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{"allowOverlap":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.timeline.dataLabels.allowOverlap","name":"allowOverlap","line":69,"lineEnd":69,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":true},"children":{}},"alternate":{"doclet":{"description":"Whether to position data labels alternately. For example, if\n[distance](#plotOptions.timeline.dataLabels.distance)\nis set equal to `100`, then data labels will be positioned\nalternately (on both sides of the point) at a distance of 100px.","samples":[{"name":"Alternate disabled","value":"highcharts/series-timeline/alternate-disabled","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.timeline.dataLabels.alternate","name":"alternate","line":70,"lineEnd":78,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":true},"children":{}},"backgroundColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#ffffff"},"meta":{"fullname":"plotOptions.timeline.dataLabels.backgroundColor","name":"backgroundColor","line":80,"lineEnd":80,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":"#ffffff"},"children":{}},"borderColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#999999"},"meta":{"fullname":"plotOptions.timeline.dataLabels.borderColor","name":"borderColor","line":82,"lineEnd":82,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":"#999999"},"children":{}},"borderRadius":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.timeline.dataLabels.borderRadius","name":"borderRadius","line":83,"lineEnd":83,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":3},"children":{}},"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.timeline.dataLabels.borderWidth","name":"borderWidth","line":81,"lineEnd":81,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":1},"children":{}},"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#333333"},"meta":{"fullname":"plotOptions.timeline.dataLabels.color","name":"color","line":84,"lineEnd":84,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":"#333333"},"children":{}},"connectorColor":{"doclet":{"description":"The color of the line connecting the data label to the point.\nThe default color is the same as the point's color.\n\nIn styled mode, the connector stroke is given in the\n`.highcharts-data-label-connector` class.","samples":[{"name":"Custom connector width and color","value":"highcharts/series-timeline/connector-styles","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.timeline.dataLabels.connectorColor","name":"connectorColor","line":85,"lineEnd":97,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{}},"connectorWidth":{"doclet":{"description":"The width of the line connecting the data label to the point.\n\nIn styled mode, the connector stroke width is given in the\n`.highcharts-data-label-connector` class.","samples":[{"name":"Custom connector width and color","value":"highcharts/series-timeline/connector-styles","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.timeline.dataLabels.connectorWidth","name":"connectorWidth","line":85,"lineEnd":97,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":1},"children":{}},"distance":{"doclet":{"description":"A pixel value defining the distance between the data label and\nthe point. Negative numbers puts the label on top of the point in a\nnon-inverted chart. Defaults to 100 for horizontal and 20 for\nvertical timeline (`chart.inverted: true`).","type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.timeline.dataLabels.distance","name":"distance","line":108,"lineEnd":113,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":"undefined"},"children":{}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.timeline.dataLabels.enabled","name":"enabled","line":68,"lineEnd":68,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":true},"children":{}},"formatter":{"doclet":{"defaultByProduct":{}},"meta":{"fullname":"plotOptions.timeline.dataLabels.formatter","name":"formatter","line":115,"lineEnd":115,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{}},"shadow":{"doclet":{"description":"Shadow options for the data label.","type":{"names":["boolean","Highcharts.CSSObject"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.timeline.dataLabels.shadow","name":"shadow","line":157,"lineEnd":161,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":false},"children":{}},"width":{"doclet":{"type":{"names":["number"]}},"meta":{"fullname":"plotOptions.timeline.dataLabels.width","name":"width","line":163,"lineEnd":166,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{}}}},"ignoreHiddenPoint":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.timeline.ignoreHiddenPoint","name":"ignoreHiddenPoint","line":45,"lineEnd":45,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":true},"children":{}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rectangle"},"meta":{"fullname":"plotOptions.timeline.legendSymbol","name":"legendSymbol","line":178,"lineEnd":178,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":"rectangle"},"children":{}},"lineWidth":{"doclet":{"description":"Pixel width of the graph line.","since":"7.0.0","type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"plotOptions.timeline.lineWidth","name":"lineWidth","line":50,"lineEnd":52,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":4},"children":{}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.timeline.marker","name":"marker","line":169,"lineEnd":169,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{"enabledThreshold":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.timeline.marker.enabledThreshold","name":"enabledThreshold","line":170,"lineEnd":170,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":0},"children":{}},"height":{"doclet":{"type":{"names":["number"]},"defaultvalue":15},"meta":{"fullname":"plotOptions.timeline.marker.height","name":"height","line":174,"lineEnd":174,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":15},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.timeline.marker.lineWidth","name":"lineWidth","line":173,"lineEnd":173,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":2},"children":{}},"radius":{"doclet":{"type":{"names":["number"]},"defaultvalue":6},"meta":{"fullname":"plotOptions.timeline.marker.radius","name":"radius","line":172,"lineEnd":172,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":6},"children":{}},"symbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"square"},"meta":{"fullname":"plotOptions.timeline.marker.symbol","name":"symbol","line":171,"lineEnd":171,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":"square"},"children":{}}}},"showInLegend":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.timeline.showInLegend","name":"showInLegend","line":176,"lineEnd":176,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":false},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.timeline.states","name":"states","line":59,"lineEnd":59,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.timeline.states.hover","name":"hover","line":60,"lineEnd":60,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{"lineWidthPlus":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.timeline.states.hover.lineWidthPlus","name":"lineWidthPlus","line":61,"lineEnd":61,"column":12,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":0},"children":{}}}}}},"stickyTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.timeline.stickyTracking","name":"stickyTracking","line":44,"lineEnd":44,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":false},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.timeline.tooltip","name":"tooltip","line":54,"lineEnd":54,"column":4,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{"headerFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> <span style=\"font-size: 0.8em\"> {point.key}</span><br/>"},"meta":{"fullname":"plotOptions.timeline.tooltip.headerFormat","name":"headerFormat","line":55,"lineEnd":55,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> <span style=\"font-size: 0.8em\"> {point.key}</span><br/>"},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{point.description}"},"meta":{"fullname":"plotOptions.timeline.tooltip.pointFormat","name":"pointFormat","line":57,"lineEnd":57,"column":8,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js","default":"{point.description}"},"children":{}}}}}},"treegraph":{"doclet":{"description":"A treegraph series is a diagram, which shows a relation between ancestors\nand descendants with a clear parent - child relation.\nThe best examples of the dataStructures, which best reflect this chart\nare e.g. genealogy tree or directory structure.\n\nTODO change back the demo path\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `treegraph` series are defined in\n   [plotOptions.treegraph](plotOptions.treegraph).\n3. Options for one single series are given in\n   [the series instance array](series.treegraph).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        treegraph: {\n            // shared options for all treegraph series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'treegraph'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.treegraph.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === treegraph) {\n    // code specific to the treegraph series\n}\n```\n            ","samples":[{"name":"Treegraph Chart","value":"highcharts/demo/treegraph-chart"}],"extends":"plotOptions.treemap","exclude":["layoutAlgorithm","dashStyle","linecap","lineWidth","negativeColor","threshold","zones","zoneAxis","colorAxis","colorKey","compare","dataGrouping","endAngle","gapSize","gapUnit","ignoreHiddenPoint","innerSize","joinBy","legendType","linecap","minSize","navigatorOptions","pointRange","allowTraversingTree","alternateStartingDirection","borderRadius","breadcrumbs","interactByLeaf","layoutStartingDirection","levelIsConstant","lineWidth","negativeColor","nodes","sortIndex","zoneAxis","zones","cluster"],"products":["highcharts"],"since":"10.3.0","requires":["module:modules/treemap","module:modules/treegraph"]},"meta":{"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","name":"treegraph","fullname":"plotOptions.treegraph","line":12,"lineEnd":16,"column":0},"children":{"collapseButton":{"doclet":{"description":"Options applied to collapse Button. The collapse button is the\nsmall button which indicates, that the node is collapsable.","since":"10.3.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treegraph.collapseButton","name":"collapseButton","line":127,"lineEnd":136,"column":4,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{"enabled":{"doclet":{"description":"Whether the button should be visible.","since":"10.3.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.treegraph.collapseButton.enabled","name":"enabled","line":148,"lineEnd":150,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":true},"children":{}},"height":{"doclet":{"description":"Height of the button.","since":"10.3.0","type":{"names":["number"]},"defaultvalue":18},"meta":{"fullname":"plotOptions.treegraph.collapseButton.height","name":"height","line":164,"lineEnd":166,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":18},"children":{}},"lineWidth":{"doclet":{"description":"The line width of the button in pixels","since":"10.3.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.treegraph.collapseButton.lineWidth","name":"lineWidth","line":152,"lineEnd":154,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":1},"children":{}},"onlyOnHover":{"doclet":{"description":"Whether the button should be visible only when the node is\nhovered. When set to true, the button is hidden for nodes,\nwhich are not collapsed, and shown for the collapsed ones.","since":"10.3.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.treegraph.collapseButton.onlyOnHover","name":"onlyOnHover","line":142,"lineEnd":146,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":true},"children":{}},"shape":{"doclet":{"description":"The symbol of the collapse button.","since":"10.3.0","type":{"names":["string"]},"defaultvalue":"circle"},"meta":{"fullname":"plotOptions.treegraph.collapseButton.shape","name":"shape","line":172,"lineEnd":174,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"circle"},"children":{}},"style":{"doclet":{"description":"CSS styles for the collapse button.\n\nIn styled mode, the collapse button style is given in the\n`.highcharts-collapse-button` class.","since":"10.3.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treegraph.collapseButton.style","name":"style","line":176,"lineEnd":181,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{"cursor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"pointer"},"meta":{"fullname":"plotOptions.treegraph.collapseButton.style.cursor","name":"cursor","line":183,"lineEnd":183,"column":12,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"pointer"},"children":{}},"fontSize":{"doclet":{"type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.treegraph.collapseButton.style.fontSize","name":"fontSize","line":185,"lineEnd":185,"column":12,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"1em"},"children":{}},"fontWeight":{"doclet":{"type":{"names":["string"]},"defaultvalue":"bold"},"meta":{"fullname":"plotOptions.treegraph.collapseButton.style.fontWeight","name":"fontWeight","line":184,"lineEnd":184,"column":12,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"bold"},"children":{}}}},"width":{"doclet":{"description":"Width of the button.","since":"10.3.0","type":{"names":["number"]},"defaultvalue":18},"meta":{"fullname":"plotOptions.treegraph.collapseButton.width","name":"width","line":168,"lineEnd":170,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":18},"children":{}},"x":{"doclet":{"description":"Offset of the button in the x direction.","since":"10.3.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.treegraph.collapseButton.x","name":"x","line":156,"lineEnd":158,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"Offset of the button in the y direction.","since":"10.3.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.treegraph.collapseButton.y","name":"y","line":160,"lineEnd":162,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":0},"children":{}}}},"dataLabels":{"doclet":{"description":"Options for the data labels appearing on top of the nodes and\nlinks. For treegraph charts, data labels are visible for the\nnodes by default, but hidden for links. This is controlled by\nmodifying the `nodeFormat`, and the `format` that applies to\nlinks and is an empty string by default.","declare":"Highcharts.SeriesTreegraphDataLabelsOptionsObject","since":"10.3.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treegraph.dataLabels","name":"dataLabels","line":228,"lineEnd":236,"column":4,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{"defer":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.treegraph.dataLabels.defer","name":"defer","line":238,"lineEnd":238,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":true},"children":{}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.treegraph.dataLabels.enabled","name":"enabled","line":258,"lineEnd":258,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":true},"children":{}},"linkTextPath":{"doclet":{"description":"Options for a _link_ label text which should follow link\nconnection. Border and background are disabled for a label\nthat follows a path.\n\n**Note:** Only SVG-based renderer supports this option.\nSetting `useHTML` to true will disable this option.","samples":[{"name":"Treegraph series with link text path dataLabels.","value":"highcharts/series-treegraph/link-text-path"}],"extends":"plotOptions.treegraph.dataLabels.textPath","since":"10.3.0"},"meta":{"fullname":"plotOptions.treegraph.dataLabels.linkTextPath","name":"linkTextPath","line":239,"lineEnd":252,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{"attributes":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treegraph.dataLabels.linkTextPath.attributes","name":"attributes","line":254,"lineEnd":254,"column":12,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{"startOffset":{"doclet":{"type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"plotOptions.treegraph.dataLabels.linkTextPath.attributes.startOffset","name":"startOffset","line":255,"lineEnd":255,"column":16,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"50%"},"children":{}}}}}},"padding":{"doclet":{"type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"plotOptions.treegraph.dataLabels.padding","name":"padding","line":270,"lineEnd":270,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":5},"children":{}},"pointFormat":{"doclet":{"description":"The\n[format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nspecifying what to show for _nodes_ in the treegraph. Overrides\n`format`. Use `pointFormat` and `linkFormat` to differentiate between\nnode and link data labels.","type":{"names":["string"]},"since":"10.3.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.treegraph.dataLabels.pointFormat","name":"pointFormat","line":260,"lineEnd":268,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"undefined"},"children":{}},"style":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treegraph.dataLabels.style","name":"style","line":271,"lineEnd":271,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{"textOverflow":{"doclet":{"type":{"names":["string"]},"defaultvalue":"none"},"meta":{"fullname":"plotOptions.treegraph.dataLabels.style.textOverflow","name":"textOverflow","line":272,"lineEnd":272,"column":12,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"none"},"children":{}}}}}},"fillSpace":{"doclet":{"description":"Whether the treegraph series should fill the entire plot area in the X\naxis direction, even when there are collapsed points.","samples":[{"name":"Fill space demonstrated","value":"highcharts/series-treegraph/fillspace"}],"products":["highcharts"],"since":"10.3.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.treegraph.fillSpace","name":"fillSpace","line":188,"lineEnd":196,"column":4,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":false},"children":{}},"levels":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"dataLabels":{"doclet":{"description":"Can set the options of dataLabels on each point which lies on the\nlevel.\n[plotOptions.treegraph.dataLabels](#plotOptions.treegraph.dataLabels)\nfor possible values.","extends":"plotOptions.treegraph.dataLabels","products":["highcharts"]},"meta":{"fullname":"plotOptions.treegraph.levels.dataLabels","name":"dataLabels","line":127,"lineEnd":136,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{}}}},"link":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treegraph.link","name":"link","line":69,"lineEnd":69,"column":4,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{"bendAt":{"doclet":{"description":"For the orthogonal link type, this defines how far down the link\nbends. A number defines the pixel offset from the start of the link,\nand a percentage defines the relative position on the link. For\nexample, a `bendAt` of `50%` means that the link bends in the middle.","type":{"names":["number","string"]},"since":"12.5.0","products":["highcharts"],"defaultvalue":"50%"},"meta":{"fullname":"plotOptions.treegraph.link.bendAt","name":"bendAt","line":81,"lineEnd":92,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{}},"color":{"doclet":{"description":"The color of the links between nodes.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"#666666"},"meta":{"fullname":"plotOptions.treegraph.link.color","name":"color","line":70,"lineEnd":80,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"#666666"},"children":{}},"cursor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"default"},"meta":{"fullname":"plotOptions.treegraph.link.cursor","name":"cursor","line":114,"lineEnd":114,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"default"},"children":{}},"curveFactor":{"doclet":{"description":"Modifier of the shape of the curved link. Works best for\nvalues between 0 and 1, where 0 is a straight line, and 1 is\na shape close to the default one.","type":{"names":["number"]},"defaultvalue":"0.5","products":["highcharts"],"since":"10.3.0"},"meta":{"fullname":"plotOptions.treegraph.link.curveFactor","name":"curveFactor","line":70,"lineEnd":80,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{}},"lineWidth":{"doclet":{"description":"The line width of the links connecting nodes, in pixels.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.treegraph.link.lineWidth","name":"lineWidth","line":100,"lineEnd":105,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":1},"children":{}},"radius":{"doclet":{"description":"Radius for the rounded corners of the links between nodes.\nWorks for the `orthogonal` link type.","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.treegraph.link.radius","name":"radius","line":107,"lineEnd":112,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":10},"children":{}},"type":{"doclet":{"description":"Type of the link shape.","samples":[{"name":"Different link types","value":"highcharts/series-treegraph/link-types"}],"type":{"names":["'orthogonal'","'curved'","'straight'"]},"products":["highcharts"],"defaultvalue":"curved"},"meta":{"fullname":"plotOptions.treegraph.link.type","name":"type","line":115,"lineEnd":124,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"curved"},"children":{}}}},"marker":{"doclet":{"extends":"plotOptions.series.marker","exclude":["enabled","enabledThreshold"]},"meta":{"fullname":"plotOptions.treegraph.marker","name":"marker","line":58,"lineEnd":61,"column":4,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{"fillOpacity":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.treegraph.marker.fillOpacity","name":"fillOpacity","line":66,"lineEnd":66,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":1},"children":{}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.treegraph.marker.lineWidth","name":"lineWidth","line":64,"lineEnd":64,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":0},"children":{}},"radius":{"doclet":{"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.treegraph.marker.radius","name":"radius","line":63,"lineEnd":63,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":10},"children":{}},"symbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"circle"},"meta":{"fullname":"plotOptions.treegraph.marker.symbol","name":"symbol","line":65,"lineEnd":65,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"circle"},"children":{}}}},"nodeDistance":{"doclet":{"description":"The distance between nodes in a tree graph in the longitudinal direction.\nThe longitudinal direction means the direction that the chart flows - in\na horizontal chart the distance is horizontal, in an inverted chart\n(vertical), the distance is vertical.\n\nIf a number is given, it denotes pixels. If a percentage string is given,\nthe distance is a percentage of the rendered node width. A `nodeDistance`\nof `100%` will render equal widths for the nodes and the gaps between\nthem.\n\nThis option applies only when the `nodeWidth` option is `auto`, making\nthe node width respond to the number of columns.","since":"11.4.0","samples":[{"name":"Node distance of 100% means equal to node width","value":"highcharts/series-treegraph/node-distance"}],"type":{"names":["number","string"]},"defaultvalue":30},"meta":{"fullname":"plotOptions.treegraph.nodeDistance","name":"nodeDistance","line":282,"lineEnd":300,"column":4,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":30},"children":{}},"nodeWidth":{"doclet":{"description":"The pixel width of each node in a, or the height in case the chart is\ninverted. For tree graphs, the node width is only applied if the marker\nsymbol is `rect`, otherwise the `marker` sizing options apply.\n\nCan be a number or a percentage string, or `auto`. If `auto`, the nodes\nare sized to fill up the plot area in the longitudinal direction,\nregardless of the number of levels.","since":"11.4.0","see":["[treegraph.nodeDistance](#nodeDistance)"],"samples":[{"name":"Node width is auto and combined with node distance","value":"highcharts/series-treegraph/node-distance"}],"type":{"names":["number","string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.treegraph.nodeWidth","name":"nodeWidth","line":302,"lineEnd":317,"column":4,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"undefined"},"children":{}},"reversed":{"doclet":{"description":"Flips the positions of the nodes of a treegraph along the\nhorizontal axis (vertical if chart is inverted).","samples":[{"name":"Treegraph series with reversed nodes.","value":"highcharts/series-treegraph/reversed-nodes"}],"type":{"names":["boolean"]},"defaultvalue":"false","products":["highcharts"],"since":"10.3.0"},"meta":{"fullname":"plotOptions.treegraph.reversed","name":"reversed","line":45,"lineEnd":56,"column":4,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":false},"children":{}},"tooltip":{"doclet":{"extends":"plotOptions.series.tooltip","exclude":["clusterFormat"]},"meta":{"fullname":"plotOptions.treegraph.tooltip","name":"tooltip","line":198,"lineEnd":201,"column":4,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js"},"children":{"linkFormat":{"doclet":{"description":"The HTML of the point's line in the tooltip. Variables are enclosed\nby curly brackets. Available variables are `point.id`,\n`point.fromNode.id`, `point.toNode.id`, `series.name`, `series.color`\nand other properties on the same form. Furthermore, This can also be\noverridden for each series, which makes it a good hook for displaying\nunits. In styled mode, the dot is colored by a class name rather than\nthe point color.","type":{"names":["string"]},"since":"10.3.0","products":["highcharts"],"defaultvalue":"{point.fromNode.id} → {point.toNode.id}"},"meta":{"fullname":"plotOptions.treegraph.tooltip.linkFormat","name":"linkFormat","line":203,"lineEnd":215,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"{point.fromNode.id} → {point.toNode.id}"},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{point.id}"},"meta":{"fullname":"plotOptions.treegraph.tooltip.pointFormat","name":"pointFormat","line":217,"lineEnd":217,"column":8,"filename":"code/es-modules/Series/Treegraph/TreegraphSeriesDefaults.js","default":"{point.id}"},"children":{}}}}}},"treemap":{"doclet":{"description":"A treemap displays hierarchical data using nested rectangles. The data\ncan be laid out in varying ways depending on options.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `treemap` series are defined in\n   [plotOptions.treemap](plotOptions.treemap).\n3. Options for one single series are given in\n   [the series instance array](series.treemap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        treemap: {\n            // shared options for all treemap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'treemap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.treemap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === treemap) {\n    // code specific to the treemap series\n}\n```\n            ","samples":[{"name":"Treemap","value":"highcharts/demo/treemap-large-dataset/"}],"extends":"plotOptions.scatter","exclude":["connectEnds","connectNulls","dataSorting","dragDrop","jitter","marker"],"products":["highcharts"],"requires":["module:modules/treemap"]},"meta":{"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","name":"treemap","fullname":"plotOptions.treemap","line":15,"lineEnd":19,"column":0},"children":{"allowDrillToNode":{"doclet":{"description":"When enabled the user can click on a point which is a parent and\nzoom in on its children. Deprecated and replaced by\n[allowTraversingTree](#plotOptions.treemap.allowTraversingTree).","samples":[{"name":"Enabled","value":"highcharts/plotoptions/treemap-allowdrilltonode/","products":["highcharts"]}],"deprecated":true,"type":{"names":["boolean"]},"defaultvalue":"false","since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.allowDrillToNode","name":"allowDrillToNode","line":34,"lineEnd":48,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"allowTraversingTree":{"doclet":{"description":"When enabled the user can click on a point which is a parent and\nzoom in on its children.","samples":[{"name":"Enabled","value":"highcharts/plotoptions/treemap-allowtraversingtree/","products":["highcharts"]},{"name":"Traversing to Grouped Points node","value":"highcharts/plotoptions/treemap-grouping-traversing/","products":["highcharts"]}],"since":"7.0.3","products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.treemap.allowTraversingTree","name":"allowTraversingTree","line":34,"lineEnd":48,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":false},"children":{}},"alternateStartingDirection":{"doclet":{"description":"Enabling this option will make the treemap alternate the drawing\ndirection between vertical and horizontal. The next levels starting\ndirection will always be the opposite of the previous.","samples":[{"name":"Enabled","value":"highcharts/plotoptions/treemap-alternatestartingdirection-true/","products":["highcharts"]}],"since":"4.1.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.treemap.alternateStartingDirection","name":"alternateStartingDirection","line":233,"lineEnd":242,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":false},"children":{}},"animationLimit":{"doclet":{"type":{"names":["number"]},"defaultvalue":250},"meta":{"fullname":"plotOptions.treemap.animationLimit","name":"animationLimit","line":62,"lineEnd":62,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":250},"children":{}},"borderColor":{"doclet":{"description":"The color of the border surrounding each tree map item.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"#e6e6e6"},"meta":{"fullname":"plotOptions.treemap.borderColor","name":"borderColor","line":289,"lineEnd":300,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"#e6e6e6"},"children":{}},"borderRadius":{"doclet":{"description":"The border radius for each treemap item.","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.treemap.borderRadius","name":"borderRadius","line":63,"lineEnd":65,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":0},"children":{}},"borderWidth":{"doclet":{"description":"The width of the border surrounding each tree map item.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.treemap.borderWidth","name":"borderWidth","line":451,"lineEnd":453,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":1},"children":{}},"breadcrumbs":{"doclet":{"description":"Options for the breadcrumbs, the navigation at the top leading the\nway up through the traversed levels.","since":"10.0.0","products":["highcharts"],"extends":"navigation.breadcrumbs"},"meta":{"fullname":"plotOptions.treemap.breadcrumbs","name":"breadcrumbs","line":67,"lineEnd":76,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"cluster":{"doclet":{"description":"An option to optimize treemap series rendering by grouping smaller leaf\nnodes below a certain square area threshold in pixels. If the square area\nof a point becomes smaller than the specified threshold, determined by\nthe `pixelWidth` and/or `pixelHeight` options, then this point is moved\ninto one group point per series.","samples":[{"name":"Simple demo of Treemap grouping","value":"highcharts/plotoptions/treemap-grouping-simple","products":["highcharts"]},{"name":"Treemap grouping with multiple parents","value":"highcharts/plotoptions/treemap-grouping-multiple-parents","products":["highcharts"]},{"name":"Advanced demo of Treemap grouping","value":"highcharts/plotoptions/treemap-grouping-advanced","products":["highcharts"]}],"since":"12.1.0","exclude":["allowOverlap","animation","dataLabels","drillToCluster","events","layoutAlgorithm","marker","states","zones"],"products":["highcharts"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treemap.cluster","name":"cluster","line":521,"lineEnd":541,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"className":{"doclet":{"description":"An additional, individual class name for the grouped point's graphic\nrepresentation.","type":{"names":["string"]},"products":["highcharts"],"since":"12.1.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.treemap.cluster.className","name":"className","line":543,"lineEnd":549,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"undefined"},"children":{}},"color":{"doclet":{"description":"Individual color for the grouped point. By default the color is\npulled from the parent color.","type":{"names":["Highcharts.ColorType"]},"products":["highcharts"],"since":"12.1.0","defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.treemap.cluster.color","name":"color","line":551,"lineEnd":557,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"undefined"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable Treemap grouping.","type":{"names":["boolean"]},"since":"12.1.0","products":["highcharts"],"defaultvalue":false},"meta":{"fullname":"plotOptions.treemap.cluster.enabled","name":"enabled","line":559,"lineEnd":565,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":false},"children":{}},"layoutAlgorithm":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treemap.cluster.layoutAlgorithm","name":"layoutAlgorithm","line":614,"lineEnd":614,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"distance":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.treemap.cluster.layoutAlgorithm.distance","name":"distance","line":615,"lineEnd":615,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":0},"children":{}},"gridSize":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.treemap.cluster.layoutAlgorithm.gridSize","name":"gridSize","line":616,"lineEnd":616,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":0},"children":{}},"kmeansThreshold":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.treemap.cluster.layoutAlgorithm.kmeansThreshold","name":"kmeansThreshold","line":617,"lineEnd":617,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":0},"children":{}}}},"marker":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treemap.cluster.marker","name":"marker","line":619,"lineEnd":619,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.treemap.cluster.marker.lineWidth","name":"lineWidth","line":620,"lineEnd":620,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":0},"children":{}},"radius":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.treemap.cluster.marker.radius","name":"radius","line":621,"lineEnd":621,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":0},"children":{}}}},"minimumClusterSize":{"doclet":{"description":"Defines the minimum number of child nodes required to create a group\nof small nodes.","type":{"names":["number"]},"since":"12.1.0","products":["highcharts"],"defaultvalue":5},"meta":{"fullname":"plotOptions.treemap.cluster.minimumClusterSize","name":"minimumClusterSize","line":605,"lineEnd":612,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":5},"children":{}},"name":{"doclet":{"description":"The name of the point of grouped nodes shown in the tooltip,\ndataLabels, etc. By default it is set to '+ n', where n is number of\ngrouped points.","type":{"names":["string"]},"since":"12.1.0","products":["highcharts"],"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.treemap.cluster.name","name":"name","line":584,"lineEnd":592,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"undefined"},"children":{}},"pixelHeight":{"doclet":{"description":"The pixel threshold height of area, which is used in Treemap\ngrouping.","type":{"names":["number"]},"since":"12.1.0","products":["highcharts"],"defaultvalue":null},"meta":{"fullname":"plotOptions.treemap.cluster.pixelHeight","name":"pixelHeight","line":575,"lineEnd":582,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"undefined"},"children":{}},"pixelWidth":{"doclet":{"description":"The pixel threshold width of area, which is used in Treemap grouping.","type":{"names":["number"]},"since":"12.1.0","products":["highcharts"],"defaultvalue":null},"meta":{"fullname":"plotOptions.treemap.cluster.pixelWidth","name":"pixelWidth","line":567,"lineEnd":573,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"undefined"},"children":{}},"reductionFactor":{"doclet":{"description":"A configuration property that specifies the factor by which the value\nand size of a grouped node are reduced. This can be particularly\nuseful when a grouped node occupies a disproportionately large\nportion of the graph, ensuring better visual balance and readability.","type":{"names":["number"]},"since":"12.1.0","products":["highcharts"],"defaultvalue":null},"meta":{"fullname":"plotOptions.treemap.cluster.reductionFactor","name":"reductionFactor","line":594,"lineEnd":603,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"undefined"},"children":{}}}},"colorByPoint":{"doclet":{"description":"When using automatic point colors pulled from the `options.colors`\ncollection, this option determines whether the chart should receive\none color per series or one color per point.","see":["[series colors](#plotOptions.treemap.colors)"],"since":"2.0.0","products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.treemap.colorByPoint","name":"colorByPoint","line":154,"lineEnd":164,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":false},"children":{}},"colorKey":{"doclet":{"type":{"names":["string"]},"defaultvalue":"colorValue"},"meta":{"fullname":"plotOptions.treemap.colorKey","name":"colorKey","line":455,"lineEnd":455,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"colorValue"},"children":{}},"colors":{"doclet":{"description":"A series specific or series type specific color set to apply instead\nof the global [colors](#colors) when\n[colorByPoint](#plotOptions.treemap.colorByPoint) is true.","type":{"names":["Array.<Highcharts.ColorType>"]},"since":"3.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.colors","name":"colors","line":135,"lineEnd":144,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"cropThreshold":{"doclet":{"description":"When the series contains less points than the crop threshold, all\npoints are drawn, even if the points fall outside the visible plot\narea at the current zoom. The advantage of drawing all points\n(including markers and columns), is that animation is performed on\nupdates. On the other hand, when the series contains more points than\nthe crop threshold, the series data is cropped to only contain points\nthat fall within the plot area. The advantage of cropping away\ninvisible points is to increase performance on large series.","type":{"names":["number"]},"defaultvalue":"300","since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.cropThreshold","name":"cropThreshold","line":77,"lineEnd":92,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"dataLabels":{"doclet":{"since":"4.1.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treemap.dataLabels","name":"dataLabels","line":166,"lineEnd":168,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.treemap.dataLabels.enabled","name":"enabled","line":170,"lineEnd":170,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":true},"children":{}},"headers":{"doclet":{"description":"Whether the data label should act as a group-level header. For leaf\nnodes, headers are not supported and the data label will be rendered\ninside.","samples":[{"name":"Headers for parent nodes","value":"highcharts/series-treemap/headers","products":["highcharts"]}],"since":"12.2.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.treemap.dataLabels.headers","name":"headers","line":177,"lineEnd":186,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":false},"children":{}},"inside":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.treemap.dataLabels.inside","name":"inside","line":188,"lineEnd":188,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":true},"children":{}},"padding":{"doclet":{"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.treemap.dataLabels.padding","name":"padding","line":189,"lineEnd":189,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":2},"children":{}},"style":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treemap.dataLabels.style","name":"style","line":191,"lineEnd":191,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"textOverflow":{"doclet":{"type":{"names":["string"]},"defaultvalue":"ellipsis"},"meta":{"fullname":"plotOptions.treemap.dataLabels.style.textOverflow","name":"textOverflow","line":192,"lineEnd":192,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"ellipsis"},"children":{}}}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"middle"},"meta":{"fullname":"plotOptions.treemap.dataLabels.verticalAlign","name":"verticalAlign","line":190,"lineEnd":190,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"middle"},"children":{}}}},"events":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"setRootNode":{"doclet":{"description":"Fires on a request for change of root node for the tree, before the\nupdate is made. An event object is passed to the function, containing\nadditional properties `newRootId`, `previousRootId`, `redraw` and\n`trigger`.","samples":[{"name":"Alert update information on setRootNode event.","value":"highcharts/plotoptions/treemap-events-setrootnode/","products":["highcharts"]}],"type":{"names":["function"]},"defaultvalue":"undefined","since":"7.0.3","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.events.setRootNode","name":"setRootNode","line":93,"lineEnd":107,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}}}},"groupPadding":{"doclet":{"description":"Group padding for parent elements in terms of pixels. See also the\n`nodeSizeBy` option that controls how the leaf nodes' size is affected by\nthe padding.","samples":[{"name":"Group padding","value":"highcharts/series-treemap/grouppadding/","products":["highcharts"]}],"type":{"names":["number"]},"since":"12.2.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.groupPadding","name":"groupPadding","line":289,"lineEnd":300,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"ignoreHiddenPoint":{"doclet":{"description":"Whether to ignore hidden points when the layout algorithm runs.\nIf `false`, hidden points will leave open spaces.","since":"5.0.8","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.treemap.ignoreHiddenPoint","name":"ignoreHiddenPoint","line":200,"lineEnd":205,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":true},"children":{}},"interactByLeaf":{"doclet":{"description":"This option decides if the user can interact with the parent nodes\nor just the leaf nodes. When this option is undefined, it will be\ntrue by default. However when allowTraversingTree is true, then it\nwill be false by default.","samples":[{"name":"False","value":"highcharts/plotoptions/treemap-interactbyleaf-false/","products":["highcharts"]},{"name":"InteractByLeaf and allowTraversingTree is true","value":"highcharts/plotoptions/treemap-interactbyleaf-true-and-allowtraversingtree/","products":["highcharts"]}],"type":{"names":["boolean"]},"since":"4.1.2","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.interactByLeaf","name":"interactByLeaf","line":108,"lineEnd":123,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"layoutAlgorithm":{"doclet":{"description":"This option decides which algorithm is used for setting position\nand dimensions of the points.","see":["[How to write your own algorithm](https://www.highcharts.com/docs/chart-and-series-types/treemap)"],"samples":[{"name":"SliceAndDice by default","value":"highcharts/plotoptions/treemap-layoutalgorithm-sliceanddice/","products":["highcharts"]},{"name":"Stripes","value":"highcharts/plotoptions/treemap-layoutalgorithm-stripes/","products":["highcharts"]},{"name":"Squarified","value":"highcharts/plotoptions/treemap-layoutalgorithm-squarified/","products":["highcharts"]},{"name":"Strip","value":"highcharts/plotoptions/treemap-layoutalgorithm-strip/","products":["highcharts"]}],"since":"4.1.0","values":"[\"sliceAndDice\", \"stripes\", \"squarified\", \"strip\"]","type":{"names":["string"]},"defaultvalue":"sliceAndDice"},"meta":{"fullname":"plotOptions.treemap.layoutAlgorithm","name":"layoutAlgorithm","line":207,"lineEnd":224,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"sliceAndDice"},"children":{}},"layoutStartingDirection":{"doclet":{"description":"Defines which direction the layout algorithm will start drawing.","since":"4.1.0","values":"[\"vertical\", \"horizontal\"]","type":{"names":["string"]},"defaultvalue":"vertical"},"meta":{"fullname":"plotOptions.treemap.layoutStartingDirection","name":"layoutStartingDirection","line":226,"lineEnd":231,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"vertical"},"children":{}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rectangle"},"meta":{"fullname":"plotOptions.treemap.legendSymbol","name":"legendSymbol","line":506,"lineEnd":506,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"rectangle"},"children":{}},"levelIsConstant":{"doclet":{"description":"Used together with the levels and allowTraversingTree options. When\nset to false the first level visible to be level one, which is\ndynamic when traversing the tree. Otherwise the level will be the\nsame as the tree structure.","since":"4.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.treemap.levelIsConstant","name":"levelIsConstant","line":244,"lineEnd":251,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":true},"children":{}},"levels":{"doclet":{"description":"Set options on specific levels. Takes precedence over series options,\nbut not point options.","samples":[{"name":"Styling dataLabels and borders","value":"highcharts/plotoptions/treemap-levels/","products":["highcharts"]},{"name":"Different layoutAlgorithm","value":"highcharts/demo/treemap-with-levels/","products":["highcharts"]}],"type":{"names":["Array.<*>"]},"since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels","name":"levels","line":301,"lineEnd":314,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"borderColor":{"doclet":{"description":"Can set a `borderColor` on all points which lies on the same level.","type":{"names":["Highcharts.ColorString"]},"since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels.borderColor","name":"borderColor","line":330,"lineEnd":337,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"borderDashStyle":{"doclet":{"description":"Set the dash style of the border of all the point which lies on the\nlevel. See\n[plotOptions.scatter.dashStyle](#plotoptions.scatter.dashstyle)\nfor possible options.","type":{"names":["Highcharts.DashStyleValue"]},"since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels.borderDashStyle","name":"borderDashStyle","line":338,"lineEnd":348,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"borderWidth":{"doclet":{"description":"Can set the borderWidth on all points which lies on the same level.","type":{"names":["number"]},"since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels.borderWidth","name":"borderWidth","line":349,"lineEnd":356,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"color":{"doclet":{"description":"Can set a color on all points which lies on the same level.","type":{"names":["Highcharts.ColorType"]},"since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels.color","name":"color","line":357,"lineEnd":364,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"colorVariation":{"doclet":{"description":"A configuration object to define how the color of a child varies from\nthe parent's color. The variation is distributed among the children\nof node. For example when setting brightness, the brightness change\nwill range from the parent's original brightness on the first child,\nto the amount set in the `to` setting on the last node. This allows a\ngradient-like color scheme that sets children out from each other\nwhile highlighting the grouping on treemaps and sectors on sunburst\ncharts.","samples":[{"name":"Sunburst with color variation","value":"highcharts/demo/sunburst/"},{"name":"Treegraph nodes with color variation","value":"highcharts/series-treegraph/color-variation"}],"since":"6.0.0","products":["highcharts"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treemap.levels.colorVariation","name":"colorVariation","line":365,"lineEnd":384,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"key":{"doclet":{"description":"The key of a color variation. Currently supports `brightness` only.","type":{"names":["\"brightness\""]},"since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels.colorVariation.key","name":"key","line":385,"lineEnd":393,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"to":{"doclet":{"description":"The ending value of a color variation. The last sibling will receive\nthis value.","type":{"names":["number"]},"since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels.colorVariation.to","name":"to","line":394,"lineEnd":402,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}}}},"dataLabels":{"doclet":{"description":"Can set the options of dataLabels on each point which lies on the\nlevel.\n[plotOptions.treemap.dataLabels](#plotOptions.treemap.dataLabels) for\npossible values.","extends":"plotOptions.treemap.dataLabels","since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels.dataLabels","name":"dataLabels","line":403,"lineEnd":413,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"layoutAlgorithm":{"doclet":{"description":"Can set the layoutAlgorithm option on a specific level.","type":{"names":["\"sliceAndDice\"","\"stripes\"","\"squarified\"","\"strip\""]},"since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels.layoutAlgorithm","name":"layoutAlgorithm","line":414,"lineEnd":422,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"layoutStartingDirection":{"doclet":{"description":"Can set the layoutStartingDirection option on a specific level.","type":{"names":["\"vertical\"","\"horizontal\""]},"since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels.layoutStartingDirection","name":"layoutStartingDirection","line":423,"lineEnd":431,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"level":{"doclet":{"description":"Decides which level takes effect from the options set in the levels\nobject.","samples":[{"name":"Styling of both levels","value":"highcharts/plotoptions/treemap-levels/","products":["highcharts"]}],"type":{"names":["number"]},"since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.levels.level","name":"level","line":432,"lineEnd":443,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}}}},"nodeSizeBy":{"doclet":{"description":"Experimental. How to set the size of child nodes when a header or padding\nis present. When `leaf`, the group is expanded to make room for headers\nand padding in order to preserve the relative sizes between leaves. When\n`group`, the leaves are naïvely fit into the remaining area after the\nheader and padding are subtracted.","samples":[{"name":"Node sizing","value":"highcharts/series-treemap/nodesizeby/","products":["highcharts"]}],"since":"12.2.0","type":{"names":["\"group\"","\"leaf\""]},"defaultvalue":"group"},"meta":{"fullname":"plotOptions.treemap.nodeSizeBy","name":"nodeSizeBy","line":315,"lineEnd":329,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"opacity":{"doclet":{"description":"The opacity of grouped points in treemap. When a point has children, the\ngroup point is covering the children, and is given this opacity. The\nvisibility of the children is determined by the opacity.","since":"4.2.4","type":{"names":["number"]},"defaultvalue":0.15},"meta":{"fullname":"plotOptions.treemap.opacity","name":"opacity","line":456,"lineEnd":462,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":0.15},"children":{}},"showInLegend":{"doclet":{"description":"Whether to display this series type or specific series item in the\nlegend.","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.treemap.showInLegend","name":"showInLegend","line":67,"lineEnd":76,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":false},"children":{}},"sortIndex":{"doclet":{"description":"The sort index of the point inside the treemap level.","samples":[{"name":"Sort by years","value":"highcharts/plotoptions/treemap-sortindex/","products":["highcharts"]}],"type":{"names":["number"]},"since":"4.1.10","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.sortIndex","name":"sortIndex","line":124,"lineEnd":134,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"states":{"doclet":{"description":"A wrapper object for all the series options in specific states.","extends":"plotOptions.heatmap.states"},"meta":{"fullname":"plotOptions.treemap.states","name":"states","line":464,"lineEnd":468,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"hover":{"doclet":{"description":"Options for the hovered series","extends":"plotOptions.heatmap.states.hover","exclude":["halo"]},"meta":{"fullname":"plotOptions.treemap.states.hover","name":"hover","line":470,"lineEnd":475,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"borderColor":{"doclet":{"description":"The border color for the hovered state.","type":{"names":["string"]},"defaultvalue":"#999999"},"meta":{"fullname":"plotOptions.treemap.states.hover.borderColor","name":"borderColor","line":477,"lineEnd":479,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"#999999"},"children":{}},"brightness":{"doclet":{"description":"Brightness for the hovered point. Defaults to 0 if the\nheatmap series is loaded first, otherwise 0.1.","type":{"names":["number"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.treemap.states.hover.brightness","name":"brightness","line":481,"lineEnd":487,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"halo":{"doclet":{"extends":"plotOptions.heatmap.states.hover.halo"},"meta":{"fullname":"plotOptions.treemap.states.hover.halo","name":"halo","line":489,"lineEnd":491,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":false},"children":{}},"opacity":{"doclet":{"description":"The opacity of a point in treemap. When a point has children,\nthe visibility of the children is determined by the opacity.","since":"4.2.4","type":{"names":["number"]},"defaultvalue":0.75},"meta":{"fullname":"plotOptions.treemap.states.hover.opacity","name":"opacity","line":493,"lineEnd":498,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":0.75},"children":{}},"shadow":{"doclet":{"description":"The shadow option for hovered state.","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.treemap.states.hover.shadow","name":"shadow","line":500,"lineEnd":502,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":false},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treemap.tooltip","name":"tooltip","line":195,"lineEnd":195,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"clusterFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"+ {point.groupedPointsAmount} more...<br/>"},"meta":{"fullname":"plotOptions.treemap.tooltip.clusterFormat","name":"clusterFormat","line":198,"lineEnd":198,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"+ {point.groupedPointsAmount} more...<br/>"},"children":{}},"headerFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"plotOptions.treemap.tooltip.headerFormat","name":"headerFormat","line":196,"lineEnd":196,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":""},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<b>{point.name}</b>: {point.value}<br/>"},"meta":{"fullname":"plotOptions.treemap.tooltip.pointFormat","name":"pointFormat","line":197,"lineEnd":197,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"<b>{point.name}</b>: {point.value}<br/>"},"children":{}}}},"traverseToLeaf":{"doclet":{"description":"This option enables automatic traversing to the last child level upon\nnode interaction. This feature simplifies navigation by immediately\nfocusing on the deepest layer of the data structure without intermediate\nsteps.","samples":[{"name":"Traverse to leaf enabled","value":"highcharts/plotoptions/treemap-traverse-to-leaf/","products":["highcharts"]}],"since":"11.4.4","products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.treemap.traverseToLeaf","name":"traverseToLeaf","line":507,"lineEnd":519,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":false},"children":{}},"traverseUpButton":{"doclet":{"description":"Options for the button appearing when traversing down in a treemap.\n\nSince v9.3.3 the `traverseUpButton` is replaced by `breadcrumbs`.","deprecated":true,"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treemap.traverseUpButton","name":"traverseUpButton","line":253,"lineEnd":259,"column":4,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"position":{"doclet":{"description":"The position of the button.","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.treemap.traverseUpButton.position","name":"position","line":261,"lineEnd":263,"column":8,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"align":{"doclet":{"description":"Horizontal alignment of the button.","type":{"names":["Highcharts.AlignValue"]},"defaultvalue":"right"},"meta":{"fullname":"plotOptions.treemap.traverseUpButton.position.align","name":"align","line":265,"lineEnd":272,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":"right"},"children":{}},"verticalAlign":{"doclet":{"description":"Vertical alignment of the button.","type":{"names":["Highcharts.VerticalAlignValue"]},"defaultvalue":"top","products":["highcharts"]},"meta":{"fullname":"plotOptions.treemap.traverseUpButton.position.verticalAlign","name":"verticalAlign","line":265,"lineEnd":272,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"x":{"doclet":{"description":"Horizontal offset of the button.","type":{"names":["number"]},"defaultvalue":-10},"meta":{"fullname":"plotOptions.treemap.traverseUpButton.position.x","name":"x","line":279,"lineEnd":281,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":-10},"children":{}},"y":{"doclet":{"description":"Vertical offset of the button.","type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"plotOptions.treemap.traverseUpButton.position.y","name":"y","line":283,"lineEnd":285,"column":12,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js","default":10},"children":{}}}}}}}},"trendline":{"doclet":{"description":"Trendline (linear regression) fits a straight line to the selected data\nusing a method called the Sum Of Least Squares. This series requires the\n`linkedTo` option to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `trendline` series are defined in\n   [plotOptions.trendline](plotOptions.trendline).\n3. Options for one single series are given in\n   [the series instance array](series.trendline).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        trendline: {\n            // shared options for all trendline series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'trendline'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.trendline.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === trendline) {\n    // code specific to the trendline series\n}\n```\n            ","samples":[{"name":"Trendline indicator","value":"stock/indicators/trendline"}],"extends":"plotOptions.sma","since":"7.1.3","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/trendline"]},"meta":{"filename":"code/es-modules/Stock/Indicators/TrendLine/TrendLineIndicator.js","name":"trendline","fullname":"plotOptions.trendline","line":79,"lineEnd":93,"column":0},"children":{"params":{"doclet":{"exclude":["period"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.trendline.params","name":"params","line":95,"lineEnd":97,"column":4,"filename":"code/es-modules/Stock/Indicators/TrendLine/TrendLineIndicator.js"},"children":{"index":{"doclet":{"description":"The point index which indicator calculations will base. For\nexample using OHLC data, index=2 means the indicator will be\ncalculated using Low values.","defaultvalue":"3","type":{"names":["number"]}},"meta":{"fullname":"plotOptions.trendline.params.index","name":"index","line":99,"lineEnd":99,"column":24,"filename":"code/es-modules/Stock/Indicators/TrendLine/TrendLineIndicator.js","default":3},"children":{}},"period":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.trendline.params.period","name":"period","line":99,"lineEnd":99,"column":8,"filename":"code/es-modules/Stock/Indicators/TrendLine/TrendLineIndicator.js","default":"undefined"},"children":{}}}}}},"trix":{"doclet":{"description":"Triple exponential average (TRIX) oscillator. This series requires\n`linkedTo` option to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `trix` series are defined in\n   [plotOptions.trix](plotOptions.trix).\n3. Options for one single series are given in\n   [the series instance array](series.trix).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        trix: {\n            // shared options for all trix series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'trix'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.trix.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === trix) {\n    // code specific to the trix series\n}\n```\n            ","samples":[{"name":"TRIX indicator","value":"stock/indicators/trix","products":["highstock"]}],"extends":"plotOptions.tema","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/tema","module:stock/indicators/trix"]},"meta":{"filename":"code/es-modules/Stock/Indicators/TRIX/TRIXIndicator.js","name":"trix","fullname":"plotOptions.trix","line":44,"lineEnd":48,"column":0},"children":{}},"variablepie":{"doclet":{"description":"A variable pie series is a two dimensional series type, where each point\nrenders an Y and Z value.  Each point is drawn as a pie slice where the\nsize (arc) of the slice relates to the Y value and the radius of pie\nslice relates to the Z value.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `variablepie` series are defined in\n   [plotOptions.variablepie](plotOptions.variablepie).\n3. Options for one single series are given in\n   [the series instance array](series.variablepie).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        variablepie: {\n            // shared options for all variablepie series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'variablepie'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.variablepie.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === variablepie) {\n    // code specific to the variablepie series\n}\n```\n            ","samples":[{"name":"Variable-radius pie chart","value":"highcharts/demo/variable-radius-pie/","products":["highcharts"]}],"extends":"plotOptions.pie","exclude":["dragDrop"],"since":"6.0.0","products":["highcharts"],"requires":["module:modules/variable-pie"]},"meta":{"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js","name":"variablepie","fullname":"plotOptions.variablepie","line":14,"lineEnd":18,"column":0},"children":{"maxPointSize":{"doclet":{"description":"The maximum size of the points' radius related to chart's `plotArea`.\nIf a number is set, it applies in pixels.","samples":[{"name":"Example of minPointSize and maxPointSize","value":"highcharts/variable-radius-pie/min-max-point-size/","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"6.0.0","defaultvalue":"100%"},"meta":{"fullname":"plotOptions.variablepie.maxPointSize","name":"maxPointSize","line":49,"lineEnd":58,"column":4,"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js","default":"100%"},"children":{}},"minPointSize":{"doclet":{"description":"The minimum size of the points' radius related to chart's `plotArea`.\nIf a number is set, it applies in pixels.","samples":[{"name":"Example of minPointSize and maxPointSize","value":"highcharts/variable-radius-pie/min-max-point-size/","products":["highcharts"]},{"name":"minPointSize set to 100","value":"highcharts/variable-radius-pie/min-point-size-100/","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"6.0.0","defaultvalue":"10%"},"meta":{"fullname":"plotOptions.variablepie.minPointSize","name":"minPointSize","line":36,"lineEnd":47,"column":4,"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js","default":"10%"},"children":{}},"sizeBy":{"doclet":{"description":"Whether the pie slice's value should be represented by the area or\nthe radius of the slice. Can be either `area` or `radius`. The\ndefault, `area`, corresponds best to the human perception of the size\nof each pie slice.","samples":[{"name":"Difference between area and radius sizeBy","value":"highcharts/variable-radius-pie/sizeby/","products":["highcharts"]}],"type":{"names":["Highcharts.VariablePieSizeByValue"]},"since":"6.0.0","defaultvalue":"area"},"meta":{"fullname":"plotOptions.variablepie.sizeBy","name":"sizeBy","line":86,"lineEnd":97,"column":4,"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js","default":"area"},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.variablepie.tooltip","name":"tooltip","line":99,"lineEnd":99,"column":4,"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> {series.name}<br/>Value: {point.y}<br/>Size: {point.z}<br/>"},"meta":{"fullname":"plotOptions.variablepie.tooltip.pointFormat","name":"pointFormat","line":100,"lineEnd":100,"column":8,"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> {series.name}<br/>Value: {point.y}<br/>Size: {point.z}<br/>"},"children":{}}}},"zMax":{"doclet":{"description":"The maximum possible z value for the point's radius calculation. If\nthe point's Z value is bigger than zMax, the slice will be drawn\naccording to the zMax value","samples":[{"name":"Series limited by both zMin and zMax","value":"highcharts/variable-radius-pie/zmin-zmax/","products":["highcharts"]}],"type":{"names":["number"]},"since":"6.0.0","defaultvalue":null},"meta":{"fullname":"plotOptions.variablepie.zMax","name":"zMax","line":74,"lineEnd":84,"column":4,"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js","default":"undefined"},"children":{}},"zMin":{"doclet":{"description":"The minimum possible z value for the point's radius calculation. If\nthe point's Z value is smaller than zMin, the slice will be drawn\naccording to the zMin value.","samples":[{"name":"zMin set to 5, smaller z values are treated as 5","value":"highcharts/variable-radius-pie/zmin-5/","products":["highcharts"]},{"name":"Series limited by both zMin and zMax","value":"highcharts/variable-radius-pie/zmin-zmax/","products":["highcharts"]}],"type":{"names":["number"]},"since":"6.0.0","defaultvalue":null},"meta":{"fullname":"plotOptions.variablepie.zMin","name":"zMin","line":60,"lineEnd":72,"column":4,"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js","default":"undefined"},"children":{}}}},"variwide":{"doclet":{"description":"A variwide chart (related to marimekko chart) is a column chart with a\nvariable width expressing a third dimension.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `variwide` series are defined in\n   [plotOptions.variwide](plotOptions.variwide).\n3. Options for one single series are given in\n   [the series instance array](series.variwide).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        variwide: {\n            // shared options for all variwide series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'variwide'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.variwide.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === variwide) {\n    // code specific to the variwide series\n}\n```\n            ","samples":[{"name":"Variwide chart","value":"highcharts/demo/variwide/","products":["highcharts"]},{"name":"Inverted variwide chart","value":"highcharts/series-variwide/inverted/","products":["highcharts"]},{"name":"Variwide columns on a datetime axis","value":"highcharts/series-variwide/datetime/","products":["highcharts"]}],"extends":"plotOptions.column","since":"6.0.0","products":["highcharts"],"exclude":["boostThreshold","crisp","depth","edgeColor","edgeWidth","groupZPadding","boostBlending"],"requires":["module:modules/variwide"]},"meta":{"filename":"code/es-modules/Series/Variwide/VariwideSeriesDefaults.js","name":"variwide","fullname":"plotOptions.variwide","line":14,"lineEnd":18,"column":0},"children":{"groupPadding":{"doclet":{"description":"In a variwide chart, the group padding is 0 in order to express the\nhorizontal stacking of items.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.variwide.groupPadding","name":"groupPadding","line":44,"lineEnd":47,"column":4,"filename":"code/es-modules/Series/Variwide/VariwideSeriesDefaults.js","default":0},"children":{}},"pointPadding":{"doclet":{"description":"In a variwide chart, the point padding is 0 in order to express the\nhorizontal stacking of items.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.variwide.pointPadding","name":"pointPadding","line":39,"lineEnd":42,"column":4,"filename":"code/es-modules/Series/Variwide/VariwideSeriesDefaults.js","default":0},"children":{}}}},"vbp":{"doclet":{"description":"Volume By Price indicator.\n\nThis series requires `linkedTo` option to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `vbp` series are defined in\n   [plotOptions.vbp](plotOptions.vbp).\n3. Options for one single series are given in\n   [the series instance array](series.vbp).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        vbp: {\n            // shared options for all vbp series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'vbp'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.vbp.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === vbp) {\n    // code specific to the vbp series\n}\n```\n            ","samples":[{"name":"Volume By Price indicator","value":"stock/indicators/volume-by-price"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/volume-by-price"]},"meta":{"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","name":"vbp","fullname":"plotOptions.vbp","line":444,"lineEnd":448,"column":0},"children":{"animationLimit":{"doclet":{"type":{"names":["number"]},"defaultvalue":1000},"meta":{"fullname":"plotOptions.vbp.animationLimit","name":"animationLimit","line":529,"lineEnd":529,"column":4,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":1000},"children":{}},"crisp":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.vbp.crisp","name":"crisp","line":534,"lineEnd":534,"column":4,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":true},"children":{}},"dataGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.vbp.dataGrouping","name":"dataGrouping","line":535,"lineEnd":535,"column":4,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.vbp.dataGrouping.enabled","name":"enabled","line":536,"lineEnd":536,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":false},"children":{}}}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.vbp.dataLabels","name":"dataLabels","line":538,"lineEnd":538,"column":4,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js"},"children":{"align":{"doclet":{"type":{"names":["string"]},"defaultvalue":"left"},"meta":{"fullname":"plotOptions.vbp.dataLabels.align","name":"align","line":539,"lineEnd":539,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":"left"},"children":{}},"allowOverlap":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.vbp.dataLabels.allowOverlap","name":"allowOverlap","line":540,"lineEnd":540,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":true},"children":{}},"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.vbp.dataLabels.enabled","name":"enabled","line":541,"lineEnd":541,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":true},"children":{}},"format":{"doclet":{"type":{"names":["string"]},"defaultvalue":"P: {point.volumePos:.2f} | N: {point.volumeNeg:.2f}"},"meta":{"fullname":"plotOptions.vbp.dataLabels.format","name":"format","line":542,"lineEnd":542,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":"P: {point.volumePos:.2f} | N: {point.volumeNeg:.2f}"},"children":{}},"padding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.vbp.dataLabels.padding","name":"padding","line":543,"lineEnd":543,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":0},"children":{}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"top"},"meta":{"fullname":"plotOptions.vbp.dataLabels.verticalAlign","name":"verticalAlign","line":548,"lineEnd":548,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":"top"},"children":{}}}},"enableMouseTracking":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.vbp.enableMouseTracking","name":"enableMouseTracking","line":531,"lineEnd":531,"column":4,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":false},"children":{}},"params":{"doclet":{"exclude":["index","period"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.vbp.params","name":"params","line":465,"lineEnd":467,"column":4,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.vbp.params.index","name":"index","line":469,"lineEnd":469,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.vbp.params.period","name":"period","line":471,"lineEnd":471,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":"undefined"},"children":{}},"ranges":{"doclet":{"description":"The number of price zones.","type":{"names":["number"]},"defaultvalue":12},"meta":{"fullname":"plotOptions.vbp.params.ranges","name":"ranges","line":472,"lineEnd":474,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":12},"children":{}},"volumeSeriesID":{"doclet":{"description":"The id of volume series which is mandatory. For example using\nOHLC data, volumeSeriesID='volume' means the indicator will be\ncalculated using OHLC and volume values.","type":{"names":["string"]},"defaultvalue":"volume"},"meta":{"fullname":"plotOptions.vbp.params.volumeSeriesID","name":"volumeSeriesID","line":476,"lineEnd":480,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":"volume"},"children":{}}}},"pointPadding":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.vbp.pointPadding","name":"pointPadding","line":532,"lineEnd":532,"column":4,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":0},"children":{}},"volumeDivision":{"doclet":{"description":"The styles for bars when volume is divided into positive/negative.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.vbp.volumeDivision","name":"volumeDivision","line":506,"lineEnd":508,"column":4,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js"},"children":{"enabled":{"doclet":{"description":"Option to control if volume is divided.","since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.vbp.volumeDivision.enabled","name":"enabled","line":510,"lineEnd":512,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":true},"children":{}},"styles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.vbp.volumeDivision.styles","name":"styles","line":514,"lineEnd":514,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js"},"children":{"negativeColor":{"doclet":{"description":"Color of negative volume bars.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"rgba(244, 91, 91, 0.8)"},"meta":{"fullname":"plotOptions.vbp.volumeDivision.styles.negativeColor","name":"negativeColor","line":521,"lineEnd":525,"column":12,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":"rgba(244, 91, 91, 0.8)"},"children":{}},"positiveColor":{"doclet":{"description":"Color of positive volume bars.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"rgba(144, 237, 125, 0.8)"},"meta":{"fullname":"plotOptions.vbp.volumeDivision.styles.positiveColor","name":"positiveColor","line":515,"lineEnd":519,"column":12,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":"rgba(144, 237, 125, 0.8)"},"children":{}}}}}},"zIndex":{"doclet":{"type":{"names":["number"]},"defaultvalue":-1},"meta":{"fullname":"plotOptions.vbp.zIndex","name":"zIndex","line":533,"lineEnd":533,"column":4,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":-1},"children":{}},"zoneLines":{"doclet":{"description":"The styles for lines which determine price zones.","since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.vbp.zoneLines","name":"zoneLines","line":483,"lineEnd":485,"column":4,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js"},"children":{"enabled":{"doclet":{"description":"Enable/disable zone lines.","since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.vbp.zoneLines.enabled","name":"enabled","line":487,"lineEnd":489,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js","default":true},"children":{}},"styles":{"doclet":{"description":"Specify the style of zone lines.","type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"color\": \"#0A9AC9\", \"dashStyle\": \"LongDash\", \"lineWidth\": 1}","since":"6.0.0"},"meta":{"fullname":"plotOptions.vbp.zoneLines.styles","name":"styles","line":491,"lineEnd":496,"column":8,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js"},"children":{}}}}}},"vector":{"doclet":{"description":"A vector plot is a type of cartesian chart where each point has an X and\nY position, a length and a direction. Vectors are drawn as arrows.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `vector` series are defined in\n   [plotOptions.vector](plotOptions.vector).\n3. Options for one single series are given in\n   [the series instance array](series.vector).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        vector: {\n            // shared options for all vector series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'vector'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.vector.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === vector) {\n    // code specific to the vector series\n}\n```\n            ","samples":[{"name":"Vector pot","value":"highcharts/demo/vector-plot/","products":["highcharts","highstock"]}],"since":"6.0.0","extends":"plotOptions.scatter","exclude":["boostThreshold","marker","connectEnds","connectNulls","cropThreshold","dashStyle","dragDrop","gapSize","gapUnit","dataGrouping","linecap","shadow","stacking","step","jitter","boostBlending"],"products":["highcharts","highstock"],"requires":["module:modules/vector"]},"meta":{"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js","name":"vector","fullname":"plotOptions.vector","line":14,"lineEnd":18,"column":0},"children":{"lineWidth":{"doclet":{"description":"The line width for each vector arrow.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.vector.lineWidth","name":"lineWidth","line":37,"lineEnd":39,"column":4,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js","default":2},"children":{}},"marker":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.vector.marker","name":"marker","line":41,"lineEnd":41,"column":4,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js","default":"undefined"},"children":{}},"rotationOrigin":{"doclet":{"description":"What part of the vector it should be rotated around. Can be one of\n`start`, `center` and `end`. When `start`, the vectors will start\nfrom the given [x, y] position, and when `end` the vectors will end\nin the [x, y] position.","samples":[{"name":"Rotate from start","value":"highcharts/plotoptions/vector-rotationorigin-start/"}],"values":"[\"start\", \"center\", \"end\"]","since":"6.0.0","type":{"names":["string"]},"defaultvalue":"center"},"meta":{"fullname":"plotOptions.vector.rotationOrigin","name":"rotationOrigin","line":42,"lineEnd":52,"column":4,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js","default":"center"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.vector.states","name":"states","line":54,"lineEnd":54,"column":4,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.vector.states.hover","name":"hover","line":55,"lineEnd":55,"column":8,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js"},"children":{"lineWidthPlus":{"doclet":{"description":"Additional line width for the vector errors when they are\nhovered.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.vector.states.hover.lineWidthPlus","name":"lineWidthPlus","line":56,"lineEnd":59,"column":12,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js","default":1},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.vector.tooltip","name":"tooltip","line":63,"lineEnd":63,"column":4,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"defaultvalue":"[{point.x}, {point.y}] Length: {point.length} Direction: {point.direction}°","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.vector.tooltip.pointFormat","name":"pointFormat","line":64,"lineEnd":66,"column":8,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js","default":"<b>[{point.x}, {point.y}]</b><br/>Length: <b>{point.length}</b><br/>Direction: <b>{point.direction}°</b><br/>"},"children":{}}}},"vectorLength":{"doclet":{"description":"Maximum length of the arrows in the vector plot. The individual arrow\nlength is computed between 0 and this value.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":20},"meta":{"fullname":"plotOptions.vector.vectorLength","name":"vectorLength","line":69,"lineEnd":72,"column":4,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js","default":20},"children":{}}}},"venn":{"doclet":{"description":"A Venn diagram displays all possible logical relations between a\ncollection of different sets. The sets are represented by circles, and\nthe relation between the sets are displayed by the overlap or lack of\noverlap between them. The venn diagram is a special case of Euler\ndiagrams, which can also be displayed by this series type.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `venn` series are defined in\n   [plotOptions.venn](plotOptions.venn).\n3. Options for one single series are given in\n   [the series instance array](series.venn).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        venn: {\n            // shared options for all venn series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'venn'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.venn.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === venn) {\n    // code specific to the venn series\n}\n```\n            ","samples":[{"name":"Venn diagram","value":"highcharts/demo/venn-diagram/","products":["highcharts"]},{"name":"Euler diagram","value":"highcharts/demo/euler-diagram/","products":["highcharts"]},{"name":"Venn diagram with a legend","value":"highcharts/series-venn/point-legend/","products":["highcharts"]}],"extends":"plotOptions.scatter","exclude":["connectEnds","connectNulls","cropThreshold","dragDrop","findNearestPointBy","getExtremesFromAll","jitter","label","linecap","lineWidth","linkedTo","marker","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointStart","softThreshold","stacking","steps","threshold","xAxis","yAxis","zoneAxis","zones","dataSorting","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:modules/venn"]},"meta":{"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","name":"venn","fullname":"plotOptions.venn","line":18,"lineEnd":22,"column":0},"children":{"borderColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"plotOptions.venn.borderColor","name":"borderColor","line":50,"lineEnd":50,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":"#cccccc"},"children":{}},"borderDashStyle":{"doclet":{"type":{"names":["string"]},"defaultvalue":"solid"},"meta":{"fullname":"plotOptions.venn.borderDashStyle","name":"borderDashStyle","line":51,"lineEnd":51,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":"solid"},"children":{}},"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.venn.borderWidth","name":"borderWidth","line":52,"lineEnd":52,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":1},"children":{}},"brighten":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.venn.brighten","name":"brighten","line":53,"lineEnd":53,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":0},"children":{}},"clip":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.venn.clip","name":"clip","line":54,"lineEnd":54,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":false},"children":{}},"colorByPoint":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.venn.colorByPoint","name":"colorByPoint","line":55,"lineEnd":55,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":true},"children":{}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.venn.dataLabels","name":"dataLabels","line":56,"lineEnd":56,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{"enabled":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.venn.dataLabels.enabled","name":"enabled","line":57,"lineEnd":57,"column":8,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":true},"children":{}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"middle"},"meta":{"fullname":"plotOptions.venn.dataLabels.verticalAlign","name":"verticalAlign","line":58,"lineEnd":58,"column":8,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":"middle"},"children":{}}}},"inactiveOtherPoints":{"doclet":{"defaultvalue":"true","extends":"plotOptions.series.inactiveOtherPoints"},"meta":{"fullname":"plotOptions.venn.inactiveOtherPoints","name":"inactiveOtherPoints","line":63,"lineEnd":67,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":true},"children":{}},"legendSymbol":{"doclet":{"type":{"names":["string"]},"defaultvalue":"rectangle"},"meta":{"fullname":"plotOptions.venn.legendSymbol","name":"legendSymbol","line":105,"lineEnd":105,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":"rectangle"},"children":{}},"opacity":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.75},"meta":{"fullname":"plotOptions.venn.opacity","name":"opacity","line":74,"lineEnd":74,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":0.75},"children":{}},"showInLegend":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.venn.showInLegend","name":"showInLegend","line":75,"lineEnd":75,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":false},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.venn.states","name":"states","line":82,"lineEnd":82,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{"hover":{"doclet":{"exclude":["halo"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.venn.states.hover","name":"hover","line":83,"lineEnd":85,"column":8,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{"borderColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#333333"},"meta":{"fullname":"plotOptions.venn.states.hover.borderColor","name":"borderColor","line":88,"lineEnd":88,"column":12,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":"#333333"},"children":{}},"opacity":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.venn.states.hover.opacity","name":"opacity","line":87,"lineEnd":87,"column":12,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":1},"children":{}}}},"inactive":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.venn.states.inactive","name":"inactive","line":98,"lineEnd":98,"column":8,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{"opacity":{"doclet":{"type":{"names":["number"]},"defaultvalue":0.075},"meta":{"fullname":"plotOptions.venn.states.inactive.opacity","name":"opacity","line":99,"lineEnd":99,"column":12,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":0.075},"children":{}}}},"select":{"doclet":{"exclude":["halo"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.venn.states.select","name":"select","line":90,"lineEnd":92,"column":8,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{"animation":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.venn.states.select.animation","name":"animation","line":96,"lineEnd":96,"column":12,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":false},"children":{}},"borderColor":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#000000"},"meta":{"fullname":"plotOptions.venn.states.select.borderColor","name":"borderColor","line":95,"lineEnd":95,"column":12,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":"#000000"},"children":{}},"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"plotOptions.venn.states.select.color","name":"color","line":94,"lineEnd":94,"column":12,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":"#cccccc"},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.venn.tooltip","name":"tooltip","line":102,"lineEnd":102,"column":4,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"{point.name}: {point.value}"},"meta":{"fullname":"plotOptions.venn.tooltip.pointFormat","name":"pointFormat","line":103,"lineEnd":103,"column":8,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js","default":"{point.name}: {point.value}"},"children":{}}}}}},"vwap":{"doclet":{"description":"Volume Weighted Average Price indicator.\n\nThis series requires `linkedTo` option to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `vwap` series are defined in\n   [plotOptions.vwap](plotOptions.vwap).\n3. Options for one single series are given in\n   [the series instance array](series.vwap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        vwap: {\n            // shared options for all vwap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'vwap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.vwap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === vwap) {\n    // code specific to the vwap series\n}\n```\n            ","samples":[{"name":"Volume Weighted Average Price indicator","value":"stock/indicators/vwap"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/vwap"]},"meta":{"filename":"code/es-modules/Stock/Indicators/VWAP/VWAPIndicator.js","name":"vwap","fullname":"plotOptions.vwap","line":119,"lineEnd":123,"column":0},"children":{"params":{"doclet":{"exclude":["index"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.vwap.params","name":"params","line":140,"lineEnd":142,"column":4,"filename":"code/es-modules/Stock/Indicators/VWAP/VWAPIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.vwap.params.index","name":"index","line":144,"lineEnd":144,"column":8,"filename":"code/es-modules/Stock/Indicators/VWAP/VWAPIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":30},"meta":{"fullname":"plotOptions.vwap.params.period","name":"period","line":144,"lineEnd":144,"column":23,"filename":"code/es-modules/Stock/Indicators/VWAP/VWAPIndicator.js","default":30},"children":{}},"volumeSeriesID":{"doclet":{"description":"The id of volume series which is mandatory. For example using\nOHLC data, volumeSeriesID='volume' means the indicator will be\ncalculated using OHLC and volume values.","type":{"names":["string"]},"defaultvalue":"volume"},"meta":{"fullname":"plotOptions.vwap.params.volumeSeriesID","name":"volumeSeriesID","line":146,"lineEnd":150,"column":8,"filename":"code/es-modules/Stock/Indicators/VWAP/VWAPIndicator.js","default":"volume"},"children":{}}}}}},"waterfall":{"doclet":{"description":"A waterfall chart displays sequentially introduced positive or negative\nvalues in cumulative columns.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `waterfall` series are defined in\n   [plotOptions.waterfall](plotOptions.waterfall).\n3. Options for one single series are given in\n   [the series instance array](series.waterfall).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        waterfall: {\n            // shared options for all waterfall series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'waterfall'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.waterfall.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === waterfall) {\n    // code specific to the waterfall series\n}\n```\n            ","samples":[{"name":"Waterfall chart","value":"highcharts/demo/waterfall/"},{"name":"Horizontal (inverted) waterfall","value":"highcharts/plotoptions/waterfall-inverted/"},{"name":"Stacked waterfall chart","value":"highcharts/plotoptions/waterfall-stacked/"}],"extends":"plotOptions.column","exclude":["boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js","name":"waterfall","fullname":"plotOptions.waterfall","line":12,"lineEnd":16,"column":0},"children":{"borderColor":{"doclet":{"description":"The color of the border of each waterfall column.\n\nIn styled mode, the border stroke can be set with the\n`.highcharts-point` class.","type":{"names":["Highcharts.ColorType"]},"since":"3.0.0","products":["highcharts"],"defaultvalue":"#333333"},"meta":{"fullname":"plotOptions.waterfall.borderColor","name":"borderColor","line":88,"lineEnd":97,"column":4,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js","default":"#333333"},"children":{}},"color":{"doclet":{"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"plotOptions.waterfall.color","name":"color","line":35,"lineEnd":38,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js"},"children":{}},"dashStyle":{"doclet":{"description":"A name for the dash style to use for the line connecting the columns\nof the waterfall series. Possible values: Dash, DashDot, Dot,\nLongDash, LongDashDot, LongDashDotDot, ShortDash, ShortDashDot,\nShortDashDotDot, ShortDot, Solid\n\nIn styled mode, the stroke dash-array can be set with the\n`.highcharts-graph` class.","type":{"names":["Highcharts.DashStyleValue"]},"since":"3.0.0","products":["highcharts"],"defaultvalue":"Dot"},"meta":{"fullname":"plotOptions.waterfall.dashStyle","name":"dashStyle","line":74,"lineEnd":86,"column":4,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js","default":"Dot"},"children":{}},"lineColor":{"doclet":{"description":"The color of the line that connects columns in a waterfall series.\n\nIn styled mode, the stroke can be set with the `.highcharts-graph`\nclass.","type":{"names":["Highcharts.ColorType"]},"since":"3.0.0","products":["highcharts"],"defaultvalue":"#333333"},"meta":{"fullname":"plotOptions.waterfall.lineColor","name":"lineColor","line":63,"lineEnd":72,"column":4,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js","default":"#333333"},"children":{}},"lineWidth":{"doclet":{"description":"The width of the line connecting waterfall columns.","products":["highcharts"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.waterfall.lineWidth","name":"lineWidth","line":57,"lineEnd":61,"column":4,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js","default":1},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.waterfall.states","name":"states","line":99,"lineEnd":99,"column":4,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.waterfall.states.hover","name":"hover","line":100,"lineEnd":100,"column":8,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js"},"children":{"lineWidthPlus":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.waterfall.states.hover.lineWidthPlus","name":"lineWidthPlus","line":101,"lineEnd":101,"column":12,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js","default":0},"children":{}}}}}},"upColor":{"doclet":{"description":"The color used specifically for positive point columns. When not\nspecified, the general series color is used.\n\nIn styled mode, the waterfall colors can be set with the\n`.highcharts-point-negative`, `.highcharts-sum` and\n`.highcharts-intermediate-sum` classes.","samples":[{"name":"Waterfall","value":"highcharts/demo/waterfall/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"products":["highcharts"]},"meta":{"fullname":"plotOptions.waterfall.upColor","name":"upColor","line":39,"lineEnd":53,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js"},"children":{}}}},"williamsr":{"doclet":{"description":"Williams %R. This series requires the `linkedTo` option to be\nset and should be loaded after the `stock/indicators/indicators.js`.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `williamsr` series are defined in\n   [plotOptions.williamsr](plotOptions.williamsr).\n3. Options for one single series are given in\n   [the series instance array](series.williamsr).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        williamsr: {\n            // shared options for all williamsr series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'williamsr'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.williamsr.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === williamsr) {\n    // code specific to the williamsr series\n}\n```\n            ","samples":[{"name":"Williams %R","value":"stock/indicators/williams-r","products":["highstock"]}],"extends":"plotOptions.sma","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/williams-r"]},"meta":{"filename":"code/es-modules/Stock/Indicators/WilliamsR/WilliamsRIndicator.js","name":"williamsr","fullname":"plotOptions.williamsr","line":69,"lineEnd":73,"column":0},"children":{"params":{"doclet":{"description":"Parameters used in calculation of Williams %R series points.","exclude":["index"],"since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.williamsr.params","name":"params","line":92,"lineEnd":95,"column":4,"filename":"code/es-modules/Stock/Indicators/WilliamsR/WilliamsRIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.williamsr.params.index","name":"index","line":97,"lineEnd":97,"column":8,"filename":"code/es-modules/Stock/Indicators/WilliamsR/WilliamsRIndicator.js","default":"undefined"},"children":{}},"period":{"doclet":{"description":"Period for Williams %R oscillator","since":"7.0.0","type":{"names":["number"]},"defaultvalue":14},"meta":{"fullname":"plotOptions.williamsr.params.period","name":"period","line":97,"lineEnd":97,"column":23,"filename":"code/es-modules/Stock/Indicators/WilliamsR/WilliamsRIndicator.js","default":14},"children":{}}}}}},"windbarb":{"doclet":{"description":"Wind barbs are a convenient way to represent wind speed and direction in\none graphical form. Wind direction is given by the stem direction, and\nwind speed by the number and shape of barbs.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `windbarb` series are defined in\n   [plotOptions.windbarb](plotOptions.windbarb).\n3. Options for one single series are given in\n   [the series instance array](series.windbarb).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        windbarb: {\n            // shared options for all windbarb series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'windbarb'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.windbarb.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === windbarb) {\n    // code specific to the windbarb series\n}\n```\n            ","samples":[{"name":"Wind barb series","value":"highcharts/demo/windbarb-series/","products":["highcharts","highstock"]}],"extends":"plotOptions.column","exclude":["boostThreshold","marker","connectEnds","connectNulls","cropThreshold","dashStyle","dragDrop","gapSize","gapUnit","linecap","shadow","stacking","step","boostBlending"],"since":"6.0.0","products":["highcharts","highstock"],"requires":["module:modules/windbarb"]},"meta":{"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","name":"windbarb","fullname":"plotOptions.windbarb","line":14,"lineEnd":18,"column":0},"children":{"colorKey":{"doclet":{"defaultvalue":"value","type":{"names":["string"]}},"meta":{"fullname":"plotOptions.windbarb.colorKey","name":"colorKey","line":105,"lineEnd":107,"column":4,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":"value"},"children":{}},"dataGrouping":{"doclet":{"description":"Data grouping options for the wind barbs. In Highcharts, this\nrequires the `modules/datagrouping.js` module to be loaded. In\nHighcharts Stock, data grouping is included.","samples":[{"name":"Wind barb with data grouping","value":"highcharts/plotoptions/windbarb-datagrouping"}],"since":"7.1.0","products":["highcharts","highstock"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.windbarb.dataGrouping","name":"dataGrouping","line":37,"lineEnd":47,"column":4,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js"},"children":{"approximation":{"doclet":{"description":"Approximation function for the data grouping. The default\nreturns an average of wind speed and a vector average direction\nweighted by wind speed.","products":["highcharts","highstock"],"type":{"names":["string","function"]},"since":"7.1.0","defaultvalue":"windbarb"},"meta":{"fullname":"plotOptions.windbarb.dataGrouping.approximation","name":"approximation","line":55,"lineEnd":63,"column":8,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":"windbarb"},"children":{}},"enabled":{"doclet":{"description":"Whether to enable data grouping.","products":["highcharts","highstock"],"since":"7.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.windbarb.dataGrouping.enabled","name":"enabled","line":49,"lineEnd":53,"column":8,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":true},"children":{}},"groupPixelWidth":{"doclet":{"description":"The approximate data group width.","products":["highcharts","highstock"],"since":"7.1.0","type":{"names":["number"]},"defaultvalue":30},"meta":{"fullname":"plotOptions.windbarb.dataGrouping.groupPixelWidth","name":"groupPixelWidth","line":65,"lineEnd":69,"column":8,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":30},"children":{}}}},"lineWidth":{"doclet":{"description":"The line width of the wind barb symbols.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.windbarb.lineWidth","name":"lineWidth","line":72,"lineEnd":74,"column":4,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":2},"children":{}},"onSeries":{"doclet":{"description":"The id of another series in the chart that the wind barbs are\nprojected on. When `null`, the wind symbols are drawn on the X axis,\nbut offset up or down by the `yOffset` setting.","samples":[{"name":"Projected on area series","value":"highcharts/plotoptions/windbarb-onseries","products":["highcharts","highstock"]}],"type":{"names":["string","null"]},"since":"6.0.0","defaultvalue":null},"meta":{"fullname":"plotOptions.windbarb.onSeries","name":"onSeries","line":76,"lineEnd":85,"column":4,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":null},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.windbarb.states","name":"states","line":87,"lineEnd":87,"column":4,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js"},"children":{"hover":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.windbarb.states.hover","name":"hover","line":88,"lineEnd":88,"column":8,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js"},"children":{"lineWidthPlus":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.windbarb.states.hover.lineWidthPlus","name":"lineWidthPlus","line":89,"lineEnd":89,"column":12,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":0},"children":{}}}}}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.windbarb.tooltip","name":"tooltip","line":92,"lineEnd":92,"column":4,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js"},"children":{"pointFormat":{"doclet":{"description":"The default point format for the wind barb tooltip. Note the\n`point.beaufort` property that refers to the Beaufort wind scale.\nThe names can be internationalized by modifying\n`Highcharts.seriesTypes.windbarb.prototype.beaufortNames`.","type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> {series.name}: <b>{point.value}</b> ({point.beaufort})<br/>"},"meta":{"fullname":"plotOptions.windbarb.tooltip.pointFormat","name":"pointFormat","line":93,"lineEnd":98,"column":8,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> {series.name}: <b>{point.value}</b> ({point.beaufort})<br/>"},"children":{}}}},"vectorLength":{"doclet":{"description":"Pixel length of the stems.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":20},"meta":{"fullname":"plotOptions.windbarb.vectorLength","name":"vectorLength","line":101,"lineEnd":103,"column":4,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":20},"children":{}},"xOffset":{"doclet":{"description":"Horizontal offset from the cartesian position, in pixels. When the\nchart is inverted, this option allows translation like\n[yOffset](#plotOptions.windbarb.yOffset) in non inverted charts.","since":"6.1.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.windbarb.xOffset","name":"xOffset","line":116,"lineEnd":122,"column":4,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":0},"children":{}},"yOffset":{"doclet":{"description":"Vertical offset from the cartesian position, in pixels. The default\nvalue makes sure the symbols don't overlap the X axis when `onSeries`\nis `null`, and that they don't overlap the linked series when\n`onSeries` is given.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":-20},"meta":{"fullname":"plotOptions.windbarb.yOffset","name":"yOffset","line":109,"lineEnd":114,"column":4,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js","default":-20},"children":{}}}},"wma":{"doclet":{"description":"Weighted moving average indicator (WMA). This series requires `linkedTo`\noption to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `wma` series are defined in\n   [plotOptions.wma](plotOptions.wma).\n3. Options for one single series are given in\n   [the series instance array](series.wma).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        wma: {\n            // shared options for all wma series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'wma'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.wma.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === wma) {\n    // code specific to the wma series\n}\n```\n            ","samples":[{"name":"Weighted moving average indicator","value":"stock/indicators/wma"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/wma"]},"meta":{"filename":"code/es-modules/Stock/Indicators/WMA/WMAIndicator.js","name":"wma","fullname":"plotOptions.wma","line":106,"lineEnd":110,"column":0},"children":{"params":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.wma.params","name":"params","line":126,"lineEnd":126,"column":4,"filename":"code/es-modules/Stock/Indicators/WMA/WMAIndicator.js"},"children":{"index":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.wma.params.index","name":"index","line":127,"lineEnd":127,"column":8,"filename":"code/es-modules/Stock/Indicators/WMA/WMAIndicator.js","default":3},"children":{}},"period":{"doclet":{"type":{"names":["number"]},"defaultvalue":9},"meta":{"fullname":"plotOptions.wma.params.period","name":"period","line":128,"lineEnd":128,"column":8,"filename":"code/es-modules/Stock/Indicators/WMA/WMAIndicator.js","default":9},"children":{}}}}}},"wordcloud":{"doclet":{"description":"A word cloud is a visualization of a set of words, where the size and\nplacement of a word is determined by how it is weighted.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `wordcloud` series are defined in\n   [plotOptions.wordcloud](plotOptions.wordcloud).\n3. Options for one single series are given in\n   [the series instance array](series.wordcloud).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        wordcloud: {\n            // shared options for all wordcloud series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'wordcloud'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.wordcloud.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === wordcloud) {\n    // code specific to the wordcloud series\n}\n```\n            ","samples":[{"name":"Word Cloud chart","value":"highcharts/demo/wordcloud"}],"extends":"plotOptions.column","exclude":["allAreas","boostThreshold","clip","colorAxis","compare","compareBase","crisp","cropThreshold","dataGrouping","dataLabels","depth","dragDrop","edgeColor","findNearestPointBy","getExtremesFromAll","grouping","groupPadding","groupZPadding","joinBy","maxPointWidth","minPointLength","navigatorOptions","negativeColor","pointInterval","pointIntervalUnit","pointPadding","pointPlacement","pointRange","pointStart","pointWidth","pointStart","pointWidth","shadow","showCheckbox","showInNavigator","softThreshold","stacking","threshold","zoneAxis","zones","dataSorting","boostBlending"],"products":["highcharts"],"since":"6.0.0","requires":["module:modules/wordcloud"]},"meta":{"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","name":"wordcloud","fullname":"plotOptions.wordcloud","line":13,"lineEnd":17,"column":0},"children":{"borderWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.wordcloud.borderWidth","name":"borderWidth","line":56,"lineEnd":56,"column":4,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":0},"children":{}},"colorByPoint":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.wordcloud.colorByPoint","name":"colorByPoint","line":60,"lineEnd":60,"column":17,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":true},"children":{}},"colorKey":{"doclet":{"type":{"names":["string"]},"defaultvalue":"weight"},"meta":{"fullname":"plotOptions.wordcloud.colorKey","name":"colorKey","line":63,"lineEnd":63,"column":4,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":"weight"},"children":{}},"maxFontSize":{"doclet":{"description":"The word with the largest weight will have a font size equal to this\nvalue. The font size of a word is the ratio between its weight and\nthe largest occurring weight, multiplied with the value of\nmaxFontSize.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":25},"meta":{"fullname":"plotOptions.wordcloud.maxFontSize","name":"maxFontSize","line":69,"lineEnd":74,"column":4,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":25},"children":{}},"minFontSize":{"doclet":{"description":"A threshold determining the minimum font size that can be applied to\na word.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.wordcloud.minFontSize","name":"minFontSize","line":64,"lineEnd":67,"column":4,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":1},"children":{}},"placementStrategy":{"doclet":{"description":"This option decides which algorithm is used for placement, and\nrotation of a word. The choice of algorithm is therefore a crucial\npart of the resulting layout of the wordcloud. It is possible for\nusers to add their own custom placement strategies for use in word\ncloud. Read more about it in our\n[documentation](https://www.highcharts.com/docs/chart-and-series-types/word-cloud-series#custom-placement-strategies)","values":"[\"center\", \"random\"]","since":"6.0.0","type":{"names":["string"]},"defaultvalue":"center"},"meta":{"fullname":"plotOptions.wordcloud.placementStrategy","name":"placementStrategy","line":76,"lineEnd":85,"column":4,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":"center"},"children":{}},"rotation":{"doclet":{"description":"Rotation options for the words in the wordcloud.","samples":[{"name":"Word cloud with rotation","value":"highcharts/plotoptions/wordcloud-rotation"}],"since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.wordcloud.rotation","name":"rotation","line":87,"lineEnd":92,"column":4,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js"},"children":{"from":{"doclet":{"description":"The smallest degree of rotation for a word.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.wordcloud.rotation.from","name":"from","line":94,"lineEnd":96,"column":8,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":0},"children":{}},"orientations":{"doclet":{"description":"The number of possible orientations for a word, within the range\nof `rotation.from` and `rotation.to`. Must be a number larger\nthan 0.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.wordcloud.rotation.orientations","name":"orientations","line":98,"lineEnd":102,"column":8,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":2},"children":{}},"to":{"doclet":{"description":"The largest degree of rotation for a word.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":90},"meta":{"fullname":"plotOptions.wordcloud.rotation.to","name":"to","line":104,"lineEnd":106,"column":8,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":90},"children":{}}}},"showInLegend":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"plotOptions.wordcloud.showInLegend","name":"showInLegend","line":109,"lineEnd":109,"column":4,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":false},"children":{}},"spiral":{"doclet":{"description":"Spiral used for placing a word after the initial position\nexperienced a collision with either another word or the borders.\nIt is possible for users to add their own custom spiralling\nalgorithms for use in word cloud. Read more about it in our\n[documentation](https://www.highcharts.com/docs/chart-and-series-types/word-cloud-series#custom-spiralling-algorithm)","values":"[\"archimedean\", \"rectangular\", \"square\"]","since":"6.0.0","type":{"names":["string"]},"defaultvalue":"rectangular"},"meta":{"fullname":"plotOptions.wordcloud.spiral","name":"spiral","line":110,"lineEnd":118,"column":4,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":"rectangular"},"children":{}},"style":{"doclet":{"description":"CSS styles for the words.","type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"fontFamily\":\"sans-serif\", \"fontWeight\": \"900\"}","since":"6.0.0"},"meta":{"fullname":"plotOptions.wordcloud.style","name":"style","line":120,"lineEnd":125,"column":4,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js"},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.wordcloud.tooltip","name":"tooltip","line":134,"lineEnd":134,"column":4,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js"},"children":{"followPointer":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.wordcloud.tooltip.followPointer","name":"followPointer","line":135,"lineEnd":135,"column":8,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":true},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> {series.name}: <b>{point.weight}</b><br/>"},"meta":{"fullname":"plotOptions.wordcloud.tooltip.pointFormat","name":"pointFormat","line":136,"lineEnd":136,"column":8,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> {series.name}: <b>{point.weight}</b><br/>"},"children":{}}}}}},"xrange":{"doclet":{"description":"The X-range series displays ranges on the X axis, typically time\nintervals with a start and end date.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `xrange` series are defined in\n   [plotOptions.xrange](plotOptions.xrange).\n3. Options for one single series are given in\n   [the series instance array](series.xrange).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        xrange: {\n            // shared options for all xrange series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'xrange'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.xrange.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === xrange) {\n    // code specific to the xrange series\n}\n```\n            ","samples":[{"name":"X-range","value":"highcharts/demo/x-range/","products":["highcharts"]},{"name":"Styled mode X-range","value":"highcharts/css/x-range/","products":["highcharts"]},{"name":"Inverted X-range","value":"highcharts/chart/inverted-xrange/","products":["highcharts"]}],"extends":"plotOptions.column","since":"6.0.0","products":["highcharts","highstock","gantt"],"exclude":["boostThreshold","crisp","cropThreshold","depth","edgeColor","edgeWidth","findNearestPointBy","getExtremesFromAll","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","softThreshold","stacking","threshold","data","dataSorting","boostBlending"],"requires":["module:modules/xrange"]},"meta":{"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js","name":"xrange","fullname":"plotOptions.xrange","line":15,"lineEnd":19,"column":0},"children":{"borderRadius":{"doclet":{"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"plotOptions.xrange.borderRadius","name":"borderRadius","line":88,"lineEnd":88,"column":4,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js","default":3},"children":{}},"colorByPoint":{"doclet":{"description":"In an X-range series, this option makes all points of the same Y-axis\ncategory the same color.","since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.xrange.colorByPoint","name":"colorByPoint","line":43,"lineEnd":54,"column":4,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js","default":true},"children":{}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.xrange.dataLabels","name":"dataLabels","line":68,"lineEnd":68,"column":4,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{"inside":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"plotOptions.xrange.dataLabels.inside","name":"inside","line":78,"lineEnd":78,"column":8,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js","default":true},"children":{}},"style":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.xrange.dataLabels.style","name":"style","line":80,"lineEnd":80,"column":8,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{"whiteSpace":{"doclet":{"type":{"names":["string"]},"defaultvalue":"nowrap"},"meta":{"fullname":"plotOptions.xrange.dataLabels.style.whiteSpace","name":"whiteSpace","line":81,"lineEnd":81,"column":12,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js","default":"nowrap"},"children":{}}}},"verticalAlign":{"doclet":{"type":{"names":["string"]},"defaultvalue":"middle"},"meta":{"fullname":"plotOptions.xrange.dataLabels.verticalAlign","name":"verticalAlign","line":79,"lineEnd":79,"column":8,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js","default":"middle"},"children":{}}}},"dragDrop":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"draggableX1":{"doclet":{"description":"Allow x value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.xrange.dragDrop.draggableX1","name":"draggableX1","line":462,"lineEnd":469,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}},"draggableX2":{"doclet":{"description":"Allow x2 value to be dragged individually.","type":{"names":["boolean"]},"defaultvalue":"true","requires":["module:modules/draggable-points"]},"meta":{"fullname":"plotOptions.xrange.dragDrop.draggableX2","name":"draggableX2","line":480,"lineEnd":487,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropProps.js"},"children":{}}}},"partialFill":{"doclet":{"description":"A partial fill for each point, typically used to visualize how much\nof a task is performed. The partial fill object can be set either on\nseries or point level. When set as a number, works as\n`{ amount: number }`.","samples":[{"name":"X-range with partial fill","value":"highcharts/demo/x-range","products":["highcharts"]}],"products":["highcharts","highstock","gantt"],"since":"6.0.0","type":{"names":["*"]}},"meta":{"fullname":"plotOptions.xrange.partialFill","name":"partialFill","line":43,"lineEnd":54,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{"fill":{"doclet":{"description":"The fill color to be used for partial fills. Defaults to a darker\nshade of the point color.","type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock","gantt"],"since":"6.0.0"},"meta":{"fullname":"plotOptions.xrange.partialFill.fill","name":"fill","line":55,"lineEnd":62,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{}}}},"pointRange":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"plotOptions.xrange.pointRange","name":"pointRange","line":89,"lineEnd":89,"column":4,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js","default":0},"children":{}},"tooltip":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.xrange.tooltip","name":"tooltip","line":84,"lineEnd":84,"column":4,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{"headerFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"font-size: 0.8em\">{ucfirst point.x} - {point.x2}</span><br/>"},"meta":{"fullname":"plotOptions.xrange.tooltip.headerFormat","name":"headerFormat","line":85,"lineEnd":85,"column":8,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js","default":"<span style=\"font-size: 0.8em\">{ucfirst point.x} - {point.x2}</span><br/>"},"children":{}},"pointFormat":{"doclet":{"type":{"names":["string"]},"defaultvalue":"<span style=\"color:{point.color}\">●</span> {series.name}: <b>{point.yCategory}</b><br/>"},"meta":{"fullname":"plotOptions.xrange.tooltip.pointFormat","name":"pointFormat","line":86,"lineEnd":86,"column":8,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js","default":"<span style=\"color:{point.color}\">●</span> {series.name}: <b>{point.yCategory}</b><br/>"},"children":{}}}}}},"zigzag":{"doclet":{"description":"Zig Zag indicator.\n\nThis series requires `linkedTo` option to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `zigzag` series are defined in\n   [plotOptions.zigzag](plotOptions.zigzag).\n3. Options for one single series are given in\n   [the series instance array](series.zigzag).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        zigzag: {\n            // shared options for all zigzag series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'zigzag'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.zigzag.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === zigzag) {\n    // code specific to the zigzag series\n}\n```\n            ","samples":[{"name":"Zig Zag indicator","value":"stock/indicators/zigzag"}],"extends":"plotOptions.sma","since":"6.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/zigzag"]},"meta":{"filename":"code/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js","name":"zigzag","fullname":"plotOptions.zigzag","line":129,"lineEnd":133,"column":0},"children":{"params":{"doclet":{"exclude":["index","period"],"type":{"names":["*"]}},"meta":{"fullname":"plotOptions.zigzag.params","name":"params","line":150,"lineEnd":152,"column":4,"filename":"code/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js"},"children":{"deviation":{"doclet":{"description":"The threshold for the value change.\n\nFor example deviation=1 means the indicator will ignore all price\nmovements less than 1%.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.zigzag.params.deviation","name":"deviation","line":173,"lineEnd":178,"column":8,"filename":"code/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js","default":1},"children":{}},"highIndex":{"doclet":{"description":"The point index which indicator calculations will base - high\nvalue.\n\nFor example using OHLC data, index=1 means the indicator will be\ncalculated using High values.","type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"plotOptions.zigzag.params.highIndex","name":"highIndex","line":165,"lineEnd":171,"column":8,"filename":"code/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js","default":1},"children":{}},"index":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.zigzag.params.index","name":"index","line":154,"lineEnd":154,"column":8,"filename":"code/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js","default":"undefined"},"children":{}},"lowIndex":{"doclet":{"description":"The point index which indicator calculations will base - low\nvalue.\n\nFor example using OHLC data, index=2 means the indicator will be\ncalculated using Low values.","type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"plotOptions.zigzag.params.lowIndex","name":"lowIndex","line":157,"lineEnd":163,"column":8,"filename":"code/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js","default":2},"children":{}},"period":{"doclet":{"type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"plotOptions.zigzag.params.period","name":"period","line":156,"lineEnd":156,"column":8,"filename":"code/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js","default":"undefined"},"children":{}}}}}}}},"rangeSelector":{"doclet":{"description":"The range selector is a tool for selecting ranges to display within\nthe chart. It provides buttons to select preconfigured ranges in\nthe chart, like 1 day, 1 week, 1 month etc. It also provides input\nboxes where min and max dates can be manually input.","products":["highstock","gantt"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","name":"rangeSelector","fullname":"rangeSelector","line":69,"lineEnd":77,"column":0},"children":{"allButtonsEnabled":{"doclet":{"description":"Whether to enable all buttons from the start. By default buttons are\nonly enabled if the corresponding time range exists on the X axis,\nbut enabling all buttons allows for dynamically loading different\ntime ranges.","samples":[{"name":"All buttons enabled","value":"stock/rangeselector/allbuttonsenabled-true/","products":["highstock"]}],"since":"2.0.3","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"rangeSelector.allButtonsEnabled","name":"allButtonsEnabled","line":79,"lineEnd":89,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":false},"children":{}},"buttonPosition":{"doclet":{"description":"Positioning for the button row.","since":"1.2.4","type":{"names":["*"]}},"meta":{"fullname":"rangeSelector.buttonPosition","name":"buttonPosition","line":481,"lineEnd":485,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{"align":{"doclet":{"description":"The alignment of the input box. Allowed properties are `left`,\n`center`, `right`.","samples":[{"name":"Opposite alignment","value":"stock/rangeselector/input-button-opposite-alignment/","products":["highstock"]},{"name":"Same alignment for buttons and input","value":"stock/rangeselector/input-button-same-alignment/","products":["highstock"]}],"type":{"names":["Highcharts.AlignValue"]},"since":"6.0.0","defaultvalue":"left"},"meta":{"fullname":"rangeSelector.buttonPosition.align","name":"align","line":487,"lineEnd":499,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"left"},"children":{}},"x":{"doclet":{"description":"X offset of the button row.","since":"1.2.4","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"rangeSelector.buttonPosition.x","name":"x","line":501,"lineEnd":503,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"Y offset of the button row.","since":"1.2.4","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"rangeSelector.buttonPosition.y","name":"y","line":505,"lineEnd":507,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":0},"children":{}}}},"buttonSpacing":{"doclet":{"description":"The space in pixels between the buttons in the range selector.","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"rangeSelector.buttonSpacing","name":"buttonSpacing","line":149,"lineEnd":156,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":5},"children":{}},"buttonTheme":{"doclet":{"description":"A collection of attributes for the buttons. The object takes SVG\nattributes like `fill`, `stroke`, `stroke-width`, as well as `style`,\na collection of CSS properties for the text.\n\nThe object can also be extended with states, so you can set\npresentational options for `hover`, `select` or `disabled` button\nstates.\n\nCSS styles for the text label.\n\nIn styled mode, the buttons are styled by the\n`.highcharts-range-selector-buttons .highcharts-button` rule with its\ndifferent states.","samples":[{"name":"Styling the buttons and inputs","value":"stock/rangeselector/styling/","products":["highstock"]}],"type":{"names":["Highcharts.SVGAttributes"]}},"meta":{"fullname":"rangeSelector.buttonTheme","name":"buttonTheme","line":290,"lineEnd":309,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}},"buttons":{"doclet":{"description":"An array of configuration objects for the buttons.\n\nDefaults to:\n```js\nbuttons: [{\n    type: 'month',\n    count: 1,\n    text: '1m',\n    title: 'View 1 month'\n}, {\n    type: 'month',\n    count: 3,\n    text: '3m',\n    title: 'View 3 months'\n}, {\n    type: 'month',\n    count: 6,\n    text: '6m',\n    title: 'View 6 months'\n}, {\n    type: 'ytd',\n    text: 'YTD',\n    title: 'View year to date'\n}, {\n    type: 'year',\n    count: 1,\n    text: '1y',\n    title: 'View 1 year'\n}, {\n    type: 'all',\n    text: 'All',\n    title: 'View all'\n}]\n```","samples":[{"name":"Data grouping by buttons","value":"stock/demo/rangeselector-datagrouping/","products":["highstock"]}],"type":{"names":["Array.<*>"]}},"meta":{"fullname":"rangeSelector.buttons","name":"buttons","line":91,"lineEnd":131,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{"count":{"doclet":{"description":"How many units of the defined type the button should span. If `type`\nis \"month\" and `count` is 3, the button spans three months.","type":{"names":["number"]},"defaultvalue":"1"},"meta":{"fullname":"rangeSelector.buttons.count","name":"count","line":149,"lineEnd":156,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}},"dataGrouping":{"doclet":{"description":"A custom data grouping object for each button.","see":["[series.dataGrouping](#plotOptions.series.dataGrouping)"],"samples":[{"name":"Data grouping by range selector buttons","value":"stock/demo/rangeselector-datagrouping/","products":["highstock"]}],"type":{"names":["*"]},"extends":"plotOptions.series.dataGrouping"},"meta":{"fullname":"rangeSelector.buttons.dataGrouping","name":"dataGrouping","line":213,"lineEnd":224,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}},"events":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"click":{"doclet":{"description":"Fires when clicking on the rangeSelector button. One parameter,\nevent, is passed to the function, containing common event\ninformation.\n\n```js\nclick: function(e) {\n  console.log(this);\n}\n```\n\nReturn false to stop default button's click action.","samples":[{"name":"Click event on the button","value":"stock/rangeselector/button-click/","products":["highstock"]}],"type":{"names":["Highcharts.RangeSelectorClickCallbackFunction"]}},"meta":{"fullname":"rangeSelector.buttons.events.click","name":"click","line":157,"lineEnd":175,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}}}},"offsetMax":{"doclet":{"description":"Additional range (in milliseconds) added to the end of the calculated\ntime span.","samples":[{"name":"Button offsets","value":"stock/rangeselector/min-max-offsets/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"6.0.0"},"meta":{"fullname":"rangeSelector.buttons.offsetMax","name":"offsetMax","line":176,"lineEnd":187,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}},"offsetMin":{"doclet":{"description":"Additional range (in milliseconds) added to the start of the\ncalculated time span.","samples":[{"name":"Button offsets","value":"stock/rangeselector/min-max-offsets/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"6.0.0"},"meta":{"fullname":"rangeSelector.buttons.offsetMin","name":"offsetMin","line":188,"lineEnd":199,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}},"preserveDataGrouping":{"doclet":{"description":"When buttons apply dataGrouping on a series, by default zooming\nin/out will deselect buttons and unset dataGrouping. Enable this\noption to keep buttons selected when extremes change.","samples":[{"name":"Different preserveDataGrouping settings","value":"stock/rangeselector/preserve-datagrouping/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"6.1.2"},"meta":{"fullname":"rangeSelector.buttons.preserveDataGrouping","name":"preserveDataGrouping","line":200,"lineEnd":212,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}},"text":{"doclet":{"description":"The text for the button itself.","type":{"names":["string"]}},"meta":{"fullname":"rangeSelector.buttons.text","name":"text","line":225,"lineEnd":230,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}},"title":{"doclet":{"description":"Explanation for the button, shown as a tooltip on hover, and used by\nassistive technology.","type":{"names":["string"]}},"meta":{"fullname":"rangeSelector.buttons.title","name":"title","line":231,"lineEnd":237,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}},"type":{"doclet":{"description":"Defined the time span for the button. Can be one of `millisecond`,\n`second`, `minute`, `hour`, `day`, `week`, `month`, `year`, `ytd`,\nand `all`.","type":{"names":["Highcharts.RangeSelectorButtonTypeValue"]}},"meta":{"fullname":"rangeSelector.buttons.type","name":"type","line":238,"lineEnd":245,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}}}},"dropdown":{"doclet":{"description":"Whether to collapse the range selector buttons into a dropdown when\nthere is not enough room to show everything in a single row, instead\nof dividing the range selector into multiple rows.\nCan be one of the following:\n - `always`: Always collapse\n - `responsive`: Only collapse when there is not enough room\n - `never`: Never collapse","samples":[{"name":"Dropdown option","value":"stock/rangeselector/dropdown/","products":["highstock"]}],"values":"[\"always\", \"responsive\", \"never\"]","since":"9.0.0","type":{"names":["string"]},"defaultvalue":"responsive"},"meta":{"fullname":"rangeSelector.dropdown","name":"dropdown","line":250,"lineEnd":264,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"responsive"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the range selector. Default to `true` for stock\ncharts, using the `stockChart` factory.","samples":[{"name":"Disable the range selector","value":"stock/rangeselector/enabled/","products":["highstock"]}],"type":{"names":["boolean","undefined"]},"defaultByProduct":{"highstock":true},"defaultvalue":"undefined"},"meta":{"fullname":"rangeSelector.enabled","name":"enabled","line":266,"lineEnd":275,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"undefined"},"children":{}},"floating":{"doclet":{"description":"When the rangeselector is floating, the plot area does not reserve\nspace for it. This opens for positioning anywhere on the chart.","samples":[{"name":"Placing the range selector between the plot area and the navigator","value":"stock/rangeselector/floating/","products":["highstock"]}],"since":"6.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"rangeSelector.floating","name":"floating","line":320,"lineEnd":329,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":false},"children":{}},"height":{"doclet":{"description":"Deprecated. The height of the range selector. Currently it is\ncalculated dynamically.","deprecated":true,"type":{"names":["number","undefined"]},"since":"2.1.9","defaultvalue":null},"meta":{"fullname":"rangeSelector.height","name":"height","line":345,"lineEnd":352,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"undefined"},"children":{}},"inputBoxBorderColor":{"doclet":{"description":"The border color of the date input boxes.","samples":[{"name":"Styling the buttons and inputs","value":"stock/rangeselector/styling/","products":["highstock"]}],"type":{"names":["Highcharts.ColorString"]},"since":"1.3.7","defaultvalue":"none"},"meta":{"fullname":"rangeSelector.inputBoxBorderColor","name":"inputBoxBorderColor","line":353,"lineEnd":353,"column":20,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"none"},"children":{}},"inputBoxHeight":{"doclet":{"description":"The pixel height of the date input boxes.","samples":[{"name":"Styling the buttons and inputs","value":"stock/rangeselector/styling/","products":["highstock"]}],"since":"1.3.7","type":{"names":["number"]},"defaultvalue":17},"meta":{"fullname":"rangeSelector.inputBoxHeight","name":"inputBoxHeight","line":364,"lineEnd":371,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":17},"children":{}},"inputBoxWidth":{"doclet":{"description":"The pixel width of the date input boxes. When `undefined`, the width\nis fitted to the rendered content.","samples":[{"name":"Styling the buttons and inputs","value":"stock/rangeselector/styling/","products":["highstock"]}],"type":{"names":["number","undefined"]},"since":"1.3.7","defaultvalue":null},"meta":{"fullname":"rangeSelector.inputBoxWidth","name":"inputBoxWidth","line":373,"lineEnd":382,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"undefined"},"children":{}},"inputDateFormat":{"doclet":{"description":"The date format in the input boxes when not selected for editing.\nDefaults to `%e %b %Y`.\n\nThis is used to determine which type of input to show,\n`datetime-local`, `date` or `time` and falling back to `text` when\nthe browser does not support the input type or the format contains\nmilliseconds.","samples":[{"name":"Input types","value":"stock/rangeselector/input-type/","products":["highstock"]},{"name":"Milliseconds in the range selector","value":"stock/rangeselector/input-format/","products":["highstock"]}],"type":{"names":["string"]},"defaultvalue":"%[ebY]"},"meta":{"fullname":"rangeSelector.inputDateFormat","name":"inputDateFormat","line":384,"lineEnd":398,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"%[ebY]"},"children":{}},"inputDateParser":{"doclet":{"description":"A custom callback function to parse values entered in the input boxes and\nreturn a valid JavaScript time as milliseconds since 1970. The first\nargument passed is the value to parse, second is a boolean indicating use\nof UTC time. The third is a reference to the `time` object. Time zone can\nbe read from `time.timezone`.\n\nThis will only get called for inputs of type `text`. Since v8.2.3, the\ninput type is dynamically determined based on the granularity of the\n`inputDateFormat` and the browser support.","samples":[{"name":"Milliseconds in the range selector","value":"stock/rangeselector/input-format/","products":["highstock"]}],"type":{"names":["Highcharts.RangeSelectorParseCallbackFunction"]},"since":"1.3.3","defaultvalue":"undefined"},"meta":{"fullname":"rangeSelector.inputDateParser","name":"inputDateParser","line":400,"lineEnd":416,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"undefined"},"children":{}},"inputEditDateFormat":{"doclet":{"description":"The date format in the input boxes when they are selected for\nediting. This must be a format that is recognized by JavaScript\nDate.parse.\n\nThis will only be used for inputs of type `text`. Since v8.2.3,\nthe input type is dynamically determined based on the granularity\nof the `inputDateFormat` and the browser support.","samples":[{"name":"Milliseconds in the range selector","value":"stock/rangeselector/input-format/","products":["highstock"]}],"type":{"names":["string"]},"defaultvalue":"%Y-%m-%d"},"meta":{"fullname":"rangeSelector.inputEditDateFormat","name":"inputEditDateFormat","line":418,"lineEnd":430,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"%Y-%m-%d"},"children":{}},"inputEnabled":{"doclet":{"description":"Enable or disable the date input boxes.","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"rangeSelector.inputEnabled","name":"inputEnabled","line":432,"lineEnd":434,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":true},"children":{}},"inputPosition":{"doclet":{"description":"Positioning for the input boxes. Allowed properties are `align`,\n `x` and `y`.","since":"1.2.4","type":{"names":["*"]}},"meta":{"fullname":"rangeSelector.inputPosition","name":"inputPosition","line":436,"lineEnd":441,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{"align":{"doclet":{"description":"The alignment of the input box. Allowed properties are `left`,\n`center`, `right`.","samples":[{"name":"Opposite alignment","value":"stock/rangeselector/input-button-opposite-alignment/","products":["highstock"]},{"name":"Same alignment for buttons and input","value":"stock/rangeselector/input-button-same-alignment/","products":["highstock"]}],"type":{"names":["Highcharts.AlignValue"]},"since":"6.0.0","defaultvalue":"right"},"meta":{"fullname":"rangeSelector.inputPosition.align","name":"align","line":443,"lineEnd":455,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"right"},"children":{}},"x":{"doclet":{"description":"X offset of the input row.","since":"1.2.4","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"rangeSelector.inputPosition.x","name":"x","line":457,"lineEnd":459,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"Y offset of the input row.","since":"1.2.4","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"rangeSelector.inputPosition.y","name":"y","line":461,"lineEnd":463,"column":8,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":0},"children":{}}}},"inputSpacing":{"doclet":{"description":"The space in pixels between the labels and the date input boxes in\nthe range selector.","since":"9.0.0","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"rangeSelector.inputSpacing","name":"inputSpacing","line":466,"lineEnd":471,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":5},"children":{}},"inputStyle":{"doclet":{"description":"CSS for the HTML inputs in the range selector.\n\nIn styled mode, the inputs are styled by the\n`.highcharts-range-input text` rule in SVG mode, and\n`input.highcharts-range-selector` when active.","samples":[{"name":"Styling the buttons and inputs","value":"stock/rangeselector/styling/","products":["highstock"]}],"type":{"names":["Highcharts.CSSObject"]}},"meta":{"fullname":"rangeSelector.inputStyle","name":"inputStyle","line":510,"lineEnd":522,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}},"labelStyle":{"doclet":{"description":"CSS styles for the labels - the Zoom, From and To texts.\n\nIn styled mode, the labels are styled by the\n`.highcharts-range-label` class.","samples":[{"name":"Styling the buttons and inputs","value":"stock/rangeselector/styling/","products":["highstock"]}],"type":{"names":["Highcharts.CSSObject"]}},"meta":{"fullname":"rangeSelector.labelStyle","name":"labelStyle","line":531,"lineEnd":541,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js"},"children":{}},"selected":{"doclet":{"description":"The index of the button to appear pre-selected. If the selected range\nexceeds the total data range and the 'all' option is available,\nthe 'all' option, showing the full range, is automatically selected.","type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"rangeSelector.selected","name":"selected","line":473,"lineEnd":479,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"undefined"},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of the rangeselector box. Allowed properties\nare `top`, `middle`, `bottom`.","samples":[{"name":"Middle","value":"stock/rangeselector/vertical-align-middle/","products":["highstock"]},{"name":"Bottom","value":"stock/rangeselector/vertical-align-bottom/","products":["highstock"]}],"type":{"names":["Highcharts.VerticalAlignValue"]},"since":"6.0.0","defaultvalue":"top"},"meta":{"fullname":"rangeSelector.verticalAlign","name":"verticalAlign","line":277,"lineEnd":288,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":"top"},"children":{}},"x":{"doclet":{"description":"The x offset of the range selector relative to its horizontal\nalignment within `chart.spacingLeft` and `chart.spacingRight`.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"rangeSelector.x","name":"x","line":331,"lineEnd":336,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"The y offset of the range selector relative to its horizontal\nalignment within `chart.spacingLeft` and `chart.spacingRight`.","since":"6.0.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"rangeSelector.y","name":"y","line":338,"lineEnd":343,"column":4,"filename":"code/es-modules/Stock/RangeSelector/RangeSelectorDefaults.js","default":0},"children":{}}}},"responsive":{"doclet":{"description":"Allows setting a set of rules to apply for different screen or chart\nsizes. Each rule specifies additional chart options.","samples":[{"name":"Stock chart","value":"stock/demo/responsive/","products":["highstock"]},{"name":"Axis","value":"highcharts/responsive/axis/"},{"name":"Legend","value":"highcharts/responsive/legend/"},{"name":"Class name","value":"highcharts/responsive/classname/"}],"since":"5.0.0","type":{"names":["*"]}},"meta":{"fullname":"responsive","name":"responsive","line":156,"lineEnd":171,"filename":"code/es-modules/Core/Responsive.js"},"children":{"rules":{"doclet":{"description":"A set of rules for responsive settings. The rules are executed from\nthe top down.","samples":[{"name":"Axis changes","value":"highcharts/responsive/axis/","products":["highcharts"]},{"name":"Axis changes","value":"highcharts/responsive/axis/","products":["highstock"]},{"name":"Axis changes","value":"highcharts/responsive/axis/","products":["highmaps"]}],"type":{"names":["Array.<*>"]},"since":"5.0.0"},"meta":{"fullname":"responsive.rules","name":"rules","line":172,"lineEnd":186,"filename":"code/es-modules/Core/Responsive.js"},"children":{"chartOptions":{"doclet":{"description":"A full set of chart options to apply as overrides to the general\nchart options. The chart options are applied when the given rule\nis active.\n\nA special case is configuration objects that take arrays, for example\n[xAxis](#xAxis), [yAxis](#yAxis) or [series](#series). For these\ncollections, an `id` option is used to map the new option set to\nan existing object. If an existing object of the same id is not found,\nthe item of the same index updated. So for example, setting `chartOptions`\nwith two series items without an `id`, will cause the existing chart's\ntwo series to be updated with respective options.","samples":[{"name":"Stock chart","value":"stock/demo/responsive/","products":["highstock"]},{"name":"Axis","value":"highcharts/responsive/axis/"},{"name":"Legend","value":"highcharts/responsive/legend/"},{"name":"Class name","value":"highcharts/responsive/classname/"}],"type":{"names":["Highcharts.Options"]},"since":"5.0.0"},"meta":{"fullname":"responsive.rules.chartOptions","name":"chartOptions","line":187,"lineEnd":212,"filename":"code/es-modules/Core/Responsive.js"},"children":{}},"condition":{"doclet":{"description":"Under which conditions the rule applies.","since":"5.0.0","type":{"names":["*"]}},"meta":{"fullname":"responsive.rules.condition","name":"condition","line":213,"lineEnd":218,"filename":"code/es-modules/Core/Responsive.js"},"children":{"callback":{"doclet":{"description":"A callback function to gain complete control on when the responsive\nrule applies. Return `true` if it applies. This opens for checking\nagainst other metrics than the chart size, for example the document\nsize or other elements. Since v12.6.0, the callback also receives `ctx`\nas the first argument, so that arrow functions can access the same\ncontext as regular functions using `this`.","type":{"names":["Highcharts.ResponsiveCallbackFunction"]},"since":"5.0.0","context":"Highcharts.Chart"},"meta":{"fullname":"responsive.rules.condition.callback","name":"callback","line":219,"lineEnd":231,"filename":"code/es-modules/Core/Responsive.js"},"children":{}},"maxHeight":{"doclet":{"description":"The responsive rule applies if the chart height is less than this.","type":{"names":["number"]},"since":"5.0.0"},"meta":{"fullname":"responsive.rules.condition.maxHeight","name":"maxHeight","line":232,"lineEnd":238,"filename":"code/es-modules/Core/Responsive.js"},"children":{}},"maxWidth":{"doclet":{"description":"The responsive rule applies if the chart width is less than this.","samples":[{"name":"Max width is 500","value":"highcharts/responsive/axis/"}],"type":{"names":["number"]},"since":"5.0.0"},"meta":{"fullname":"responsive.rules.condition.maxWidth","name":"maxWidth","line":239,"lineEnd":248,"filename":"code/es-modules/Core/Responsive.js"},"children":{}},"minHeight":{"doclet":{"description":"The responsive rule applies if the chart height is greater than this.","type":{"names":["number"]},"defaultvalue":"0","since":"5.0.0"},"meta":{"fullname":"responsive.rules.condition.minHeight","name":"minHeight","line":249,"lineEnd":256,"filename":"code/es-modules/Core/Responsive.js"},"children":{}},"minWidth":{"doclet":{"description":"The responsive rule applies if the chart width is greater than this.","type":{"names":["number"]},"defaultvalue":"0","since":"5.0.0"},"meta":{"fullname":"responsive.rules.condition.minWidth","name":"minWidth","line":257,"lineEnd":264,"filename":"code/es-modules/Core/Responsive.js"},"children":{}}}}}}}},"scrollbar":{"doclet":{"description":"The scrollbar is a means of panning over the X axis of a stock chart.\nScrollbars can also be applied to other types of axes.\n\nAnother approach to scrollable charts is the [chart.scrollablePlotArea](https://api.highcharts.com/highcharts/chart.scrollablePlotArea) option that\nis especially suitable for simpler cartesian charts on mobile.\n\nIn styled mode, all the presentational options for the\nscrollbar are replaced by the classes `.highcharts-scrollbar-thumb`,\n`.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`,\n`.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`.","samples":[{"name":"A scrollbar on a simple bar chart","value":"stock/yaxis/inverted-bar-scrollbar/"}],"products":["highstock","gantt"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","name":"scrollbar","fullname":"scrollbar","line":12,"lineEnd":16,"column":0},"children":{"barBackgroundColor":{"doclet":{"description":"The background color of the scrollbar itself.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"scrollbar.barBackgroundColor","name":"barBackgroundColor","line":123,"lineEnd":130,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":"#cccccc"},"children":{}},"barBorderColor":{"doclet":{"description":"The color of the scrollbar's border.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"scrollbar.barBorderColor","name":"barBorderColor","line":139,"lineEnd":143,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":"#cccccc"},"children":{}},"barBorderRadius":{"doclet":{"description":"The border rounding radius of the bar.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"scrollbar.barBorderRadius","name":"barBorderRadius","line":51,"lineEnd":56,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":5},"children":{}},"barBorderWidth":{"doclet":{"description":"The width of the bar's border.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"scrollbar.barBorderWidth","name":"barBorderWidth","line":132,"lineEnd":137,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":0},"children":{}},"buttonArrowColor":{"doclet":{"description":"The color of the small arrow inside the scrollbar buttons.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#333333"},"meta":{"fullname":"scrollbar.buttonArrowColor","name":"buttonArrowColor","line":145,"lineEnd":152,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":"#333333"},"children":{}},"buttonBackgroundColor":{"doclet":{"description":"The color of scrollbar buttons.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#e6e6e6"},"meta":{"fullname":"scrollbar.buttonBackgroundColor","name":"buttonBackgroundColor","line":154,"lineEnd":161,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":"#e6e6e6"},"children":{}},"buttonBorderColor":{"doclet":{"description":"The color of the border of the scrollbar buttons.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"scrollbar.buttonBorderColor","name":"buttonBorderColor","line":163,"lineEnd":170,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":"#cccccc"},"children":{}},"buttonBorderRadius":{"doclet":{"description":"The corner radius of the scrollbar buttons.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"scrollbar.buttonBorderRadius","name":"buttonBorderRadius","line":58,"lineEnd":63,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":0},"children":{}},"buttonBorderWidth":{"doclet":{"description":"The border width of the scrollbar buttons.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"scrollbar.buttonBorderWidth","name":"buttonBorderWidth","line":172,"lineEnd":177,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":1},"children":{}},"buttonsEnabled":{"doclet":{"description":"Enable or disable the buttons at the end of the scrollbar.","since":"11.0.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"scrollbar.buttonsEnabled","name":"buttonsEnabled","line":65,"lineEnd":69,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":false},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the scrollbar.","samples":[{"name":"Disable the scrollbar, only use navigator","value":"stock/scrollbar/enabled/"}],"type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"scrollbar.enabled","name":"enabled","line":71,"lineEnd":80,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js"},"children":{}},"height":{"doclet":{"description":"The height of the scrollbar. If `buttonsEnabled` is true , the height\nalso applies to the width of the scroll arrows so that they are always\nsquares.","samples":[{"name":"Non-default height","value":"stock/scrollbar/style/"}],"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"scrollbar.height","name":"height","line":40,"lineEnd":49,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":10},"children":{}},"liveRedraw":{"doclet":{"description":"Whether to redraw the main chart as the scrollbar or the navigator\nzoomed window is moved. Defaults to `true` for modern browsers and\n`false` for legacy IE browsers as well as mobile devices. This option\nworks regardless of whether the scrollbar is enabled or not.","samples":[{"name":"Setting live redraw to false","value":"stock/scrollbar/liveredraw"}],"type":{"names":["boolean"]},"since":"1.3.0","defaultvalue":"undefined"},"meta":{"fullname":"scrollbar.liveRedraw","name":"liveRedraw","line":71,"lineEnd":80,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":"undefined"},"children":{}},"margin":{"doclet":{"description":"The margin between the scrollbar and its axis when the scrollbar is\napplied directly to an axis, or the navigator in case that is enabled.\nDefaults to 10 for axis, 3 for navigator.","type":{"names":["number","undefined"]},"defaultvalue":null},"meta":{"fullname":"scrollbar.margin","name":"margin","line":94,"lineEnd":100,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":"undefined"},"children":{}},"minWidth":{"doclet":{"description":"The minimum width of the scrollbar.","since":"1.2.5","type":{"names":["number"]},"defaultvalue":6},"meta":{"fullname":"scrollbar.minWidth","name":"minWidth","line":102,"lineEnd":106,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":6},"children":{}},"rifleColor":{"doclet":{"description":"The color of the small rifles in the middle of the scrollbar.","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"none"},"meta":{"fullname":"scrollbar.rifleColor","name":"rifleColor","line":179,"lineEnd":183,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":"none"},"children":{}},"showFull":{"doclet":{"description":"Whether to show or hide the scrollbar when the scrolled content is\nzoomed out to it full extent.","type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"scrollbar.showFull","name":"showFull","line":110,"lineEnd":117,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js"},"children":{}},"trackBackgroundColor":{"doclet":{"description":"The color of the track background.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"rgba(255, 255, 255, 0.001)"},"meta":{"fullname":"scrollbar.trackBackgroundColor","name":"trackBackgroundColor","line":185,"lineEnd":192,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":"rgba(255, 255, 255, 0.001)"},"children":{}},"trackBorderColor":{"doclet":{"description":"The color of the border of the scrollbar track.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc"},"meta":{"fullname":"scrollbar.trackBorderColor","name":"trackBorderColor","line":193,"lineEnd":193,"column":56,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":"#cccccc"},"children":{}},"trackBorderRadius":{"doclet":{"description":"The corner radius of the border of the scrollbar track.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"scrollbar.trackBorderRadius","name":"trackBorderRadius","line":203,"lineEnd":208,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":5},"children":{}},"trackBorderWidth":{"doclet":{"description":"The width of the border of the scrollbar track.","samples":[{"name":"Scrollbar styling","value":"stock/scrollbar/style/"}],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"scrollbar.trackBorderWidth","name":"trackBorderWidth","line":210,"lineEnd":215,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":1},"children":{}},"zIndex":{"doclet":{"description":"The z index of the scrollbar group.","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"scrollbar.zIndex","name":"zIndex","line":119,"lineEnd":121,"column":4,"filename":"code/es-modules/Stock/Scrollbar/ScrollbarDefaults.js","default":3},"children":{}}}},"series":{"doclet":{"description":"Series options for specific data and the data itself. In TypeScript you\nhave to cast the series options to specific series types, to get all\npossible options for a series.\n\n```ts\n// TypeScript example\nHighcharts.chart('container', {\n    series: [{\n        color: '#06C',\n        data: [[0, 1], [2, 3]]\n    } as Highcharts.SeriesLineOptions ]\n});\n```","type":{"names":["Array.<*>"]}},"meta":{"fullname":"series","name":"series","line":3627,"lineEnd":3644,"filename":"code/es-modules/Core/Series/Series.js"},"children":{"abands":{"doclet":{"description":"An Acceleration bands indicator. If the [type](#series.abands.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `abands` series are defined in\n   [plotOptions.abands](plotOptions.abands).\n3. Options for one single series are given in\n   [the series instance array](series.abands).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        abands: {\n            // shared options for all abands series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'abands'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.abands.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === abands) {\n    // code specific to the abands series\n}\n```\n            ","extends":"series,plotOptions.abands","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","stacking","showInNavigator",""],"requires":["module:stock/indicators/indicators","module:stock/indicators/acceleration-bands"]},"meta":{"fullname":"series.abands","name":"abands","line":208,"lineEnd":222,"filename":"code/es-modules/Stock/Indicators/ABands/ABandsIndicator.js"},"children":{}},"ad":{"doclet":{"description":"A `AD` series. If the [type](#series.ad.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ad` series are defined in\n   [plotOptions.ad](plotOptions.ad).\n3. Options for one single series are given in\n   [the series instance array](series.ad).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ad: {\n            // shared options for all ad series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ad'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ad.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ad) {\n    // code specific to the ad series\n}\n```\n            ","extends":"series,plotOptions.ad","since":"6.0.0","exclude":["dataParser","dataURL"],"products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/accumulation-distribution"]},"meta":{"fullname":"series.ad","name":"ad","line":129,"lineEnd":140,"filename":"code/es-modules/Stock/Indicators/AD/ADIndicator.js"},"children":{}},"ao":{"doclet":{"description":"An `AO` series. If the [type](#series.ao.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ao` series are defined in\n   [plotOptions.ao](plotOptions.ao).\n3. Options for one single series are given in\n   [the series instance array](series.ao).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ao: {\n            // shared options for all ao series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ao'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ao.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ao) {\n    // code specific to the ao series\n}\n```\n            ","extends":"series,plotOptions.ao","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/ao"]},"meta":{"fullname":"series.ao","name":"ao","line":182,"lineEnd":195,"filename":"code/es-modules/Stock/Indicators/AO/AOIndicator.js"},"children":{}},"apo":{"doclet":{"description":"An `Absolute Price Oscillator` series. If the [type](#series.apo.type) option\nis not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `apo` series are defined in\n   [plotOptions.apo](plotOptions.apo).\n3. Options for one single series are given in\n   [the series instance array](series.apo).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        apo: {\n            // shared options for all apo series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'apo'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.apo.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === apo) {\n    // code specific to the apo series\n}\n```\n            ","extends":"series,plotOptions.apo","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/apo"]},"meta":{"fullname":"series.apo","name":"apo","line":130,"lineEnd":143,"filename":"code/es-modules/Stock/Indicators/APO/APOIndicator.js"},"children":{}},"arcdiagram":{"doclet":{"description":"An `arcdiagram` series. If the [type](#series.arcdiagram.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `arcdiagram` series are defined in\n   [plotOptions.arcdiagram](plotOptions.arcdiagram).\n3. Options for one single series are given in\n   [the series instance array](series.arcdiagram).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        arcdiagram: {\n            // shared options for all arcdiagram series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'arcdiagram'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.arcdiagram.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === arcdiagram) {\n    // code specific to the arcdiagram series\n}\n```\n            ","extends":"series,plotOptions.arcdiagram","exclude":["dataSorting","boostThreshold","boostBlending","curveFactor","connectEnds","connectNulls","colorAxis","colorKey","dataSorting","dragDrop","getExtremesFromAll","nodePadding","centerInCategory","pointInterval","pointIntervalUnit","pointPlacement","pointStart","relativeXValue","softThreshold","stack","stacking","step","xAxis","yAxis"],"products":["highcharts"],"requires":["module:modules/sankey","module:modules/arc-diagram"]},"meta":{"fullname":"series.arcdiagram","name":"arcdiagram","line":161,"lineEnd":176,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `arcdiagram` series type,\npoints can be given in the following way:\n\nAn array of objects with named values. The following snippet shows only a few\nsettings, see the complete options set below. If the total number of data\npoints exceeds the series' [turboThreshold](#series.area.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        from: 'Category1',\n        to: 'Category2',\n        weight: 2\n    }, {\n        from: 'Category1',\n        to: 'Category3',\n        weight: 5\n    }]\n ```","type":{"names":["Array.<*>"]},"extends":"series.sankey.data","products":["highcharts"],"exclude":["outgoing"]},"meta":{"fullname":"series.arcdiagram.data","name":"data","line":207,"lineEnd":233,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{"dataLabels":{"doclet":{"type":{"names":["Highcharts.SeriesArcDiagramDataLabelsOptionsObject","Array.<Highcharts.SeriesArcDiagramDataLabelsOptionsObject>"]},"products":["highcharts"]},"meta":{"fullname":"series.arcdiagram.data.dataLabels","name":"dataLabels","line":234,"lineEnd":238,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{}},"linkWeight":{"doclet":{"description":"The link weight, in pixels. If not set, width is calculated per link,\ndepending on the weight value.","samples":[{"name":"Link weight set on series","value":"highcharts/series-arcdiagram/link-weight"}],"type":{"names":["number"]},"since":"10.0.0","products":["highcharts"]},"meta":{"fullname":"series.arcdiagram.data.linkWeight","name":"linkWeight","line":239,"lineEnd":250,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{}}}},"dataLabels":{"doclet":{"type":{"names":["Highcharts.SeriesArcDiagramDataLabelsOptionsObject","Array.<Highcharts.SeriesArcDiagramDataLabelsOptionsObject>"]},"products":["highcharts"]},"meta":{"fullname":"series.arcdiagram.dataLabels","name":"dataLabels","line":177,"lineEnd":181,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{}},"linkRadius":{"doclet":{"description":"The radius of the link arc. If not set, series renders a semi-circle\nbetween the nodes, except when overflowing the edge of the plot area,\nin which case an arc touching the edge is rendered. If `linkRadius`\nis set, an arc extending to the given value is rendered.","type":{"names":["number"]},"since":"10.0.0","products":["highcharts"]},"meta":{"fullname":"series.arcdiagram.linkRadius","name":"linkRadius","line":97,"lineEnd":107,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{}},"linkWeight":{"doclet":{"description":"The global link weight, in pixels. If not set, width is calculated\nper link, depending on the weight value.","samples":[{"name":"Link weight","value":"highcharts/series-arcdiagram/link-weight"}],"type":{"names":["number"]},"since":"10.0.0","products":["highcharts"]},"meta":{"fullname":"series.arcdiagram.linkWeight","name":"linkWeight","line":108,"lineEnd":119,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{}},"marker":{"doclet":{"extends":"plotOptions.series.marker","exclude":["enabled","enabledThreshold","height","radius","width"]},"meta":{"fullname":"series.arcdiagram.marker","name":"marker","line":182,"lineEnd":186,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{}},"nodes":{"doclet":{"description":"A collection of options for the individual nodes. The nodes in an arc diagram\nare auto-generated instances of `Highcharts.Point`, but options can be\napplied here and linked by the `id`.","extends":"series.sankey.nodes","type":{"names":["Array.<*>"]},"products":["highcharts"],"exclude":["column","level"]},"meta":{"fullname":"series.arcdiagram.nodes","name":"nodes","line":187,"lineEnd":197,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{"dataLabels":{"doclet":{"description":"Individual data label for each node. The options are the same as the ones for\n[series.arcdiagram.dataLabels](#series.arcdiagram.dataLabels).","type":{"names":["Highcharts.SeriesArcDiagramDataLabelsOptionsObject","Array.<Highcharts.SeriesArcDiagramDataLabelsOptionsObject>"]}},"meta":{"fullname":"series.arcdiagram.nodes.dataLabels","name":"dataLabels","line":198,"lineEnd":206,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{}}}},"offset":{"doclet":{"description":"The offset of an arc diagram nodes column in relation to the\n`plotArea`. The offset equal to 50% places nodes in the center of a\nchart. By default the series is placed so that the biggest node is\ntouching the bottom border of the `plotArea`.","type":{"names":["string"]},"since":"10.0.0","defaultvalue":"'100%'","products":["highcharts"]},"meta":{"fullname":"series.arcdiagram.offset","name":"offset","line":137,"lineEnd":148,"filename":"code/es-modules/Series/ArcDiagram/ArcDiagramSeriesDefaults.js"},"children":{}}}},"area":{"doclet":{"description":"A `area` series. If the [type](#series.area.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `area` series are defined in\n   [plotOptions.area](plotOptions.area).\n3. Options for one single series are given in\n   [the series instance array](series.area).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        area: {\n            // shared options for all area series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'area'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.area.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === area) {\n    // code specific to the area series\n}\n```\n            ","extends":"series,plotOptions.area","exclude":["dataParser","dataURL","useOhlcData"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.area","name":"area","line":146,"lineEnd":154,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{"color":{"doclet":{"see":["[fillColor](#series.area.fillColor)","[fillOpacity](#series.area.fillOpacity)"]},"meta":{"fullname":"series.area.color","name":"color","line":155,"lineEnd":160,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{}},"data":{"doclet":{"description":"An array of data points for the series. For the `area` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` * and `pointInterval` given in the series options. If the\n   axis has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 9],\n       [1, 7],\n       [2, 6]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.area.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       y: 9,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 6,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.line.data","products":["highcharts","highstock"]},"meta":{"fullname":"series.area.data","name":"data","line":161,"lineEnd":219,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{}},"fillColor":{"doclet":{"see":["[color](#series.area.color)","[fillOpacity](#series.area.fillOpacity)"]},"meta":{"fullname":"series.area.fillColor","name":"fillColor","line":220,"lineEnd":225,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#series.area.color)","[fillColor](#series.area.fillColor)"],"defaultByProduct":{"highcharts":"0.75","highstock":"0.75"}},"meta":{"fullname":"series.area.fillOpacity","name":"fillOpacity","line":226,"lineEnd":233,"filename":"code/es-modules/Series/Area/AreaSeriesDefaults.js"},"children":{}}}},"arearange":{"doclet":{"description":"A `arearange` series. If the [type](#series.arearange.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `arearange` series are defined in\n   [plotOptions.arearange](plotOptions.arearange).\n3. Options for one single series are given in\n   [the series instance array](series.arearange).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        arearange: {\n            // shared options for all arearange series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'arearange'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.arearange.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === arearange) {\n    // code specific to the arearange series\n}\n```\n            ","extends":"series,plotOptions.arearange","exclude":["dataParser","dataURL","stack","stacking"],"products":["highcharts","highstock"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.arearange","name":"arearange","line":142,"lineEnd":152,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{"color":{"doclet":{"see":["[fillColor](#series.arearange.fillColor)","[fillOpacity](#series.arearange.fillOpacity)"],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"series.arearange.color","name":"color","line":153,"lineEnd":159,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{}},"data":{"doclet":{"description":"An array of data points for the series. For the `arearange` series type,\npoints can be given in the following ways:\n\n1.  An array of arrays with 3 or 2 values. In this case, the values\n    correspond to `x,low,high`. If the first value is a string, it is\n    applied as the name of the point, and the `x` value is inferred.\n    The `x` value can also be omitted, in which case the inner arrays\n    should be of length 2\\. Then the `x` value is automatically calculated,\n    either starting at 0 and incremented by 1, or from `pointStart`\n    and `pointInterval` given in the series options.\n    ```js\n    data: [\n        [0, 8, 3],\n        [1, 1, 1],\n        [2, 6, 8]\n    ]\n    ```\n\n2.  An array of objects with named values. The following snippet shows only a\n    few settings, see the complete options set below. If the total number of\n    data points exceeds the series'\n    [turboThreshold](#series.arearange.turboThreshold),\n    this option is not available.\n    ```js\n    data: [{\n        x: 1,\n        low: 9,\n        high: 0,\n        name: \"Point2\",\n        color: \"#00FF00\"\n    }, {\n        x: 1,\n        low: 3,\n        high: 4,\n        name: \"Point1\",\n        color: \"#FF00FF\"\n    }]\n    ```","samples":[{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number>|Array.<(number|string), number, number>|*)>"]},"extends":"series.line.data","exclude":["marker","y"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.arearange.data","name":"data","line":160,"lineEnd":214,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{"dataLabels":{"doclet":{"extends":"series.arearange.dataLabels","products":["highcharts","highstock"]},"meta":{"fullname":"series.arearange.data.dataLabels","name":"dataLabels","line":215,"lineEnd":219,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{}},"high":{"doclet":{"description":"The high or maximum value for each data point.","type":{"names":["number"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.arearange.data.high","name":"high","line":255,"lineEnd":261,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{}},"low":{"doclet":{"description":"The low or minimum value for each data point.","type":{"names":["number"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.arearange.data.low","name":"low","line":262,"lineEnd":268,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{}}}},"fillColor":{"doclet":{"see":["[color](#series.arearange.color)","[fillOpacity](#series.arearange.fillOpacity)"]},"meta":{"fullname":"series.arearange.fillColor","name":"fillColor","line":220,"lineEnd":225,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#series.arearange.color)","[fillColor](#series.arearange.fillColor)"],"type":{"names":["number"]},"defaultByProduct":{"highcharts":0.75,"highstock":0.75}},"meta":{"fullname":"series.arearange.fillOpacity","name":"fillOpacity","line":226,"lineEnd":234,"filename":"code/es-modules/Series/AreaRange/AreaRangeSeriesDefaults.js"},"children":{}}}},"areaspline":{"doclet":{"description":"A `areaspline` series. If the [type](#series.areaspline.type) option\nis not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `areaspline` series are defined in\n   [plotOptions.areaspline](plotOptions.areaspline).\n3. Options for one single series are given in\n   [the series instance array](series.areaspline).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        areaspline: {\n            // shared options for all areaspline series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'areaspline'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.areaspline.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === areaspline) {\n    // code specific to the areaspline series\n}\n```\n            ","extends":"series,plotOptions.areaspline","exclude":["dataParser","dataURL","step","boostThreshold","boostBlending"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.areaspline","name":"areaspline","line":89,"lineEnd":98,"filename":"code/es-modules/Series/AreaSpline/AreaSplineSeries.js"},"children":{"color":{"doclet":{"see":["[fillColor](#series.areaspline.fillColor)","[fillOpacity](#series.areaspline.fillOpacity)"]},"meta":{"fullname":"series.areaspline.color","name":"color","line":99,"lineEnd":104,"filename":"code/es-modules/Series/AreaSpline/AreaSplineSeries.js"},"children":{}},"data":{"doclet":{"description":"An array of data points for the series. For the `areaspline` series\ntype, points can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 10],\n       [1, 9],\n       [2, 3]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.areaspline.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       y: 4,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 4,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.line.data","products":["highcharts","highstock"]},"meta":{"fullname":"series.areaspline.data","name":"data","line":105,"lineEnd":163,"filename":"code/es-modules/Series/AreaSpline/AreaSplineSeries.js"},"children":{}},"fillColor":{"doclet":{"see":["[color](#series.areaspline.color)","[fillOpacity](#series.areaspline.fillOpacity)"]},"meta":{"fullname":"series.areaspline.fillColor","name":"fillColor","line":164,"lineEnd":169,"filename":"code/es-modules/Series/AreaSpline/AreaSplineSeries.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#series.areaspline.color)","[fillColor](#series.areaspline.fillColor)"],"defaultvalue":"0.75","type":{"names":["number"]}},"meta":{"fullname":"series.areaspline.fillOpacity","name":"fillOpacity","line":170,"lineEnd":176,"filename":"code/es-modules/Series/AreaSpline/AreaSplineSeries.js"},"children":{}}}},"areasplinerange":{"doclet":{"description":"A `areasplinerange` series. If the [type](#series.areasplinerange.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `areasplinerange` series are defined in\n   [plotOptions.areasplinerange](plotOptions.areasplinerange).\n3. Options for one single series are given in\n   [the series instance array](series.areasplinerange).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        areasplinerange: {\n            // shared options for all areasplinerange series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'areasplinerange'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.areasplinerange.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === areasplinerange) {\n    // code specific to the areasplinerange series\n}\n```\n            ","extends":"series,plotOptions.areasplinerange","exclude":["dataParser","dataURL","stack","step","boostThreshold","boostBlending"],"products":["highcharts","highstock"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.areasplinerange","name":"areasplinerange","line":88,"lineEnd":97,"filename":"code/es-modules/Series/AreaSplineRange/AreaSplineRangeSeries.js"},"children":{"color":{"doclet":{"see":["[fillColor](#series.areasplinerange.fillColor)","[fillOpacity](#series.areasplinerange.fillOpacity)"]},"meta":{"fullname":"series.areasplinerange.color","name":"color","line":98,"lineEnd":103,"filename":"code/es-modules/Series/AreaSplineRange/AreaSplineRangeSeries.js"},"children":{}},"data":{"doclet":{"description":"An array of data points for the series. For the `areasplinerange`\nseries type, points can be given in the following ways:\n\n1. An array of arrays with 3 or 2 values. In this case, the values correspond\n   to `x,low,high`. If the first value is a string, it is applied as the name\n   of the point, and the `x` value is inferred. The `x` value can also be\n   omitted, in which case the inner arrays should be of length 2\\. Then the\n   `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 0, 5],\n       [1, 9, 1],\n       [2, 5, 2]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.areasplinerange.turboThreshold), this option is\n   not available.\n   ```js\n   data: [{\n       x: 1,\n       low: 5,\n       high: 0,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       low: 4,\n       high: 1,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number>|Array.<(number|string), number, number>|*)>"]},"extends":"series.arearange.data","products":["highcharts","highstock"]},"meta":{"fullname":"series.areasplinerange.data","name":"data","line":104,"lineEnd":157,"filename":"code/es-modules/Series/AreaSplineRange/AreaSplineRangeSeries.js"},"children":{}},"fillColor":{"doclet":{"see":["[color](#series.areasplinerange.color)","[fillOpacity](#series.areasplinerange.fillOpacity)"]},"meta":{"fullname":"series.areasplinerange.fillColor","name":"fillColor","line":158,"lineEnd":163,"filename":"code/es-modules/Series/AreaSplineRange/AreaSplineRangeSeries.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#series.areasplinerange.color)","[fillColor](#series.areasplinerange.fillColor)"],"defaultvalue":"0.75","type":{"names":["number"]}},"meta":{"fullname":"series.areasplinerange.fillOpacity","name":"fillOpacity","line":164,"lineEnd":170,"filename":"code/es-modules/Series/AreaSplineRange/AreaSplineRangeSeries.js"},"children":{}}}},"aroon":{"doclet":{"description":"A Aroon indicator. If the [type](#series.aroon.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `aroon` series are defined in\n   [plotOptions.aroon](plotOptions.aroon).\n3. Options for one single series are given in\n   [the series instance array](series.aroon).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        aroon: {\n            // shared options for all aroon series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'aroon'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.aroon.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === aroon) {\n    // code specific to the aroon series\n}\n```\n            ","extends":"series,plotOptions.aroon","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/aroon"]},"meta":{"fullname":"series.aroon","name":"aroon","line":169,"lineEnd":182,"filename":"code/es-modules/Stock/Indicators/Aroon/AroonIndicator.js"},"children":{}},"aroonoscillator":{"doclet":{"description":"An `Aroon Oscillator` series. If the [type](#series.aroonoscillator.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `aroonoscillator` series are defined in\n   [plotOptions.aroonoscillator](plotOptions.aroonoscillator).\n3. Options for one single series are given in\n   [the series instance array](series.aroonoscillator).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        aroonoscillator: {\n            // shared options for all aroonoscillator series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'aroonoscillator'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.aroonoscillator.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === aroonoscillator) {\n    // code specific to the aroonoscillator series\n}\n```\n            ","extends":"series,plotOptions.aroonoscillator","since":"7.0.0","products":["highstock"],"exclude":["allAreas","aroonDown","colorAxis","compare","compareBase","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/aroon","module:stock/indicators/aroon-oscillator"]},"meta":{"fullname":"series.aroonoscillator","name":"aroonoscillator","line":102,"lineEnd":117,"filename":"code/es-modules/Stock/Indicators/AroonOscillator/AroonOscillatorIndicator.js"},"children":{}},"atr":{"doclet":{"description":"A `ATR` series. If the [type](#series.atr.type) option is not specified, it\nis inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `atr` series are defined in\n   [plotOptions.atr](plotOptions.atr).\n3. Options for one single series are given in\n   [the series instance array](series.atr).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        atr: {\n            // shared options for all atr series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'atr'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.atr.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === atr) {\n    // code specific to the atr series\n}\n```\n            ","extends":"series,plotOptions.atr","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/atr"]},"meta":{"fullname":"series.atr","name":"atr","line":134,"lineEnd":145,"filename":"code/es-modules/Stock/Indicators/ATR/ATRIndicator.js"},"children":{}},"bar":{"doclet":{"description":"A `bar` series. If the [type](#series.bar.type) option is not specified,\nit is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `bar` series are defined in\n   [plotOptions.bar](plotOptions.bar).\n3. Options for one single series are given in\n   [the series instance array](series.bar).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        bar: {\n            // shared options for all bar series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'bar'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.bar.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === bar) {\n    // code specific to the bar series\n}\n```\n            ","extends":"series,plotOptions.bar","exclude":["connectNulls","dashStyle","dataParser","dataURL","gapSize","gapUnit","linecap","lineWidth","marker","connectEnds","step"],"products":["highcharts"]},"meta":{"fullname":"series.bar","name":"bar","line":65,"lineEnd":74,"filename":"code/es-modules/Series/Bar/BarSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `bar` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 5],\n       [1, 10],\n       [2, 3]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.bar.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       y: 1,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 10,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.column.data","products":["highcharts"]},"meta":{"fullname":"series.bar.data","name":"data","line":75,"lineEnd":133,"filename":"code/es-modules/Series/Bar/BarSeries.js"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"hover":{"doclet":{"exclude":["halo","lineWidth","lineWidthPlus","marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.bar.states.hover","name":"hover","line":134,"lineEnd":138,"filename":"code/es-modules/Series/Bar/BarSeries.js"},"children":{}},"select":{"doclet":{"exclude":["halo","lineWidth","lineWidthPlus","marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.bar.states.select","name":"select","line":139,"lineEnd":143,"filename":"code/es-modules/Series/Bar/BarSeries.js"},"children":{}}}}}},"bb":{"doclet":{"description":"A bollinger bands indicator. If the [type](#series.bb.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `bb` series are defined in\n   [plotOptions.bb](plotOptions.bb).\n3. Options for one single series are given in\n   [the series instance array](series.bb).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        bb: {\n            // shared options for all bb series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'bb'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.bb.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === bb) {\n    // code specific to the bb series\n}\n```\n            ","extends":"series,plotOptions.bb","since":"6.0.0","exclude":["dataParser","dataURL"],"products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/bollinger-bands"]},"meta":{"fullname":"series.bb","name":"bb","line":218,"lineEnd":229,"filename":"code/es-modules/Stock/Indicators/BB/BBIndicator.js"},"children":{}},"bellcurve":{"doclet":{"description":"A `bellcurve` series. If the [type](#series.bellcurve.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nFor options that apply to multiple series, it is recommended to add\nthem to the [plotOptions.series](#plotOptions.series) options structure.\nTo apply to all series of this specific type, apply it to\n[plotOptions.bellcurve](#plotOptions.bellcurve).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `bellcurve` series are defined in\n   [plotOptions.bellcurve](plotOptions.bellcurve).\n3. Options for one single series are given in\n   [the series instance array](series.bellcurve).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        bellcurve: {\n            // shared options for all bellcurve series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'bellcurve'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.bellcurve.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === bellcurve) {\n    // code specific to the bellcurve series\n}\n```\n            ","extends":"series,plotOptions.bellcurve","since":"6.0.0","products":["highcharts"],"exclude":["dataParser","dataURL","data","boostThreshold","boostBlending"],"requires":["module:modules/histogram-bellcurve"]},"meta":{"fullname":"series.bellcurve","name":"bellcurve","line":76,"lineEnd":91,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js"},"children":{"baseSeries":{"doclet":{"description":"An integer identifying the index to use for the base series, or a string\nrepresenting the id of the series.","type":{"names":["number","string"]},"since":"6.0.0"},"meta":{"fullname":"series.bellcurve.baseSeries","name":"baseSeries","line":92,"lineEnd":98,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js"},"children":{}},"color":{"doclet":{"see":["[fillColor](#series.bellcurve.fillColor)","[fillOpacity](#series.bellcurve.fillOpacity)"]},"meta":{"fullname":"series.bellcurve.color","name":"color","line":99,"lineEnd":104,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js"},"children":{}},"fillColor":{"doclet":{"see":["[color](#series.bellcurve.color)","[fillOpacity](#series.bellcurve.fillOpacity)"]},"meta":{"fullname":"series.bellcurve.fillColor","name":"fillColor","line":105,"lineEnd":110,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#series.bellcurve.color)","[fillColor](#series.bellcurve.fillColor)"],"defaultByProduct":{"highcharts":"0.75","highstock":"0.75"}},"meta":{"fullname":"series.bellcurve.fillOpacity","name":"fillOpacity","line":111,"lineEnd":118,"filename":"code/es-modules/Series/Bellcurve/BellcurveSeriesDefaults.js"},"children":{}}}},"boxplot":{"doclet":{"description":"A `boxplot` series. If the [type](#series.boxplot.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `boxplot` series are defined in\n   [plotOptions.boxplot](plotOptions.boxplot).\n3. Options for one single series are given in\n   [the series instance array](series.boxplot).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        boxplot: {\n            // shared options for all boxplot series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'boxplot'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.boxplot.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === boxplot) {\n    // code specific to the boxplot series\n}\n```\n            ","extends":"series,plotOptions.boxplot","exclude":["dataParser","dataURL","marker","stack","stacking","states","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.boxplot","name":"boxplot","line":277,"lineEnd":287,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `boxplot` series\ntype, points can be given in the following ways:\n\n1. An array of arrays with 6 or 5 values. In this case, the values correspond\n   to `x,low,q1,median,q3,high`. If the first value is a string, it is\n   applied as the name of the point, and the `x` value is inferred. The `x`\n   value can also be omitted, in which case the inner arrays should be of\n   length 5. Then the `x` value is automatically calculated, either starting\n   at 0 and incremented by 1, or from `pointStart` and `pointInterval` given\n   in the series options.\n   ```js\n   data: [\n       [0, 3, 0, 10, 3, 5],\n       [1, 7, 8, 7, 2, 9],\n       [2, 6, 9, 5, 1, 3]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.boxplot.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       low: 4,\n       q1: 9,\n       median: 9,\n       q3: 1,\n       high: 10,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       low: 5,\n       q1: 7,\n       median: 3,\n       q3: 6,\n       high: 2,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number, number, number, number>|Array.<(number|string), number, number, number, number, number>|*)>"]},"extends":"series.line.data","exclude":["marker"],"products":["highcharts"]},"meta":{"fullname":"series.boxplot.data","name":"data","line":288,"lineEnd":348,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{"boxDashStyle":{"doclet":{"description":"The dash style of the box.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"8.1.0","products":["highcharts"]},"meta":{"fullname":"series.boxplot.data.boxDashStyle","name":"boxDashStyle","line":388,"lineEnd":401,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"high":{"doclet":{"description":"The `high` value for each data point, signifying the highest value\nin the sample set. The top whisker is drawn here.","type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"series.boxplot.data.high","name":"high","line":349,"lineEnd":356,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"low":{"doclet":{"description":"The `low` value for each data point, signifying the lowest value\nin the sample set. The bottom whisker is drawn here.","type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"series.boxplot.data.low","name":"low","line":357,"lineEnd":364,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"median":{"doclet":{"description":"The median for each data point. This is drawn as a line through the\nmiddle area of the box.","type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"series.boxplot.data.median","name":"median","line":365,"lineEnd":372,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"medianDashStyle":{"doclet":{"description":"The dash style of the median.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"8.1.0","products":["highcharts"]},"meta":{"fullname":"series.boxplot.data.medianDashStyle","name":"medianDashStyle","line":402,"lineEnd":415,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"q1":{"doclet":{"description":"The lower quartile for each data point. This is the bottom of the\nbox.","type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"series.boxplot.data.q1","name":"q1","line":373,"lineEnd":380,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"q3":{"doclet":{"description":"The higher quartile for each data point. This is the top of the box.","type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"series.boxplot.data.q3","name":"q3","line":381,"lineEnd":387,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"stemDashStyle":{"doclet":{"description":"The dash style of the stem.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"8.1.0","products":["highcharts"]},"meta":{"fullname":"series.boxplot.data.stemDashStyle","name":"stemDashStyle","line":416,"lineEnd":429,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}},"whiskerDashStyle":{"doclet":{"description":"The dash style of the whiskers.","samples":[{"name":"Box plot styling","value":"highcharts/plotoptions/box-plot-styling/","products":["highcharts"]},{"name":"Box plot in styled mode","value":"highcharts/css/boxplot/","products":["highcharts"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"8.1.0","products":["highcharts"]},"meta":{"fullname":"series.boxplot.data.whiskerDashStyle","name":"whiskerDashStyle","line":430,"lineEnd":443,"filename":"code/es-modules/Series/BoxPlot/BoxPlotSeriesDefaults.js"},"children":{}}}}}},"bubble":{"doclet":{"description":"A `bubble` series. If the [type](#series.bubble.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `bubble` series are defined in\n   [plotOptions.bubble](plotOptions.bubble).\n3. Options for one single series are given in\n   [the series instance array](series.bubble).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        bubble: {\n            // shared options for all bubble series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'bubble'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.bubble.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === bubble) {\n    // code specific to the bubble series\n}\n```\n            ","extends":"series,plotOptions.bubble","exclude":["dataParser","dataURL","legendSymbolColor","stack"],"products":["highcharts","highstock"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.bubble","name":"bubble","line":642,"lineEnd":651,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `bubble` series type,\npoints can be given in the following ways:\n\n1. An array of arrays with 3 or 2 values. In this case, the values correspond\n   to `x,y,z`. If the first value is a string, it is applied as the name of\n   the point, and the `x` value is inferred. The `x` value can also be\n   omitted, in which case the inner arrays should be of length 2\\. Then the\n   `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 1, 2],\n       [1, 5, 5],\n       [2, 0, 2]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.bubble.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       y: 1,\n       z: 1,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 5,\n       z: 4,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number>|Array.<(number|string), number, number>|*)>"]},"extends":"series.line.data","products":["highcharts"]},"meta":{"fullname":"series.bubble.data","name":"data","line":652,"lineEnd":705,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{"marker":{"doclet":{"extends":"series.line.data.marker","exclude":["enabledThreshold","height","radius","width"],"products":["highcharts"]},"meta":{"fullname":"series.bubble.data.marker","name":"marker","line":706,"lineEnd":711,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{}},"z":{"doclet":{"description":"The size value for each bubble. The bubbles' diameters are computed\nbased on the `z`, and controlled by series options like `minSize`,\n`maxSize`, `sizeBy`, `zMin` and `zMax`.","type":{"names":["number","null"]},"products":["highcharts"]},"meta":{"fullname":"series.bubble.data.z","name":"z","line":712,"lineEnd":720,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{}}}},"marker":{"doclet":{"exclude":["enabled","enabledThreshold","height","radius","width"]},"meta":{"fullname":"series.bubble.marker","name":"marker","line":721,"lineEnd":724,"filename":"code/es-modules/Series/Bubble/BubbleSeries.js"},"children":{}}}},"bullet":{"doclet":{"description":"A `bullet` series. If the [type](#series.bullet.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `bullet` series are defined in\n   [plotOptions.bullet](plotOptions.bullet).\n3. Options for one single series are given in\n   [the series instance array](series.bullet).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        bullet: {\n            // shared options for all bullet series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'bullet'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.bullet.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === bullet) {\n    // code specific to the bullet series\n}\n```\n            ","extends":"series,plotOptions.bullet","since":"6.0.0","products":["highcharts"],"exclude":["dataParser","dataURL","marker","boostThreshold","boostBlending"],"requires":["module:modules/bullet"]},"meta":{"fullname":"series.bullet","name":"bullet","line":92,"lineEnd":103,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `bullet` series type,\npoints can be given in the following ways:\n\n1. An array of arrays with 3 or 2 values. In this case, the values correspond\n   to `x,y,target`. If the first value is a string, it is applied as the name\n   of the point, and the `x` value is inferred. The `x` value can also be\n   omitted, in which case the inner arrays should be of length 2\\. Then the\n   `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 40, 75],\n       [1, 50, 50],\n       [2, 60, 40]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.bullet.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 0,\n       y: 40,\n       target: 75,\n       name: \"Point1\",\n       color: \"#00FF00\"\n   }, {\n        x: 1,\n       y: 60,\n       target: 40,\n       name: \"Point2\",\n       color: \"#FF00FF\"\n   }]\n   ```","type":{"names":["Array.<(Array.<(number|string), number>|Array.<(number|string), number, number>|*)>"]},"extends":"series.column.data","since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"series.bullet.data","name":"data","line":104,"lineEnd":149,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js"},"children":{"target":{"doclet":{"description":"The target value of a point.","type":{"names":["number"]},"since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"series.bullet.data.target","name":"target","line":150,"lineEnd":157,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js"},"children":{}},"targetOptions":{"doclet":{"description":"Individual target options for each point.","extends":"plotOptions.bullet.targetOptions","products":["highcharts"],"since":"6.0.0"},"meta":{"fullname":"series.bullet.data.targetOptions","name":"targetOptions","line":158,"lineEnd":164,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js"},"children":{}}}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"hover":{"doclet":{"products":["highcharts"],"exclude":["halo","lineWidth","lineWidthPlus","marker"]},"meta":{"fullname":"series.bullet.states.hover","name":"hover","line":165,"lineEnd":169,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js"},"children":{}},"select":{"doclet":{"products":["highcharts"],"exclude":["halo","lineWidth","lineWidthPlus","marker"]},"meta":{"fullname":"series.bullet.states.select","name":"select","line":170,"lineEnd":174,"filename":"code/es-modules/Series/Bullet/BulletSeriesDefaults.js"},"children":{}}}}}},"candlestick":{"doclet":{"description":"A `candlestick` series. If the [type](#series.candlestick.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `candlestick` series are defined in\n   [plotOptions.candlestick](plotOptions.candlestick).\n3. Options for one single series are given in\n   [the series instance array](series.candlestick).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        candlestick: {\n            // shared options for all candlestick series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'candlestick'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.candlestick.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === candlestick) {\n    // code specific to the candlestick series\n}\n```\n            ","type":{"names":["*"]},"extends":"series,plotOptions.candlestick","exclude":["dataParser","dataURL","marker"],"products":["highstock"]},"meta":{"fullname":"series.candlestick","name":"candlestick","line":109,"lineEnd":119,"filename":"code/es-modules/Series/Candlestick/CandlestickSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `candlestick` series\ntype, points can be given in the following ways:\n\n1. An array of arrays with 5 or 4 values. In this case, the values correspond\n   to `x,open,high,low,close`. If the first value is a string, it is applied\n   as the name of the point, and the `x` value is inferred. The `x` value can\n   also be omitted, in which case the inner arrays should be of length 4.\n   Then the `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 7, 2, 0, 4],\n       [1, 1, 4, 2, 8],\n       [2, 3, 3, 9, 3]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.candlestick.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       open: 9,\n       high: 2,\n       low: 4,\n       close: 6,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       open: 1,\n       high: 4,\n       low: 7,\n       close: 7,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","type":{"names":["Array.<(Array.<(number|string), number, number, number>|Array.<(number|string), number, number, number, number>|*)>"]},"extends":"series.ohlc.data","exclude":["y"],"products":["highstock"]},"meta":{"fullname":"series.candlestick.data","name":"data","line":120,"lineEnd":169,"filename":"code/es-modules/Series/Candlestick/CandlestickSeriesDefaults.js"},"children":{}}}},"cci":{"doclet":{"description":"A `CCI` series. If the [type](#series.cci.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `cci` series are defined in\n   [plotOptions.cci](plotOptions.cci).\n3. Options for one single series are given in\n   [the series instance array](series.cci).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        cci: {\n            // shared options for all cci series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'cci'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.cci.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === cci) {\n    // code specific to the cci series\n}\n```\n            ","extends":"series,plotOptions.cci","since":"6.0.0","exclude":["dataParser","dataURL"],"products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/cci"]},"meta":{"fullname":"series.cci","name":"cci","line":129,"lineEnd":140,"filename":"code/es-modules/Stock/Indicators/CCI/CCIIndicator.js"},"children":{}},"chaikin":{"doclet":{"description":"A `Chaikin Oscillator` series. If the [type](#series.chaikin.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `chaikin` series are defined in\n   [plotOptions.chaikin](plotOptions.chaikin).\n3. Options for one single series are given in\n   [the series instance array](series.chaikin).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        chaikin: {\n            // shared options for all chaikin series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'chaikin'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.chaikin.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === chaikin) {\n    // code specific to the chaikin series\n}\n```\n            ","extends":"series,plotOptions.chaikin","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","stacking","showInNavigator"],"requires":["module:stock/indicators/indicators","module:stock/indicators/chaikin"]},"meta":{"fullname":"series.chaikin","name":"chaikin","line":149,"lineEnd":162,"filename":"code/es-modules/Stock/Indicators/Chaikin/ChaikinIndicator.js"},"children":{}},"cmf":{"doclet":{"description":"A `CMF` series. If the [type](#series.cmf.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `cmf` series are defined in\n   [plotOptions.cmf](plotOptions.cmf).\n3. Options for one single series are given in\n   [the series instance array](series.cmf).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        cmf: {\n            // shared options for all cmf series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'cmf'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.cmf.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === cmf) {\n    // code specific to the cmf series\n}\n```\n            ","extends":"series,plotOptions.cmf","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/cmf"]},"meta":{"fullname":"series.cmf","name":"cmf","line":222,"lineEnd":233,"filename":"code/es-modules/Stock/Indicators/CMF/CMFIndicator.js"},"children":{}},"cmo":{"doclet":{"description":"A `CMO` series. If the [type](#series.cmo.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `cmo` series are defined in\n   [plotOptions.cmo](plotOptions.cmo).\n3. Options for one single series are given in\n   [the series instance array](series.cmo).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        cmo: {\n            // shared options for all cmo series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'cmo'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.cmo.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === cmo) {\n    // code specific to the cmo series\n}\n```\n            ","extends":"series,plotOptions.cmo","since":"9.1.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/cmo"]},"meta":{"fullname":"series.cmo","name":"cmo","line":140,"lineEnd":151,"filename":"code/es-modules/Stock/Indicators/CMO/CMOIndicator.js"},"children":{}},"column":{"doclet":{"description":"A `column` series. If the [type](#series.column.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `column` series are defined in\n   [plotOptions.column](plotOptions.column).\n3. Options for one single series are given in\n   [the series instance array](series.column).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        column: {\n            // shared options for all column series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'column'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.column.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === column) {\n    // code specific to the column series\n}\n```\n            ","extends":"series,plotOptions.column","exclude":["connectNulls","dataParser","dataURL","gapSize","gapUnit","linecap","lineWidth","marker","connectEnds","step"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.column","name":"column","line":361,"lineEnd":370,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `column` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 6],\n       [1, 2],\n       [2, 6]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.column.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       y: 9,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 6,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.line.data","exclude":["marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.column.data","name":"data","line":371,"lineEnd":430,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{"borderColor":{"doclet":{"description":"The color of the border surrounding the column or bar.\n\nIn styled mode, the border stroke can be set with the `.highcharts-point`\nrule.","samples":[{"name":"Dark gray border","value":"highcharts/plotoptions/column-bordercolor/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.column.data.borderColor","name":"borderColor","line":431,"lineEnd":443,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"borderWidth":{"doclet":{"description":"The width of the border surrounding the column or bar.\n\nIn styled mode, the stroke width can be set with the `.highcharts-point`\nrule.","samples":[{"name":"2px black border","value":"highcharts/plotoptions/column-borderwidth/","products":["highcharts"]}],"type":{"names":["number"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.column.data.borderWidth","name":"borderWidth","line":444,"lineEnd":456,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"dashStyle":{"doclet":{"description":"A name for the dash style to use for the column or bar. Overrides\ndashStyle on the series.\n\nIn styled mode, the stroke dash-array can be set with the same classes as\nlisted under [data.color](#series.column.data.color).","see":["[series.pointWidth](#plotOptions.column.dashStyle)"],"type":{"names":["Highcharts.DashStyleValue"]}},"meta":{"fullname":"series.column.data.dashStyle","name":"dashStyle","line":457,"lineEnd":468,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"pointWidth":{"doclet":{"description":"A pixel value specifying a fixed width for the column or bar. Overrides\npointWidth on the series. The width effects the dimension that is not based\non the point value.","see":["[series.pointWidth](#plotOptions.column.pointWidth)"],"type":{"names":["number"]},"defaultvalue":"undefined","since":"7.0.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.column.data.pointWidth","name":"pointWidth","line":173,"lineEnd":184,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"states":{"doclet":{"extends":"series.column.states","products":["highcharts","highstock"]},"meta":{"fullname":"series.column.data.states","name":"states","line":489,"lineEnd":493,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}}}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"hover":{"doclet":{"exclude":["halo","lineWidth","lineWidthPlus","marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.column.states.hover","name":"hover","line":479,"lineEnd":483,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}},"select":{"doclet":{"exclude":["halo","lineWidth","lineWidthPlus","marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.column.states.select","name":"select","line":484,"lineEnd":488,"filename":"code/es-modules/Series/Column/ColumnSeriesDefaults.js"},"children":{}}}}}},"columnpyramid":{"doclet":{"description":"A `columnpyramid` series. If the [type](#series.columnpyramid.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `columnpyramid` series are defined in\n   [plotOptions.columnpyramid](plotOptions.columnpyramid).\n3. Options for one single series are given in\n   [the series instance array](series.columnpyramid).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        columnpyramid: {\n            // shared options for all columnpyramid series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'columnpyramid'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.columnpyramid.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === columnpyramid) {\n    // code specific to the columnpyramid series\n}\n```\n            ","extends":"series,plotOptions.columnpyramid","exclude":["connectEnds","connectNulls","dashStyle","dataParser","dataURL","gapSize","gapUnit","linecap","lineWidth","marker","step","boostThreshold","boostBlending"],"products":["highcharts","highstock"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.columnpyramid","name":"columnpyramid","line":39,"lineEnd":50,"filename":"code/es-modules/Series/ColumnPyramid/ColumnPyramidSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `columnpyramid` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 6],\n       [1, 2],\n       [2, 6]\n   ]\n   ```\n\n3. An array of objects with named values. The objects are point configuration\n   objects as seen below. If the total number of data points exceeds the\n   series' [turboThreshold](#series.columnpyramid.turboThreshold), this\n   option is not available.\n   ```js\n   data: [{\n       x: 1,\n       y: 9,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 6,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.line.data","exclude":["marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.columnpyramid.data","name":"data","line":61,"lineEnd":119,"filename":"code/es-modules/Series/ColumnPyramid/ColumnPyramidSeriesDefaults.js"},"children":{}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"hover":{"doclet":{"exclude":["halo","lineWidth","lineWidthPlus","marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.columnpyramid.states.hover","name":"hover","line":51,"lineEnd":55,"filename":"code/es-modules/Series/ColumnPyramid/ColumnPyramidSeriesDefaults.js"},"children":{}},"select":{"doclet":{"exclude":["halo","lineWidth","lineWidthPlus","marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.columnpyramid.states.select","name":"select","line":56,"lineEnd":60,"filename":"code/es-modules/Series/ColumnPyramid/ColumnPyramidSeriesDefaults.js"},"children":{}}}}}},"columnrange":{"doclet":{"description":"A `columnrange` series. If the [type](#series.columnrange.type)\noption is not specified, it is inherited from\n[chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `columnrange` series are defined in\n   [plotOptions.columnrange](plotOptions.columnrange).\n3. Options for one single series are given in\n   [the series instance array](series.columnrange).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        columnrange: {\n            // shared options for all columnrange series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'columnrange'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.columnrange.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === columnrange) {\n    // code specific to the columnrange series\n}\n```\n            ","extends":"series,plotOptions.columnrange","exclude":["dataParser","dataURL","stack","stacking"],"products":["highcharts","highstock"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.columnrange","name":"columnrange","line":220,"lineEnd":230,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `columnrange` series\ntype, points can be given in the following ways:\n\n1. An array of arrays with 3 or 2 values. In this case, the values correspond\n   to `x,low,high`. If the first value is a string, it is applied as the name\n   of the point, and the `x` value is inferred. The `x` value can also be\n   omitted, in which case the inner arrays should be of length 2\\. Then the\n   `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 4, 2],\n       [1, 2, 1],\n       [2, 9, 10]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.columnrange.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       low: 0,\n       high: 4,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       low: 5,\n       high: 3,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number>|Array.<(number|string), number, number>|*)>"]},"extends":"series.arearange.data","exclude":["marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.columnrange.data","name":"data","line":231,"lineEnd":285,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js"},"children":{"dataLabels":{"doclet":{"extends":"series.columnrange.dataLabels","products":["highcharts","highstock"]},"meta":{"fullname":"series.columnrange.data.dataLabels","name":"dataLabels","line":286,"lineEnd":290,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js"},"children":{}}}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"hover":{"doclet":{"exclude":["halo","lineWidth","lineWidthPlus","marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.columnrange.states.hover","name":"hover","line":291,"lineEnd":295,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js"},"children":{}},"select":{"doclet":{"exclude":["halo","lineWidth","lineWidthPlus","marker"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.columnrange.states.select","name":"select","line":296,"lineEnd":300,"filename":"code/es-modules/Series/ColumnRange/ColumnRangeSeries.js"},"children":{}}}}}},"contour":{"doclet":{"description":"A contour plot is a graphical representation of three-dimensional data\nin two dimensions using contour lines or color-coded regions.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `contour` series are defined in\n   [plotOptions.contour](plotOptions.contour).\n3. Options for one single series are given in\n   [the series instance array](series.contour).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        contour: {\n            // shared options for all contour series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'contour'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.contour.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === contour) {\n    // code specific to the contour series\n}\n```\n            ","productdesc":[{"value":"Requires `modules/contour`.","products":["highcharts"]}],"samples":[{"name":"Simple contour","value":"highcharts/demo/contour-mountain/"}],"extends":"series,plotOptions.contour","exclude":["cropThreshold","dataParser","dataURL","dragDrop","pointRange","stack","allowPointSelect","boostBlending","boostThreshold","color","colorIndex","connectEnds","connectNulls","crisp","dashStyle","inactiveOtherPoints","jitter","linecap","negativeColor","pointInterval","pointStart","pointIntervalUnit","lineWidth","onPoint","pointPlacement","shadow","stacking","step","threshold","zoneAxis","zones","onPoint","grouping","groupPadding","groupZPadding"],"products":["highcharts","highmaps"]},"meta":{"fullname":"series.contour","name":"contour","line":132,"lineEnd":155,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `contour` series\ntype, points can be given in the following ways:\n\n1.  An array of arrays with 3 or 2 values. In this case, the values\ncorrespond to `x,y,value`. If the first value is a string, it is\napplied as the name of the point, and the `x` value is inferred.\nUnlike the heatmap, the contour series data points, do not have to appear\nin any specific order.\n\n ```js\n    data: [\n        [0, 9, 7],\n        [1, 10, 4],\n        [2, 6, 3]\n    ]\n ```\n\n2.  An array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series' [turboThreshold](#series.contour.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        x: 1,\n        y: 3,\n        value: 10,\n        name: \"Point2\"\n    }, {\n        x: 1,\n        y: 7,\n        value: 10,\n        name: \"Point1\"\n    }]\n ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<number>|*)>"]},"extends":"series.line.data","products":["highcharts","highmaps"]},"meta":{"fullname":"series.contour.data","name":"data","line":156,"lineEnd":208,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{"value":{"doclet":{"description":"The value of the point, resulting in a color controlled by options\nas set in the [colorAxis](#colorAxis) configuration.","type":{"names":["number"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.contour.data.value","name":"value","line":209,"lineEnd":216,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{}},"x":{"doclet":{"description":"The x value of the point. For datetime axes,\nthe X value is the timestamp in milliseconds since 1970.","type":{"names":["number"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.contour.data.x","name":"x","line":217,"lineEnd":224,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{}},"y":{"doclet":{"description":"The y value of the point.","type":{"names":["number"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.contour.data.y","name":"y","line":225,"lineEnd":231,"filename":"code/es-modules/Series/Contour/ContourSeriesDefaults.js"},"children":{}}}}}},"cylinder":{"doclet":{"description":"A `cylinder` series. If the [type](#series.cylinder.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `cylinder` series are defined in\n   [plotOptions.cylinder](plotOptions.cylinder).\n3. Options for one single series are given in\n   [the series instance array](series.cylinder).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        cylinder: {\n            // shared options for all cylinder series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'cylinder'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.cylinder.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === cylinder) {\n    // code specific to the cylinder series\n}\n```\n            ","extends":"series,plotOptions.cylinder","since":"7.0.0","products":["highcharts"],"exclude":["allAreas","boostThreshold","colorAxis","compare","compareBase","boostBlending"],"requires":["module:modules/cylinder"]},"meta":{"fullname":"series.cylinder","name":"cylinder","line":36,"lineEnd":47,"filename":"code/es-modules/Series/Cylinder/CylinderSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `cylinder` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 0],\n       [1, 8],\n       [2, 9]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.cylinder.turboThreshold), this option is not\n   available.\n\n   ```js\n   data: [{\n       x: 1,\n       y: 2,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 4,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.column.data","products":["highcharts","highstock"],"since":"7.0.0"},"meta":{"fullname":"series.cylinder.data","name":"data","line":48,"lineEnd":107,"filename":"code/es-modules/Series/Cylinder/CylinderSeriesDefaults.js"},"children":{}}}},"dema":{"doclet":{"description":"A `DEMA` series. If the [type](#series.dema.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `dema` series are defined in\n   [plotOptions.dema](plotOptions.dema).\n3. Options for one single series are given in\n   [the series instance array](series.dema).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        dema: {\n            // shared options for all dema series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'dema'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.dema.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === dema) {\n    // code specific to the dema series\n}\n```\n            ","extends":"series,plotOptions.dema","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/dema"]},"meta":{"fullname":"series.dema","name":"dema","line":132,"lineEnd":145,"filename":"code/es-modules/Stock/Indicators/DEMA/DEMAIndicator.js"},"children":{}},"dependencywheel":{"doclet":{"description":"A `dependencywheel` series. If the [type](#series.dependencywheel.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `dependencywheel` series are defined in\n   [plotOptions.dependencywheel](plotOptions.dependencywheel).\n3. Options for one single series are given in\n   [the series instance array](series.dependencywheel).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        dependencywheel: {\n            // shared options for all dependencywheel series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'dependencywheel'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.dependencywheel.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === dependencywheel) {\n    // code specific to the dependencywheel series\n}\n```\n            ","extends":"series,plotOptions.dependencywheel","exclude":["dataSorting"],"products":["highcharts"],"requires":["module:modules/sankey","module:modules/dependency-wheel"]},"meta":{"fullname":"series.dependencywheel","name":"dependencywheel","line":129,"lineEnd":139,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `dependencywheel` series\ntype, points can be given in the following way:\n\nAn array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series' [turboThreshold](#series.area.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        from: 'Category1',\n        to: 'Category2',\n        weight: 2\n    }, {\n        from: 'Category1',\n        to: 'Category3',\n        weight: 5\n    }]\n ```","type":{"names":["Array.<(Array.<string, string, number>|*)>"]},"extends":"series.sankey.data","products":["highcharts"],"exclude":["outgoing","dataLabels"]},"meta":{"fullname":"series.dependencywheel.data","name":"data","line":151,"lineEnd":177,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}},"nodes":{"doclet":{"description":"A collection of options for the individual nodes. The nodes in a dependency\ndiagram are auto-generated instances of `Highcharts.Point`, but options can\nbe applied here and linked by the `id`.","extends":"series.sankey.nodes","type":{"names":["Array.<*>"]},"products":["highcharts"],"exclude":["offset"]},"meta":{"fullname":"series.dependencywheel.nodes","name":"nodes","line":140,"lineEnd":150,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{"dataLabels":{"doclet":{"description":"Individual data label for each node. The options are the same as\nthe ones for [series.dependencywheel.dataLabels](#series.dependencywheel.dataLabels)."},"meta":{"fullname":"series.dependencywheel.nodes.dataLabels","name":"dataLabels","line":178,"lineEnd":183,"filename":"code/es-modules/Series/DependencyWheel/DependencyWheelSeriesDefaults.js"},"children":{}}}}}},"disparityindex":{"doclet":{"description":"The Disparity Index indicator series.\nIf the [type](#series.disparityindex.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `disparityindex` series are defined in\n   [plotOptions.disparityindex](plotOptions.disparityindex).\n3. Options for one single series are given in\n   [the series instance array](series.disparityindex).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        disparityindex: {\n            // shared options for all disparityindex series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'disparityindex'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.disparityindex.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === disparityindex) {\n    // code specific to the disparityindex series\n}\n```\n            ","extends":"series,plotOptions.disparityindex","since":"9.1.0","products":["highstock"],"exclude":["allAreas","colorAxis","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/disparity-index"]},"meta":{"fullname":"series.disparityindex","name":"disparityindex","line":136,"lineEnd":150,"filename":"code/es-modules/Stock/Indicators/DisparityIndex/DisparityIndexIndicator.js"},"children":{}},"dmi":{"doclet":{"description":"The Directional Movement Index (DMI) indicator series.\nIf the [type](#series.dmi.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `dmi` series are defined in\n   [plotOptions.dmi](plotOptions.dmi).\n3. Options for one single series are given in\n   [the series instance array](series.dmi).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        dmi: {\n            // shared options for all dmi series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'dmi'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.dmi.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === dmi) {\n    // code specific to the dmi series\n}\n```\n            ","extends":"series,plotOptions.dmi","since":"9.1.0","products":["highstock"],"exclude":["allAreas","colorAxis","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/dmi"]},"meta":{"fullname":"series.dmi","name":"dmi","line":241,"lineEnd":255,"filename":"code/es-modules/Stock/Indicators/DMI/DMIIndicator.js"},"children":{}},"dpo":{"doclet":{"description":"A Detrended Price Oscillator. If the [type](#series.dpo.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `dpo` series are defined in\n   [plotOptions.dpo](plotOptions.dpo).\n3. Options for one single series are given in\n   [the series instance array](series.dpo).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        dpo: {\n            // shared options for all dpo series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'dpo'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.dpo.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === dpo) {\n    // code specific to the dpo series\n}\n```\n            ","extends":"series,plotOptions.dpo","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/dpo"]},"meta":{"fullname":"series.dpo","name":"dpo","line":133,"lineEnd":146,"filename":"code/es-modules/Stock/Indicators/DPO/DPOIndicator.js"},"children":{}},"dumbbell":{"doclet":{"description":"The `dumbbell` series. If the [type](#series.dumbbell.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `dumbbell` series are defined in\n   [plotOptions.dumbbell](plotOptions.dumbbell).\n3. Options for one single series are given in\n   [the series instance array](series.dumbbell).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        dumbbell: {\n            // shared options for all dumbbell series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'dumbbell'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.dumbbell.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === dumbbell) {\n    // code specific to the dumbbell series\n}\n```\n            ","extends":"series,plotOptions.dumbbell","exclude":["boostThreshold","boostBlending"],"products":["highcharts","highstock"],"requires":["module:highcharts-more","module:modules/dumbbell"]},"meta":{"fullname":"series.dumbbell","name":"dumbbell","line":97,"lineEnd":107,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `dumbbell` series\ntype, points can be given in the following ways:\n\n1. An array of arrays with 3 or 2 values. In this case, the values correspond\n   to `x,low,high`. If the first value is a string, it is applied as the name\n   of the point, and the `x` value is inferred. The `x` value can also be\n   omitted, in which case the inner arrays should be of length 2\\. Then the\n   `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 4, 2],\n       [1, 2, 1],\n       [2, 9, 10]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.dumbbell.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       low: 0,\n       high: 4,\n       name: \"Point2\",\n       color: \"#00FF00\",\n       lowColor: \"#00FFFF\",\n       connectorWidth: 3,\n       connectorColor: \"#FF00FF\"\n   }, {\n       x: 1,\n       low: 5,\n       high: 3,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number>|Array.<(number|string), number, number>|*)>"]},"extends":"series.arearange.data","products":["highcharts","highstock"]},"meta":{"fullname":"series.dumbbell.data","name":"data","line":108,"lineEnd":164,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{"connectorColor":{"doclet":{"description":"Color of the line that connects the dumbbell point's values.\nBy default it is the series' color.","type":{"names":["string"]},"since":"8.0.0","products":["highcharts","highstock"]},"meta":{"fullname":"series.dumbbell.data.connectorColor","name":"connectorColor","line":197,"lineEnd":205,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{}},"connectorWidth":{"doclet":{"description":"Pixel width of the line that connects the dumbbell point's values.","type":{"names":["number"]},"since":"8.0.0","defaultvalue":"1","products":["highcharts","highstock"]},"meta":{"fullname":"series.dumbbell.data.connectorWidth","name":"connectorWidth","line":206,"lineEnd":214,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{}},"lowColor":{"doclet":{"description":"Color of the start markers in a dumbbell graph. This option takes\npriority over the series color. To avoid this, set `lowColor` to\n`undefined`.","type":{"names":["Highcharts.ColorType"]},"since":"8.0.0","defaultvalue":"#333333","products":["highcharts","highstock"]},"meta":{"fullname":"series.dumbbell.data.lowColor","name":"lowColor","line":215,"lineEnd":225,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{}}}},"lowColor":{"doclet":{"description":"Color of the start markers in a dumbbell graph. This option takes\npriority over the series color. To avoid this, set `lowColor` to\n`undefined`.","type":{"names":["Highcharts.ColorType"]},"since":"8.0.0","products":["highcharts","highstock"]},"meta":{"fullname":"series.dumbbell.lowColor","name":"lowColor","line":165,"lineEnd":174,"filename":"code/es-modules/Series/Dumbbell/DumbbellSeriesDefaults.js"},"children":{}}}},"ema":{"doclet":{"description":"A `EMA` series. If the [type](#series.ema.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ema` series are defined in\n   [plotOptions.ema](plotOptions.ema).\n3. Options for one single series are given in\n   [the series instance array](series.ema).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ema: {\n            // shared options for all ema series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ema'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ema.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ema) {\n    // code specific to the ema series\n}\n```\n            ","extends":"series,plotOptions.ema","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators"]},"meta":{"fullname":"series.ema","name":"ema","line":125,"lineEnd":135,"filename":"code/es-modules/Stock/Indicators/EMA/EMAIndicator.js"},"children":{}},"errorbar":{"doclet":{"description":"A `errorbar` series. If the [type](#series.errorbar.type) option\nis not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `errorbar` series are defined in\n   [plotOptions.errorbar](plotOptions.errorbar).\n3. Options for one single series are given in\n   [the series instance array](series.errorbar).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        errorbar: {\n            // shared options for all errorbar series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'errorbar'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.errorbar.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === errorbar) {\n    // code specific to the errorbar series\n}\n```\n            ","extends":"series,plotOptions.errorbar","exclude":["dataParser","dataURL","stack","stacking","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.errorbar","name":"errorbar","line":76,"lineEnd":86,"filename":"code/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `errorbar` series\ntype, points can be given in the following ways:\n\n1. An array of arrays with 3 or 2 values. In this case, the values correspond\n   to `x,low,high`. If the first value is a string, it is applied as the name\n   of the point, and the `x` value is inferred. The `x` value can also be\n   omitted, in which case the inner arrays should be of length 2\\. Then the\n   `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 10, 2],\n       [1, 1, 8],\n       [2, 4, 5]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.errorbar.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       low: 0,\n       high: 0,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       low: 5,\n       high: 5,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number>|Array.<(number|string), number, number>|*)>"]},"extends":"series.arearange.data","exclude":["dataLabels","drilldown","marker","states"],"products":["highcharts"]},"meta":{"fullname":"series.errorbar.data","name":"data","line":87,"lineEnd":141,"filename":"code/es-modules/Series/ErrorBar/ErrorBarSeriesDefaults.js"},"children":{}}}},"flags":{"doclet":{"description":"A `flags` series. If the [type](#series.flags.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `flags` series are defined in\n   [plotOptions.flags](plotOptions.flags).\n3. Options for one single series are given in\n   [the series instance array](series.flags).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        flags: {\n            // shared options for all flags series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'flags'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.flags.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === flags) {\n    // code specific to the flags series\n}\n```\n            ","extends":"series,plotOptions.flags","exclude":["animation","borderColor","borderRadius","borderWidth","colorByPoint","connectNulls","cropThreshold","dashStyle","dataGrouping","dataParser","dataURL","gapSize","gapUnit","linecap","lineWidth","marker","pointPadding","pointWidth","step","turboThreshold","useOhlcData"],"products":["highstock"]},"meta":{"fullname":"series.flags","name":"flags","line":237,"lineEnd":248,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `flags` series type,\npoints can be given in the following ways:\n\n1. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.flags.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       title: \"A\",\n       text: \"First event\"\n   }, {\n       x: 1,\n       title: \"B\",\n       text: \"Second event\"\n   }]\n   ```","type":{"names":["Array.<*>"]},"extends":"series.line.data","exclude":["dataLabels","marker","name","y"],"products":["highstock"]},"meta":{"fullname":"series.flags.data","name":"data","line":249,"lineEnd":275,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{"fillColor":{"doclet":{"description":"The fill color of an individual flag. By default it inherits from\nthe series color.","type":{"names":["Highcharts.ColorType"]},"products":["highstock"]},"meta":{"fullname":"series.flags.data.fillColor","name":"fillColor","line":276,"lineEnd":283,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}},"text":{"doclet":{"description":"The longer text to be shown in the flag's tooltip.","type":{"names":["string"]},"products":["highstock"]},"meta":{"fullname":"series.flags.data.text","name":"text","line":284,"lineEnd":290,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}},"title":{"doclet":{"description":"The short text to be shown on the flag.","type":{"names":["string"]},"products":["highstock"]},"meta":{"fullname":"series.flags.data.title","name":"title","line":291,"lineEnd":297,"filename":"code/es-modules/Series/Flags/FlagsSeriesDefaults.js"},"children":{}}}}}},"flowmap":{"doclet":{"description":"A `flowmap` series. If the [type](#series.flowmap.type) option\nis not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `flowmap` series are defined in\n   [plotOptions.flowmap](plotOptions.flowmap).\n3. Options for one single series are given in\n   [the series instance array](series.flowmap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        flowmap: {\n            // shared options for all flowmap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'flowmap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.flowmap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === flowmap) {\n    // code specific to the flowmap series\n}\n```\n            ","extends":"series,plotOptions.flowmap","exclude":["affectsMapView","allAreas","allowPointSelect","boostBlending","boostThreshold","borderColor","borderWidth","dashStyle","dataLabels","dragDrop","joinBy","mapData","negativeColor","onPoint","shadow","showCheckbox"],"products":["highmaps"]},"meta":{"fullname":"series.flowmap","name":"flowmap","line":583,"lineEnd":593,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `flowmap` series\ntype, points can be given in the following ways:\n\n1.  An array of arrays with options as values. In this case,\n    the values correspond to `from, to, weight`. Example:\n    ```js\n    data: [\n        ['Point 1', 'Point 2', 4]\n    ]\n    ```\n\n2.  An array of objects with named values. The following snippet shows only a\n    few settings, see the complete options set below.\n\n    ```js\n    data: [{\n        from: 'Point 1',\n        to: 'Point 2',\n        curveFactor: 0.4,\n        weight: 5,\n        growTowards: true,\n        markerEnd: {\n            enabled: true,\n            height: 15,\n            width: 8\n        }\n    }]\n    ```\n\n3.   For objects with named values, instead of using the `mappoint` `id`,\n     you can use `[longitude, latitude]` arrays.\n\n     ```js\n     data: [{\n         from: [longitude, latitude],\n         to: [longitude, latitude]\n     }]\n     ```","type":{"names":["Array.<(number|null|*)>"]}},"meta":{"fullname":"series.flowmap.data","name":"data","line":594,"lineEnd":636,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{"curveFactor":{"doclet":{"description":"A `curveFactor` with a higher value than 0 will curve the link clockwise.\nA negative value will curve the link counter clockwise.\nIf the value is 0 the link will be straight.","samples":[{"name":"Example ship route","value":"maps/series-flowmap/ship-route/","products":["highmaps"]}],"type":{"names":["number"]}},"meta":{"fullname":"series.flowmap.data.curveFactor","name":"curveFactor","line":637,"lineEnd":647,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"fillColor":{"doclet":{"description":"The fill color of an individual link.","type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"series.flowmap.data.fillColor","name":"fillColor","line":648,"lineEnd":653,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"fillOpacity":{"doclet":{"description":"The opacity of the link color fill.","type":{"names":["number"]}},"meta":{"fullname":"series.flowmap.data.fillOpacity","name":"fillOpacity","line":680,"lineEnd":685,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"from":{"doclet":{"description":"ID referencing a map point holding coordinates of the link origin or\ncoordinates in terms of array of `[longitude, latitude]` or object with `lon`\nand `lat` properties.","samples":[{"name":"Flowmap point using lon-lat coordinates","value":"maps/series-flowmap/from-to-lon-lat","products":["highmaps"]},{"name":"Highmaps basic flight routes demo","value":"maps/series-flowmap/flight-routes","products":["highmaps"]}],"type":{"names":["string","Highcharts.LonLatArray","Highcharts.MapLonLatObject"]}},"meta":{"fullname":"series.flowmap.data.from","name":"from","line":654,"lineEnd":666,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"growTowards":{"doclet":{"description":"If set to `true`, the line will grow towards its end.","samples":[{"name":"Example ship route","value":"maps/series-flowmap/ship-route/","products":["highmaps"]}],"type":{"names":["boolean"]}},"meta":{"fullname":"series.flowmap.data.growTowards","name":"growTowards","line":686,"lineEnd":694,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"lineWidth":{"doclet":{"description":"Specify the `lineWidth` of the link.","type":{"names":["number"]}},"meta":{"fullname":"series.flowmap.data.lineWidth","name":"lineWidth","line":749,"lineEnd":754,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"markerEnd":{"doclet":{"description":"Specifying a `markerEnd` here will create an arrow symbol\nindicating the direction of flow at the destination of one individual link.\nIf one has been previously specified at the higher level option it will be\noverridden for the current link.","samples":[{"name":"Example ship route","value":"maps/series-flowmap/ship-route/","products":["highmaps"]}],"type":{"names":["*","null"]}},"meta":{"fullname":"series.flowmap.data.markerEnd","name":"markerEnd","line":695,"lineEnd":706,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{"enabled":{"doclet":{"description":"Enable or disable the `markerEnd`.","type":{"names":["boolean"]}},"meta":{"fullname":"series.flowmap.data.markerEnd.enabled","name":"enabled","line":707,"lineEnd":712,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"height":{"doclet":{"description":"Height of the `markerEnd`. Can be a number in pixels\nor a percentage based on the weight of the link.","type":{"names":["number","string"]}},"meta":{"fullname":"series.flowmap.data.markerEnd.height","name":"height","line":713,"lineEnd":719,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"markerType":{"doclet":{"description":"Change the shape of the `markerEnd`. Can be `arrow` or `mushroom`.","type":{"names":["string"]}},"meta":{"fullname":"series.flowmap.data.markerEnd.markerType","name":"markerType","line":727,"lineEnd":732,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"width":{"doclet":{"description":"Width of the `markerEnd`. Can be a number in pixels\nor a percentage based on the weight of the link.","type":{"names":["number","string"]}},"meta":{"fullname":"series.flowmap.data.markerEnd.width","name":"width","line":720,"lineEnd":726,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}}}},"opacity":{"doclet":{"description":"The opacity of an individual link.","type":{"names":["number"]}},"meta":{"fullname":"series.flowmap.data.opacity","name":"opacity","line":733,"lineEnd":738,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"to":{"doclet":{"description":"ID referencing a map point holding coordinates of the link origin or\ncoordinates in terms of array of `[longitude, latitude]` or object with `lon`\nand `lat` properties.","samples":[{"name":"Flowmap point using lon-lat coordinates","value":"maps/series-flowmap/from-to-lon-lat","products":["highmaps"]},{"name":"Highmaps basic flight routes demo","value":"maps/series-flowmap/flight-routes","products":["highmaps"]}],"type":{"names":["string","Highcharts.LonLatArray","Highcharts.MapLonLatObject"]}},"meta":{"fullname":"series.flowmap.data.to","name":"to","line":667,"lineEnd":679,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}},"weight":{"doclet":{"description":"The weight of a link determines its thickness compared to\nother links.","samples":[{"name":"Example ship route","value":"maps/series-flowmap/ship-route/","products":["highmaps"]}],"type":{"names":["number"]}},"meta":{"fullname":"series.flowmap.data.weight","name":"weight","line":739,"lineEnd":748,"filename":"code/es-modules/Series/FlowMap/FlowMapSeries.js"},"children":{}}}}}},"funnel":{"doclet":{"description":"A `funnel` series. If the [type](#series.funnel.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `funnel` series are defined in\n   [plotOptions.funnel](plotOptions.funnel).\n3. Options for one single series are given in\n   [the series instance array](series.funnel).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        funnel: {\n            // shared options for all funnel series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'funnel'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.funnel.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === funnel) {\n    // code specific to the funnel series\n}\n```\n            ","extends":"series,plotOptions.funnel","exclude":["dataParser","dataURL","stack","xAxis","yAxis","dataSorting","boostBlending","boostThreshold"],"products":["highcharts"],"requires":["module:modules/funnel"]},"meta":{"fullname":"series.funnel","name":"funnel","line":141,"lineEnd":151,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `funnel` series type,\npoints can be given in the following ways:\n\n1.  An array of numerical values. In this case, the numerical values\nwill be interpreted as `y` options. Example:\n\n ```js\n data: [0, 5, 3, 5]\n ```\n\n2.  An array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series' [turboThreshold](#series.funnel.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        y: 3,\n        name: \"Point2\",\n        color: \"#00FF00\"\n    }, {\n        y: 1,\n        name: \"Point1\",\n        color: \"#FF00FF\"\n    }]\n ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|null|*)>"]},"extends":"series.pie.data","exclude":["sliced"],"products":["highcharts"]},"meta":{"fullname":"series.funnel.data","name":"data","line":152,"lineEnd":196,"filename":"code/es-modules/Series/Funnel/FunnelSeriesDefaults.js"},"children":{}}}},"funnel3d":{"doclet":{"description":"A `funnel3d` series. If the [type](#series.funnel3d.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `funnel3d` series are defined in\n   [plotOptions.funnel3d](plotOptions.funnel3d).\n3. Options for one single series are given in\n   [the series instance array](series.funnel3d).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        funnel3d: {\n            // shared options for all funnel3d series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'funnel3d'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.funnel3d.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === funnel3d) {\n    // code specific to the funnel3d series\n}\n```\n            ","samples":[{"name":"Funnel3d demo","value":"highcharts/demo/funnel3d/","products":["highcharts"]}],"since":"7.1.0","extends":"series,plotOptions.funnel3d","exclude":["allAreas","boostThreshold","colorAxis","compare","compareBase"],"products":["highcharts"],"requires":["module:highcharts-3d","module:modules/cylinder","module:modules/funnel3d"]},"meta":{"fullname":"series.funnel3d","name":"funnel3d","line":99,"lineEnd":114,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `funnel3d` series\ntype, points can be given in the following ways:\n\n1.  An array of numerical values. In this case, the numerical values\nwill be interpreted as `y` options. The `x` values will be automatically\ncalculated, either starting at 0 and incremented by 1, or from `pointStart`\nand `pointInterval` given in the series options. If the axis has\ncategories, these will be used. Example:\n\n ```js\n data: [0, 5, 3, 5]\n ```\n\n2.  An array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series' [turboThreshold](#series.funnel3d.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        y: 2,\n        name: \"Point2\",\n        color: \"#00FF00\"\n    }, {\n        y: 4,\n        name: \"Point1\",\n        color: \"#FF00FF\"\n    }]\n ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<number>|*)>"]},"extends":"series.column.data","products":["highcharts"],"since":"7.1.0"},"meta":{"fullname":"series.funnel3d.data","name":"data","line":115,"lineEnd":161,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js"},"children":{"gradientForSides":{"doclet":{"description":"By default sides fill is set to a gradient through this option being\nset to `true`. Set to `false` to get solid color for the sides.","type":{"names":["boolean"]},"products":["highcharts"],"since":"7.1.0"},"meta":{"fullname":"series.funnel3d.data.gradientForSides","name":"gradientForSides","line":162,"lineEnd":169,"filename":"code/es-modules/Series/Funnel3D/Funnel3DSeriesDefaults.js"},"children":{}}}}}},"gantt":{"doclet":{"description":"A `gantt` series.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `gantt` series are defined in\n   [plotOptions.gantt](plotOptions.gantt).\n3. Options for one single series are given in\n   [the series instance array](series.gantt).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        gantt: {\n            // shared options for all gantt series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'gantt'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.gantt.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === gantt) {\n    // code specific to the gantt series\n}\n```\n            ","extends":"series,plotOptions.gantt","exclude":["boostThreshold","dashStyle","findNearestPointBy","getExtremesFromAll","marker","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointStart"],"products":["gantt"],"requires":["module:highcharts-gantt"]},"meta":{"fullname":"series.gantt","name":"gantt","line":90,"lineEnd":100,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"Data for a Gantt series.","declare":"Highcharts.GanttPointOptionsObject","type":{"names":["Array.<*>"]},"extends":"series.xrange.data","exclude":["className","connect","dataLabels","events","selected","x","x2"],"products":["gantt"]},"meta":{"fullname":"series.gantt.data","name":"data","line":101,"lineEnd":110,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{"collapsed":{"doclet":{"description":"Whether the grid node belonging to this point should start as collapsed. Used\nin axes of type treegrid.","samples":[{"name":"Start as collapsed","value":"gantt/treegrid-axis/collapsed/","products":["gantt"]}],"type":{"names":["boolean"]},"defaultvalue":"false","products":["gantt"]},"meta":{"fullname":"series.gantt.data.collapsed","name":"collapsed","line":111,"lineEnd":122,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}},"completed":{"doclet":{"description":"Progress indicator, how much of the task completed. When set as a number,\nworks as `{ amount: number }`.","samples":[{"name":"Progress indicator","value":"gantt/demo/progress-indicator","products":["gantt"]}],"type":{"names":["number","*"]},"extends":"series.xrange.data.partialFill","products":["gantt"]},"meta":{"fullname":"series.gantt.data.completed","name":"completed","line":152,"lineEnd":163,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{"amount":{"doclet":{"description":"The amount of the progress indicator, ranging from 0 (not started) to 1\n(finished).","type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"series.gantt.data.completed.amount","name":"amount","line":164,"lineEnd":171,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}},"fill":{"doclet":{"description":"The fill of the progress indicator. Defaults to a darkened variety of the\nmain color.","type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"series.gantt.data.completed.fill","name":"fill","line":172,"lineEnd":178,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}}}},"dependency":{"doclet":{"description":"The ID of the point (task) that this point depends on in Gantt charts.\nAliases [connect](series.xrange.data.connect). Can also be an object,\nspecifying further connecting [options](series.gantt.connectors) between the\npoints. Multiple connections can be specified by providing an array.","samples":[{"name":"Dependencies","value":"gantt/demo/project-management"},{"name":"Different connection types","value":"gantt/pathfinder/demo"}],"type":{"names":["string","Array.<(string|*)>","*"]},"extends":"series.xrange.data.connect","since":"6.2.0","products":["gantt"]},"meta":{"fullname":"series.gantt.data.dependency","name":"dependency","line":179,"lineEnd":195,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}},"end":{"doclet":{"description":"The end time of a task. May be a timestamp or a date string.","type":{"names":["number","string"]},"products":["gantt"]},"meta":{"fullname":"series.gantt.data.end","name":"end","line":130,"lineEnd":136,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}},"milestone":{"doclet":{"description":"Whether this point is a milestone. If so, only the `start` option is handled,\nwhile `end` is ignored.","samples":[{"name":"Milestones","value":"gantt/gantt/milestones"}],"type":{"names":["boolean"]},"since":"6.2.0","products":["gantt"]},"meta":{"fullname":"series.gantt.data.milestone","name":"milestone","line":196,"lineEnd":207,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}},"name":{"doclet":{"description":"The name of a task. If a `treegrid` y-axis is used (default in Gantt charts),\nthis will be picked up automatically, and used to calculate the y-value.","type":{"names":["string"]},"products":["gantt"]},"meta":{"fullname":"series.gantt.data.name","name":"name","line":144,"lineEnd":151,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}},"parent":{"doclet":{"description":"The ID of the parent point (task) of this point in Gantt charts.","samples":[{"name":"Gantt chart with subtasks","value":"gantt/demo/subtasks"}],"type":{"names":["string"]},"since":"6.2.0","products":["gantt"]},"meta":{"fullname":"series.gantt.data.parent","name":"parent","line":208,"lineEnd":218,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}},"start":{"doclet":{"description":"The start time of a task. May be a timestamp or a date string.","type":{"names":["number","string"]},"products":["gantt"]},"meta":{"fullname":"series.gantt.data.start","name":"start","line":123,"lineEnd":129,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}},"y":{"doclet":{"description":"The Y value of a task.","type":{"names":["number"]},"products":["gantt"]},"meta":{"fullname":"series.gantt.data.y","name":"y","line":137,"lineEnd":143,"filename":"code/es-modules/Series/Gantt/GanttSeriesDefaults.js"},"children":{}}}}}},"gauge":{"doclet":{"description":"A `gauge` series. If the [type](#series.gauge.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `gauge` series are defined in\n   [plotOptions.gauge](plotOptions.gauge).\n3. Options for one single series are given in\n   [the series instance array](series.gauge).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        gauge: {\n            // shared options for all gauge series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'gauge'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.gauge.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === gauge) {\n    // code specific to the gauge series\n}\n```\n            ","extends":"series,plotOptions.gauge","exclude":["animationLimit","boostThreshold","connectEnds","connectNulls","cropThreshold","dashStyle","dataParser","dataURL","findNearestPointBy","getExtremesFromAll","marker","negativeColor","pointPlacement","shadow","softThreshold","stack","stacking","states","step","threshold","turboThreshold","zoneAxis","zones","dataSorting","boostBlending"],"products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.gauge","name":"gauge","line":503,"lineEnd":516,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `gauge` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.gauge.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       y: 6,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       y: 8,\n       name: \"Point1\",\n      color: \"#FF00FF\"\n   }]\n   ```\n\nThe typical gauge only contains a single data value.","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|null|*)>"]},"extends":"series.line.data","exclude":["drilldown","marker","x"],"products":["highcharts"]},"meta":{"fullname":"series.gauge.data","name":"data","line":517,"lineEnd":556,"filename":"code/es-modules/Series/Gauge/GaugeSeries.js"},"children":{}}}},"geoheatmap":{"doclet":{"description":"A `geoheatmap` series. If the [type](#series.map.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `geoheatmap` series are defined in\n   [plotOptions.geoheatmap](plotOptions.geoheatmap).\n3. Options for one single series are given in\n   [the series instance array](series.geoheatmap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        geoheatmap: {\n            // shared options for all geoheatmap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'geoheatmap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.geoheatmap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === geoheatmap) {\n    // code specific to the geoheatmap series\n}\n```\n            ","extends":"series,plotOptions.geoheatmap","exclude":["allAreas","dataParser","dataURL","dragDrop","findNearestPointBy","joinBy","marker","mapData","negativeColor","onPoint","shadow","stickyTracking"],"products":["highmaps"]},"meta":{"fullname":"series.geoheatmap","name":"geoheatmap","line":461,"lineEnd":471,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `geoheatmap` series\ntype, points can be given in the following ways:\n\n1.  An array of arrays with 3 or 2 values. In this case, the values\ncorrespond to `lon,lat,value`. The `value` refers to the color on the `colorAxis`.\n\n ```js\n    data: [\n        [51.50, -0.12, 7],\n        [54.59, -5.93, 4],\n        [55.8, -4.25, 3]\n    ]\n ```\n\n2.  An array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series' [turboThreshold](#series.heatmap.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        lat: 51.50,\n        lon: -0.12,\n        value: 7,\n        name: \"London\"\n    }, {\n        lat: 54.59,\n        lon: -5.93,\n        value: 4,\n        name: \"Belfast\"\n    }]\n ```","samples":[{"name":"GeoHeatmap Chart with interpolation on Europe map","value":"maps/demo/geoheatmap-europe/"},{"name":"GeoHeatmap Chart on the Equal Earth Projection","value":"maps/series-geoheatmap/geoheatmap-equalearth/"}],"type":{"names":["Array.<(Array.<number>|*)>"]},"extends":"series.map.data","products":["highmaps"]},"meta":{"fullname":"series.geoheatmap.data","name":"data","line":472,"lineEnd":515,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js"},"children":{"color":{"doclet":{"description":"Individual color for the point. By default the color is either used\nto denote the value, or pulled from the global `colors` array.","type":{"names":["Highcharts.ColorType"]},"products":["highmaps"]},"meta":{"fullname":"series.geoheatmap.data.color","name":"color","line":516,"lineEnd":523,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js"},"children":{}},"value":{"doclet":{"description":"The value of the point, resulting in a color controlled by options\nas set in the [colorAxis](#colorAxis) configuration.","type":{"names":["number","null"]},"products":["highmaps"]},"meta":{"fullname":"series.geoheatmap.data.value","name":"value","line":524,"lineEnd":531,"filename":"code/es-modules/Series/GeoHeatmap/GeoHeatmapSeries.js"},"children":{}}}}}},"heatmap":{"doclet":{"description":"A `heatmap` series. If the [type](#series.heatmap.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `heatmap` series are defined in\n   [plotOptions.heatmap](plotOptions.heatmap).\n3. Options for one single series are given in\n   [the series instance array](series.heatmap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        heatmap: {\n            // shared options for all heatmap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'heatmap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.heatmap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === heatmap) {\n    // code specific to the heatmap series\n}\n```\n            ","productdesc":[{"value":"Requires `modules/heatmap`.","products":["highcharts"]}],"extends":"series,plotOptions.heatmap","exclude":["cropThreshold","dataParser","dataURL","dragDrop","pointRange","stack",""],"products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap","name":"heatmap","line":305,"lineEnd":316,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `heatmap` series\ntype, points can be given in the following ways:\n\n1.  An array of arrays with 3 or 2 values. In this case, the values\ncorrespond to `x,y,value`. If the first value is a string, it is\napplied as the name of the point, and the `x` value is inferred.\nThe `x` value can also be omitted, in which case the inner arrays\nshould be of length 2\\. Then the `x` value is automatically calculated,\neither starting at 0 and incremented by 1, or from `pointStart`\nand `pointInterval` given in the series options.\n\n ```js\n    data: [\n        [0, 9, 7],\n        [1, 10, 4],\n        [2, 6, 3]\n    ]\n ```\n\n2.  An array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series' [turboThreshold](#series.heatmap.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        x: 1,\n        y: 3,\n        value: 10,\n        name: \"Point2\",\n        color: \"#00FF00\"\n    }, {\n        x: 1,\n        y: 7,\n        value: 10,\n        name: \"Point1\",\n        color: \"#FF00FF\"\n    }]\n ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<number>|*)>"]},"extends":"series.line.data","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data","name":"data","line":317,"lineEnd":373,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"color":{"doclet":{"description":"The color of the point. In heat maps the point color is rarely set\nexplicitly, as we use the color to denote the `value`. Options for\nthis are set in the [colorAxis](#colorAxis) configuration.","type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data.color","name":"color","line":374,"lineEnd":382,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"marker":{"doclet":{"exclude":["radius","enabledThreshold"],"products":["highcharts","highmaps"],"since":"8.1","type":{"names":["*"]}},"meta":{"fullname":"series.heatmap.data.marker","name":"marker","line":416,"lineEnd":421,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"states":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"hover":{"doclet":{"exclude":["radius","radiusPlus"],"products":["highcharts","highmaps"],"type":{"names":["*"]}},"meta":{"fullname":"series.heatmap.data.marker.states.hover","name":"hover","line":438,"lineEnd":442,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"height":{"doclet":{"description":"Set the marker's fixed height on hover state.","samples":[{"name":"70px fixed marker's width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-width","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data.marker.states.hover.height","name":"height","line":551,"lineEnd":561,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"heightPlus":{"doclet":{"description":"The number of pixels to increase the height of the\nhovered point.","samples":[{"name":"One day","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highstock"]},"meta":{"fullname":"series.heatmap.data.marker.states.hover.heightPlus","name":"heightPlus","line":574,"lineEnd":585,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"lineWidthPlus":{"doclet":{"description":"Set the marker's fixed width on hover state.","samples":[{"name":"5 pixels wider lineWidth on hover","value":"maps/plotoptions/heatmap-marker-states-hover-linewidthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"0","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data.marker.states.hover.lineWidthPlus","name":"lineWidthPlus","line":529,"lineEnd":539,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"width":{"doclet":{"description":"Set the marker's fixed width on hover state.","samples":[{"name":"70px fixed marker's width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-width","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data.marker.states.hover.width","name":"width","line":540,"lineEnd":550,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"widthPlus":{"doclet":{"description":"The number of pixels to increase the width of the\nhovered point.","samples":[{"name":"One day","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highstock"]},"meta":{"fullname":"series.heatmap.data.marker.states.hover.widthPlus","name":"widthPlus","line":562,"lineEnd":573,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}}}},"select":{"doclet":{"exclude":["radius"],"products":["highcharts","highmaps"],"type":{"names":["*"]}},"meta":{"fullname":"series.heatmap.data.marker.states.select","name":"select","line":443,"lineEnd":447,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"height":{"doclet":{"description":"Set the marker's fixed height on select state.","samples":[{"name":"70px fixed marker's width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-width","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data.marker.states.select.height","name":"height","line":597,"lineEnd":607,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"heightPlus":{"doclet":{"description":"The number of pixels to increase the height of the\nhovered point.","samples":[{"name":"One day","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highstock"]},"meta":{"fullname":"series.heatmap.data.marker.states.select.heightPlus","name":"heightPlus","line":620,"lineEnd":631,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"width":{"doclet":{"description":"Set the marker's fixed width on select state.","samples":[{"name":"70px fixed marker's width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-width","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data.marker.states.select.width","name":"width","line":586,"lineEnd":596,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"widthPlus":{"doclet":{"description":"The number of pixels to increase the width of the\nhovered point.","samples":[{"name":"One day","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highstock"]},"meta":{"fullname":"series.heatmap.data.marker.states.select.widthPlus","name":"widthPlus","line":608,"lineEnd":619,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}}}}}}}},"pointPadding":{"doclet":{"description":"Point padding for a single point.","samples":[{"name":"Point padding on tiles","value":"maps/plotoptions/tilemap-pointpadding"}],"type":{"names":["number"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data.pointPadding","name":"pointPadding","line":406,"lineEnd":415,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"value":{"doclet":{"description":"The value of the point, resulting in a color controlled by options\nas set in the [colorAxis](#colorAxis) configuration.","type":{"names":["number"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data.value","name":"value","line":383,"lineEnd":390,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"x":{"doclet":{"description":"The x value of the point. For datetime axes,\nthe X value is the timestamp in milliseconds since 1970.","type":{"names":["number"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data.x","name":"x","line":391,"lineEnd":398,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"y":{"doclet":{"description":"The y value of the point.","type":{"names":["number"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.data.y","name":"y","line":399,"lineEnd":405,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}}}},"marker":{"doclet":{"exclude":["radius","enabledThreshold"],"products":["highcharts","highmaps"],"since":"8.1","type":{"names":["*"]}},"meta":{"fullname":"series.heatmap.marker","name":"marker","line":422,"lineEnd":427,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"states":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"hover":{"doclet":{"exclude":["radius","radiusPlus"],"products":["highcharts","highmaps"],"type":{"names":["*"]}},"meta":{"fullname":"series.heatmap.marker.states.hover","name":"hover","line":428,"lineEnd":432,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"height":{"doclet":{"description":"Set the marker's fixed height on hover state.","samples":[{"name":"70px fixed marker's width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-width","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.marker.states.hover.height","name":"height","line":470,"lineEnd":480,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"heightPlus":{"doclet":{"description":"The number of pixels to increase the height of the\nhovered point.","samples":[{"name":"One day","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.marker.states.hover.heightPlus","name":"heightPlus","line":493,"lineEnd":504,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"lineWidthPlus":{"doclet":{"description":"Set the marker's fixed width on hover state.","samples":[{"name":"5 pixels wider lineWidth on hover","value":"maps/plotoptions/heatmap-marker-states-hover-linewidthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"0","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.marker.states.hover.lineWidthPlus","name":"lineWidthPlus","line":448,"lineEnd":458,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"width":{"doclet":{"description":"Set the marker's fixed width on hover state.","samples":[{"name":"70px fixed marker's width and height on hover","value":"maps/plotoptions/heatmap-marker-states-hover-width","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.marker.states.hover.width","name":"width","line":459,"lineEnd":469,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"widthPlus":{"doclet":{"description":"The number of pixels to increase the width of the\nhovered point.","samples":[{"name":"One day","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.marker.states.hover.widthPlus","name":"widthPlus","line":481,"lineEnd":492,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}}}},"select":{"doclet":{"exclude":["radius"],"products":["highcharts","highmaps"],"type":{"names":["*"]}},"meta":{"fullname":"series.heatmap.marker.states.select","name":"select","line":433,"lineEnd":437,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{"heightPlus":{"doclet":{"description":"The number of pixels to increase the height of the\nhovered point.","samples":[{"name":"One day","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.marker.states.select.heightPlus","name":"heightPlus","line":517,"lineEnd":528,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}},"widthPlus":{"doclet":{"description":"The number of pixels to increase the width of the\nhovered point.","samples":[{"name":"One day","value":"maps/plotoptions/heatmap-marker-states-hover-widthplus","products":["highcharts"]}],"type":{"names":["number","undefined"]},"defaultvalue":"undefined","products":["highcharts","highmaps"]},"meta":{"fullname":"series.heatmap.marker.states.select.widthPlus","name":"widthPlus","line":505,"lineEnd":516,"filename":"code/es-modules/Series/Heatmap/HeatmapSeriesDefaults.js"},"children":{}}}}}}}}}},"heikinashi":{"doclet":{"description":"A `heikinashi` series. If the [type](#series.heikinashi.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `heikinashi` series are defined in\n   [plotOptions.heikinashi](plotOptions.heikinashi).\n3. Options for one single series are given in\n   [the series instance array](series.heikinashi).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        heikinashi: {\n            // shared options for all heikinashi series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'heikinashi'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.heikinashi.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === heikinashi) {\n    // code specific to the heikinashi series\n}\n```\n            ","type":{"names":["*"]},"extends":"series,plotOptions.heikinashi","exclude":["dataParser","dataURL","marker"],"products":["highstock"],"requires":["module:modules/heikinashi"]},"meta":{"fullname":"series.heikinashi","name":"heikinashi","line":35,"lineEnd":46,"filename":"code/es-modules/Series/HeikinAshi/HeikinAshiSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `heikinashi` series\ntype, points can be given in the following ways:\n\n1. An array of arrays with 5 or 4 values. In this case, the values correspond\n   to `x,open,high,low,close`. If the first value is a string, it is applied\n   as the name of the point, and the `x` value is inferred. The `x` value can\n   also be omitted, in which case the inner arrays should be of length 4.\n   Then the `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 7, 2, 0, 4],\n       [1, 1, 4, 2, 8],\n       [2, 3, 3, 9, 3]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.heikinashi.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       open: 9,\n       high: 2,\n       low: 4,\n       close: 6,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       open: 1,\n       high: 4,\n       low: 7,\n       close: 7,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","type":{"names":["Array.<(Array.<(number|string), number, number, number>|Array.<(number|string), number, number, number, number>|*)>"]},"extends":"series.candlestick.data","exclude":["y"],"products":["highstock"]},"meta":{"fullname":"series.heikinashi.data","name":"data","line":47,"lineEnd":96,"filename":"code/es-modules/Series/HeikinAshi/HeikinAshiSeriesDefaults.js"},"children":{}}}},"histogram":{"doclet":{"description":"A `histogram` series. If the [type](#series.histogram.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `histogram` series are defined in\n   [plotOptions.histogram](plotOptions.histogram).\n3. Options for one single series are given in\n   [the series instance array](series.histogram).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        histogram: {\n            // shared options for all histogram series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'histogram'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.histogram.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === histogram) {\n    // code specific to the histogram series\n}\n```\n            ","extends":"series,plotOptions.histogram","exclude":["data","dataParser","dataURL","boostThreshold","boostBlending"],"products":["highcharts"],"since":"6.0.0","requires":["module:modules/histogram-bellcurve"]},"meta":{"fullname":"series.histogram","name":"histogram","line":65,"lineEnd":75,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js"},"children":{"baseSeries":{"doclet":{"description":"An integer identifying the index to use for the base series, or a string\nrepresenting the id of the series.","type":{"names":["number","string"]},"since":"6.0.0"},"meta":{"fullname":"series.histogram.baseSeries","name":"baseSeries","line":76,"lineEnd":82,"filename":"code/es-modules/Series/Histogram/HistogramSeriesDefaults.js"},"children":{}}}},"hlc":{"doclet":{"description":"A `hlc` series. If the [type](#series.hlc.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `hlc` series are defined in\n   [plotOptions.hlc](plotOptions.hlc).\n3. Options for one single series are given in\n   [the series instance array](series.hlc).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        hlc: {\n            // shared options for all hlc series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'hlc'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.hlc.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === hlc) {\n    // code specific to the hlc series\n}\n```\n            ","extends":"series,plotOptions.hlc","exclude":["dataParser","dataURL"],"products":["highstock"]},"meta":{"fullname":"series.hlc","name":"hlc","line":116,"lineEnd":124,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `hlc` series type,\npoints can be given in the following ways:\n\n1. An array of arrays with 4 or 3 values. In this case, the values correspond\n   to `x,high,low,close`. If the first value is a string, it is applied\n   as the name of the point, and the `x` value is inferred. The `x` value can\n   also be omitted, in which case the inner arrays should be of length of 3\\.\n   Then the `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 5, 6, 7],\n       [1, 4, 8, 2],\n       [2, 3, 4, 10]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.hlc.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       high: 4,\n       low: 5,\n       close: 2,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       high: 3,\n       low: 6,\n       close: 7,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","type":{"names":["Array.<(Array.<(number|string), number, number>|Array.<(number|string), number, number, number>|*)>"]},"extends":"series.arearange.data","exclude":["y","marker"],"products":["highstock"]},"meta":{"fullname":"series.hlc.data","name":"data","line":125,"lineEnd":172,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js"},"children":{"close":{"doclet":{"description":"The closing value of each data point.","type":{"names":["number"]},"products":["highstock"]},"meta":{"fullname":"series.hlc.data.close","name":"close","line":173,"lineEnd":179,"filename":"code/es-modules/Series/HLC/HLCSeriesDefaults.js"},"children":{}}}}}},"hollowcandlestick":{"doclet":{"description":"A `hollowcandlestick` series. If the [type](#series.candlestick.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `hollowcandlestick` series are defined in\n   [plotOptions.hollowcandlestick](plotOptions.hollowcandlestick).\n3. Options for one single series are given in\n   [the series instance array](series.hollowcandlestick).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        hollowcandlestick: {\n            // shared options for all hollowcandlestick series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'hollowcandlestick'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.hollowcandlestick.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === hollowcandlestick) {\n    // code specific to the hollowcandlestick series\n}\n```\n            ","type":{"names":["*"]},"extends":"series,plotOptions.hollowcandlestick","exclude":["dataParser","dataURL","marker"],"products":["highstock"]},"meta":{"fullname":"series.hollowcandlestick","name":"hollowcandlestick","line":278,"lineEnd":288,"filename":"code/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `hollowcandlestick` series\ntype, points can be given in the following ways:\n\n1. An array of arrays with 5 or 4 values. In this case, the values correspond\n   to `x,open,high,low,close`. If the first value is a string, it is applied\n   as the name of the point, and the `x` value is inferred. The `x` value can\n   also be omitted, in which case the inner arrays should be of length 4.\n   Then the `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 7, 2, 0, 4],\n       [1, 1, 4, 2, 8],\n       [2, 3, 3, 9, 3]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.hollowcandlestick.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       open: 9,\n       high: 2,\n       low: 4,\n       close: 6,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       open: 1,\n       high: 4,\n       low: 7,\n       close: 7,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","type":{"names":["Array.<(Array.<(number|string), number, number, number>|Array.<(number|string), number, number, number, number>|*)>"]},"extends":"series.candlestick.data","exclude":["y"],"products":["highstock"]},"meta":{"fullname":"series.hollowcandlestick.data","name":"data","line":289,"lineEnd":338,"filename":"code/es-modules/Series/HollowCandlestick/HollowCandlestickSeries.js"},"children":{}}}},"id":{"doclet":{"description":"An id for the series. This can be used after render time to get a pointer\nto the series object through `chart.get()`.","samples":[{"name":"Get series by id","value":"highcharts/plotoptions/series-id/","products":["highcharts"]}],"type":{"names":["string"]},"since":"1.2.0"},"meta":{"fullname":"series.id","name":"id","line":3645,"lineEnd":3655,"filename":"code/es-modules/Core/Series/Series.js"},"children":{}},"ikh":{"doclet":{"description":"A `IKH` series. If the [type](#series.ikh.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ikh` series are defined in\n   [plotOptions.ikh](plotOptions.ikh).\n3. Options for one single series are given in\n   [the series instance array](series.ikh).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ikh: {\n            // shared options for all ikh series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ikh'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ikh.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ikh) {\n    // code specific to the ikh series\n}\n```\n            ","extends":"series,plotOptions.ikh","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/ichimoku-kinko-hyo"]},"meta":{"fullname":"series.ikh","name":"ikh","line":679,"lineEnd":690,"filename":"code/es-modules/Stock/Indicators/IKH/IKHIndicator.js"},"children":{}},"index":{"doclet":{"description":"The index of the series in the chart, affecting the internal index in the\n`chart.series` array, the visible Z index as well as the order in the\nlegend.","type":{"names":["number"]},"since":"2.3.0"},"meta":{"fullname":"series.index","name":"index","line":3656,"lineEnd":3664,"filename":"code/es-modules/Core/Series/Series.js"},"children":{}},"item":{"doclet":{"description":"An `item` series. If the [type](#series.item.type) option is not specified,\nit is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `item` series are defined in\n   [plotOptions.item](plotOptions.item).\n3. Options for one single series are given in\n   [the series instance array](series.item).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        item: {\n            // shared options for all item series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'item'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.item.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === item) {\n    // code specific to the item series\n}\n```\n            ","extends":"series,plotOptions.item","exclude":["dataParser","dataURL","stack","xAxis","yAxis","dataSorting","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:modules/item-series"]},"meta":{"fullname":"series.item","name":"item","line":109,"lineEnd":119,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `item` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.item.turboThreshold),\n   this option is not available.\n   ```js\n   data: [{\n       y: 1,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       y: 7,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<string, (number|null)>|null|*)>"]},"extends":"series.pie.data","exclude":["sliced"],"products":["highcharts"]},"meta":{"fullname":"series.item.data","name":"data","line":120,"lineEnd":163,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js"},"children":{}},"events":{"doclet":{"exclude":["legendItemClick"]},"meta":{"fullname":"series.item.events","name":"events","line":171,"lineEnd":174,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js"},"children":{}}}},"keltnerchannels":{"doclet":{"description":"A Keltner Channels indicator. If the [type](#series.keltnerchannels.type)\noption is not specified, it is inherited from[chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `keltnerchannels` series are defined in\n   [plotOptions.keltnerchannels](plotOptions.keltnerchannels).\n3. Options for one single series are given in\n   [the series instance array](series.keltnerchannels).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        keltnerchannels: {\n            // shared options for all keltnerchannels series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'keltnerchannels'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.keltnerchannels.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === keltnerchannels) {\n    // code specific to the keltnerchannels series\n}\n```\n            ","extends":"series,plotOptions.keltnerchannels","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","stacking","showInNavigator"],"requires":["module:stock/indicators/indicators","module:stock/indicators/keltner-channels"]},"meta":{"fullname":"series.keltnerchannels","name":"keltnerchannels","line":199,"lineEnd":213,"filename":"code/es-modules/Stock/Indicators/KeltnerChannels/KeltnerChannelsIndicator.js"},"children":{}},"klinger":{"doclet":{"description":"A Klinger oscillator. If the [type](#series.klinger.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `klinger` series are defined in\n   [plotOptions.klinger](plotOptions.klinger).\n3. Options for one single series are given in\n   [the series instance array](series.klinger).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        klinger: {\n            // shared options for all klinger series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'klinger'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.klinger.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === klinger) {\n    // code specific to the klinger series\n}\n```\n            ","extends":"series,plotOptions.klinger","since":"9.1.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/klinger"]},"meta":{"fullname":"series.klinger","name":"klinger","line":237,"lineEnd":247,"filename":"code/es-modules/Stock/Indicators/Klinger/KlingerIndicator.js"},"children":{}},"legendIndex":{"doclet":{"description":"The sequential index of the series in the legend.","see":["[legend.reversed](#legend.reversed),\n     [yAxis.reversedStacks](#yAxis.reversedStacks)"],"samples":[{"name":"Legend in opposite order","value":"highcharts/series/legendindex/","products":["highcharts","highstock"]}],"type":{"names":["number"]}},"meta":{"fullname":"series.legendIndex","name":"legendIndex","line":3665,"lineEnd":3676,"filename":"code/es-modules/Core/Series/Series.js"},"children":{}},"line":{"doclet":{"description":"A `line` series. If the [type](#series.line.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `line` series are defined in\n   [plotOptions.line](plotOptions.line).\n3. Options for one single series are given in\n   [the series instance array](series.line).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        line: {\n            // shared options for all line series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'line'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.line.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === line) {\n    // code specific to the line series\n}\n```\n            ","extends":"series,plotOptions.line","exclude":["dataParser","dataURL"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.line","name":"line","line":273,"lineEnd":281,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `line` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 1],\n       [1, 2],\n       [2, 8]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.line.turboThreshold),\n   this option is not available.\n   ```js\n   data: [{\n       x: 1,\n       y: 9,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 6,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```\n\n**Note:** In TypeScript you have to extend `PointOptionsObject` with an\nadditional declaration to allow custom data types:\n```ts\ndeclare module `highcharts` {\n  interface PointOptionsObject {\n    custom: Record<string, (boolean|number|string)>;\n  }\n}\n```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"declare":"Highcharts.PointOptionsObject","type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]}},"meta":{"fullname":"series.line.data","name":"data","line":282,"lineEnd":349,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{"accessibility":{"doclet":{"description":"Accessibility options for a data point.","declare":"Highcharts.PointAccessibilityOptionsObject","since":"7.1.0","type":{"names":["*"]}},"meta":{"fullname":"series.line.data.accessibility","name":"accessibility","line":757,"lineEnd":763,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"description":{"doclet":{"description":"Provide a description of the data point, announced to screen readers.","type":{"names":["string"]},"since":"7.1.0"},"meta":{"fullname":"series.line.data.accessibility.description","name":"description","line":764,"lineEnd":770,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Set to false to disable accessibility functionality for a specific point.\nThe point will not be included in keyboard navigation, and will not be\nexposed to assistive technology.","type":{"names":["boolean"]},"since":"9.0.1"},"meta":{"fullname":"series.line.data.accessibility.enabled","name":"enabled","line":771,"lineEnd":779,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}}}},"className":{"doclet":{"description":"An additional, individual class name for the data point's graphic\nrepresentation. Changes to a point's color will also be reflected in a\nchart's legend and tooltip.","samples":[{"name":"Series and point class name","value":"highcharts/css/point-series-classname","products":["highcharts"]}],"type":{"names":["string"]},"since":"5.0.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.line.data.className","name":"className","line":350,"lineEnd":362,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"color":{"doclet":{"description":"Individual color for the point. By default the color is pulled from\nthe global `colors` array.\n\nIn styled mode, the `color` option doesn't take effect. Instead, use\n`colorIndex`.","samples":[{"name":"Mark the highest point","value":"highcharts/point/color/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.line.data.color","name":"color","line":363,"lineEnd":376,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"colorIndex":{"doclet":{"description":"A specific color index to use for the point, so its graphic representations\nare given the class name `highcharts-color-{n}`. In styled mode this will\nchange the color of the graphic. In non-styled mode, the color is set by the\n`fill` attribute, so the change in class name won't have a visual effect by\ndefault.\n\nSince v11, CSS variables on the form `--highcharts-color-{n}` make changing\nthe color scheme very convenient.","samples":[{"name":"Series and point color index","value":"highcharts/css/colorindex/","products":["highcharts"]}],"type":{"names":["number"]},"since":"5.0.0","products":["highcharts","gantt"]},"meta":{"fullname":"series.line.data.colorIndex","name":"colorIndex","line":377,"lineEnd":394,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"custom":{"doclet":{"description":"A reserved subspace to store options and values for customized functionality.\nHere you can add additional data for your own event callbacks and formatter\ncallbacks.","samples":[{"name":"Point and series with custom data","value":"highcharts/point/custom/","products":["highcharts"]}],"type":{"names":["Highcharts.Dictionary.<*>"]}},"meta":{"fullname":"series.line.data.custom","name":"custom","line":395,"lineEnd":405,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"dataLabels":{"doclet":{"description":"Individual data label for each point. The options are the same as\nthe ones for [plotOptions.series.dataLabels](#plotOptions.series.dataLabels) with exception of `zIndex` which is applied\non the data label's parent group.","samples":[{"name":"Show a label for the last value","value":"highcharts/point/datalabels/"}],"type":{"names":["*","Array.<*>"]},"declare":"Highcharts.DataLabelsOptions","extends":"plotOptions.line.dataLabels","exclude":["zIndex"],"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.line.data.dataLabels","name":"dataLabels","line":406,"lineEnd":421,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"dragDrop":{"doclet":{"description":"Point specific options for the draggable-points module. Overrides options\non `series.dragDrop`.","declare":"Highcharts.SeriesLineDataDragDropOptions","extends":"plotOptions.series.dragDrop","since":"6.2.0","requires":["module:modules/draggable-points"]},"meta":{"fullname":"series.line.data.dragDrop","name":"dragDrop","line":223,"lineEnd":232,"filename":"code/es-modules/Extensions/DraggablePoints/DragDropDefaults.js"},"children":{}},"drilldown":{"doclet":{"description":"The `id` of a series in the [drilldown.series](#drilldown.series) array to\nuse for a drilldown for this point.","samples":[{"name":"Basic drilldown","value":"highcharts/drilldown/basic/","products":["highcharts"]}],"type":{"names":["string"]},"since":"3.0.8","products":["highcharts"],"requires":["module:modules/drilldown"]},"meta":{"fullname":"series.line.data.drilldown","name":"drilldown","line":296,"lineEnd":308,"filename":"code/es-modules/Extensions/Drilldown/DrilldownDefaults.js"},"children":{}},"events":{"doclet":{"description":"The individual point events.","extends":"plotOptions.series.point.events","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.line.data.events","name":"events","line":482,"lineEnd":488,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"id":{"doclet":{"description":"An id for the point. This can be used after render time to get a\npointer to the point object through `chart.get()`.","samples":[{"name":"Remove an id'd point","value":"highcharts/point/id/","products":["highcharts"]}],"type":{"names":["string"]},"since":"1.2.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.line.data.id","name":"id","line":422,"lineEnd":433,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"labelrank":{"doclet":{"description":"The rank for all this point's data labels in case of collision. If two\ndata labels are about to overlap, only the one with the highest `labelrank`\nwill be drawn.\n\nThe `labelrank` set on `series.dataLabels` takes precedence over this.","type":{"names":["number"]}},"meta":{"fullname":"series.line.data.labelrank","name":"labelrank","line":434,"lineEnd":443,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"marker":{"doclet":{"description":"Options for the point markers of line-like series.","declare":"Highcharts.PointMarkerOptionsObject","extends":"plotOptions.series.marker","products":["highcharts","highstock"]},"meta":{"fullname":"series.line.data.marker","name":"marker","line":489,"lineEnd":496,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"name":{"doclet":{"description":"The name of the point as shown in the legend, tooltip, dataLabels, etc.","see":["[xAxis.uniqueNames](#xAxis.uniqueNames)"],"samples":[{"name":"Point names","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["string"]}},"meta":{"fullname":"series.line.data.name","name":"name","line":444,"lineEnd":454,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"selected":{"doclet":{"description":"Whether the data point is selected initially.","type":{"names":["boolean"]},"defaultvalue":"false","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.line.data.selected","name":"selected","line":455,"lineEnd":462,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"x":{"doclet":{"description":"The x value of the point.\n\nFor datetime axes, a number value is the timestamp in milliseconds since\n1970, while a date string is parsed according to the [current time zone]\n(https://api.highcharts.com/highcharts/time.timezone) of the\nchart. Date strings are supported since v12.","type":{"names":["number","string"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.line.data.x","name":"x","line":463,"lineEnd":474,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}},"y":{"doclet":{"description":"The y value of the point.","type":{"names":["number","null"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.line.data.y","name":"y","line":475,"lineEnd":481,"filename":"code/es-modules/Series/Line/LineSeries.js"},"children":{}}}}}},"linearregression":{"doclet":{"description":"A linear regression series. If the\n[type](#series.linearregression.type) option is not specified, it is\ninherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `linearregression` series are defined in\n   [plotOptions.linearregression](plotOptions.linearregression).\n3. Options for one single series are given in\n   [the series instance array](series.linearregression).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        linearregression: {\n            // shared options for all linearregression series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'linearregression'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.linearregression.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === linearregression) {\n    // code specific to the linearregression series\n}\n```\n            ","extends":"series,plotOptions.linearregression","since":"7.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/regressions"]},"meta":{"fullname":"series.linearregression","name":"linearregression","line":262,"lineEnd":274,"filename":"code/es-modules/Stock/Indicators/LinearRegression/LinearRegressionIndicator.js"},"children":{}},"linearregressionangle":{"doclet":{"description":"A linear regression intercept series. If the\n[type](#series.linearregressionangle.type) option is not specified, it is\ninherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `linearregressionangle` series are defined in\n   [plotOptions.linearregressionangle](plotOptions.linearregressionangle).\n3. Options for one single series are given in\n   [the series instance array](series.linearregressionangle).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        linearregressionangle: {\n            // shared options for all linearregressionangle series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'linearregressionangle'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.linearregressionangle.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === linearregressionangle) {\n    // code specific to the linearregressionangle series\n}\n```\n            ","extends":"series,plotOptions.linearregressionangle","since":"7.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/regressions"]},"meta":{"fullname":"series.linearregressionangle","name":"linearregressionangle","line":87,"lineEnd":99,"filename":"code/es-modules/Stock/Indicators/LinearRegressionAngle/LinearRegressionAngleIndicator.js"},"children":{}},"linearregressionintercept":{"doclet":{"description":"A linear regression intercept series. If the\n[type](#series.linearregressionintercept.type) option is not specified, it is\ninherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `linearregressionintercept` series are defined in\n   [plotOptions.linearregressionintercept](plotOptions.linearregressionintercept).\n3. Options for one single series are given in\n   [the series instance array](series.linearregressionintercept).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        linearregressionintercept: {\n            // shared options for all linearregressionintercept series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'linearregressionintercept'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.linearregressionintercept.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === linearregressionintercept) {\n    // code specific to the linearregressionintercept series\n}\n```\n            ","extends":"series,plotOptions.linearregressionintercept","since":"7.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/regressions"]},"meta":{"fullname":"series.linearregressionintercept","name":"linearregressionintercept","line":77,"lineEnd":89,"filename":"code/es-modules/Stock/Indicators/LinearRegressionIntercept/LinearRegressionInterceptIndicator.js"},"children":{}},"linearregressionslope":{"doclet":{"description":"A linear regression intercept series. If the\n[type](#series.linearregressionslope.type) option is not specified, it is\ninherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `linearregressionslope` series are defined in\n   [plotOptions.linearregressionslope](plotOptions.linearregressionslope).\n3. Options for one single series are given in\n   [the series instance array](series.linearregressionslope).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        linearregressionslope: {\n            // shared options for all linearregressionslope series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'linearregressionslope'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.linearregressionslope.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === linearregressionslope) {\n    // code specific to the linearregressionslope series\n}\n```\n            ","extends":"series,plotOptions.linearregressionslope","since":"7.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/regressions"]},"meta":{"fullname":"series.linearregressionslope","name":"linearregressionslope","line":77,"lineEnd":89,"filename":"code/es-modules/Stock/Indicators/LinearRegressionSlopes/LinearRegressionSlopesIndicator.js"},"children":{}},"lollipop":{"doclet":{"description":"The `lollipop` series. If the [type](#series.lollipop.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `lollipop` series are defined in\n   [plotOptions.lollipop](plotOptions.lollipop).\n3. Options for one single series are given in\n   [the series instance array](series.lollipop).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        lollipop: {\n            // shared options for all lollipop series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'lollipop'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.lollipop.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === lollipop) {\n    // code specific to the lollipop series\n}\n```\n            ","extends":"series,plotOptions.lollipop","exclude":["boostThreshold","boostBlending"],"products":["highcharts","highstock"],"requires":["module:highcharts-more","module:modules/dumbbell","module:modules/lollipop"]},"meta":{"fullname":"series.lollipop","name":"lollipop","line":156,"lineEnd":167,"filename":"code/es-modules/Series/Lollipop/LollipopSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `lollipop` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 6],\n       [1, 2],\n       [2, 6]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.lollipop.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       y: 9,\n       name: \"Point2\",\n       color: \"#00FF00\",\n       connectorWidth: 3,\n       connectorColor: \"#FF00FF\"\n   }, {\n       x: 1,\n       y: 6,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.dumbbell.data","exclude":["high","low","lowColor"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.lollipop.data","name":"data","line":168,"lineEnd":229,"filename":"code/es-modules/Series/Lollipop/LollipopSeries.js"},"children":{}}}},"macd":{"doclet":{"description":"A `MACD` series. If the [type](#series.macd.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `macd` series are defined in\n   [plotOptions.macd](plotOptions.macd).\n3. Options for one single series are given in\n   [the series instance array](series.macd).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        macd: {\n            // shared options for all macd series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'macd'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.macd.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === macd) {\n    // code specific to the macd series\n}\n```\n            ","extends":"series,plotOptions.macd","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/macd"]},"meta":{"fullname":"series.macd","name":"macd","line":358,"lineEnd":369,"filename":"code/es-modules/Stock/Indicators/MACD/MACDIndicator.js"},"children":{}},"map":{"doclet":{"description":"A `map` series. If the [type](#series.map.type) option is not specified, it\nis inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `map` series are defined in\n   [plotOptions.map](plotOptions.map).\n3. Options for one single series are given in\n   [the series instance array](series.map).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        map: {\n            // shared options for all map series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'map'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.map.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === map) {\n    // code specific to the map series\n}\n```\n            ","extends":"series,plotOptions.map","exclude":["dataParser","dataURL","dragDrop","marker"],"products":["highmaps"]},"meta":{"fullname":"series.map","name":"map","line":300,"lineEnd":308,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `map` series type, points can\nbe given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `value` options. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `[hc-key, value]`. Example:\n   ```js\n       data: [\n           ['us-ny', 0],\n           ['us-mi', 5],\n           ['us-tx', 3],\n           ['us-ak', 5]\n       ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.map.turboThreshold),\n   this option is not available.\n   ```js\n       data: [{\n           value: 6,\n           name: \"Point2\",\n           color: \"#00FF00\"\n       }, {\n           value: 6,\n           name: \"Point1\",\n           color: \"#FF00FF\"\n       }]\n   ```","type":{"names":["Array.<(number|Array.<string, (number|null)>|null|*)>"]},"products":["highmaps"]},"meta":{"fullname":"series.map.data","name":"data","line":309,"lineEnd":350,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{"color":{"doclet":{"description":"Individual color for the point. By default the color is either used\nto denote the value, or pulled from the global `colors` array.","type":{"names":["Highcharts.ColorType"]},"products":["highmaps"]},"meta":{"fullname":"series.map.data.color","name":"color","line":385,"lineEnd":392,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"dataLabels":{"doclet":{"description":"Individual data label for each point. The options are the same as\nthe ones for [plotOptions.series.dataLabels](#plotOptions.series.dataLabels).","samples":[{"name":"Disable data labels for individual areas","value":"maps/series/data-datalabels/"}],"type":{"names":["Highcharts.DataLabelsOptions"]},"products":["highmaps"]},"meta":{"fullname":"series.map.data.dataLabels","name":"dataLabels","line":393,"lineEnd":404,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"drilldown":{"doclet":{"description":"The `id` of a series in the [drilldown.series](#drilldown.series)\narray to use for a drilldown for this point.","samples":[{"name":"Basic drilldown","value":"maps/demo/map-drilldown/"}],"type":{"names":["string"]},"products":["highmaps"]},"meta":{"fullname":"series.map.data.drilldown","name":"drilldown","line":405,"lineEnd":415,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"events":{"doclet":{"description":"Individual point events","extends":"plotOptions.series.point.events","products":["highmaps"]},"meta":{"fullname":"series.map.data.events","name":"events","line":544,"lineEnd":550,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"geometry":{"doclet":{"description":"For map and mapline series types, the geometry of a point.\n\nTo achieve a better separation between the structure and the data,\nit is recommended to use `mapData` to define the geometry instead\nof defining it on the data points themselves.\n\nThe geometry object is compatible to that of a `feature` in GeoJSON, so\nfeatures of GeoJSON can be passed directly into the `data`, optionally\nafter first filtering and processing it.\n\nFor pre-projected maps (like GeoJSON maps from our\n[map collection](https://code.highcharts.com/mapdata/)), user has to specify\ncoordinates in `projectedUnits` for geometry type other than `Point`,\ninstead of `[longitude, latitude]`.","samples":[{"name":"Map point and line geometry","value":"maps/series/mappoint-line-geometry/"},{"name":"Geometry types","value":"maps/series/geometry-types/"}],"type":{"names":["Object"]},"since":"9.3.0","products":["highmaps"]},"meta":{"fullname":"series.map.data.geometry","name":"geometry","line":416,"lineEnd":441,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{"coordinates":{"doclet":{"description":"The geometry coordinates in terms of arrays of `[longitude, latitude]`, or\na two dimensional array of the same. The dimensionality must comply with the\n`type`.","type":{"names":["Array.<LonLatArray>","Array.<Array.<LonLatArray>>"]},"since":"9.3.0","products":["highmaps"]},"meta":{"fullname":"series.map.data.geometry.coordinates","name":"coordinates","line":456,"lineEnd":465,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"type":{"doclet":{"description":"The geometry type. Can be one of `LineString`, `Polygon`, `MultiLineString`\nor `MultiPolygon`.","samples":[{"name":"Geometry types","value":"maps/series/geometry-types/"}],"declare":"Highcharts.MapGeometryTypeValue","type":{"names":["\"LineString\"","\"Polygon\"","\"MultiLineString\"","\"MultiPolygon\""]},"since":"9.3.0","products":["highmaps"]},"meta":{"fullname":"series.map.data.geometry.type","name":"type","line":442,"lineEnd":455,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}}}},"id":{"doclet":{"description":"An id for the point. This can be used after render time to get a\npointer to the point object through `chart.get()`.","samples":[{"name":"Highlight a point by id","value":"maps/series/data-id/"}],"type":{"names":["string"]},"products":["highmaps"]},"meta":{"fullname":"series.map.data.id","name":"id","line":466,"lineEnd":476,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"labelrank":{"doclet":{"description":"When data labels are laid out on a map, Highmaps runs a simplified\nalgorithm to detect collision. When two labels collide, the one with\nthe lowest rank is hidden. By default the rank is computed from the\narea.","type":{"names":["number"]},"products":["highmaps"]},"meta":{"fullname":"series.map.data.labelrank","name":"labelrank","line":477,"lineEnd":486,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"middleX":{"doclet":{"description":"The relative mid point of an area, used to place the data label.\nRanges from 0 to 1\\. When `mapData` is used, middleX can be defined\nthere.","type":{"names":["number"]},"defaultvalue":"0.5","products":["highmaps"]},"meta":{"fullname":"series.map.data.middleX","name":"middleX","line":487,"lineEnd":496,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"middleY":{"doclet":{"description":"The relative mid point of an area, used to place the data label.\nRanges from 0 to 1\\. When `mapData` is used, middleY can be defined\nthere.","type":{"names":["number"]},"defaultvalue":"0.5","products":["highmaps"]},"meta":{"fullname":"series.map.data.middleY","name":"middleY","line":497,"lineEnd":506,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"name":{"doclet":{"description":"The name of the point as shown in the legend, tooltip, dataLabel\netc.","samples":[{"name":"Point names","value":"maps/series/data-datalabels/"}],"type":{"names":["string"]},"products":["highmaps"]},"meta":{"fullname":"series.map.data.name","name":"name","line":507,"lineEnd":517,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"path":{"doclet":{"description":"For map and mapline series types, the SVG path for the shape. For\ncompatibility with old IE, not all SVG path definitions are supported,\nbut M, L and C operators are safe.\n\nTo achieve a better separation between the structure and the data,\nit is recommended to use `mapData` to define that paths instead\nof defining them on the data points themselves.\n\nFor providing true geographical shapes based on longitude and latitude, use\nthe `geometry` option instead.","samples":[{"name":"Paths defined in data","value":"maps/series/data-path/"}],"type":{"names":["string"]},"products":["highmaps"]},"meta":{"fullname":"series.map.data.path","name":"path","line":518,"lineEnd":536,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"states":{"doclet":{"extends":"plotOptions.map.states","products":["highmaps"]},"meta":{"fullname":"series.map.data.states","name":"states","line":551,"lineEnd":555,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"value":{"doclet":{"description":"The numeric value of the data point.","type":{"names":["number","null"]},"products":["highmaps"]},"meta":{"fullname":"series.map.data.value","name":"value","line":537,"lineEnd":543,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}}}}}},"mapData":{"doclet":{"description":"An array of objects containing a `geometry` or `path` definition and\noptionally additional properties to join in the `data` as per the `joinBy`\noption. GeoJSON and TopoJSON structures can also be passed directly into\n`mapData`.","samples":[{"name":"Map data and joinBy","value":"maps/demo/category-map/"},{"name":"Multiple map sources","value":"maps/series/mapdata-multiple/"}],"type":{"names":["Array.<Highcharts.SeriesMapDataOptions>","Highcharts.GeoJSON","Highcharts.TopoJSON"]},"products":["highmaps"]},"meta":{"fullname":"series.mapData","name":"mapData","line":285,"lineEnd":299,"filename":"code/es-modules/Series/Map/MapSeriesDefaults.js"},"children":{}},"mapbubble":{"doclet":{"description":"A `mapbubble` series. If the [type](#series.mapbubble.type) option\nis not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `mapbubble` series are defined in\n   [plotOptions.mapbubble](plotOptions.mapbubble).\n3. Options for one single series are given in\n   [the series instance array](series.mapbubble).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        mapbubble: {\n            // shared options for all mapbubble series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'mapbubble'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.mapbubble.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === mapbubble) {\n    // code specific to the mapbubble series\n}\n```\n            ","extends":"series,plotOptions.mapbubble","exclude":["dataParser","dataURL"],"products":["highmaps"]},"meta":{"fullname":"series.mapbubble","name":"mapbubble","line":262,"lineEnd":270,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `mapbubble` series\ntype, points can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values\n   will be interpreted as `z` options. Example:\n\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.mapbubble.turboThreshold),\n   this option is not available.\n\n   ```js\n       data: [{\n           z: 9,\n           name: \"Point2\",\n           color: \"#00FF00\"\n       }, {\n           z: 10,\n           name: \"Point1\",\n           color: \"#FF00FF\"\n       }]\n   ```","type":{"names":["Array.<(number|null|*)>"]},"extends":"series.mappoint.data","exclude":["labelrank","middleX","middleY","path","value","x","y","lat","lon"],"products":["highmaps"]},"meta":{"fullname":"series.mapbubble.data","name":"data","line":271,"lineEnd":305,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{"z":{"doclet":{"description":"While the `x` and `y` values of the bubble are determined by the\nunderlying map, the `z` indicates the actual value that gives the\nsize of the bubble.","samples":[{"name":"Bubble","value":"maps/demo/map-bubble/","products":["highmaps"]}],"type":{"names":["number","null"]},"products":["highmaps"]},"meta":{"fullname":"series.mapbubble.data.z","name":"z","line":306,"lineEnd":317,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}}}},"marker":{"doclet":{"exclude":["enabled","enabledThreshold","height","radius","width"],"samples":[{"name":"Map bubble with mapmarker symbol","value":"maps/plotoptions/mapbubble-symbol","products":["highmaps"]}]},"meta":{"fullname":"series.mapbubble.marker","name":"marker","line":318,"lineEnd":323,"filename":"code/es-modules/Series/MapBubble/MapBubbleSeries.js"},"children":{}}}},"mapline":{"doclet":{"description":"A `mapline` series. If the [type](#series.mapline.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `mapline` series are defined in\n   [plotOptions.mapline](plotOptions.mapline).\n3. Options for one single series are given in\n   [the series instance array](series.mapline).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        mapline: {\n            // shared options for all mapline series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'mapline'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.mapline.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === mapline) {\n    // code specific to the mapline series\n}\n```\n            ","extends":"series,plotOptions.mapline","exclude":["dataParser","dataURL","dragDrop","marker"],"products":["highmaps"]},"meta":{"fullname":"series.mapline","name":"mapline","line":59,"lineEnd":67,"filename":"code/es-modules/Series/MapLine/MapLineSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `mapline` series type,\npoints can be given in the following ways:\n\n1.  An array of numerical values. In this case, the numerical values\nwill be interpreted as `value` options. Example:\n\n ```js\n data: [0, 5, 3, 5]\n ```\n\n2.  An array of arrays with 2 values. In this case, the values correspond\nto `[hc-key, value]`. Example:\n\n ```js\n    data: [\n        ['us-ny', 0],\n        ['us-mi', 5],\n        ['us-tx', 3],\n        ['us-ak', 5]\n    ]\n ```\n\n3.  An array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series' [turboThreshold](#series.map.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        value: 6,\n        name: \"Point2\",\n        color: \"#00FF00\"\n    }, {\n        value: 6,\n        name: \"Point1\",\n        color: \"#FF00FF\"\n    }]\n ```","type":{"names":["Array.<(number|Array.<string, (number|null)>|null|*)>"]},"extends":"series.map.data","exclude":["drilldown"],"products":["highmaps"]},"meta":{"fullname":"series.mapline.data","name":"data","line":68,"lineEnd":113,"filename":"code/es-modules/Series/MapLine/MapLineSeriesDefaults.js"},"children":{"lineWidth":{"doclet":{"description":"Pixel width of the mapline line.","type":{"names":["number","undefined"]},"since":"10.3.3","products":["highmaps"]},"meta":{"fullname":"series.mapline.data.lineWidth","name":"lineWidth","line":122,"lineEnd":129,"filename":"code/es-modules/Series/MapLine/MapLineSeriesDefaults.js"},"children":{}}}}}},"mappoint":{"doclet":{"description":"A `mappoint` series. If the [type](#series.mappoint.type) option\nis not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `mappoint` series are defined in\n   [plotOptions.mappoint](plotOptions.mappoint).\n3. Options for one single series are given in\n   [the series instance array](series.mappoint).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        mappoint: {\n            // shared options for all mappoint series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'mappoint'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.mappoint.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === mappoint) {\n    // code specific to the mappoint series\n}\n```\n            ","extends":"series,plotOptions.mappoint","exclude":["dataParser","dataURL"],"products":["highmaps"]},"meta":{"fullname":"series.mappoint","name":"mappoint","line":63,"lineEnd":72,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `mappoint` series\ntype, points can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond\nto `[hc-key, value]`. Example:\n\n ```js\n    data: [\n        ['us-ny', 0],\n        ['us-mi', 5],\n        ['us-tx', 3],\n        ['us-ak', 5]\n    ]\n ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.mappoint.turboThreshold),\n   this option is not available.\n   ```js\n       data: [{\n           x: 1,\n           y: 7,\n           name: \"Point2\",\n           color: \"#00FF00\"\n       }, {\n           x: 1,\n           y: 4,\n           name: \"Point1\",\n           color: \"#FF00FF\"\n       }]\n   ```","type":{"names":["Array.<(number|Array.<number, (number|null)>|null|*)>"]},"extends":"series.map.data","exclude":["labelrank","middleX","middleY","path","value"],"products":["highmaps"]},"meta":{"fullname":"series.mappoint.data","name":"data","line":73,"lineEnd":122,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{"geometry":{"doclet":{"description":"The geometry of a point.\n\nTo achieve a better separation between the structure and the data,\nit is recommended to use `mapData` to define the geometry instead\nof defining it on the data points themselves.\n\nThe geometry object is compatible to that of a `feature` in geoJSON, so\nfeatures of geoJSON can be passed directly into the `data`, optionally\nafter first filtering and processing it.","samples":[{"name":"Map point and line geometry","value":"maps/series/mappoint-line-geometry/"}],"type":{"names":["Object"]},"since":"9.3.0","products":["highmaps"]},"meta":{"fullname":"series.mappoint.data.geometry","name":"geometry","line":123,"lineEnd":141,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{"coordinates":{"doclet":{"description":"The geometry coordinates in terms of `[longitude, latitude]`.","type":{"names":["Highcharts.LonLatArray"]},"since":"9.3.0","products":["highmaps"]},"meta":{"fullname":"series.mappoint.data.geometry.coordinates","name":"coordinates","line":151,"lineEnd":158,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{}},"type":{"doclet":{"description":"The geometry type, which in case of the `mappoint` series is always `Point`.","type":{"names":["\"Point\""]},"since":"9.3.0","products":["highmaps"]},"meta":{"fullname":"series.mappoint.data.geometry.type","name":"type","line":142,"lineEnd":150,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{}}}},"lat":{"doclet":{"description":"The latitude of the point. Must be combined with the `lon` option\nto work. Overrides `x` and `y` values.","samples":[{"name":"Point position by lat/lon","value":"maps/demo/mappoint-latlon/","products":["highmaps"]}],"type":{"names":["number"]},"since":"1.1.0","products":["highmaps"]},"meta":{"fullname":"series.mappoint.data.lat","name":"lat","line":159,"lineEnd":170,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{}},"lon":{"doclet":{"description":"The longitude of the point. Must be combined with the `lon` option\nto work. Overrides `x` and `y` values.","samples":[{"name":"Point position by lat/lon","value":"maps/demo/mappoint-latlon/","products":["highmaps"]}],"type":{"names":["number"]},"since":"1.1.0","products":["highmaps"]},"meta":{"fullname":"series.mappoint.data.lon","name":"lon","line":171,"lineEnd":182,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{}},"x":{"doclet":{"description":"The x coordinate of the point in terms of projected units.","samples":[{"name":"Map point demo","value":"maps/series/mapline-mappoint-path-xy/","products":["highmaps"]}],"type":{"names":["number"]},"products":["highmaps"]},"meta":{"fullname":"series.mappoint.data.x","name":"x","line":183,"lineEnd":192,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{}},"y":{"doclet":{"description":"The x coordinate of the point in terms of projected units.","samples":[{"name":"Map point demo","value":"maps/series/mapline-mappoint-path-xy/","products":["highmaps"]}],"type":{"names":["number","null"]},"products":["highmaps"]},"meta":{"fullname":"series.mappoint.data.y","name":"y","line":193,"lineEnd":202,"filename":"code/es-modules/Series/MapPoint/MapPointSeriesDefaults.js"},"children":{}}}}}},"mfi":{"doclet":{"description":"A `MFI` series. If the [type](#series.mfi.type) option is not specified, it\nis inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `mfi` series are defined in\n   [plotOptions.mfi](plotOptions.mfi).\n3. Options for one single series are given in\n   [the series instance array](series.mfi).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        mfi: {\n            // shared options for all mfi series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'mfi'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.mfi.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === mfi) {\n    // code specific to the mfi series\n}\n```\n            ","extends":"series,plotOptions.mfi","since":"6.0.0","exclude":["dataParser","dataURL"],"products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/mfi"]},"meta":{"fullname":"series.mfi","name":"mfi","line":186,"lineEnd":197,"filename":"code/es-modules/Stock/Indicators/MFI/MFIIndicator.js"},"children":{}},"momentum":{"doclet":{"description":"A `Momentum` series. If the [type](#series.momentum.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `momentum` series are defined in\n   [plotOptions.momentum](plotOptions.momentum).\n3. Options for one single series are given in\n   [the series instance array](series.momentum).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        momentum: {\n            // shared options for all momentum series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'momentum'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.momentum.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === momentum) {\n    // code specific to the momentum series\n}\n```\n            ","extends":"series,plotOptions.momentum","since":"6.0.0","exclude":["dataParser","dataURL"],"products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/momentum"]},"meta":{"fullname":"series.momentum","name":"momentum","line":110,"lineEnd":121,"filename":"code/es-modules/Stock/Indicators/Momentum/MomentumIndicator.js"},"children":{}},"name":{"doclet":{"description":"The name of the series as shown in the legend, tooltip etc.","samples":[{"name":"Series name","value":"highcharts/series/name/","products":["highcharts"]},{"name":"Series name","value":"maps/demo/category-map/","products":["highmaps"]}],"type":{"names":["string"]}},"meta":{"fullname":"series.name","name":"name","line":3677,"lineEnd":3687,"filename":"code/es-modules/Core/Series/Series.js"},"children":{}},"natr":{"doclet":{"description":"A `NATR` series. If the [type](#series.natr.type) option is not specified, it\nis inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `natr` series are defined in\n   [plotOptions.natr](plotOptions.natr).\n3. Options for one single series are given in\n   [the series instance array](series.natr).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        natr: {\n            // shared options for all natr series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'natr'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.natr.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === natr) {\n    // code specific to the natr series\n}\n```\n            ","extends":"series,plotOptions.natr","since":"7.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/atr","module:stock/indicators/natr"]},"meta":{"fullname":"series.natr","name":"natr","line":83,"lineEnd":95,"filename":"code/es-modules/Stock/Indicators/NATR/NATRIndicator.js"},"children":{}},"networkgraph":{"doclet":{"description":"A `networkgraph` series. If the [type](#series.networkgraph.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `networkgraph` series are defined in\n   [plotOptions.networkgraph](plotOptions.networkgraph).\n3. Options for one single series are given in\n   [the series instance array](series.networkgraph).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        networkgraph: {\n            // shared options for all networkgraph series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'networkgraph'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.networkgraph.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === networkgraph) {\n    // code specific to the networkgraph series\n}\n```\n            ","extends":"series,plotOptions.networkgraph","exclude":["boostThreshold","animation","animationLimit","connectEnds","connectNulls","cropThreshold","dragDrop","getExtremesFromAll","label","linecap","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointStart","softThreshold","stack","stacking","step","threshold","xAxis","yAxis","zoneAxis","dataSorting","boostBlending"],"products":["highcharts"],"requires":["module:modules/networkgraph"]},"meta":{"fullname":"series.networkgraph","name":"networkgraph","line":417,"lineEnd":431,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `networkgraph` series type,\npoints can be given in the following way:\n\nAn array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of\ndata points exceeds the series'\n[turboThreshold](#series.area.turboThreshold), this option is not available.\n\n ```js\n    data: [{\n        from: 'Category1',\n        to: 'Category2'\n    }, {\n        from: 'Category1',\n        to: 'Category3'\n    }]\n ```","type":{"names":["Array.<(Object|Array|number)>"]},"extends":"series.line.data","exclude":["drilldown","marker","x","y","dragDrop"],"samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.data","name":"data","line":432,"lineEnd":466,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"dataLabels":{"doclet":{"type":{"names":["Highcharts.SeriesNetworkgraphDataLabelsOptionsObject","Array.<Highcharts.SeriesNetworkgraphDataLabelsOptionsObject>"]},"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.data.dataLabels","name":"dataLabels","line":467,"lineEnd":471,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"from":{"doclet":{"description":"The node that the link runs from.","type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.data.from","name":"from","line":472,"lineEnd":478,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"to":{"doclet":{"description":"The node that the link runs to.","type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.data.to","name":"to","line":479,"lineEnd":485,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}}}},"events":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"afterSimulation":{"doclet":{"description":"Fires after the simulation is ended and the layout is stable.","type":{"names":["Highcharts.NetworkgraphAfterSimulationCallbackFunction"]},"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.events.afterSimulation","name":"afterSimulation","line":410,"lineEnd":416,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}}}},"nodes":{"doclet":{"description":"A collection of options for the individual nodes. The nodes in a\nnetworkgraph diagram are auto-generated instances of `Highcharts.Point`,\nbut options can be applied here and linked by the `id`.","samples":[{"name":"Networkgraph diagram with node options","value":"highcharts/series-networkgraph/data-options/"}],"type":{"names":["Array.<*>"]},"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.nodes","name":"nodes","line":486,"lineEnd":497,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{"color":{"doclet":{"description":"The color of the auto generated node.","type":{"names":["Highcharts.ColorString"]},"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.nodes.color","name":"color","line":506,"lineEnd":512,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"colorIndex":{"doclet":{"description":"The color index of the auto generated node, especially for use in styled\nmode.","type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.nodes.colorIndex","name":"colorIndex","line":513,"lineEnd":520,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"dataLabels":{"doclet":{"description":"Individual data label for each node. The options are the same as\nthe ones for [series.networkgraph.dataLabels](#series.networkgraph.dataLabels).","type":{"names":["Highcharts.SeriesNetworkgraphDataLabelsOptionsObject","Array.<Highcharts.SeriesNetworkgraphDataLabelsOptionsObject>"]}},"meta":{"fullname":"series.networkgraph.nodes.dataLabels","name":"dataLabels","line":556,"lineEnd":563,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"id":{"doclet":{"description":"The id of the auto-generated node, referring to the `from` or `to` setting of\nthe link.","type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.nodes.id","name":"id","line":498,"lineEnd":505,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"marker":{"doclet":{"description":"Options for the node markers.","extends":"plotOptions.networkgraph.marker"},"meta":{"fullname":"series.networkgraph.nodes.marker","name":"marker","line":550,"lineEnd":555,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"mass":{"doclet":{"description":"Mass of the node. By default, each node has mass equal to it's marker radius\n. Mass is used to determine how two connected nodes should affect\neach other:\n\nAttractive force is multiplied by the ratio of two connected\nnodes; if a big node has weights twice as the small one, then the small one\nwill move towards the big one twice faster than the big one to the small one\n.","samples":[{"name":"Mass determined by marker.radius","value":"highcharts/series-networkgraph/ragdoll/"}],"type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.nodes.mass","name":"mass","line":533,"lineEnd":549,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}},"name":{"doclet":{"description":"The name to display for the node in data labels and tooltips. Use this when\nthe name is different from the `id`. Where the id must be unique for each\nnode, this is not necessary for the name.","samples":[{"name":"Networkgraph diagram with node options","value":"highcharts/series-networkgraph/data-options/"}],"type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.networkgraph.nodes.name","name":"name","line":521,"lineEnd":532,"filename":"code/es-modules/Series/Networkgraph/NetworkgraphSeriesDefaults.js"},"children":{}}}}}},"obv":{"doclet":{"description":"A `OBV` series. If the [type](#series.obv.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `obv` series are defined in\n   [plotOptions.obv](plotOptions.obv).\n3. Options for one single series are given in\n   [the series instance array](series.obv).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        obv: {\n            // shared options for all obv series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'obv'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.obv.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === obv) {\n    // code specific to the obv series\n}\n```\n            ","extends":"series,plotOptions.obv","since":"9.1.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/obv"]},"meta":{"fullname":"series.obv","name":"obv","line":141,"lineEnd":152,"filename":"code/es-modules/Stock/Indicators/OBV/OBVIndicator.js"},"children":{}},"ohlc":{"doclet":{"description":"A `ohlc` series. If the [type](#series.ohlc.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ohlc` series are defined in\n   [plotOptions.ohlc](plotOptions.ohlc).\n3. Options for one single series are given in\n   [the series instance array](series.ohlc).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ohlc: {\n            // shared options for all ohlc series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ohlc'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ohlc.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ohlc) {\n    // code specific to the ohlc series\n}\n```\n            ","extends":"series,plotOptions.ohlc","exclude":["dataParser","dataURL"],"products":["highstock"]},"meta":{"fullname":"series.ohlc","name":"ohlc","line":74,"lineEnd":82,"filename":"code/es-modules/Series/OHLC/OHLCSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `ohlc` series type,\npoints can be given in the following ways:\n\n1. An array of arrays with 5 or 4 values. In this case, the values correspond\n   to `x,open,high,low,close`. If the first value is a string, it is applied\n   as the name of the point, and the `x` value is inferred. The `x` value can\n   also be omitted, in which case the inner arrays should be of length 4\\.\n   Then the `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 6, 5, 6, 7],\n       [1, 9, 4, 8, 2],\n       [2, 6, 3, 4, 10]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.ohlc.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       open: 3,\n       high: 4,\n       low: 5,\n       close: 2,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       open: 4,\n       high: 3,\n       low: 6,\n       close: 7,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","type":{"names":["Array.<(Array.<(number|string), number, number, number>|Array.<(number|string), number, number, number, number>|*)>"]},"extends":"series.arearange.data","exclude":["y","marker"],"products":["highstock"]},"meta":{"fullname":"series.ohlc.data","name":"data","line":83,"lineEnd":132,"filename":"code/es-modules/Series/OHLC/OHLCSeriesDefaults.js"},"children":{"close":{"doclet":{"description":"The closing value of each data point.","type":{"names":["number"]},"products":["highstock"]},"meta":{"fullname":"series.ohlc.data.close","name":"close","line":133,"lineEnd":139,"filename":"code/es-modules/Series/OHLC/OHLCSeriesDefaults.js"},"children":{}},"open":{"doclet":{"description":"The opening value of each data point.","type":{"names":["number"]},"products":["highstock"]},"meta":{"fullname":"series.ohlc.data.open","name":"open","line":140,"lineEnd":146,"filename":"code/es-modules/Series/OHLC/OHLCSeriesDefaults.js"},"children":{}}}}}},"organization":{"doclet":{"description":"An `organization` series. If the [type](#series.organization.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `organization` series are defined in\n   [plotOptions.organization](plotOptions.organization).\n3. Options for one single series are given in\n   [the series instance array](series.organization).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        organization: {\n            // shared options for all organization series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'organization'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.organization.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === organization) {\n    // code specific to the organization series\n}\n```\n            ","extends":"series,plotOptions.organization","exclude":["dataSorting","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:modules/sankey","module:modules/organization"]},"meta":{"fullname":"series.organization","name":"organization","line":320,"lineEnd":330,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `organization` series\ntype, points can be given in the following way:\n\nAn array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series' [turboThreshold](#series.area.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        from: 'Category1',\n        to: 'Category2',\n        weight: 2\n    }, {\n        from: 'Category1',\n        to: 'Category3',\n        weight: 5\n    }]\n ```","type":{"names":["Array.<*>"]},"extends":"series.sankey.data","products":["highcharts"]},"meta":{"fullname":"series.organization.data","name":"data","line":438,"lineEnd":463,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{"dataLabels":{"doclet":{"type":{"names":["Highcharts.SeriesOrganizationDataLabelsOptionsObject","Array.<Highcharts.SeriesOrganizationDataLabelsOptionsObject>"]},"products":["highcharts"]},"meta":{"fullname":"series.organization.data.dataLabels","name":"dataLabels","line":331,"lineEnd":335,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}}}},"dataLabels":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"linkFormat":{"doclet":{"description":"The format string specifying what to show for *links* in the\norganization chart.\n\nBest to use with [`linkTextPath`](#series.organization.dataLabels.linkTextPath) enabled.","samples":[{"name":"Organization chart with link labels","value":"highcharts/series-organization/link-labels"}],"type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.organization.dataLabels.linkFormat","name":"linkFormat","line":376,"lineEnd":389,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}},"linkFormatter":{"doclet":{"description":"Callback to format data labels for _links_ in the\norganization chart. The `linkFormat` option takes\nprecedence over the `linkFormatter`.","type":{"names":["OrganizationDataLabelsFormatterCallbackFunction"]},"products":["highcharts"]},"meta":{"fullname":"series.organization.dataLabels.linkFormatter","name":"linkFormatter","line":390,"lineEnd":399,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}},"linkTextPath":{"doclet":{"description":"Options for a _link_ label text which should follow link\nconnection.","samples":[{"name":"Organization chart with link labels","value":"highcharts/series-organization/link-labels"}],"type":{"names":["DataLabelTextPathOptions"]},"products":["highcharts"]},"meta":{"fullname":"series.organization.dataLabels.linkTextPath","name":"linkTextPath","line":400,"lineEnd":411,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}}}},"link":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"offset":{"doclet":{"description":"Modifier of the shape of the curved link. Works best for values\nbetween 0 and 1, where 0 is a straight line, and 1 is a shape\nclose to the default one.","defaultvalue":"0.5","type":{"names":["number"]},"since":"10.3.0","products":["highcharts"]},"meta":{"fullname":"series.organization.link.offset","name":"offset","line":70,"lineEnd":80,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}}}},"linkColor":{"doclet":{"description":"The color of the links between nodes. This option is moved to\n[link.color](#plotOptions.organization.link.color).","type":{"names":["Highcharts.ColorString"]},"deprecated":true},"meta":{"fullname":"series.organization.linkColor","name":"linkColor","line":270,"lineEnd":279,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}},"linkLineWidth":{"doclet":{"description":"The line width of the links connecting nodes, in pixels. This option\nis now deprecated and moved to the\n[link.radius](#plotOptions.organization.link.lineWidth).","samples":[{"name":"Square links","value":"highcharts/series-organization/link-options"}],"deprecated":true},"meta":{"fullname":"series.organization.linkLineWidth","name":"linkLineWidth","line":280,"lineEnd":291,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}},"linkRadius":{"doclet":{"description":"Radius for the rounded corners of the links between nodes. This\noption is now deprecated, and moved to\n[link.radius](#plotOptions.organization.link.radius).","samples":[{"name":"Square links","value":"highcharts/series-organization/link-options"}],"deprecated":true},"meta":{"fullname":"series.organization.linkRadius","name":"linkRadius","line":53,"lineEnd":63,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}},"nodes":{"doclet":{"description":"A collection of options for the individual nodes. The nodes in an org chart\nare auto-generated instances of `Highcharts.Point`, but options can be\napplied here and linked by the `id`.","extends":"series.sankey.nodes","type":{"names":["Array.<*>"]},"products":["highcharts"]},"meta":{"fullname":"series.organization.nodes","name":"nodes","line":336,"lineEnd":345,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{"dataLabels":{"doclet":{"description":"Individual data label for each node. The options are the same as\nthe ones for [series.organization.dataLabels](#series.organization.dataLabels).","type":{"names":["Highcharts.SeriesOrganizationDataLabelsOptionsObject","Array.<Highcharts.SeriesOrganizationDataLabelsOptionsObject>"]}},"meta":{"fullname":"series.organization.nodes.dataLabels","name":"dataLabels","line":346,"lineEnd":353,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}},"description":{"doclet":{"description":"The job description for the node card, will be inserted by the default\n`dataLabel.nodeFormatter`.","samples":[{"name":"Org chart with job descriptions","value":"highcharts/demo/organization-chart"}],"type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.organization.nodes.description","name":"description","line":354,"lineEnd":364,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}},"image":{"doclet":{"description":"An image for the node card, will be inserted by the default\n`dataLabel.nodeFormatter`.","samples":[{"name":"Org chart with images","value":"highcharts/demo/organization-chart"}],"type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.organization.nodes.image","name":"image","line":365,"lineEnd":375,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}},"layout":{"doclet":{"description":"Layout for the node's children. If `hanging`, this node's children will hang\nbelow their parent, allowing a tighter packing of nodes in the diagram.\n\nNote: Since version 10.0.0, the `hanging` layout is set by default for\nchildren of a parent using `hanging` layout.","samples":[{"name":"Hanging layout","value":"highcharts/demo/organization-chart"}],"type":{"names":["Highcharts.SeriesOrganizationNodesLayoutValue"]},"defaultvalue":"normal","products":["highcharts"]},"meta":{"fullname":"series.organization.nodes.layout","name":"layout","line":412,"lineEnd":426,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}},"title":{"doclet":{"description":"The job title for the node card, will be inserted by the default\n`dataLabel.nodeFormatter`.","samples":[{"name":"Org chart with job titles","value":"highcharts/demo/organization-chart"}],"type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.organization.nodes.title","name":"title","line":427,"lineEnd":437,"filename":"code/es-modules/Series/Organization/OrganizationSeriesDefaults.js"},"children":{}}}}}},"packedbubble":{"doclet":{"description":"A `packedbubble` series. If the [type](#series.packedbubble.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `packedbubble` series are defined in\n   [plotOptions.packedbubble](plotOptions.packedbubble).\n3. Options for one single series are given in\n   [the series instance array](series.packedbubble).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        packedbubble: {\n            // shared options for all packedbubble series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'packedbubble'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.packedbubble.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === packedbubble) {\n    // code specific to the packedbubble series\n}\n```\n            ","type":{"names":["Object"]},"extends":"series,plotOptions.packedbubble","exclude":["cropThreshold","dataParser","dataSorting","dataURL","dragDrop","stack","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.packedbubble","name":"packedbubble","line":336,"lineEnd":347,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `packedbubble` series type,\npoints can be given in the following ways:\n\n1.  An array of `values`.\n\n ```js\n    data: [5, 1, 20]\n ```\n\n2.  An array of objects with named values. The objects are point\nconfiguration objects as seen below. If the total number of data points\nexceeds the series' [turboThreshold](#series.packedbubble.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        value: 1,\n        name: \"Point2\",\n        color: \"#00FF00\"\n    }, {\n        value: 5,\n        name: \"Point1\",\n        color: \"#FF00FF\"\n    }]\n ```","type":{"names":["Array.<(Object|Array)>"]},"extends":"series.line.data","exclude":["marker","x","y"],"samples":[{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"products":["highcharts"]},"meta":{"fullname":"series.packedbubble.data","name":"data","line":348,"lineEnd":382,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{"dataLabels":{"doclet":{"type":{"names":["Highcharts.SeriesPackedBubbleDataLabelsOptionsObject","Array.<Highcharts.SeriesPackedBubbleDataLabelsOptionsObject>"]},"products":["highcharts"]},"meta":{"fullname":"series.packedbubble.data.dataLabels","name":"dataLabels","line":383,"lineEnd":387,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{}}}},"marker":{"doclet":{"exclude":["enabled","enabledThreshold","height","radius","width"],"products":["highcharts"]},"meta":{"fullname":"series.packedbubble.marker","name":"marker","line":388,"lineEnd":392,"filename":"code/es-modules/Series/PackedBubble/PackedBubbleSeriesDefaults.js"},"children":{}}}},"pareto":{"doclet":{"description":"A `pareto` series. If the [type](#series.pareto.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pareto` series are defined in\n   [plotOptions.pareto](plotOptions.pareto).\n3. Options for one single series are given in\n   [the series instance array](series.pareto).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pareto: {\n            // shared options for all pareto series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pareto'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pareto.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pareto) {\n    // code specific to the pareto series\n}\n```\n            ","extends":"series,plotOptions.pareto","since":"6.0.0","products":["highcharts"],"exclude":["data","dataParser","dataURL","boostThreshold","boostBlending"],"requires":["module:modules/pareto"]},"meta":{"fullname":"series.pareto","name":"pareto","line":45,"lineEnd":55,"filename":"code/es-modules/Series/ParetoSeries/ParetoSeriesDefaults.js"},"children":{"baseSeries":{"doclet":{"description":"An integer identifying the index to use for the base series, or a string\nrepresenting the id of the series.","type":{"names":["number","string"]},"defaultvalue":"undefined","since":"6.0.0"},"meta":{"fullname":"series.pareto.baseSeries","name":"baseSeries","line":56,"lineEnd":63,"filename":"code/es-modules/Series/ParetoSeries/ParetoSeriesDefaults.js"},"children":{}},"data":{"doclet":{"description":"An array of data points for the series. For the `pareto` series type,\npoints are calculated dynamically.","type":{"names":["Array.<(Array.<(number|string)>|*)>"]},"extends":"series.column.data","since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"series.pareto.data","name":"data","line":64,"lineEnd":73,"filename":"code/es-modules/Series/ParetoSeries/ParetoSeriesDefaults.js"},"children":{}}}},"pc":{"doclet":{"description":"A Price channel indicator. If the [type](#series.pc.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pc` series are defined in\n   [plotOptions.pc](plotOptions.pc).\n3. Options for one single series are given in\n   [the series instance array](series.pc).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pc: {\n            // shared options for all pc series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pc'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pc.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pc) {\n    // code specific to the pc series\n}\n```\n            ","extends":"series,plotOptions.pc","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/price-channel"]},"meta":{"fullname":"series.pc","name":"pc","line":160,"lineEnd":174,"filename":"code/es-modules/Stock/Indicators/PC/PCIndicator.js"},"children":{}},"pictorial":{"doclet":{"description":"A `pictorial` series. If the [type](#series.pictorial.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pictorial` series are defined in\n   [plotOptions.pictorial](plotOptions.pictorial).\n3. Options for one single series are given in\n   [the series instance array](series.pictorial).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pictorial: {\n            // shared options for all pictorial series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pictorial'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pictorial.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pictorial) {\n    // code specific to the pictorial series\n}\n```\n            ","extends":"series,plotOptions.pictorial","since":"11.0.0","products":["highcharts"],"exclude":["dataParser","borderRadius","boostBlending","boostThreshold","borderColor","borderWidth","centerInCategory","connectEnds","connectNulls","crisp","colorKey","dataURL","dataAsColumns","depth","dragDrop","edgeColor","edgeWidth","linecap","lineWidth","marker","dataSorting","dashStyle","onPoint","relativeXValue","shadow","zoneAxis","zones"],"requires":["module:modules/pictorial"]},"meta":{"fullname":"series.pictorial","name":"pictorial","line":361,"lineEnd":376,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `pictorial` series type,\npoints can be given in the following ways:\n\n1. An array of arrays with 2 values. In this case, the values correspond\n   to `x,y`. If the first value is a string, it is applied as the name\n   of the point, and the `x` value is inferred. The `x` value can also be\n   omitted, in which case the inner arrays should be of length 2. Then the\n   `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 40],\n       [1, 50],\n       [2, 60]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.pictorial.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 0,\n       y: 40,\n       name: \"Point1\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 60,\n       name: \"Point2\",\n       color: \"#FF00FF\"\n   }]\n   ```","type":{"names":["Array.<(Array.<(number|string), number>|Array.<(number|string), number, number>|*)>"]},"extends":"series.column.data","samples":[{"name":"Pictorial chart","value":"highcharts/demo/pictorial/","products":["highcharts"]},{"name":"Pictorial stackShadow option","value":"highcharts/demo/pictorial-stackshadow/","products":["highcharts"]},{"name":"Pictorial max option","value":"highcharts/series-pictorial/paths-max/","products":["highcharts"]}],"exclude":["borderColor","borderWidth","dashStyle","dragDrop"],"since":"11.0.0","products":["highcharts"]},"meta":{"fullname":"series.pictorial.data","name":"data","line":377,"lineEnd":429,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js"},"children":{}},"paths":{"doclet":{"description":"The paths include options describing the series image. For further details on\npreparing the SVG image, please refer to the [pictorial\ndocumentation](https://www.highcharts.com/docs/chart-and-series-types/pictorial).","declare":"Highcharts.SeriesPictorialPathsOptionsObject","type":{"names":["Array.<*>"]},"samples":[{"name":"Pictorial chart","value":"highcharts/demo/pictorial/","products":["highcharts"]}],"since":"11.0.0","products":["highcharts"]},"meta":{"fullname":"series.pictorial.paths","name":"paths","line":430,"lineEnd":444,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js"},"children":{"definition":{"doclet":{"description":"The definition defines a path to be drawn. It corresponds `d` SVG attribute.","type":{"names":["string"]},"samples":[{"name":"Pictorial chart","value":"highcharts/demo/pictorial/","products":["highcharts"]}],"products":["highcharts"],"since":"11.0.0"},"meta":{"fullname":"series.pictorial.paths.definition","name":"definition","line":445,"lineEnd":455,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js"},"children":{}},"max":{"doclet":{"description":"The max option determines height of the image. It is the ratio of\n`yAxis.max` to the `paths.max`.","samples":[{"name":"Pictorial max option","value":"highcharts/series-pictorial/paths-max","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"yAxis.max","products":["highcharts"],"since":"11.0.0"},"meta":{"fullname":"series.pictorial.paths.max","name":"max","line":456,"lineEnd":467,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js"},"children":{}}}}}},"pie":{"doclet":{"description":"A `pie` series. If the [type](#series.pie.type) option is not specified,\nit is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pie` series are defined in\n   [plotOptions.pie](plotOptions.pie).\n3. Options for one single series are given in\n   [the series instance array](series.pie).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pie: {\n            // shared options for all pie series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pie'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pie.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pie) {\n    // code specific to the pie series\n}\n```\n            ","extends":"series,plotOptions.pie","exclude":["cropThreshold","dataParser","dataURL","linkedTo","stack","xAxis","yAxis","dataSorting","step","boostThreshold","boostBlending"],"products":["highcharts","highmaps"]},"meta":{"fullname":"series.pie","name":"pie","line":558,"lineEnd":567,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `pie` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.pie.turboThreshold),\n   this option is not available.\n   ```js\n   data: [{\n       y: 1,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       y: 7,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<string, (number|null)>|null|*)>"]},"extends":"series.line.data","exclude":["marker","x"],"products":["highcharts","highmaps"]},"meta":{"fullname":"series.pie.data","name":"data","line":568,"lineEnd":611,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{"dataLabels":{"doclet":{"type":{"names":["Highcharts.SeriesPieDataLabelsOptionsObject"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.pie.data.dataLabels","name":"dataLabels","line":612,"lineEnd":616,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"legendIndex":{"doclet":{"description":"The sequential index of the data point in the legend.","type":{"names":["number"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.pie.data.legendIndex","name":"legendIndex","line":164,"lineEnd":170,"filename":"code/es-modules/Series/Item/ItemSeriesDefaults.js"},"children":{}},"sliced":{"doclet":{"description":"Whether to display a slice offset from the center.","samples":[{"name":"One sliced point","value":"highcharts/point/sliced/","products":["highcharts"]}],"type":{"names":["boolean"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.pie.data.sliced","name":"sliced","line":624,"lineEnd":633,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}}}},"dataLabels":{"doclet":{"extends":"plotOptions.pie.dataLabels","exclude":["align","allowOverlap","inside","staggerLines","step"],"products":["highcharts","highmaps"]},"meta":{"fullname":"series.pie.dataLabels","name":"dataLabels","line":634,"lineEnd":639,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}},"events":{"doclet":{"exclude":["legendItemClick"],"products":["highcharts","highmaps"]},"meta":{"fullname":"series.pie.events","name":"events","line":640,"lineEnd":644,"filename":"code/es-modules/Series/Pie/PieSeriesDefaults.js"},"children":{}}}},"pivotpoints":{"doclet":{"description":"A pivot points indicator. If the [type](#series.pivotpoints.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pivotpoints` series are defined in\n   [plotOptions.pivotpoints](plotOptions.pivotpoints).\n3. Options for one single series are given in\n   [the series instance array](series.pivotpoints).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pivotpoints: {\n            // shared options for all pivotpoints series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pivotpoints'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pivotpoints.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pivotpoints) {\n    // code specific to the pivotpoints series\n}\n```\n            ","extends":"series,plotOptions.pivotpoints","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/pivot-points"]},"meta":{"fullname":"series.pivotpoints","name":"pivotpoints","line":282,"lineEnd":293,"filename":"code/es-modules/Stock/Indicators/PivotPoints/PivotPointsIndicator.js"},"children":{}},"pointandfigure":{"doclet":{"description":"A `pointandfigure` series. If the [type](#series.pointandfigure.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pointandfigure` series are defined in\n   [plotOptions.pointandfigure](plotOptions.pointandfigure).\n3. Options for one single series are given in\n   [the series instance array](series.pointandfigure).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pointandfigure: {\n            // shared options for all pointandfigure series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pointandfigure'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pointandfigure.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pointandfigure) {\n    // code specific to the pointandfigure series\n}\n```\n            ","type":{"names":["*"]},"extends":"series,plotOptions.pointandfigure","products":["highstock"],"exclude":["boostBlending","boostThreshold","compare","compareBase","compareStart","cumulative","cumulativeStart","dataGrouping","dataGrouping","dragDrop"],"requires":["module:modules/pointandfigure"]},"meta":{"fullname":"series.pointandfigure","name":"pointandfigure","line":68,"lineEnd":81,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `pointandfigure` series\ntype, points can be given in the following way:\n\n1. An array of arrays with 2 values. In this case, the values correspond\n   to `x, y`. Y values are parsed under the hood to create\n   point and figure format data points.\n   ```js\n   data: [\n       [1665408600000, 140.42],\n       [1665495000000, 138.98],\n       [1665581400000, 138.34]\n   ]\n   ```\n2. An array of objects with named values `{x, y}`.\n   ```js\n   data: [\n       {x: 1665408600000, y: 140.42},\n       {x: 1665495000000, y: 138.98},\n       {x: 1665581400000, y: 138.34}\n   ]\n   ```","type":{"names":["Array.<(Array.<number, number>|*)>"]},"extends":"series.scatter.data","products":["highstock"]},"meta":{"fullname":"series.pointandfigure.data","name":"data","line":82,"lineEnd":109,"filename":"code/es-modules/Series/PointAndFigure/PointAndFigureSeriesDefaults.js"},"children":{}}}},"polygon":{"doclet":{"description":"A `polygon` series. If the [type](#series.polygon.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `polygon` series are defined in\n   [plotOptions.polygon](plotOptions.polygon).\n3. Options for one single series are given in\n   [the series instance array](series.polygon).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        polygon: {\n            // shared options for all polygon series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'polygon'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.polygon.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === polygon) {\n    // code specific to the polygon series\n}\n```\n            ","extends":"series,plotOptions.polygon","exclude":["dataParser","dataURL","stack","boostThreshold","boostBlending"],"products":["highcharts","highstock"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.polygon","name":"polygon","line":52,"lineEnd":61,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `polygon` series\ntype, points can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 10],\n       [1, 3],\n       [2, 1]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.polygon.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       y: 1,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 8,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.line.data","products":["highcharts","highstock"]},"meta":{"fullname":"series.polygon.data","name":"data","line":62,"lineEnd":120,"filename":"code/es-modules/Series/Polygon/PolygonSeriesDefaults.js"},"children":{}}}},"ppo":{"doclet":{"description":"A `Percentage Price Oscillator` series. If the [type](#series.ppo.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `ppo` series are defined in\n   [plotOptions.ppo](plotOptions.ppo).\n3. Options for one single series are given in\n   [the series instance array](series.ppo).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        ppo: {\n            // shared options for all ppo series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'ppo'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.ppo.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === ppo) {\n    // code specific to the ppo series\n}\n```\n            ","extends":"series,plotOptions.ppo","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/ppo"]},"meta":{"fullname":"series.ppo","name":"ppo","line":132,"lineEnd":145,"filename":"code/es-modules/Stock/Indicators/PPO/PPOIndicator.js"},"children":{}},"priceenvelopes":{"doclet":{"description":"A price envelopes indicator. If the [type](#series.priceenvelopes.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `priceenvelopes` series are defined in\n   [plotOptions.priceenvelopes](plotOptions.priceenvelopes).\n3. Options for one single series are given in\n   [the series instance array](series.priceenvelopes).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        priceenvelopes: {\n            // shared options for all priceenvelopes series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'priceenvelopes'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.priceenvelopes.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === priceenvelopes) {\n    // code specific to the priceenvelopes series\n}\n```\n            ","extends":"series,plotOptions.priceenvelopes","since":"6.0.0","exclude":["dataParser","dataURL"],"products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/price-envelopes"]},"meta":{"fullname":"series.priceenvelopes","name":"priceenvelopes","line":190,"lineEnd":201,"filename":"code/es-modules/Stock/Indicators/PriceEnvelopes/PriceEnvelopesIndicator.js"},"children":{}},"psar":{"doclet":{"description":"A `PSAR` series. If the [type](#series.psar.type) option is not specified, it\nis inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `psar` series are defined in\n   [plotOptions.psar](plotOptions.psar).\n3. Options for one single series are given in\n   [the series instance array](series.psar).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        psar: {\n            // shared options for all psar series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'psar'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.psar.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === psar) {\n    // code specific to the psar series\n}\n```\n            ","extends":"series,plotOptions.psar","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/psar"]},"meta":{"fullname":"series.psar","name":"psar","line":277,"lineEnd":288,"filename":"code/es-modules/Stock/Indicators/PSAR/PSARIndicator.js"},"children":{}},"pyramid":{"doclet":{"description":"A `pyramid` series. If the [type](#series.pyramid.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pyramid` series are defined in\n   [plotOptions.pyramid](plotOptions.pyramid).\n3. Options for one single series are given in\n   [the series instance array](series.pyramid).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pyramid: {\n            // shared options for all pyramid series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pyramid'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pyramid.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pyramid) {\n    // code specific to the pyramid series\n}\n```\n            ","extends":"series,plotOptions.pyramid","exclude":["dataParser","dataURL","stack","xAxis","yAxis","dataSorting","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:modules/funnel"]},"meta":{"fullname":"series.pyramid","name":"pyramid","line":42,"lineEnd":52,"filename":"code/es-modules/Series/Pyramid/PyramidSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `pyramid` series\ntype, points can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.pyramid.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       y: 9,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       y: 6,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|null|*)>"]},"extends":"series.pie.data","exclude":["sliced"],"products":["highcharts"]},"meta":{"fullname":"series.pyramid.data","name":"data","line":53,"lineEnd":90,"filename":"code/es-modules/Series/Pyramid/PyramidSeriesDefaults.js"},"children":{}}}},"pyramid3d":{"doclet":{"description":"A `pyramid3d` series. If the [type](#series.pyramid3d.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `pyramid3d` series are defined in\n   [plotOptions.pyramid3d](plotOptions.pyramid3d).\n3. Options for one single series are given in\n   [the series instance array](series.pyramid3d).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        pyramid3d: {\n            // shared options for all pyramid3d series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'pyramid3d'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.pyramid3d.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === pyramid3d) {\n    // code specific to the pyramid3d series\n}\n```\n            ","since":"7.1.0","extends":"series,plotOptions.pyramid3d","exclude":["allAreas","boostThreshold","colorAxis","compare","compareBase","dataSorting"],"products":["highcharts"],"samples":[{"name":"Pyramid3d","value":"highcharts/demo/pyramid3d/","products":["highcharts"]}],"requires":["module:modules/pyramid3d"]},"meta":{"fullname":"series.pyramid3d","name":"pyramid3d","line":54,"lineEnd":65,"filename":"code/es-modules/Series/Pyramid3D/Pyramid3DSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `pyramid3d` series\ntype, points can be given in the following ways:\n\n1.  An array of numerical values. In this case, the numerical values\nwill be interpreted as `y` options. The `x` values will be automatically\ncalculated, either starting at 0 and incremented by 1, or from `pointStart`\nand `pointInterval` given in the series options. If the axis has\ncategories, these will be used. Example:\n\n ```js\n data: [0, 5, 3, 5]\n ```\n\n2.  An array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series'\n[turboThreshold](#series.pyramid3d.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        y: 2,\n        name: \"Point2\",\n        color: \"#00FF00\"\n    }, {\n        y: 4,\n        name: \"Point1\",\n        color: \"#FF00FF\"\n    }]\n ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<number>|*)>"]},"extends":"series.funnel3d.data","products":["highcharts"],"since":"7.1.0"},"meta":{"fullname":"series.pyramid3d.data","name":"data","line":66,"lineEnd":113,"filename":"code/es-modules/Series/Pyramid3D/Pyramid3DSeriesDefaults.js"},"children":{}}}},"renko":{"doclet":{"description":"A `renko` series. If the [type](#series.renko.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `renko` series are defined in\n   [plotOptions.renko](plotOptions.renko).\n3. Options for one single series are given in\n   [the series instance array](series.renko).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        renko: {\n            // shared options for all renko series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'renko'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.renko.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === renko) {\n    // code specific to the renko series\n}\n```\n            ","type":{"names":["*"]},"extends":"series,plotOptions.renko","products":["highstock"],"exclude":["boost","compare","compareStart","connectNulls","cumulative","cumulativeStart","dataGrouping","dataParser","dataSorting","dataURL","dragDrop","marker","step"],"requires":["module:modules/renko"]},"meta":{"fullname":"series.renko","name":"renko","line":69,"lineEnd":82,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `renko` series\ntype, points can be given in the following ways:\n\n1. An array of arrays with 1 or 2 values correspond to `x,close`. If the\nfirst value is a string, it is applied as the name of the point, and the\n`x` value is inferred. The `x` value can also be omitted, in which case\nthe inner arrays should be of length 4. Then the `x` value is\nautomatically calculated, either starting at 0 and incremented by 1, or\nfrom `pointStart` and `pointInterval` given in the series options.\n   ```js\n   data: [\n       [0, 7],\n       [1, 1],\n       [2, 3]\n   ]\n   ```\n\n2. An array of objects with named values. With renko series, the data\ndoes not directly correspond to the points in the series. the reason\nis that the points are calculated based on the trends and boxSize.\nSetting options for individual point is impossible.\n\n   ```js\n   data: [{\n       x: 1,\n       y: 6\n   }, {\n       x: 1,\n       y: 7,\n   }]\n   ```","type":{"names":["Array.<(Array.<number, number>|*)>"]},"extends":"series.column.data","products":["highstock"]},"meta":{"fullname":"series.renko.data","name":"data","line":83,"lineEnd":120,"filename":"code/es-modules/Series/Renko/RenkoSeriesDefaults.js"},"children":{}}}},"roc":{"doclet":{"description":"A `ROC` series. If the [type](#series.wma.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nRate of change indicator (ROC). The indicator value for each point\nis defined as:\n\n`(C - Cn) / Cn * 100`\n\nwhere: `C` is the close value of the point of the same x in the\nlinked series and `Cn` is the close value of the point `n` periods\nago. `n` is set through [period](#series.roc.params.period).\n\nThis series requires `linkedTo` option to be set.\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `roc` series are defined in\n   [plotOptions.roc](plotOptions.roc).\n3. Options for one single series are given in\n   [the series instance array](series.roc).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        roc: {\n            // shared options for all roc series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'roc'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.roc.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === roc) {\n    // code specific to the roc series\n}\n```\n            ","extends":"series,plotOptions.roc","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/roc"]},"meta":{"fullname":"series.roc","name":"roc","line":143,"lineEnd":165,"filename":"code/es-modules/Stock/Indicators/ROC/ROCIndicator.js"},"children":{}},"rsi":{"doclet":{"description":"A `RSI` series. If the [type](#series.rsi.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `rsi` series are defined in\n   [plotOptions.rsi](plotOptions.rsi).\n3. Options for one single series are given in\n   [the series instance array](series.rsi).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        rsi: {\n            // shared options for all rsi series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'rsi'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.rsi.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === rsi) {\n    // code specific to the rsi series\n}\n```\n            ","extends":"series,plotOptions.rsi","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/rsi"]},"meta":{"fullname":"series.rsi","name":"rsi","line":153,"lineEnd":164,"filename":"code/es-modules/Stock/Indicators/RSI/RSIIndicator.js"},"children":{}},"sankey":{"doclet":{"description":"A `sankey` series. If the [type](#series.sankey.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `sankey` series are defined in\n   [plotOptions.sankey](plotOptions.sankey).\n3. Options for one single series are given in\n   [the series instance array](series.sankey).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        sankey: {\n            // shared options for all sankey series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'sankey'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.sankey.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === sankey) {\n    // code specific to the sankey series\n}\n```\n            ","extends":"series,plotOptions.sankey","exclude":["animationLimit","boostBlending","boostThreshold","borderColor","borderRadius","borderWidth","crisp","cropThreshold","dataParser","dataURL","depth","dragDrop","edgeColor","edgeWidth","findNearestPointBy","getExtremesFromAll","grouping","groupPadding","groupZPadding","label","maxPointWidth","negativeColor","pointInterval","pointIntervalUnit","pointPadding","pointPlacement","pointRange","pointStart","pointWidth","shadow","softThreshold","stacking","threshold","zoneAxis","zones","dataSorting"],"products":["highcharts"],"requires":["module:modules/sankey"]},"meta":{"fullname":"series.sankey","name":"sankey","line":347,"lineEnd":363,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `sankey` series type,\npoints can be given in the following way:\n\nAn array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series' [turboThreshold](#series.area.turboThreshold),\nthis option is not available.\n\n ```js\n    data: [{\n        from: 'Category1',\n        to: 'Category2',\n        weight: 2\n    }, {\n        from: 'Category1',\n        to: 'Category3',\n        weight: 5\n    }]\n ```\n\n When you provide the data as tuples, the keys option has to be set as well.\n\n ```js\n    keys: ['from', 'to', 'weight'],\n    data: [\n        ['Category1', 'Category2', 2],\n        ['Category1', 'Category3', 5]\n    ]\n ```","samples":[{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"declare":"Highcharts.SeriesSankeyPointOptionsObject","type":{"names":["Array.<*>","Array.<Array.<(string|number)>>"]},"extends":"series.line.data","exclude":["dragDrop","drilldown","marker","x","y"],"products":["highcharts"]},"meta":{"fullname":"series.sankey.data","name":"data","line":502,"lineEnd":542,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{"color":{"doclet":{"description":"The color for the individual _link_. By default, the link color is the same\nas the node it extends from. The `series.fillOpacity` option also applies to\nthe points, so when setting a specific link color, consider setting the\n`fillOpacity` to 1.","type":{"names":["Highcharts.ColorType"]},"products":["highcharts"]},"meta":{"fullname":"series.sankey.data.color","name":"color","line":543,"lineEnd":552,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"dataLabels":{"doclet":{"type":{"names":["Highcharts.SeriesSankeyDataLabelsOptionsObject","Array.<Highcharts.SeriesSankeyDataLabelsOptionsObject>"]},"products":["highcharts"]},"meta":{"fullname":"series.sankey.data.dataLabels","name":"dataLabels","line":553,"lineEnd":557,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"from":{"doclet":{"description":"The node that the link runs from.","type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.sankey.data.from","name":"from","line":558,"lineEnd":564,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"outgoing":{"doclet":{"description":"Whether the link goes out of the system.","samples":[{"name":"Sankey chart with outgoing links","value":"highcharts/plotoptions/sankey-outgoing"}],"type":{"names":["boolean"]},"defaultvalue":"false","products":["highcharts"]},"meta":{"fullname":"series.sankey.data.outgoing","name":"outgoing","line":572,"lineEnd":582,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"to":{"doclet":{"description":"The node that the link runs to.","type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.sankey.data.to","name":"to","line":565,"lineEnd":571,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"weight":{"doclet":{"description":"The weight of the link.","type":{"names":["number","null"]},"products":["highcharts"]},"meta":{"fullname":"series.sankey.data.weight","name":"weight","line":583,"lineEnd":589,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}}}},"nodes":{"doclet":{"description":"A collection of options for the individual nodes. The nodes in a sankey\ndiagram are auto-generated instances of `Highcharts.Point`, but options can\nbe applied here and linked by the `id`.","samples":[{"name":"Sankey diagram with node options","value":"highcharts/css/sankey/"}],"declare":"Highcharts.SeriesSankeyNodesOptionsObject","type":{"names":["Array.<*>"]},"products":["highcharts"]},"meta":{"fullname":"series.sankey.nodes","name":"nodes","line":364,"lineEnd":376,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{"color":{"doclet":{"description":"The color of the auto generated node.","type":{"names":["Highcharts.ColorType"]},"products":["highcharts"]},"meta":{"fullname":"series.sankey.nodes.color","name":"color","line":385,"lineEnd":391,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"colorIndex":{"doclet":{"description":"The color index of the auto generated node, especially for use in styled\nmode.","type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"series.sankey.nodes.colorIndex","name":"colorIndex","line":392,"lineEnd":399,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"column":{"doclet":{"description":"An optional column index of where to place the node. The default behavior is\nto place it next to the preceding node. Note that this option name is\ncounter intuitive in inverted charts, like for example an organization chart\nrendered top down. In this case the \"columns\" are horizontal.","samples":[{"name":"Specified node column","value":"highcharts/plotoptions/sankey-node-column/"}],"type":{"names":["number"]},"since":"6.0.5","products":["highcharts"]},"meta":{"fullname":"series.sankey.nodes.column","name":"column","line":400,"lineEnd":413,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"dataLabels":{"doclet":{"description":"Individual data label for each node. The options are the same as\nthe ones for [series.sankey.dataLabels](#series.sankey.dataLabels).","extends":"plotOptions.sankey.dataLabels"},"meta":{"fullname":"series.sankey.nodes.dataLabels","name":"dataLabels","line":414,"lineEnd":420,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"height":{"doclet":{"description":"The height of the node.","samples":[{"name":"Sankey diagram with height options","value":"highcharts/series-sankey/height/"}],"type":{"names":["number"]},"since":"11.3.0"},"meta":{"fullname":"series.sankey.nodes.height","name":"height","line":421,"lineEnd":430,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"id":{"doclet":{"description":"The id of the auto-generated node, referring to the `from` or `to` setting of\nthe link.","type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.sankey.nodes.id","name":"id","line":377,"lineEnd":384,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"level":{"doclet":{"description":"An optional level index of where to place the node. The default behavior is\nto place it next to the preceding node. Alias of `nodes.column`, but in\ninverted sankey and org chart, the levels are laid out as rows.","type":{"names":["number"]},"since":"7.1.0","products":["highcharts"]},"meta":{"fullname":"series.sankey.nodes.level","name":"level","line":431,"lineEnd":440,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"name":{"doclet":{"description":"The name to display for the node in data labels and tooltips. Use this when\nthe name is different from the `id`. Where the id must be unique for each\nnode, this is not necessary for the name.","samples":[{"name":"Sankey diagram with node options","value":"highcharts/css/sankey/"}],"type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.sankey.nodes.name","name":"name","line":441,"lineEnd":452,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"offset":{"doclet":{"description":"This option is deprecated, use\n[offsetHorizontal](#series.sankey.nodes.offsetHorizontal) and\n[offsetVertical](#series.sankey.nodes.offsetVertical) instead.\n\nIn a horizontal layout, the vertical offset of a node in terms of weight.\nPositive values shift the node downwards, negative shift it upwards. In a\nvertical layout, like organization chart, the offset is horizontal.\n\nIf a percentage string is given, the node is offset by the percentage of the\nnode size plus `nodePadding`.","deprecated":true,"type":{"names":["number","string"]},"defaultvalue":"0","since":"6.0.5","products":["highcharts"]},"meta":{"fullname":"series.sankey.nodes.offset","name":"offset","line":453,"lineEnd":471,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"offsetHorizontal":{"doclet":{"description":"The horizontal offset of a node. Positive values shift the node right,\nnegative shift it left.\n\nIf a percentage string is given, the node is offset by the percentage of the\nnode size.","samples":[{"name":"Specified node offset","value":"highcharts/plotoptions/sankey-node-column/"}],"type":{"names":["number","string"]},"since":"9.3.0","products":["highcharts"]},"meta":{"fullname":"series.sankey.nodes.offsetHorizontal","name":"offsetHorizontal","line":472,"lineEnd":486,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}},"offsetVertical":{"doclet":{"description":"The vertical offset of a node. Positive values shift the node down,\nnegative shift it up.\n\nIf a percentage string is given, the node is offset by the percentage of the\nnode size.","samples":[{"name":"Specified node offset","value":"highcharts/plotoptions/sankey-node-column/"}],"type":{"names":["number","string"]},"since":"9.3.0","products":["highcharts"]},"meta":{"fullname":"series.sankey.nodes.offsetVertical","name":"offsetVertical","line":487,"lineEnd":501,"filename":"code/es-modules/Series/Sankey/SankeySeriesDefaults.js"},"children":{}}}}}},"scatter":{"doclet":{"description":"A `scatter` series. If the [type](#series.scatter.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `scatter` series are defined in\n   [plotOptions.scatter](plotOptions.scatter).\n3. Options for one single series are given in\n   [the series instance array](series.scatter).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        scatter: {\n            // shared options for all scatter series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'scatter'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.scatter.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === scatter) {\n    // code specific to the scatter series\n}\n```\n            ","extends":"series,plotOptions.scatter","exclude":["cropThreshold","dataParser","dataURL","useOhlcData"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.scatter","name":"scatter","line":118,"lineEnd":126,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `scatter` series\ntype, points can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 0],\n       [1, 8],\n       [2, 9]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.scatter.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       y: 2,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 4,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.line.data","products":["highcharts","highstock"]},"meta":{"fullname":"series.scatter.data","name":"data","line":127,"lineEnd":185,"filename":"code/es-modules/Series/Scatter/ScatterSeriesDefaults.js"},"children":{}}}},"scatter3d":{"doclet":{"description":"A `scatter3d` series. If the [type](#series.scatter3d.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `scatter3d` series are defined in\n   [plotOptions.scatter3d](plotOptions.scatter3d).\n3. Options for one single series are given in\n   [the series instance array](series.scatter3d).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        scatter3d: {\n            // shared options for all scatter3d series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'scatter3d'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.scatter3d.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === scatter3d) {\n    // code specific to the scatter3d series\n}\n```\n            ","extends":"series,plotOptions.scatter3d","exclude":["boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:highcharts-3d"]},"meta":{"fullname":"series.scatter3d","name":"scatter3d","line":40,"lineEnd":49,"filename":"code/es-modules/Series/Scatter3D/Scatter3DSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `scatter3d` series\ntype, points can be given in the following ways:\n\n1.  An array of arrays with 3 values. In this case, the values correspond\nto `x,y,z`. If the first value is a string, it is applied as the name\nof the point, and the `x` value is inferred.\n\n ```js\n    data: [\n        [0, 0, 1],\n        [1, 8, 7],\n        [2, 9, 2]\n    ]\n ```\n\n3.  An array of objects with named values. The following snippet shows only a\nfew settings, see the complete options set below. If the total number of data\npoints exceeds the series'\n[turboThreshold](#series.scatter3d.turboThreshold), this option is not\navailable.\n\n ```js\n    data: [{\n        x: 1,\n        y: 2,\n        z: 24,\n        name: \"Point2\",\n        color: \"#00FF00\"\n    }, {\n        x: 1,\n        y: 4,\n        z: 12,\n        name: \"Point1\",\n        color: \"#FF00FF\"\n    }]\n ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<number>|*)>"]},"extends":"series.scatter.data","products":["highcharts"]},"meta":{"fullname":"series.scatter3d.data","name":"data","line":50,"lineEnd":103,"filename":"code/es-modules/Series/Scatter3D/Scatter3DSeriesDefaults.js"},"children":{"z":{"doclet":{"description":"The z value for each data point.","type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"series.scatter3d.data.z","name":"z","line":104,"lineEnd":110,"filename":"code/es-modules/Series/Scatter3D/Scatter3DSeriesDefaults.js"},"children":{}}}}}},"slowstochastic":{"doclet":{"description":"A Slow Stochastic indicator. If the [type](#series.slowstochastic.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `slowstochastic` series are defined in\n   [plotOptions.slowstochastic](plotOptions.slowstochastic).\n3. Options for one single series are given in\n   [the series instance array](series.slowstochastic).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        slowstochastic: {\n            // shared options for all slowstochastic series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'slowstochastic'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.slowstochastic.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === slowstochastic) {\n    // code specific to the slowstochastic series\n}\n```\n            ","extends":"series,plotOptions.slowstochastic","since":"8.0.0","products":["highstock"],"requires":["module:stock/indicators/indicators","module:stock/indicators/stochastic","module:stock/indicators/slow-stochastic"]},"meta":{"fullname":"series.slowstochastic","name":"slowstochastic","line":116,"lineEnd":127,"filename":"code/es-modules/Stock/Indicators/SlowStochastic/SlowStochasticIndicator.js"},"children":{}},"sma":{"doclet":{"description":"A `SMA` series. If the [type](#series.sma.type) option is not specified, it\nis inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `sma` series are defined in\n   [plotOptions.sma](plotOptions.sma).\n3. Options for one single series are given in\n   [the series instance array](series.sma).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        sma: {\n            // shared options for all sma series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'sma'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.sma.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === sma) {\n    // code specific to the sma series\n}\n```\n            ","extends":"series,plotOptions.sma","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL","useOhlcData"],"requires":["module:stock/indicators/indicators"]},"meta":{"fullname":"series.sma","name":"sma","line":388,"lineEnd":398,"filename":"code/es-modules/Stock/Indicators/SMA/SMAIndicator.js"},"children":{}},"solidgauge":{"doclet":{"description":"A `solidgauge` series. If the [type](#series.solidgauge.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `solidgauge` series are defined in\n   [plotOptions.solidgauge](plotOptions.solidgauge).\n3. Options for one single series are given in\n   [the series instance array](series.solidgauge).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        solidgauge: {\n            // shared options for all solidgauge series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'solidgauge'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.solidgauge.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === solidgauge) {\n    // code specific to the solidgauge series\n}\n```\n            ","extends":"series,plotOptions.solidgauge","exclude":["animationLimit","boostThreshold","connectEnds","connectNulls","cropThreshold","dashStyle","dataParser","dataURL","dial","findNearestPointBy","getExtremesFromAll","marker","negativeColor","pointPlacement","pivot","shadow","softThreshold","stack","stacking","states","step","threshold","turboThreshold","wrap","zoneAxis","zones","dataSorting","boostBlending"],"products":["highcharts"],"requires":["module:modules/solid-gauge"]},"meta":{"fullname":"series.solidgauge","name":"solidgauge","line":132,"lineEnd":147,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `solidgauge` series\ntype, points can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.solidgauge.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       y: 5,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       y: 7,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```\n\nThe typical gauge only contains a single data value.","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|null|*)>"]},"extends":"series.gauge.data","products":["highcharts"]},"meta":{"fullname":"series.solidgauge.data","name":"data","line":148,"lineEnd":186,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{"innerRadius":{"doclet":{"description":"The inner radius of an individual point in a solid gauge. Can be given only\nin percentage, either as a number or a string like `\"50%\"`.","samples":[{"name":"Individual radius and innerRadius","value":"highcharts/plotoptions/solidgauge-radius/","products":["highcharts"]}],"type":{"names":["string"]},"since":"4.1.6","products":["highcharts"]},"meta":{"fullname":"series.solidgauge.data.innerRadius","name":"innerRadius","line":187,"lineEnd":198,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{}},"radius":{"doclet":{"description":"The outer radius of an individual point in a solid gauge. Can be\ngiven only in percentage, either as a number or a string like `\"100%\"`.","samples":[{"name":"Individual radius and innerRadius","value":"highcharts/plotoptions/solidgauge-radius/","products":["highcharts"]}],"type":{"names":["string"]},"since":"4.1.6","products":["highcharts"]},"meta":{"fullname":"series.solidgauge.data.radius","name":"radius","line":199,"lineEnd":210,"filename":"code/es-modules/Series/SolidGauge/SolidGaugeSeriesDefaults.js"},"children":{}}}}}},"spline":{"doclet":{"description":"A `spline` series. If the [type](#series.spline.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `spline` series are defined in\n   [plotOptions.spline](plotOptions.spline).\n3. Options for one single series are given in\n   [the series instance array](series.spline).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        spline: {\n            // shared options for all spline series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'spline'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.spline.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === spline) {\n    // code specific to the spline series\n}\n```\n            ","extends":"series,plotOptions.spline","exclude":["dataParser","dataURL","step","boostThreshold","boostBlending"],"products":["highcharts","highstock"]},"meta":{"fullname":"series.spline","name":"spline","line":203,"lineEnd":211,"filename":"code/es-modules/Series/Spline/SplineSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `spline` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 9],\n       [1, 2],\n       [2, 8]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.spline.turboThreshold),\n   this option is not available.\n   ```js\n   data: [{\n       x: 1,\n       y: 9,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 0,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.line.data","products":["highcharts","highstock"]},"meta":{"fullname":"series.spline.data","name":"data","line":212,"lineEnd":270,"filename":"code/es-modules/Series/Spline/SplineSeries.js"},"children":{}}}},"stack":{"doclet":{"description":"This option allows grouping series in a stacked chart. The stack option\ncan be a string or anything else, as long as the grouped series' stack\noptions match each other after conversion into a string.","samples":[{"name":"Stacked and grouped columns","value":"highcharts/series/stack/","products":["highcharts"]},{"name":"Stacked and grouped, centered in category","value":"highcharts/series/stack-centerincategory/","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"2.1.0","products":["highcharts","highstock"]},"meta":{"fullname":"series.stack","name":"stack","line":760,"lineEnd":774,"filename":"code/es-modules/Core/Series/SeriesDefaults.js"},"children":{}},"stochastic":{"doclet":{"description":"A Stochastic indicator. If the [type](#series.stochastic.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `stochastic` series are defined in\n   [plotOptions.stochastic](plotOptions.stochastic).\n3. Options for one single series are given in\n   [the series instance array](series.stochastic).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        stochastic: {\n            // shared options for all stochastic series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'stochastic'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.stochastic.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === stochastic) {\n    // code specific to the stochastic series\n}\n```\n            ","extends":"series,plotOptions.stochastic","since":"6.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/stochastic"]},"meta":{"fullname":"series.stochastic","name":"stochastic","line":204,"lineEnd":217,"filename":"code/es-modules/Stock/Indicators/Stochastic/StochasticIndicator.js"},"children":{}},"streamgraph":{"doclet":{"description":"A `streamgraph` series. If the [type](#series.streamgraph.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `streamgraph` series are defined in\n   [plotOptions.streamgraph](plotOptions.streamgraph).\n3. Options for one single series are given in\n   [the series instance array](series.streamgraph).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        streamgraph: {\n            // shared options for all streamgraph series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'streamgraph'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.streamgraph.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === streamgraph) {\n    // code specific to the streamgraph series\n}\n```\n            ","extends":"series,plotOptions.streamgraph","exclude":["dataParser","dataURL","step","boostThreshold","boostBlending"],"products":["highcharts","highstock"],"requires":["module:modules/streamgraph"]},"meta":{"fullname":"series.streamgraph","name":"streamgraph","line":58,"lineEnd":67,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js"},"children":{"color":{"doclet":{"see":["[fillColor](#series.streamgraph.fillColor)","[fillOpacity](#series.streamgraph.fillOpacity)"]},"meta":{"fullname":"series.streamgraph.color","name":"color","line":68,"lineEnd":73,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js"},"children":{}},"data":{"doclet":{"description":"An array of data points for the series. For the `streamgraph` series type,\npoints can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n       data: [\n           [0, 9],\n           [1, 7],\n           [2, 6]\n       ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.area.turboThreshold),\n   this option is not available.\n   ```js\n       data: [{\n           x: 1,\n           y: 9,\n           name: \"Point2\",\n           color: \"#00FF00\"\n       }, {\n           x: 1,\n           y: 6,\n           name: \"Point1\",\n           color: \"#FF00FF\"\n       }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.line.data","products":["highcharts","highstock"]},"meta":{"fullname":"series.streamgraph.data","name":"data","line":74,"lineEnd":132,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js"},"children":{}},"fillColor":{"doclet":{"see":["[color](#series.streamgraph.color)","[fillOpacity](#series.streamgraph.fillOpacity)"]},"meta":{"fullname":"series.streamgraph.fillColor","name":"fillColor","line":133,"lineEnd":138,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js"},"children":{}},"fillOpacity":{"doclet":{"see":["[color](#series.streamgraph.color)","[fillColor](#series.streamgraph.fillColor)"],"type":{"names":["number"]},"defaultvalue":"1"},"meta":{"fullname":"series.streamgraph.fillOpacity","name":"fillOpacity","line":139,"lineEnd":146,"filename":"code/es-modules/Series/Streamgraph/StreamgraphSeriesDefaults.js"},"children":{}}}},"sunburst":{"doclet":{"description":"A `sunburst` series. If the [type](#series.sunburst.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `sunburst` series are defined in\n   [plotOptions.sunburst](plotOptions.sunburst).\n3. Options for one single series are given in\n   [the series instance array](series.sunburst).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        sunburst: {\n            // shared options for all sunburst series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'sunburst'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.sunburst.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === sunburst) {\n    // code specific to the sunburst series\n}\n```\n            ","extends":"series,plotOptions.sunburst","exclude":["dataParser","dataURL","stack","dataSorting","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:modules/sunburst"]},"meta":{"fullname":"series.sunburst","name":"sunburst","line":294,"lineEnd":304,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{"data":{"doclet":{"type":{"names":["Array.<(number|null|*)>"]},"extends":"series.treemap.data","exclude":["x","y"],"products":["highcharts"]},"meta":{"fullname":"series.sunburst.data","name":"data","line":305,"lineEnd":311,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{"dataLabels":{"doclet":{"type":{"names":["Highcharts.SeriesSunburstDataLabelsOptionsObject","Array.<Highcharts.SeriesSunburstDataLabelsOptionsObject>"]},"products":["highcharts"]},"meta":{"fullname":"series.sunburst.data.dataLabels","name":"dataLabels","line":312,"lineEnd":316,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"parent":{"doclet":{"description":"Use this option to build a tree structure. The value should be the id of the\npoint which is the parent. If no points has a matching id, or this option is\nundefined, then the parent will be set to the root.","type":{"names":["string"]},"since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"series.sunburst.data.parent","name":"parent","line":326,"lineEnd":335,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"sliced":{"doclet":{"description":"Whether to display a slice offset from the center. When a sunburst point is\nsliced, its children are also offset.","samples":[{"name":"Sliced sunburst","value":"highcharts/plotoptions/sunburst-sliced"}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"6.0.4","products":["highcharts"]},"meta":{"fullname":"series.sunburst.data.sliced","name":"sliced","line":336,"lineEnd":348,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}},"value":{"doclet":{"description":"The value of the point, resulting in a relative area of the point\nin the sunburst.","type":{"names":["number","null"]},"since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"series.sunburst.data.value","name":"value","line":317,"lineEnd":325,"filename":"code/es-modules/Series/Sunburst/SunburstSeriesDefaults.js"},"children":{}}}}}},"supertrend":{"doclet":{"description":"A `Supertrend indicator` series. If the [type](#series.supertrend.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `supertrend` series are defined in\n   [plotOptions.supertrend](plotOptions.supertrend).\n3. Options for one single series are given in\n   [the series instance array](series.supertrend).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        supertrend: {\n            // shared options for all supertrend series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'supertrend'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.supertrend.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === supertrend) {\n    // code specific to the supertrend series\n}\n```\n            ","extends":"series,plotOptions.supertrend","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","cropThreshold","data","dataParser","dataURL","joinBy","keys","navigatorOptions","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking","threshold"],"requires":["module:stock/indicators/indicators","module:stock/indicators/supertrend"]},"meta":{"fullname":"series.supertrend","name":"supertrend","line":459,"lineEnd":473,"filename":"code/es-modules/Stock/Indicators/Supertrend/SupertrendIndicator.js"},"children":{}},"tema":{"doclet":{"description":"A `TEMA` series. If the [type](#series.tema.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `tema` series are defined in\n   [plotOptions.tema](plotOptions.tema).\n3. Options for one single series are given in\n   [the series instance array](series.tema).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        tema: {\n            // shared options for all tema series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'tema'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.tema.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === tema) {\n    // code specific to the tema series\n}\n```\n            ","extends":"series,plotOptions.tema","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/tema"]},"meta":{"fullname":"series.tema","name":"tema","line":165,"lineEnd":178,"filename":"code/es-modules/Stock/Indicators/TEMA/TEMAIndicator.js"},"children":{}},"tiledwebmap":{"doclet":{"description":"A `tiledwebmap` series. The [type](#series.tiledwebmap.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `tiledwebmap` series are defined in\n   [plotOptions.tiledwebmap](plotOptions.tiledwebmap).\n3. Options for one single series are given in\n   [the series instance array](series.tiledwebmap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        tiledwebmap: {\n            // shared options for all tiledwebmap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'tiledwebmap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.tiledwebmap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === tiledwebmap) {\n    // code specific to the tiledwebmap series\n}\n```\n            ","samples":[{"name":"Simple demo of data for Norway on TiledWebMap","value":"maps/series-tiledwebmap/simple-demo-norway"},{"name":"OpenStreetMap demo","value":"maps/series-tiledwebmap/only-twm"}],"extends":"series,plotOptions.tiledwebmap","exclude":["affectsMapView","allAreas","allowPointSelect","animation","animationLimit","boostBlending","boostThreshold","borderColor","borderWidth","clip","color","colorAxis","colorByPoint","colorIndex","colorKey","colors","cursor","dashStyle","dataLabels","dataParser","dataURL","dragDrop","enableMouseTracking","findNearestPointBy","joinBy","keys","marker","negativeColor","nullColor","nullInteraction","onPoint","point","pointDescriptionFormatter","selected","shadow","showCheckbox","stickyTracking","tooltip","type"],"products":["highmaps"]},"meta":{"fullname":"series.tiledwebmap","name":"tiledwebmap","line":50,"lineEnd":69,"filename":"code/es-modules/Series/TiledWebMap/TiledWebMapSeriesDefaults.js"},"children":{}},"tilemap":{"doclet":{"description":"A `tilemap` series. If the [type](#series.tilemap.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `tilemap` series are defined in\n   [plotOptions.tilemap](plotOptions.tilemap).\n3. Options for one single series are given in\n   [the series instance array](series.tilemap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        tilemap: {\n            // shared options for all tilemap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'tilemap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.tilemap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === tilemap) {\n    // code specific to the tilemap series\n}\n```\n            ","extends":"series,plotOptions.tilemap","exclude":["allAreas","dataParser","dataURL","joinBy","mapData","marker","pointRange","shadow","stack","dataSorting","boostThreshold","boostBlending"],"products":["highcharts","highmaps"],"requires":["module:modules/tilemap"]},"meta":{"fullname":"series.tilemap","name":"tilemap","line":108,"lineEnd":119,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `tilemap` series\ntype, points can be given in the following ways:\n\n1. An array of arrays with 3 or 2 values. In this case, the values correspond\n   to `x,y,value`. If the first value is a string, it is applied as the name\n   of the point, and the `x` value is inferred. The `x` value can also be\n   omitted, in which case the inner arrays should be of length 2\\. Then the\n   `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n   data: [\n       [0, 9, 7],\n       [1, 10, 4],\n       [2, 6, 3]\n   ]\n   ```\n\n2. An array of objects with named values. The objects are point configuration\n   objects as seen below. If the total number of data points exceeds the\n   series' [turboThreshold](#series.tilemap.turboThreshold), this option is\n   not available.\n   ```js\n   data: [{\n       x: 1,\n       y: 3,\n       value: 10,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 7,\n       value: 10,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```\n\nNote that for some [tileShapes](#plotOptions.tilemap.tileShape) the grid\ncoordinates are offset.","samples":[{"name":"Offset grid coordinates","value":"maps/series/tilemap-gridoffset"},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number>|Array.<(number|string), number, number>|*)>"]},"extends":"series.heatmap.data","exclude":["marker"],"products":["highcharts","highmaps"]},"meta":{"fullname":"series.tilemap.data","name":"data","line":120,"lineEnd":178,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{"color":{"doclet":{"description":"The color of the point. In tilemap, the point color is rarely set\nexplicitly, as we use the color to denote the `value`. Options for\nthis are set in the [colorAxis](#colorAxis) configuration.","type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.tilemap.data.color","name":"color","line":179,"lineEnd":187,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{}},"x":{"doclet":{"description":"The x coordinate of the point.\n\nNote that for some [tileShapes](#plotOptions.tilemap.tileShape) the grid\ncoordinates are offset.","samples":[{"name":"Offset grid coordinates","value":"maps/series/tilemap-gridoffset"}],"type":{"names":["number"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.tilemap.data.x","name":"x","line":188,"lineEnd":200,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{}},"y":{"doclet":{"description":"The y coordinate of the point.\n\nNote that for some [tileShapes](#plotOptions.tilemap.tileShape) the grid\ncoordinates are offset.","samples":[{"name":"Offset grid coordinates","value":"maps/series/tilemap-gridoffset"}],"type":{"names":["number"]},"products":["highcharts","highmaps"]},"meta":{"fullname":"series.tilemap.data.y","name":"y","line":201,"lineEnd":213,"filename":"code/es-modules/Series/Tilemap/TilemapSeriesDefaults.js"},"children":{}}}}}},"timeline":{"doclet":{"description":"The `timeline` series. If the [type](#series.timeline.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `timeline` series are defined in\n   [plotOptions.timeline](plotOptions.timeline).\n3. Options for one single series are given in\n   [the series instance array](series.timeline).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        timeline: {\n            // shared options for all timeline series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'timeline'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.timeline.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === timeline) {\n    // code specific to the timeline series\n}\n```\n            ","extends":"series,plotOptions.timeline","exclude":["animationLimit","boostThreshold","connectEnds","connectNulls","cropThreshold","dashStyle","dataParser","dataURL","findNearestPointBy","getExtremesFromAll","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointStart","softThreshold","stacking","stack","step","threshold","turboThreshold","zoneAxis","zones","dataSorting","boostBlending"],"products":["highcharts"],"requires":["module:modules/timeline"]},"meta":{"fullname":"series.timeline","name":"timeline","line":180,"lineEnd":194,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `timeline` series type,\npoints can be given with three general parameters, `name`, `label`,\nand `description`:\n\nExample:\n\n```js\nseries: [{\n   type: 'timeline',\n   data: [{\n       name: 'Jan 2018',\n       label: 'Some event label',\n       description: 'Description to show in tooltip'\n   }]\n}]\n```\nIf all points additionally have the `x` values, and xAxis type is set to\n`datetime`, then events are laid out on a true time axis, where their\nplacement reflects the actual time between them.","samples":[{"name":"Alternate labels","value":"highcharts/series-timeline/alternate-labels","products":["highcharts"]},{"name":"Real time intervals","value":"highcharts/series-timeline/datetime-axis","products":["highcharts"]}],"type":{"names":["Array.<*>"]},"extends":"series.line.data","exclude":["marker","y"],"products":["highcharts"]},"meta":{"fullname":"series.timeline.data","name":"data","line":195,"lineEnd":226,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{"description":{"doclet":{"description":"The description of event. This description will be shown in tooltip.","type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.timeline.data.description","name":"description","line":241,"lineEnd":247,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{}},"label":{"doclet":{"description":"The label of event.","type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.timeline.data.label","name":"label","line":234,"lineEnd":240,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{}},"name":{"doclet":{"description":"The name of event.","type":{"names":["string"]},"products":["highcharts"]},"meta":{"fullname":"series.timeline.data.name","name":"name","line":227,"lineEnd":233,"filename":"code/es-modules/Series/Timeline/TimelineSeriesDefaults.js"},"children":{}}}}}},"treegraph":{"doclet":{"description":"A `treegraph` series. If the [type](#series.treegraph.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `treegraph` series are defined in\n   [plotOptions.treegraph](plotOptions.treegraph).\n3. Options for one single series are given in\n   [the series instance array](series.treegraph).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        treegraph: {\n            // shared options for all treegraph series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'treegraph'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.treegraph.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === treegraph) {\n    // code specific to the treegraph series\n}\n```\n            ","extends":"series,plotOptions.treegraph","exclude":["allowDrillToNode","boostBlending","boostThreshold","curveFactor","centerInCategory","connectEnds","connectNulls","colorAxis","colorKey","dataSorting","dragDrop","findNearestPointBy","getExtremesFromAll","groupPadding","headers","layout","nodePadding","nodeSizeBy","pointInterval","pointIntervalUnit","pointPlacement","pointStart","relativeXValue","softThreshold","stack","stacking","step","traverseUpButton","xAxis","yAxis","zoneAxis","zones"],"products":["highcharts"],"requires":["module:modules/treemap","module:modules/treegraph"]},"meta":{"fullname":"series.treegraph","name":"treegraph","line":466,"lineEnd":481,"filename":"code/es-modules/Series/Treegraph/TreegraphSeries.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `treegraph` series type,\npoints can be given in the following ways:\n\n1. The array of arrays, with `keys` property, which defines how the fields in\n    array should be interpreted\n   ```js\n      keys: ['id', 'parent'],\n      data: [\n          ['Category1'],\n          ['Category1', 'Category2']\n      ]\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the\n   series' [turboThreshold](#series.area.turboThreshold),\n   this option is not available.\n   The data of the treegraph series needs to be formatted in such a way, that\n   there are no circular dependencies on the nodes\n\n ```js\n    data: [{\n        id: 'Category1'\n    }, {\n        id: 'Category1',\n        parent: 'Category2',\n    }]\n ```","type":{"names":["Array.<*>"]},"extends":"series.treemap.data","products":["highcharts"],"exclude":["outgoing","weight","value"]},"meta":{"fullname":"series.treegraph.data","name":"data","line":510,"lineEnd":545,"filename":"code/es-modules/Series/Treegraph/TreegraphSeries.js"},"children":{"collapseButton":{"doclet":{"description":"Options used for button, which toggles the collapse status of the node."},"meta":{"fullname":"series.treegraph.data.collapseButton","name":"collapseButton","line":546,"lineEnd":551,"filename":"code/es-modules/Series/Treegraph/TreegraphSeries.js"},"children":{}},"collapsed":{"doclet":{"description":"If point's children should be initially hidden","samples":[{"name":"Treegraph chart with initially hidden children","value":"highcharts/series-treegraph/level-options"}],"type":{"names":["boolean"]}},"meta":{"fullname":"series.treegraph.data.collapsed","name":"collapsed","line":552,"lineEnd":560,"filename":"code/es-modules/Series/Treegraph/TreegraphSeries.js"},"children":{}},"dataLabels":{"doclet":{"type":{"names":["Highcharts.SeriesTreegraphDataLabelsOptionsObject","Array.<Highcharts.SeriesTreegraphDataLabelsOptionsObject>"]},"products":["highcharts"]},"meta":{"fullname":"series.treegraph.data.dataLabels","name":"dataLabels","line":487,"lineEnd":491,"filename":"code/es-modules/Series/Treegraph/TreegraphSeries.js"},"children":{}}}},"levels":{"doclet":{"samples":[{"name":"Treegraph chart with level options applied","value":"highcharts/series-treegraph/level-options"}],"type":{"names":["Array.<*>"]},"exclude":["layoutStartingDirection","layoutAlgorithm"]},"meta":{"fullname":"series.treegraph.levels","name":"levels","line":492,"lineEnd":499,"filename":"code/es-modules/Series/Treegraph/TreegraphSeries.js"},"children":{"collapsed":{"doclet":{"description":"Set collapsed status for nodes level-wise.","type":{"names":["boolean"]}},"meta":{"fullname":"series.treegraph.levels.collapsed","name":"collapsed","line":500,"lineEnd":504,"filename":"code/es-modules/Series/Treegraph/TreegraphSeries.js"},"children":{}},"marker":{"doclet":{"description":"Set marker options for nodes at the level.","extends":"series.treegraph.marker"},"meta":{"fullname":"series.treegraph.levels.marker","name":"marker","line":505,"lineEnd":509,"filename":"code/es-modules/Series/Treegraph/TreegraphSeries.js"},"children":{}}}},"marker":{"doclet":{"extends":"plotOptions.series.marker","exclude":["enabled","enabledThreshold"]},"meta":{"fullname":"series.treegraph.marker","name":"marker","line":482,"lineEnd":486,"filename":"code/es-modules/Series/Treegraph/TreegraphSeries.js"},"children":{}}}},"treemap":{"doclet":{"description":"A `treemap` series. If the [type](#series.treemap.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `treemap` series are defined in\n   [plotOptions.treemap](plotOptions.treemap).\n3. Options for one single series are given in\n   [the series instance array](series.treemap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        treemap: {\n            // shared options for all treemap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'treemap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.treemap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === treemap) {\n    // code specific to the treemap series\n}\n```\n            ","extends":"series,plotOptions.treemap","exclude":["dataParser","dataURL","stack","dataSorting"],"products":["highcharts"],"requires":["module:modules/treemap"]},"meta":{"fullname":"series.treemap","name":"treemap","line":625,"lineEnd":634,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `treemap` series\ntype, points can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `value` options. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.treemap.turboThreshold),\n   this option is not available.\n   ```js\n     data: [{\n       value: 9,\n       name: \"Point2\",\n       color: \"#00FF00\"\n     }, {\n       value: 6,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n     }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|null|*)>"]},"extends":"series.heatmap.data","exclude":["x","y","pointPadding"],"products":["highcharts"]},"meta":{"fullname":"series.treemap.data","name":"data","line":635,"lineEnd":672,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{"colorValue":{"doclet":{"description":"Serves a purpose only if a `colorAxis` object is defined in the chart\noptions. This value will decide which color the point gets from the\nscale of the colorAxis.","type":{"names":["number"]},"since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"series.treemap.data.colorValue","name":"colorValue","line":681,"lineEnd":690,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"parent":{"doclet":{"description":"Only for treemap. Use this option to build a tree structure. The\nvalue should be the id of the point which is the parent. If no points\nhas a matching id, or this option is undefined, then the parent will\nbe set to the root.","samples":[{"name":"Point parent","value":"highcharts/point/parent/","products":["highcharts"]},{"name":"Example where parent id is not matching","value":"highcharts/demo/treemap-with-levels/","products":["highcharts"]}],"type":{"names":["string"]},"since":"4.1.0","products":["highcharts"]},"meta":{"fullname":"series.treemap.data.parent","name":"parent","line":691,"lineEnd":706,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}},"value":{"doclet":{"description":"The value of the point, resulting in a relative area of the point\nin the treemap.","type":{"names":["number","null"]},"products":["highcharts"]},"meta":{"fullname":"series.treemap.data.value","name":"value","line":673,"lineEnd":680,"filename":"code/es-modules/Series/Treemap/TreemapSeriesDefaults.js"},"children":{}}}}}},"trendline":{"doclet":{"description":"A `TrendLine` series. If the [type](#series.trendline.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `trendline` series are defined in\n   [plotOptions.trendline](plotOptions.trendline).\n3. Options for one single series are given in\n   [the series instance array](series.trendline).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        trendline: {\n            // shared options for all trendline series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'trendline'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.trendline.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === trendline) {\n    // code specific to the trendline series\n}\n```\n            ","extends":"series,plotOptions.trendline","since":"7.1.3","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/trendline"]},"meta":{"fullname":"series.trendline","name":"trendline","line":126,"lineEnd":137,"filename":"code/es-modules/Stock/Indicators/TrendLine/TrendLineIndicator.js"},"children":{}},"trix":{"doclet":{"description":"A `TRIX` series. If the [type](#series.trix.type) option is not specified, it\nis inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `trix` series are defined in\n   [plotOptions.trix](plotOptions.trix).\n3. Options for one single series are given in\n   [the series instance array](series.trix).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        trix: {\n            // shared options for all trix series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'trix'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.trix.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === trix) {\n    // code specific to the trix series\n}\n```\n            ","extends":"series,plotOptions.trix","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","compare","compareBase","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/tema"]},"meta":{"fullname":"series.trix","name":"trix","line":81,"lineEnd":94,"filename":"code/es-modules/Stock/Indicators/TRIX/TRIXIndicator.js"},"children":{}},"type":{"doclet":{"description":"The type of series, for example `line` or `column`. By default, the\nseries type is inherited from [chart.type](#chart.type), so unless the\nchart is a combination of series types, there is no need to set it on the\nseries level.","samples":[{"name":"Line and column in the same chart","value":"highcharts/series/type/","products":["highcharts"]},{"name":"Dynamic types with button selector","value":"highcharts/series/type-dynamic/"},{"name":"Multiple types in the same map","value":"maps/demo/mapline-mappoint/","products":["highmaps"]}],"type":{"names":["string"]}},"meta":{"fullname":"series.type","name":"type","line":3688,"lineEnd":3703,"filename":"code/es-modules/Core/Series/Series.js"},"children":{}},"variablepie":{"doclet":{"description":"A `variablepie` series. If the [type](#series.variablepie.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `variablepie` series are defined in\n   [plotOptions.variablepie](plotOptions.variablepie).\n3. Options for one single series are given in\n   [the series instance array](series.variablepie).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        variablepie: {\n            // shared options for all variablepie series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'variablepie'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.variablepie.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === variablepie) {\n    // code specific to the variablepie series\n}\n```\n            ","extends":"series,plotOptions.variablepie","exclude":["dataParser","dataURL","stack","xAxis","yAxis","dataSorting","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:modules/variable-pie"]},"meta":{"fullname":"series.variablepie","name":"variablepie","line":103,"lineEnd":113,"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `variablepie` series type,\npoints can be given in the following ways:\n\n1. An array of arrays with 2 values. In this case, the numerical values will\n   be interpreted as `y, z` options. Example:\n   ```js\n   data: [\n       [40, 75],\n       [50, 50],\n       [60, 40]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.variablepie.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       y: 1,\n       z: 4,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       y: 7,\n       z: 10,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number>|*)>"]},"extends":"series.pie.data","exclude":["marker","x"],"products":["highcharts"]},"meta":{"fullname":"series.variablepie.data","name":"data","line":114,"lineEnd":161,"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js"},"children":{"z":{"doclet":{"description":"The z value of the point.","type":{"names":["number","null"]},"products":["highcharts"]},"meta":{"fullname":"series.variablepie.data.z","name":"z","line":162,"lineEnd":170,"filename":"code/es-modules/Series/VariablePie/VariablePieSeriesDefaults.js"},"children":{}}}}}},"variwide":{"doclet":{"description":"A `variwide` series. If the [type](#series.variwide.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `variwide` series are defined in\n   [plotOptions.variwide](plotOptions.variwide).\n3. Options for one single series are given in\n   [the series instance array](series.variwide).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        variwide: {\n            // shared options for all variwide series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'variwide'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.variwide.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === variwide) {\n    // code specific to the variwide series\n}\n```\n            ","extends":"series,plotOptions.variwide","exclude":["boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:modules/variwide"]},"meta":{"fullname":"series.variwide","name":"variwide","line":50,"lineEnd":59,"filename":"code/es-modules/Series/Variwide/VariwideSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `variwide` series type,\npoints can be given in the following ways:\n\n1. An array of arrays with 3 or 2 values. In this case, the values correspond\n   to `x,y,z`. If the first value is a string, it is applied as the name of\n   the point, and the `x` value is inferred. The `x` value can also be\n   omitted, in which case the inner arrays should be of length 2. Then the\n   `x` value is automatically calculated, either starting at 0 and\n   incremented by 1, or from `pointStart` and `pointInterval` given in the\n   series options.\n   ```js\n      data: [\n          [0, 1, 2],\n          [1, 5, 5],\n          [2, 0, 2]\n      ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.variwide.turboThreshold), this option is not\n   available.\n   ```js\n      data: [{\n          x: 1,\n          y: 1,\n          z: 1,\n          name: \"Point2\",\n          color: \"#00FF00\"\n      }, {\n          x: 1,\n          y: 5,\n          z: 4,\n          name: \"Point1\",\n          color: \"#FF00FF\"\n      }]\n   ```","samples":[{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number>|Array.<(number|string), number, number>|*)>"]},"extends":"series.line.data","exclude":["marker"],"products":["highcharts"]},"meta":{"fullname":"series.variwide.data","name":"data","line":60,"lineEnd":114,"filename":"code/es-modules/Series/Variwide/VariwideSeriesDefaults.js"},"children":{"z":{"doclet":{"description":"The relative width for each column. On a category axis, the widths are\ndistributed so they sum up to the X axis length. On linear and datetime axes,\nthe columns will be laid out from the X value and Z units along the axis.","type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"series.variwide.data.z","name":"z","line":115,"lineEnd":123,"filename":"code/es-modules/Series/Variwide/VariwideSeriesDefaults.js"},"children":{}}}}}},"vbp":{"doclet":{"description":"A `Volume By Price (VBP)` series. If the [type](#series.vbp.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `vbp` series are defined in\n   [plotOptions.vbp](plotOptions.vbp).\n3. Options for one single series are given in\n   [the series instance array](series.vbp).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        vbp: {\n            // shared options for all vbp series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'vbp'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.vbp.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === vbp) {\n    // code specific to the vbp series\n}\n```\n            ","extends":"series,plotOptions.vbp","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL","compare","compareBase","compareStart"],"requires":["module:stock/indicators/indicators","module:stock/indicators/volume-by-price"]},"meta":{"fullname":"series.vbp","name":"vbp","line":576,"lineEnd":587,"filename":"code/es-modules/Stock/Indicators/VBP/VBPIndicator.js"},"children":{}},"vector":{"doclet":{"description":"A `vector` series. If the [type](#series.vector.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `vector` series are defined in\n   [plotOptions.vector](plotOptions.vector).\n3. Options for one single series are given in\n   [the series instance array](series.vector).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        vector: {\n            // shared options for all vector series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'vector'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.vector.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === vector) {\n    // code specific to the vector series\n}\n```\n            ","extends":"series,plotOptions.vector","exclude":["dataParser","dataURL","boostThreshold","boostBlending"],"products":["highcharts","highstock"],"requires":["module:modules/vector"]},"meta":{"fullname":"series.vector","name":"vector","line":75,"lineEnd":84,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `vector` series type,\npoints can be given in the following ways:\n\n1. An array of arrays with 4 values. In this case, the values correspond to\n   to `x,y,length,direction`. If the first value is a string, it is applied\n   as the name of the point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 0, 10, 90],\n       [0, 1, 5, 180],\n       [1, 1, 2, 270]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.area.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 0,\n       y: 0,\n       name: \"Point2\",\n       length: 10,\n       direction: 90\n   }, {\n       x: 1,\n       y: 1,\n       name: \"Point1\",\n       direction: 270\n   }]\n   ```","samples":[{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number, number, number>|*)>"]},"extends":"series.line.data","products":["highcharts","highstock"]},"meta":{"fullname":"series.vector.data","name":"data","line":85,"lineEnd":133,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js"},"children":{"direction":{"doclet":{"description":"The vector direction in degrees, where 0 is north (pointing towards south).","type":{"names":["number"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.vector.data.direction","name":"direction","line":142,"lineEnd":148,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js"},"children":{}},"length":{"doclet":{"description":"The length of the vector. The rendered length will relate to the\n`vectorLength` setting.","type":{"names":["number"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.vector.data.length","name":"length","line":134,"lineEnd":141,"filename":"code/es-modules/Series/Vector/VectorSeriesDefaults.js"},"children":{}}}}}},"venn":{"doclet":{"description":"A `venn` series. If the [type](#series.venn.type) option is\nnot specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `venn` series are defined in\n   [plotOptions.venn](plotOptions.venn).\n3. Options for one single series are given in\n   [the series instance array](series.venn).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        venn: {\n            // shared options for all venn series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'venn'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.venn.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === venn) {\n    // code specific to the venn series\n}\n```\n            ","extends":"series,plotOptions.venn","exclude":["connectEnds","connectNulls","cropThreshold","dataParser","dataURL","findNearestPointBy","getExtremesFromAll","label","linecap","lineWidth","linkedTo","marker","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointStart","softThreshold","stack","stacking","steps","threshold","xAxis","yAxis","zoneAxis","zones","dataSorting","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:modules/venn"]},"meta":{"fullname":"series.venn","name":"venn","line":107,"lineEnd":121,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{"data":{"doclet":{"type":{"names":["Array.<*>"]},"extends":"series.scatter.data","exclude":["marker","x","y"],"products":["highcharts"]},"meta":{"fullname":"series.venn.data","name":"data","line":122,"lineEnd":128,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{"name":{"doclet":{"description":"The name of the point. Used in data labels and tooltip. If name is not\ndefined then it will default to the joined values in\n[sets](#series.venn.sets).","samples":[{"name":"Venn diagram","value":"highcharts/demo/venn-diagram/","products":["highcharts"]},{"name":"Euler diagram","value":"highcharts/demo/euler-diagram/","products":["highcharts"]}],"type":{"names":["string"]},"since":"7.0.0","products":["highcharts"]},"meta":{"fullname":"series.venn.data.name","name":"name","line":129,"lineEnd":143,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{}},"sets":{"doclet":{"description":"The set or sets the options will be applied to. If a single entry is defined,\nthen it will create a new set. If more than one entry is defined, then it\nwill define the overlap between the sets in the array.","samples":[{"name":"Venn diagram","value":"highcharts/demo/venn-diagram/","products":["highcharts"]},{"name":"Euler diagram","value":"highcharts/demo/euler-diagram/","products":["highcharts"]}],"type":{"names":["Array.<string>"]},"since":"7.0.0","products":["highcharts"]},"meta":{"fullname":"series.venn.data.sets","name":"sets","line":158,"lineEnd":172,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{}},"value":{"doclet":{"description":"The value of the point, resulting in a relative area of the circle, or area\nof overlap between two sets in the venn or euler diagram.","samples":[{"name":"Venn diagram","value":"highcharts/demo/venn-diagram/","products":["highcharts"]},{"name":"Euler diagram","value":"highcharts/demo/euler-diagram/","products":["highcharts"]}],"type":{"names":["number"]},"since":"7.0.0","products":["highcharts"]},"meta":{"fullname":"series.venn.data.value","name":"value","line":144,"lineEnd":157,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{}}}},"states":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"hover":{"doclet":{"exclude":["halo"]},"meta":{"fullname":"series.venn.states.hover","name":"hover","line":173,"lineEnd":176,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{}},"select":{"doclet":{"exclude":["halo"]},"meta":{"fullname":"series.venn.states.select","name":"select","line":177,"lineEnd":180,"filename":"code/es-modules/Series/Venn/VennSeriesDefaults.js"},"children":{}}}}}},"vwap":{"doclet":{"description":"A `Volume Weighted Average Price (VWAP)` series. If the\n[type](#series.vwap.type) option is not specified, it is inherited from\n[chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `vwap` series are defined in\n   [plotOptions.vwap](plotOptions.vwap).\n3. Options for one single series are given in\n   [the series instance array](series.vwap).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        vwap: {\n            // shared options for all vwap series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'vwap'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.vwap.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === vwap) {\n    // code specific to the vwap series\n}\n```\n            ","extends":"series,plotOptions.vwap","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/vwap"]},"meta":{"fullname":"series.vwap","name":"vwap","line":166,"lineEnd":178,"filename":"code/es-modules/Stock/Indicators/VWAP/VWAPIndicator.js"},"children":{}},"waterfall":{"doclet":{"description":"A `waterfall` series. If the [type](#series.waterfall.type) option\nis not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `waterfall` series are defined in\n   [plotOptions.waterfall](plotOptions.waterfall).\n3. Options for one single series are given in\n   [the series instance array](series.waterfall).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        waterfall: {\n            // shared options for all waterfall series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'waterfall'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.waterfall.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === waterfall) {\n    // code specific to the waterfall series\n}\n```\n            ","extends":"series,plotOptions.waterfall","exclude":["dataParser","dataURL","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:highcharts-more"]},"meta":{"fullname":"series.waterfall","name":"waterfall","line":105,"lineEnd":114,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `waterfall` series\ntype, points can be given in the following ways:\n\n1. An array of numerical values. In this case, the numerical values will be\n   interpreted as `y` options. The `x` values will be automatically\n   calculated, either starting at 0 and incremented by 1, or from\n   `pointStart` and `pointInterval` given in the series options. If the axis\n   has categories, these will be used. Example:\n   ```js\n   data: [0, 5, 3, 5]\n   ```\n\n2. An array of arrays with 2 values. In this case, the values correspond to\n   `x,y`. If the first value is a string, it is applied as the name of the\n   point, and the `x` value is inferred.\n   ```js\n   data: [\n       [0, 7],\n       [1, 8],\n       [2, 3]\n   ]\n   ```\n\n3. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.waterfall.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       x: 1,\n       y: 8,\n       name: \"Point2\",\n       color: \"#00FF00\"\n   }, {\n       x: 1,\n       y: 8,\n       name: \"Point1\",\n       color: \"#FF00FF\"\n   }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(number|Array.<(number|string), (number|null)>|null|*)>"]},"extends":"series.line.data","exclude":["marker"],"products":["highcharts"]},"meta":{"fullname":"series.waterfall.data","name":"data","line":115,"lineEnd":174,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js"},"children":{"isIntermediateSum":{"doclet":{"description":"When this property is true, the points acts as a summary column for\nthe values added or subtracted since the last intermediate sum,\nor since the start of the series. The `y` value is ignored.","samples":[{"name":"Waterfall","value":"highcharts/demo/waterfall/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","products":["highcharts"]},"meta":{"fullname":"series.waterfall.data.isIntermediateSum","name":"isIntermediateSum","line":175,"lineEnd":187,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js"},"children":{}},"isSum":{"doclet":{"description":"When this property is true, the point display the total sum across\nthe entire series. The `y` value is ignored.","samples":[{"name":"Waterfall","value":"highcharts/demo/waterfall/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","products":["highcharts"]},"meta":{"fullname":"series.waterfall.data.isSum","name":"isSum","line":188,"lineEnd":199,"filename":"code/es-modules/Series/Waterfall/WaterfallSeriesDefaults.js"},"children":{}}}}}},"williamsr":{"doclet":{"description":"A `Williams %R Oscillator` series. If the [type](#series.williamsr.type)\noption is not specified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `williamsr` series are defined in\n   [plotOptions.williamsr](plotOptions.williamsr).\n3. Options for one single series are given in\n   [the series instance array](series.williamsr).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        williamsr: {\n            // shared options for all williamsr series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'williamsr'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.williamsr.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === williamsr) {\n    // code specific to the williamsr series\n}\n```\n            ","extends":"series,plotOptions.williamsr","since":"7.0.0","products":["highstock"],"exclude":["allAreas","colorAxis","dataParser","dataURL","joinBy","keys","navigatorOptions","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","showInNavigator","stacking"],"requires":["module:stock/indicators/indicators","module:stock/indicators/williams-r"]},"meta":{"fullname":"series.williamsr","name":"williamsr","line":119,"lineEnd":132,"filename":"code/es-modules/Stock/Indicators/WilliamsR/WilliamsRIndicator.js"},"children":{}},"windbarb":{"doclet":{"description":"A `windbarb` series. If the [type](#series.windbarb.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `windbarb` series are defined in\n   [plotOptions.windbarb](plotOptions.windbarb).\n3. Options for one single series are given in\n   [the series instance array](series.windbarb).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        windbarb: {\n            // shared options for all windbarb series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'windbarb'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.windbarb.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === windbarb) {\n    // code specific to the windbarb series\n}\n```\n            ","extends":"series,plotOptions.windbarb","exclude":["dataParser","dataURL","boostThreshold","boostBlending"],"products":["highcharts","highstock"],"requires":["module:modules/windbarb"]},"meta":{"fullname":"series.windbarb","name":"windbarb","line":125,"lineEnd":134,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `windbarb` series type,\npoints can be given in the following ways:\n\n1. An array of arrays with 3 values. In this case, the values correspond to\n   `x,value,direction`. If the first value is a string, it is applied as the\n   name of the point, and the `x` value is inferred.\n   ```js\n      data: [\n          [Date.UTC(2017, 0, 1, 0), 3.3, 90],\n          [Date.UTC(2017, 0, 1, 1), 12.1, 180],\n          [Date.UTC(2017, 0, 1, 2), 11.1, 270]\n      ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.area.turboThreshold), this option is not\n   available.\n   ```js\n      data: [{\n          x: Date.UTC(2017, 0, 1, 0),\n          value: 12.1,\n          direction: 90\n      }, {\n          x: Date.UTC(2017, 0, 1, 1),\n          value: 11.1,\n          direction: 270\n      }]\n   ```","samples":[{"name":"Numerical values","value":"highcharts/chart/reflow-true/","products":["highcharts"]},{"name":"Arrays of numeric x and y","value":"highcharts/series/data-array-of-arrays/","products":["highcharts"]},{"name":"Arrays of datetime x and y","value":"highcharts/series/data-array-of-arrays-datetime/","products":["highcharts"]},{"name":"Arrays of point.name and y","value":"highcharts/series/data-array-of-name-value/","products":["highcharts"]},{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"type":{"names":["Array.<(Array.<(number|string), number, number>|*)>"]},"extends":"series.line.data","products":["highcharts","highstock"]},"meta":{"fullname":"series.windbarb.data","name":"data","line":135,"lineEnd":182,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js"},"children":{"direction":{"doclet":{"description":"The wind direction in degrees, where 0 is north (pointing towards south).","type":{"names":["number"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.windbarb.data.direction","name":"direction","line":190,"lineEnd":196,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js"},"children":{}},"value":{"doclet":{"description":"The wind speed in meters per second.","type":{"names":["number","null"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.windbarb.data.value","name":"value","line":183,"lineEnd":189,"filename":"code/es-modules/Series/Windbarb/WindbarbSeriesDefaults.js"},"children":{}}}}}},"wma":{"doclet":{"description":"A `WMA` series. If the [type](#series.wma.type) option is not specified, it\nis inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `wma` series are defined in\n   [plotOptions.wma](plotOptions.wma).\n3. Options for one single series are given in\n   [the series instance array](series.wma).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        wma: {\n            // shared options for all wma series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'wma'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.wma.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === wma) {\n    // code specific to the wma series\n}\n```\n            ","extends":"series,plotOptions.wma","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/wma"]},"meta":{"fullname":"series.wma","name":"wma","line":143,"lineEnd":154,"filename":"code/es-modules/Stock/Indicators/WMA/WMAIndicator.js"},"children":{}},"wordcloud":{"doclet":{"description":"A `wordcloud` series. If the [type](#series.wordcloud.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `wordcloud` series are defined in\n   [plotOptions.wordcloud](plotOptions.wordcloud).\n3. Options for one single series are given in\n   [the series instance array](series.wordcloud).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        wordcloud: {\n            // shared options for all wordcloud series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'wordcloud'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.wordcloud.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === wordcloud) {\n    // code specific to the wordcloud series\n}\n```\n            ","extends":"series,plotOptions.wordcloud","exclude":["dataSorting","boostThreshold","boostBlending"],"products":["highcharts"],"requires":["module:modules/wordcloud"]},"meta":{"fullname":"series.wordcloud","name":"wordcloud","line":139,"lineEnd":148,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `wordcloud` series type,\npoints can be given in the following ways:\n\n1. An array of arrays with 2 values. In this case, the values correspond to\n   `name,weight`.\n   ```js\n   data: [\n       ['Lorem', 4],\n       ['Ipsum', 1]\n   ]\n   ```\n\n2. An array of objects with named values. The following snippet shows only a\n   few settings, see the complete options set below. If the total number of\n   data points exceeds the series'\n   [turboThreshold](#series.arearange.turboThreshold), this option is not\n   available.\n   ```js\n   data: [{\n       name: \"Lorem\",\n       weight: 4\n   }, {\n       name: \"Ipsum\",\n       weight: 1\n   }]\n   ```","type":{"names":["Array.<(Array.<string, number>|*)>"]},"extends":"series.line.data","exclude":["drilldown","marker","x","y"],"products":["highcharts"]},"meta":{"fullname":"series.wordcloud.data","name":"data","line":149,"lineEnd":182,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js"},"children":{"name":{"doclet":{"description":"The name decides the text for a word.","type":{"names":["string"]},"since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"series.wordcloud.data.name","name":"name","line":183,"lineEnd":190,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js"},"children":{}},"weight":{"doclet":{"description":"The weighting of a word. The weight decides the relative size of a word\ncompared to the rest of the collection.","type":{"names":["number"]},"since":"6.0.0","products":["highcharts"]},"meta":{"fullname":"series.wordcloud.data.weight","name":"weight","line":191,"lineEnd":199,"filename":"code/es-modules/Series/Wordcloud/WordcloudSeriesDefaults.js"},"children":{}}}}}},"xAxis":{"doclet":{"description":"When using dual or multiple x axes, this number defines which xAxis the\nparticular series is connected to. It refers to either the\n{@link #xAxis.id|axis id}\nor the index of the axis in the xAxis array, with 0 being the first.","type":{"names":["number","string"]},"defaultvalue":"0","products":["highcharts","highstock"]},"meta":{"fullname":"series.xAxis","name":"xAxis","line":3704,"lineEnd":3714,"filename":"code/es-modules/Core/Series/Series.js"},"children":{}},"xrange":{"doclet":{"description":"An `xrange` series. If the [type](#series.xrange.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `xrange` series are defined in\n   [plotOptions.xrange](plotOptions.xrange).\n3. Options for one single series are given in\n   [the series instance array](series.xrange).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        xrange: {\n            // shared options for all xrange series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'xrange'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.xrange.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === xrange) {\n    // code specific to the xrange series\n}\n```\n            ","extends":"series,plotOptions.xrange","exclude":["boostThreshold","crisp","cropThreshold","depth","edgeColor","edgeWidth","findNearestPointBy","getExtremesFromAll","negativeColor","pointInterval","pointIntervalUnit","pointPlacement","pointRange","pointStart","softThreshold","stacking","threshold","dataSorting","boostBlending"],"products":["highcharts","highstock","gantt"],"requires":["module:modules/xrange"]},"meta":{"fullname":"series.xrange","name":"xrange","line":102,"lineEnd":115,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{"data":{"doclet":{"description":"An array of data points for the series. For the `xrange` series type,\npoints can be given in the following ways:\n\n1. An array of objects with named values. The objects are point configuration\n   objects as seen below.\n   ```js\n   data: [{\n       x: Date.UTC(2017, 0, 1),\n       x2: Date.UTC(2017, 0, 3),\n       name: \"Test\",\n       y: 0,\n       color: \"#00FF00\"\n   }, {\n       x: Date.UTC(2017, 0, 4),\n       x2: Date.UTC(2017, 0, 5),\n       name: \"Deploy\",\n       y: 1,\n       color: \"#FF0000\"\n   }]\n   ```","samples":[{"name":"Config objects","value":"highcharts/series/data-array-of-objects/","products":["highcharts"]}],"declare":"Highcharts.XrangePointOptionsObject","type":{"names":["Array.<*>"]},"extends":"series.line.data","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.xrange.data","name":"data","line":116,"lineEnd":146,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{"connect":{"doclet":{"description":"Connect to a point. This option can be either a string, referring to the ID\nof another point, or an object, or an array of either. If the option is an\narray, each element defines a connection.","samples":[{"name":"Different connection types","value":"gantt/pathfinder/demo"}],"declare":"Highcharts.XrangePointConnectorsOptionsObject","type":{"names":["string","Array.<(string|*)>","*"]},"extends":"plotOptions.series.connectors","since":"6.2.0","exclude":["enabled"],"products":["gantt"],"requires":["module:highcharts-gantt"]},"meta":{"fullname":"series.xrange.data.connect","name":"connect","line":259,"lineEnd":275,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{"to":{"doclet":{"description":"The ID of the point to connect to.","type":{"names":["string"]},"since":"6.2.0","products":["gantt"]},"meta":{"fullname":"series.xrange.data.connect.to","name":"to","line":276,"lineEnd":283,"filename":"code/es-modules/Gantt/ConnectorsDefaults.js"},"children":{}}}},"partialFill":{"doclet":{"description":"A partial fill for each point, typically used to visualize how much of\na task is performed. The partial fill object can be set either on series\nor point level.","samples":[{"name":"X-range with partial fill","value":"highcharts/demo/x-range","products":["highcharts"]}],"declare":"Highcharts.XrangePointPartialFillOptionsObject","products":["highcharts","highstock","gantt"],"type":{"names":["*"]}},"meta":{"fullname":"series.xrange.data.partialFill","name":"partialFill","line":177,"lineEnd":188,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{"amount":{"doclet":{"description":"The amount of the X-range point to be filled. Values can be 0-1 and are\nconverted to percentages in the default data label formatter.","type":{"names":["number"]},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.xrange.data.partialFill.amount","name":"amount","line":189,"lineEnd":196,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{}},"fill":{"doclet":{"description":"The fill color to be used for partial fills. Defaults to a darker shade\nof the point color.","type":{"names":["Highcharts.ColorType"]},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.xrange.data.partialFill.fill","name":"fill","line":197,"lineEnd":204,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{}}}},"x":{"doclet":{"description":"The starting X value of the range point.","samples":[{"name":"X-range","value":"highcharts/demo/x-range","products":["highcharts"]}],"type":{"names":["number"]},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.xrange.data.x","name":"x","line":147,"lineEnd":156,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{}},"x2":{"doclet":{"description":"The ending X value of the range point.","samples":[{"name":"X-range","value":"highcharts/demo/x-range","products":["highcharts"]}],"type":{"names":["number"]},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.xrange.data.x2","name":"x2","line":157,"lineEnd":166,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{}},"y":{"doclet":{"description":"The Y value of the range point.","samples":[{"name":"X-range","value":"highcharts/demo/x-range","products":["highcharts"]}],"type":{"names":["number"]},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"series.xrange.data.y","name":"y","line":167,"lineEnd":176,"filename":"code/es-modules/Series/XRange/XRangeSeriesDefaults.js"},"children":{}}}}}},"yAxis":{"doclet":{"description":"When using dual or multiple y axes, this number defines which yAxis the\nparticular series is connected to. It refers to either the\n{@link #yAxis.id|axis id}\nor the index of the axis in the yAxis array, with 0 being the first.","samples":[{"name":"Apply the column series to the secondary Y axis","value":"highcharts/series/yaxis/","products":["highcharts"]}],"type":{"names":["number","string"]},"defaultvalue":"0","products":["highcharts","highstock"]},"meta":{"fullname":"series.yAxis","name":"yAxis","line":3715,"lineEnd":3728,"filename":"code/es-modules/Core/Series/Series.js"},"children":{}},"zIndex":{"doclet":{"description":"Define the visual z index of the series.","samples":[{"name":"With no z index, the series defined last are on top","value":"highcharts/plotoptions/series-zindex-default/","products":["highcharts"]},{"name":"With a z index, the series with the highest z index is on top","value":"highcharts/plotoptions/series-zindex/","products":["highcharts"]},{"name":"With no z index, the series defined last are on top","value":"highcharts/plotoptions/series-zindex-default/","products":["highstock"]},{"name":"With a z index, the series with the highest z index is on top","value":"highcharts/plotoptions/series-zindex/","products":["highstock"]}],"type":{"names":["number"]},"products":["highcharts","highstock"]},"meta":{"fullname":"series.zIndex","name":"zIndex","line":3729,"lineEnd":3744,"filename":"code/es-modules/Core/Series/Series.js"},"children":{}},"zigzag":{"doclet":{"description":"A `Zig Zag` series. If the [type](#series.zigzag.type) option is not\nspecified, it is inherited from [chart.type](#chart.type).\n\nConfiguration options for the series are given in three levels:\n1. Options for all series in a chart are defined in the\n   [plotOptions.series](plotOptions.series) object.\n2. Options for all `zigzag` series are defined in\n   [plotOptions.zigzag](plotOptions.zigzag).\n3. Options for one single series are given in\n   [the series instance array](series.zigzag).\n\n```\nHighcharts.chart('container', {\n    plotOptions: {\n        series: {\n            // general options for all series\n        },\n        zigzag: {\n            // shared options for all zigzag series\n        }\n    },\n    series: [{\n        // specific options for this series instance\n        type: 'zigzag'\n    }]\n});\n```\n\n**TypeScript:**\n- [type](series.zigzag.type) option should always be set, otherwise a broad set\n  of unsupported options is allowed.\n- when accessing an array of series, the combined set of all series types is\n  represented by [Highcharts.SeriesOptionsType\n  ](/class-reference/Highcharts#.SeriesOptionsType). Narrowing down to the\n  specific type can be done by checking the `type` property.\n\n```\nif (chart.options.series?.[0]?.type === zigzag) {\n    // code specific to the zigzag series\n}\n```\n            ","extends":"series,plotOptions.zigzag","since":"6.0.0","products":["highstock"],"exclude":["dataParser","dataURL"],"requires":["module:stock/indicators/indicators","module:stock/indicators/zigzag"]},"meta":{"fullname":"series.zigzag","name":"zigzag","line":199,"lineEnd":210,"filename":"code/es-modules/Stock/Indicators/Zigzag/ZigzagIndicator.js"},"children":{}}}},"sonification":{"doclet":{"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/Sonification/Options.js","name":"sonification","fullname":"sonification","line":15,"lineEnd":17,"column":4},"children":{"afterSeriesWait":{"doclet":{"description":"The time to wait in milliseconds after each data series when playing\nthe series one after the other.","samples":[{"name":"Notification after series","value":"highcharts/sonification/chart-earcon"}],"see":["[order](#sonification.order)"],"type":{"names":["number"]},"defaultvalue":700},"meta":{"fullname":"sonification.afterSeriesWait","name":"afterSeriesWait","line":206,"lineEnd":214,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":700},"children":{}},"defaultInstrumentOptions":{"doclet":{"description":"Default sonification options for all instrument tracks.\n\nIf specific options are also set on individual tracks or per\nseries, those will override these options.","samples":[{"name":"Sonify points on click","value":"highcharts/sonification/point-sonify"}],"declare":"Highcharts.SonificationInstrumentOptions","type":{"names":["*"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions","name":"defaultInstrumentOptions","line":305,"lineEnd":315,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"activeWhen":{"doclet":{"description":"Define a condition for when a track should be active and not.\n\nCan either be a function callback or a configuration object.\n\nIf a function is used, it should return a `boolean` for whether\nor not the track should be active. The function is called for\neach audio event, and receives a parameter object with `time`,\nand potentially `point` and `value` properties depending on the\ntrack. `point` is available if the audio event is related to a\ndata point. `value` is available if the track is used as a\ncontext track, and `valueInterval` is used.","samples":[{"name":"Mapping zones","value":"highcharts/sonification/mapping-zones"}],"declare":"Highcharts.SonificationInstrumentActiveWhenOptions","type":{"names":["function","*"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.activeWhen","name":"activeWhen","line":357,"lineEnd":376,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"crossingDown":{"doclet":{"description":"Track is only active when `prop` was above, and is now at or\nbelow this value.\n\nIf both `crossingUp` and `crossingDown` are defined, the track\nis active if either condition is met.","type":{"names":["number"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.activeWhen.crossingDown","name":"crossingDown","line":399,"lineEnd":408,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"crossingUp":{"doclet":{"description":"Track is only active when `prop` was below, and is now at or\nabove this value.\n\nIf both `crossingUp` and `crossingDown` are defined, the track\nis active if either condition is met.","type":{"names":["number"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.activeWhen.crossingUp","name":"crossingUp","line":389,"lineEnd":398,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"max":{"doclet":{"description":"Track is only active when `prop` is below or at this value.","type":{"names":["number"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.activeWhen.max","name":"max","line":383,"lineEnd":388,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"min":{"doclet":{"description":"Track is only active when `prop` is above or at this value.","type":{"names":["number"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.activeWhen.min","name":"min","line":377,"lineEnd":382,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"prop":{"doclet":{"description":"The point property to compare, for example `y` or `x`.","type":{"names":["string"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.activeWhen.prop","name":"prop","line":409,"lineEnd":414,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"instrument":{"doclet":{"description":"Instrument to use for playing.\n\nCan either be a string referencing a synth preset, or it can be\na synth configuration object.","samples":[{"name":"Overview of available presets","value":"highcharts/demo/all-instruments"},{"name":"Custom instrument","value":"highcharts/sonification/custom-instrument"}],"type":{"names":["string","Highcharts.SynthPatchOptionsObject"]},"defaultvalue":"piano"},"meta":{"fullname":"sonification.defaultInstrumentOptions.instrument","name":"instrument","line":325,"lineEnd":334,"column":12,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"piano"},"children":{}},"mapping":{"doclet":{"description":"Mapping options for the audio parameters.\n\nAll parameters can be either:\n - A string, referencing a point property to map to.\n - A number, setting the value of the audio parameter directly.\n - A callback function, returning the value programmatically.\n - An object defining detailed configuration of the mapping.\n\nIf a function is used, it should return the desired value for\nthe audio parameter. The function is called for each audio event\nto be played, and receives a context object parameter with\n`time`, and potentially `point` and `value` depending on the\ntrack. `point` is available if the audio event is related to a\ndata point, and `value` is available if the track is used for a\ncontext track using `valueInterval`.","samples":[{"name":"Overview of common mapping parameters","value":"highcharts/sonification/mapping-overview"},{"name":"Various types of mapping used","value":"highcharts/sonification/pitch-mapping"},{"name":"Inverted mapping to property","value":"highcharts/sonification/polarity-invert"},{"name":"Logarithmic mapping to property","value":"highcharts/sonification/log-mapping"}],"declare":"Highcharts.SonificationInstrumentMappingOptions","type":{"names":["*"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping","name":"mapping","line":429,"lineEnd":456,"column":12,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"frequency":{"doclet":{"description":"Frequency in Hertz of notes. Overrides pitch mapping if set.","declare":"Highcharts.SonificationInstrumentFrequencyOptions","extends":"sonification.defaultInstrumentOptions.mapping.time"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.frequency","name":"frequency","line":466,"lineEnd":472,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"gapBetweenNotes":{"doclet":{"description":"Gap in milliseconds between notes if pitch is mapped to an\narray of notes.\n\nCan be set to a fixed value, a prop to map to, a function,\nor a mapping object.","samples":[{"name":"Mapping to gap between notes","value":"maps/demo/audio-map"}],"extends":"sonification.defaultInstrumentOptions.mapping.time","defaultvalue":"100"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.gapBetweenNotes","name":"gapBetweenNotes","line":704,"lineEnd":713,"column":16,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":100},"children":{}},"highpass":{"doclet":{"description":"Mapping options for the highpass filter.\n\nA highpass filter lets high frequencies through, but stops\nlow frequencies, making the sound thinner.","declare":"Highcharts.SonificationInstrumentHighpassOptions","extends":"sonification.defaultInstrumentOptions.mapping.lowpass"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.highpass","name":"highpass","line":535,"lineEnd":544,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"lowpass":{"doclet":{"description":"Mapping options for the lowpass filter.\n\nA lowpass filter lets low frequencies through, but stops high\nfrequencies, making the sound more dull.","declare":"Highcharts.SonificationInstrumentLowpassOptions","type":{"names":["*"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.lowpass","name":"lowpass","line":511,"lineEnd":519,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"frequency":{"doclet":{"description":"Map to filter frequency in Hertz from 1 to 20,000Hz.","declare":"Highcharts.SonificationInstrumentLowpassFrequencyOptions","extends":"sonification.defaultInstrumentOptions.mapping.time"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.lowpass.frequency","name":"frequency","line":520,"lineEnd":526,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"resonance":{"doclet":{"description":"Map to filter resonance in dB. Can be negative to cause a\ndip, or positive to cause a bump.","declare":"Highcharts.SonificationInstrumentLowpassResonanceOptions","extends":"sonification.defaultInstrumentOptions.mapping.time"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.lowpass.resonance","name":"resonance","line":527,"lineEnd":534,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"noteDuration":{"doclet":{"description":"Note duration determines for how long a note plays, in\nmilliseconds.\n\nIt only affects instruments that are able to play\ncontinuous sustained notes. Examples of these instruments\nfrom the presets include `flute`, `saxophone`, `trumpet`,\n`sawsynth`, `wobble`, `basic1`, `basic2`, `sine`,\n`sineGlide`, `triangle`, `square`, `sawtooth`, `noise`,\n`filteredNoise`, and `wind`.\n\nCan be set to a fixed value, a prop to map to, a function,\nor a mapping object.","extends":"sonification.defaultInstrumentOptions.mapping.time","defaultvalue":"200"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.noteDuration","name":"noteDuration","line":645,"lineEnd":661,"column":16,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":200},"children":{}},"pan":{"doclet":{"description":"Pan refers to the stereo panning position of the sound.\nIt is defined from -1 (left) to 1 (right).\n\nBy default it is mapped to `x`, making the sound move from\nleft to right as the chart plays.\n\nCan be set to a fixed value, a prop to map to, a function,\nor a mapping object.","extends":"sonification.defaultInstrumentOptions.mapping.time","defaultvalue":"\"x\""},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.pan","name":"pan","line":565,"lineEnd":576,"column":16,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"x"},"children":{}},"pitch":{"doclet":{"description":"Musical pitch refers to how high or low notes are played.\n\nBy default it is mapped to `y` so low `y` values are played\nwith a lower pitch, and high values are played with a higher\npitch.\n\nPitch mapping has a few extra features compared to other\naudio parameters.\n\nFirstly, it accepts not only number values, but also string\nvalues denoting note names. These are given in the form\n`<note><octave>`, for example `\"c6\"` or `\"F#2\"`.\n\nSecondly, it is possible to map pitch to an array of notes.\nIn this case, the `[gapBetweenNotes](#sonification.defaultInstrumentOptions.mapping.gapBetweenNotes)`\nmapping determines the delay between these notes.\n\nThirdly, it is possible to define a musical scale to follow\nwhen mapping.\n\nCan be set to a fixed value, an array, a prop to map to, a\nfunction, or a mapping object.","samples":[{"name":"Various types of mapping used","value":"highcharts/sonification/pitch-mapping"},{"name":"Inverted mapping to property","value":"highcharts/sonification/polarity-invert"},{"name":"Logarithmic mapping to property","value":"highcharts/sonification/log-mapping"}],"declare":"Highcharts.SonificationInstrumentPitchOptions","extends":"sonification.defaultInstrumentOptions.mapping.time","type":{"names":["string","number","function","Array.<(string|number)>","*"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.pitch","name":"pitch","line":663,"lineEnd":697,"column":16,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"mapTo":{"doclet":{"type":{"names":["string"]},"defaultvalue":"y"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.pitch.mapTo","name":"mapTo","line":699,"lineEnd":699,"column":20,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"y"},"children":{}},"max":{"doclet":{"type":{"names":["string"]},"defaultvalue":"c6"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.pitch.max","name":"max","line":701,"lineEnd":701,"column":20,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"c6"},"children":{}},"min":{"doclet":{"type":{"names":["string"]},"defaultvalue":"c2"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.pitch.min","name":"min","line":700,"lineEnd":700,"column":20,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"c2"},"children":{}},"scale":{"doclet":{"description":"Map pitches to a musical scale. The scale is defined as an\narray of semitone offsets from the root note.","samples":[{"name":"Predefined scale presets","value":"highcharts/sonification/all-scales"}],"type":{"names":["Array.<number>"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.pitch.scale","name":"scale","line":704,"lineEnd":713,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"within":{"doclet":{"type":{"names":["string"]},"defaultvalue":"yAxis"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.pitch.within","name":"within","line":702,"lineEnd":702,"column":20,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"yAxis"},"children":{}}}},"playDelay":{"doclet":{"description":"Milliseconds to wait before playing, comes in addition to\nthe time determined by the `time` mapping.\n\nCan also be negative to play before the mapped time.","declare":"Highcharts.SonificationInstrumentPlayDelayOptions","extends":"sonification.defaultInstrumentOptions.mapping.time"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.playDelay","name":"playDelay","line":473,"lineEnd":482,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"time":{"doclet":{"description":"Time mapping determines what time each point plays. It is\ndefined as an offset in milliseconds, where 0 means it\nplays immediately when the chart is sonified.\n\nBy default time is mapped to `x`, meaning points with the\nlowest `x` value plays first, and points with the highest\n`x` value plays last.\n\nCan be set to a fixed value, a prop to map to, a function,\nor a mapping object.","samples":[{"name":"Play points in order of Y value","value":"highcharts/sonification/point-play-time"}],"declare":"Highcharts.SonificationInstrumentTimeOptions","type":{"names":["string","number","function","*"]},"defaultvalue":"\"x\""},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.time","name":"time","line":458,"lineEnd":465,"column":16,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"x"},"children":{"mapFunction":{"doclet":{"description":"How to perform the mapping.","samples":[{"name":"Logarithmic mapping to property","value":"highcharts/sonification/log-mapping"}],"type":{"names":["\"linear\"","\"logarithmic\""]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.time.mapFunction","name":"mapFunction","line":611,"lineEnd":618,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"mapTo":{"doclet":{"description":"A point property to map the mapping parameter to.\n\nA negative sign `-` can be placed before the property name\nto make mapping inverted.","samples":[{"name":"Inverted mapping to property","value":"highcharts/sonification/polarity-invert"}],"type":{"names":["string"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.time.mapTo","name":"mapTo","line":565,"lineEnd":576,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"max":{"doclet":{"description":"The maximum value for the audio parameter. This is the\nhighest value the audio parameter will be mapped to.","type":{"names":["number"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.time.max","name":"max","line":584,"lineEnd":590,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"min":{"doclet":{"description":"The minimum value for the audio parameter. This is the\nlowest value the audio parameter will be mapped to.","type":{"names":["number"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.time.min","name":"min","line":577,"lineEnd":583,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"value":{"doclet":{"description":"A fixed value to use for the prop when mapping.\n\nFor example, if mapping to `y`, setting value to `4` will\nmap as if all points had a y value of 4.","samples":[{"name":"Map to fixed y value","value":"highcharts/demo/plotline-context"}],"type":{"names":["number"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.time.value","name":"value","line":619,"lineEnd":630,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"within":{"doclet":{"description":"What data values to map the parameter within.\n\nMapping within `\"series\"` will make the lowest value point\nin the series map to the min audio parameter value, and the\nhighest value will map to the max audio parameter.\n\nMapping within `\"chart\"` will make the lowest value point in\nthe whole chart map to the min audio parameter value, and\nthe highest value in the whole chart will map to the max\naudio parameter.\n\nYou can also map within the X or Y axis of each series.","samples":[{"name":"Mapping within demonstrated","value":"highcharts/sonification/mapping-within"}],"type":{"names":["\"chart\"","\"series\"","\"xAxis\"","\"yAxis\""]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.time.within","name":"within","line":591,"lineEnd":610,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"tremolo":{"doclet":{"description":"Mapping options for tremolo effects.\n\nTremolo is repeated changes of volume over time.","declare":"Highcharts.SonificationInstrumentTremoloOptions","type":{"names":["*"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.tremolo","name":"tremolo","line":483,"lineEnd":490,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"depth":{"doclet":{"description":"Map to tremolo depth, from 0 to 1.\n\nThis determines the intensity of the tremolo effect, how\nmuch the volume changes.","declare":"Highcharts.SonificationInstrumentTremoloDepthOptions","extends":"sonification.defaultInstrumentOptions.mapping.time"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.tremolo.depth","name":"depth","line":491,"lineEnd":500,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"speed":{"doclet":{"description":"Map to tremolo speed, from 0 to 1.\n\nThis determines the speed of the tremolo effect, how fast\nthe volume changes.","declare":"Highcharts.SonificationInstrumentTremoloSpeedOptions","extends":"sonification.defaultInstrumentOptions.mapping.time"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.tremolo.speed","name":"speed","line":501,"lineEnd":510,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"volume":{"doclet":{"description":"The volume of notes, from 0 to 1.","declare":"Highcharts.SonificationInstrumentVolumeOptions","extends":"sonification.defaultInstrumentOptions.mapping.time","defaultvalue":"1"},"meta":{"fullname":"sonification.defaultInstrumentOptions.mapping.volume","name":"volume","line":458,"lineEnd":465,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"midiName":{"doclet":{"description":"Name to use for a track when exporting to MIDI.\nBy default it uses the series name if the track is related to\na series.","type":{"names":["string"]}},"meta":{"fullname":"sonification.defaultInstrumentOptions.midiName","name":"midiName","line":342,"lineEnd":349,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"pointGrouping":{"doclet":{"description":"Options for point grouping, specifically for instrument tracks.","declare":"Highcharts.SonificationInstrumentPointGroupingOptions","extends":"sonification.pointGrouping"},"meta":{"fullname":"sonification.defaultInstrumentOptions.pointGrouping","name":"pointGrouping","line":350,"lineEnd":356,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"roundToMusicalNotes":{"doclet":{"description":"Round pitch mapping to musical notes.\n\nIf `false`, will play the exact mapped note, even if it is out\nof tune compared to the musical notes as defined by 440Hz\nstandard tuning.","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"sonification.defaultInstrumentOptions.roundToMusicalNotes","name":"roundToMusicalNotes","line":317,"lineEnd":323,"column":12,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":true},"children":{}},"showPlayMarker":{"doclet":{"description":"Show play marker (tooltip and/or crosshair) for a track.","type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"sonification.defaultInstrumentOptions.showPlayMarker","name":"showPlayMarker","line":335,"lineEnd":341,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"type":{"doclet":{"description":"Type of track. Always `\"instrument\"` for instrument tracks, and\n`\"speech\"` for speech tracks.","declare":"Highcharts.SonifcationTypeValue","type":{"names":["\"instrument\"","\"speech\""]},"defaultvalue":"instrument"},"meta":{"fullname":"sonification.defaultInstrumentOptions.type","name":"type","line":325,"lineEnd":334,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"defaultSpeechOptions":{"doclet":{"description":"Default sonification options for all speech tracks.\n\nIf specific options are also set on individual tracks or per\nseries, those will override these options.","samples":[{"name":"Speak values","value":"highcharts/sonification/speak-values"}],"declare":"Highcharts.SonificationSpeechOptions","extends":"sonification.defaultInstrumentOptions","exclude":["roundToMusicalNotes","midiName","instrument"]},"meta":{"fullname":"sonification.defaultSpeechOptions","name":"defaultSpeechOptions","line":730,"lineEnd":742,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"language":{"doclet":{"description":"The language to speak in for speech tracks, as an IETF BCP 47\nlanguage tag.","samples":[{"name":"French language speech","value":"maps/demo/audio-map"}],"type":{"names":["string"]},"defaultvalue":"en-US"},"meta":{"fullname":"sonification.defaultSpeechOptions.language","name":"language","line":744,"lineEnd":753,"column":12,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"en-US"},"children":{}},"mapping":{"doclet":{"description":"Mapping configuration for the speech/audio parameters.\n\nAll parameters except `text` can be either:\n - A string, referencing a point property to map to.\n - A number, setting the value of the speech parameter directly.\n - A callback function, returning the value programmatically.\n - An object defining detailed configuration of the mapping.\n\nIf a function is used, it should return the desired value for\nthe speech parameter. The function is called for each speech\nevent to be played, and receives a context object parameter with\n`time`, and potentially `point` and `value` depending on the\ntrack. `point` is available if the audio event is related to a\ndata point, and `value` is available if the track is used for a\ncontext track using `valueInterval`.","declare":"Highcharts.SonificationSpeechMappingOptions","extends":"sonification.defaultInstrumentOptions.mapping","exclude":["frequency","gapBetweenNotes","highpass","lowpass","tremolo","noteDuration","pan"]},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping","name":"mapping","line":774,"lineEnd":796,"column":12,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"pitch":{"doclet":{"description":"Speech pitch (how high/low the voice is) multiplier.","samples":[{"name":"Speak values","value":"highcharts/sonification/speak-values"}],"declare":"Highcharts.SonificationSpeechPitchOptions","extends":"sonification.defaultInstrumentOptions.mapping.time","exclude":["scale"],"type":{"names":["string","number","function","*"]},"defaultvalue":"1"},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping.pitch","name":"pitch","line":808,"lineEnd":819,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"mapTo":{"doclet":{"defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping.pitch.mapTo","name":"mapTo","line":820,"lineEnd":823,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"max":{"doclet":{"defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping.pitch.max","name":"max","line":828,"lineEnd":831,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"min":{"doclet":{"defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping.pitch.min","name":"min","line":824,"lineEnd":827,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"within":{"doclet":{"defaultvalue":"undefined","type":{"names":["string"]}},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping.pitch.within","name":"within","line":832,"lineEnd":835,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"playDelay":{"doclet":{"description":"Milliseconds to wait before playing, comes in addition to\nthe time determined by the `time` mapping.\n\nCan also be negative to play before the mapped time.","declare":"Highcharts.SonificationSpeechPlayDelayOptions","extends":"sonification.defaultInstrumentOptions.mapping.time"},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping.playDelay","name":"playDelay","line":798,"lineEnd":807,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"rate":{"doclet":{"description":"Speech rate (speed) multiplier.","extends":"sonification.defaultInstrumentOptions.mapping.time","defaultvalue":"1.3"},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping.rate","name":"rate","line":868,"lineEnd":872,"column":16,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":1.3},"children":{}},"text":{"doclet":{"description":"The text to announce for speech tracks. Can either be a\nformat string or a function.\n\nIf it is a function, it should return the format string to\nannounce. The function is called for each audio event, and\nreceives a parameter object with `time`, and potentially\n`point` and `value` properties depending on the track.\n`point` is available if the audio event is related to a data\npoint. `value` is available if the track is used as a\ncontext track, and `valueInterval` is used.\n\nIf it is a format string, in addition to normal string\ncontent, format values can be accessed using bracket\nnotation. For example `\"Value is {point.y}%\"`.\n\n`time`, `point` and `value` are available to the format\nstrings similarly to with functions. Nested properties can\nbe accessed with dot notation, for example\n`\"Density: {point.options.custom.density}\"`","samples":[{"name":"Speak values","value":"highcharts/sonification/speak-values"}],"type":{"names":["string","function"]}},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping.text","name":"text","line":836,"lineEnd":862,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"time":{"doclet":{"extends":"sonification.defaultInstrumentOptions.mapping.time","defaultvalue":"\"x\""},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping.time","name":"time","line":798,"lineEnd":807,"column":16,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"x"},"children":{}},"volume":{"doclet":{"description":"Volume of the speech announcement.","extends":"sonification.defaultInstrumentOptions.mapping.volume","defaultvalue":"0.4"},"meta":{"fullname":"sonification.defaultSpeechOptions.mapping.volume","name":"volume","line":874,"lineEnd":878,"column":16,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":0.4},"children":{}}}},"pointGrouping":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"sonification.defaultSpeechOptions.pointGrouping","name":"pointGrouping","line":881,"lineEnd":881,"column":12,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"algorithm":{"doclet":{"type":{"names":["string"]},"defaultvalue":"last"},"meta":{"fullname":"sonification.defaultSpeechOptions.pointGrouping.algorithm","name":"algorithm","line":882,"lineEnd":882,"column":16,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"last"},"children":{}}}},"preferredVoice":{"doclet":{"description":"Name of the voice synthesis to prefer for speech tracks.\n\nIf not available, falls back to the default voice for the\nselected language.\n\nDifferent platforms provide different voices for web speech\nsynthesis.","type":{"names":["string"]}},"meta":{"fullname":"sonification.defaultSpeechOptions.preferredVoice","name":"preferredVoice","line":754,"lineEnd":765,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"type":{"doclet":{"description":"Type of track. Always `\"instrument\"` for instrument tracks, and\n`\"speech\"` for speech tracks.","declare":"Highcharts.SonifcationTypeValue","type":{"names":["\"instrument\"","\"speech\""]},"defaultvalue":"speech"},"meta":{"fullname":"sonification.defaultSpeechOptions.type","name":"type","line":744,"lineEnd":753,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"duration":{"doclet":{"description":"The total duration of the sonification, in milliseconds.","type":{"names":["number"]},"defaultvalue":6000},"meta":{"fullname":"sonification.duration","name":"duration","line":202,"lineEnd":204,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":6000},"children":{}},"enabled":{"doclet":{"description":"Enable sonification functionality for the chart.","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"sonification.enabled","name":"enabled","line":19,"lineEnd":30,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":true},"children":{}},"events":{"doclet":{"description":"Set up event handlers for the sonification","type":{"names":["*"]}},"meta":{"fullname":"sonification.events","name":"events","line":102,"lineEnd":106,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"afterUpdate":{"doclet":{"description":"Called after updating the sonification.\n\nA context object is passed to the function, with properties `chart`\nand `timeline`.","type":{"names":["function"]}},"meta":{"fullname":"sonification.events.afterUpdate","name":"afterUpdate","line":156,"lineEnd":164,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"beforePlay":{"doclet":{"description":"Called immediately when a play is requested.\n\nA context object is passed to the function, with properties `chart`\nand `timeline`.","type":{"names":["function"]}},"meta":{"fullname":"sonification.events.beforePlay","name":"beforePlay","line":138,"lineEnd":146,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"beforeUpdate":{"doclet":{"description":"Called before updating the sonification.\n\nA context object is passed to the function, with properties `chart`\nand `timeline`.","type":{"names":["function"]}},"meta":{"fullname":"sonification.events.beforeUpdate","name":"beforeUpdate","line":147,"lineEnd":155,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"onBoundaryHit":{"doclet":{"description":"Called when attempting to play an adjacent point or series, and\nthere is none.\n\nBy default a percussive sound is played.\n\nA context object is passed to the function, with properties `chart`,\n`timeline`, and `attemptedNext`. `attemptedNext` is a boolean\nproperty that is `true` if the boundary hit was from trying to play\nthe next series/point, and `false` if it was from trying to play the\nprevious.","type":{"names":["function"]}},"meta":{"fullname":"sonification.events.onBoundaryHit","name":"onBoundaryHit","line":183,"lineEnd":197,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"onEnd":{"doclet":{"description":"Called when play is completed.\n\nA context object is passed to the function, with properties `chart`,\n`timeline` and `pointsPlayed`. `pointsPlayed` is an array of `Point`\nobjects, referencing data points that were related to the audio\nevents played.","type":{"names":["function"]}},"meta":{"fullname":"sonification.events.onEnd","name":"onEnd","line":127,"lineEnd":137,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"onPlay":{"doclet":{"description":"Called on play.\n\nA context object is passed to the function, with properties `chart`\nand `timeline`.","type":{"names":["function"]}},"meta":{"fullname":"sonification.events.onPlay","name":"onPlay","line":107,"lineEnd":115,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"onSeriesEnd":{"doclet":{"description":"Called when finished playing a series.\n\nA context object is passed to the function, with properties `series`\nand `timeline`.","type":{"names":["function"]}},"meta":{"fullname":"sonification.events.onSeriesEnd","name":"onSeriesEnd","line":174,"lineEnd":182,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"onSeriesStart":{"doclet":{"description":"Called on the beginning of playing a series.\n\nA context object is passed to the function, with properties `series`\nand `timeline`.","type":{"names":["function"]}},"meta":{"fullname":"sonification.events.onSeriesStart","name":"onSeriesStart","line":165,"lineEnd":173,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"onStop":{"doclet":{"description":"Called on pause, cancel, or if play is completed.\n\nA context object is passed to the function, with properties `chart`,\n`timeline` and `pointsPlayed`. `pointsPlayed` is an array of `Point`\nobjects, referencing data points that were related to the audio\nevents played.","type":{"names":["function"]}},"meta":{"fullname":"sonification.events.onStop","name":"onStop","line":116,"lineEnd":126,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"globalContextTracks":{"doclet":{"description":"Context tracks to add globally, an array of either instrument\ntracks, speech tracks, or a mix.\n\nContext tracks are not tied to data points, but play at a set\ninterval - either based on time or on prop values.","samples":[{"name":"Using contexts","value":"highcharts/demo/plotline-context"}],"declare":"Highcharts.SonificationContextTracksOptions","extends":"sonification.globalTracks","type":{"names":["Array.<*>"]}},"meta":{"fullname":"sonification.globalContextTracks","name":"globalContextTracks","line":45,"lineEnd":59,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"timeInterval":{"doclet":{"description":"Set a context track to play periodically every `timeInterval`\nmilliseconds while the sonification is playing.","samples":[{"name":"Using contexts","value":"highcharts/demo/plotline-context"}],"type":{"names":["number"]}},"meta":{"fullname":"sonification.globalContextTracks.timeInterval","name":"timeInterval","line":60,"lineEnd":69,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"valueInterval":{"doclet":{"description":"Set a context track to play periodically every `valueInterval`\nunits of a data property `valueProp` while the sonification is\nplaying.\n\nFor example, setting `valueProp` to `x` and `valueInterval` to 5\nwill play the context track for every 5th X value.\n\nThe context audio events will be mapped to time according to the\nprop value relative to the min/max values for that prop.","samples":[{"name":"Using contexts","value":"highcharts/demo/plotline-context"}],"type":{"names":["number"]}},"meta":{"fullname":"sonification.globalContextTracks.valueInterval","name":"valueInterval","line":70,"lineEnd":86,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"valueMapFunction":{"doclet":{"description":"How to map context events to time when using the `valueInterval`\noption.","type":{"names":["\"linear\"","\"logarithmic\""]},"defaultvalue":"\"linear\""},"meta":{"fullname":"sonification.globalContextTracks.valueMapFunction","name":"valueMapFunction","line":94,"lineEnd":101,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"valueProp":{"doclet":{"description":"The point property to play context for when using `valueInterval`.","type":{"names":["string"]},"defaultvalue":"\"x\""},"meta":{"fullname":"sonification.globalContextTracks.valueProp","name":"valueProp","line":87,"lineEnd":93,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}},"globalTracks":{"doclet":{"description":"Global tracks to add to every series.\n\nDefined as an array of either instrument or speech tracks,\nor a combination.","declare":"Highcharts.SonificationTracksOptions","extends":"sonification.defaultInstrumentOptions","type":{"names":["Array.<*>"]}},"meta":{"fullname":"sonification.globalTracks","name":"globalTracks","line":19,"lineEnd":30,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"mapping":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"rate":{"doclet":{"description":"Rate mapping for speech tracks.","declare":"Highcharts.SonificationTracksRateOptions","extends":"sonification.defaultSpeechOptions.mapping.rate"},"meta":{"fullname":"sonification.globalTracks.mapping.rate","name":"rate","line":31,"lineEnd":37,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}},"text":{"doclet":{"description":"Text mapping for speech tracks.","declare":"Highcharts.SonificationTracksTextOptions","extends":"sonification.defaultSpeechOptions.mapping.text"},"meta":{"fullname":"sonification.globalTracks.mapping.text","name":"text","line":38,"lineEnd":44,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{}}}}}},"masterVolume":{"doclet":{"description":"Overall/master volume for the sonification, from 0 to 1.","type":{"names":["number"]},"defaultvalue":0.7},"meta":{"fullname":"sonification.masterVolume","name":"masterVolume","line":222,"lineEnd":224,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":0.7},"children":{}},"order":{"doclet":{"description":"What order to play the data series in, either `sequential` where\nthe series play individually one after the other, or `simultaneous`\nwhere the series play all at once.","samples":[{"name":"Simultaneous sonification","value":"highcharts/sonification/chart-simultaneous"}],"type":{"names":["\"sequential\"","\"simultaneous\""]},"defaultvalue":"sequential"},"meta":{"fullname":"sonification.order","name":"order","line":226,"lineEnd":235,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"sequential"},"children":{}},"pointGrouping":{"doclet":{"description":"Options for grouping data points together when sonifying. This\nallows for the visual presentation to contain more points than what\nis being played. If not enabled, all visible / uncropped points are\nplayed.","see":["[series.cropThreshold](#plotOptions.series.cropThreshold)"],"type":{"names":["*"]}},"meta":{"fullname":"sonification.pointGrouping","name":"pointGrouping","line":262,"lineEnd":269,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js"},"children":{"algorithm":{"doclet":{"description":"The grouping algorithm, deciding which points to keep when\ngrouping a set of points together. By default `\"minmax\"` is\nused, which keeps both the minimum and maximum points.\n\nThe other algorithms will either keep the first point in the\ngroup (time wise), last point, middle point, or both the first\nand the last point.\n\nThe timing of the resulting point(s) is then adjusted to play\nevenly, regardless of its original position within the group.","type":{"names":["\"minmax\"","\"first\"","\"last\"","\"middle\"","\"firstlast\""]},"defaultvalue":"minmax"},"meta":{"fullname":"sonification.pointGrouping.algorithm","name":"algorithm","line":280,"lineEnd":293,"column":12,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"minmax"},"children":{}},"enabled":{"doclet":{"description":"Whether or not to group points","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"sonification.pointGrouping.enabled","name":"enabled","line":271,"lineEnd":273,"column":12,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":true},"children":{}},"groupTimespan":{"doclet":{"description":"The size of each group in milliseconds. Audio events closer than\nthis are grouped together.","type":{"names":["number"]},"defaultvalue":15},"meta":{"fullname":"sonification.pointGrouping.groupTimespan","name":"groupTimespan","line":275,"lineEnd":278,"column":12,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":15},"children":{}},"prop":{"doclet":{"description":"The data property for each point to compare when deciding which\npoints to keep in the group.\n\nBy default it is \"y\", which means that if the `\"minmax\"`\nalgorithm is used, the two points the group with the lowest and\nhighest `y` value will be kept, and the others not played.","type":{"names":["string"]},"defaultvalue":"y"},"meta":{"fullname":"sonification.pointGrouping.prop","name":"prop","line":295,"lineEnd":302,"column":12,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":"y"},"children":{}}}},"showCrosshair":{"doclet":{"description":"Show X and Y axis crosshairs (if they exist) as the chart plays.\n\nNote that if multiple tracks that play at different times try to\nshow the crosshairs, it can be glitchy, so it is recommended in\nthose cases to turn this on/off for individual tracks using the\n[showPlayMarker](#plotOptions.series.sonification.tracks.showPlayMarker)\noption.","see":["[showTooltip](#sonification.showTooltip)","[crosshair](#xAxis.crosshair)"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"sonification.showCrosshair","name":"showCrosshair","line":249,"lineEnd":260,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":true},"children":{}},"showTooltip":{"doclet":{"description":"Show tooltip as the chart plays.\n\nNote that if multiple tracks that play at different times try to\nshow the tooltip, it can be glitchy, so it is recommended in\nthose cases to turn this on/off for individual tracks using the\n[showPlayMarker](#plotOptions.series.sonification.tracks.showPlayMarker)\noption.","see":["[showCrosshair](#sonification.showCrosshair)"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"sonification.showTooltip","name":"showTooltip","line":237,"lineEnd":247,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":true},"children":{}},"updateInterval":{"doclet":{"description":"How long to wait between each recomputation of the sonification, if\nthe chart updates rapidly. This avoids slowing down processes like\npanning. Given in milliseconds.","type":{"names":["number"]},"defaultvalue":200},"meta":{"fullname":"sonification.updateInterval","name":"updateInterval","line":216,"lineEnd":220,"column":8,"filename":"code/es-modules/Extensions/Sonification/Options.js","default":200},"children":{}}}},"stockTools":{"doclet":{"description":"Configure the stockTools gui strings in the chart. Requires the\n[stockTools module]() to be loaded. For a description of the module\nand information on its features, see [Highcharts StockTools]().","products":["highstock"],"samples":[{"name":"Stock Tools GUI","value":"stock/demo/stock-tools-gui"},{"name":"Stock Tools customized GUI","value":"stock/demo/stock-tools-custom-gui"}],"since":"7.0.0","type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","name":"stockTools","fullname":"stockTools","line":522,"lineEnd":535,"column":0},"children":{"gui":{"doclet":{"description":"Definitions of buttons in Stock Tools GUI.","since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui","name":"gui","line":537,"lineEnd":539,"column":4,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"buttons":{"doclet":{"description":"A collection of strings pointing to config options for the\ntoolbar items. Each name refers to a unique key from the\ndefinitions object.","type":{"names":["Array.<string>"]},"defaultvalue":"[\n  'indicators',\n  'separator',\n  'simpleShapes',\n  'lines',\n  'crookedLines',\n  'measure',\n  'advanced',\n  'toggleAnnotations',\n  'separator',\n  'verticalLabels',\n  'flags',\n  'separator',\n  'zoomChange',\n  'fullScreen',\n  'typeChange',\n  'separator',\n  'currentPriceIndicator',\n  'saveChart'\n]","since":"7.0.0"},"meta":{"fullname":"stockTools.gui.buttons","name":"buttons","line":566,"lineEnd":592,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"className":{"doclet":{"description":"A CSS class name to apply to the stocktools' div,\nallowing unique CSS styling for each chart.","since":"7.0.0","type":{"names":["string"]},"defaultvalue":"highcharts-bindings-wrapper"},"meta":{"fullname":"stockTools.gui.className","name":"className","line":556,"lineEnd":559,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"highcharts-bindings-wrapper"},"children":{}},"definitions":{"doclet":{"description":"An options object of the buttons definitions. Each name refers to\nunique key from buttons array.","since":"7.0.0","type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions","name":"definitions","line":613,"lineEnd":616,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"advanced":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.advanced","name":"advanced","line":924,"lineEnd":924,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"fibonacci":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.advanced.fibonacci","name":"fibonacci","line":953,"lineEnd":953,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"fibonacci.svg"},"meta":{"fullname":"stockTools.gui.definitions.advanced.fibonacci.symbol","name":"symbol","line":954,"lineEnd":958,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"fibonacci.svg"},"children":{}}}},"fibonacciTimeZones":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.advanced.fibonacciTimeZones","name":"fibonacciTimeZones","line":961,"lineEnd":961,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"fibonacci-timezone.svg"},"meta":{"fullname":"stockTools.gui.definitions.advanced.fibonacciTimeZones.symbol","name":"symbol","line":962,"lineEnd":966,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"fibonacci-timezone.svg"},"children":{}}}},"items":{"doclet":{"description":"A collection of strings pointing to config options for\nthe items.","type":{"names":["Array.<string>"]},"defaultvalue":"[\n  'fibonacci',\n  'fibonacciTimeZones',\n  'pitchfork',\n  'parallelChannel',\n  'timeCycles'\n]"},"meta":{"fullname":"stockTools.gui.definitions.advanced.items","name":"items","line":925,"lineEnd":937,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"parallelChannel":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.advanced.parallelChannel","name":"parallelChannel","line":969,"lineEnd":969,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"parallel-channel.svg"},"meta":{"fullname":"stockTools.gui.definitions.advanced.parallelChannel.symbol","name":"symbol","line":970,"lineEnd":974,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"parallel-channel.svg"},"children":{}}}},"pitchfork":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.advanced.pitchfork","name":"pitchfork","line":945,"lineEnd":945,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"pitchfork.svg"},"meta":{"fullname":"stockTools.gui.definitions.advanced.pitchfork.symbol","name":"symbol","line":946,"lineEnd":950,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"pitchfork.svg"},"children":{}}}},"timeCycles":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.advanced.timeCycles","name":"timeCycles","line":977,"lineEnd":977,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"time-cycles.svg"},"meta":{"fullname":"stockTools.gui.definitions.advanced.timeCycles.symbol","name":"symbol","line":978,"lineEnd":982,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"time-cycles.svg"},"children":{}}}}}},"crookedLines":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.crookedLines","name":"crookedLines","line":829,"lineEnd":829,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"crooked3":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.crookedLines.crooked3","name":"crooked3","line":849,"lineEnd":849,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"crooked-3.svg"},"meta":{"fullname":"stockTools.gui.definitions.crookedLines.crooked3.symbol","name":"symbol","line":850,"lineEnd":854,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"crooked-3.svg"},"children":{}}}},"crooked5":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.crookedLines.crooked5","name":"crooked5","line":857,"lineEnd":857,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"crooked-5.svg"},"meta":{"fullname":"stockTools.gui.definitions.crookedLines.crooked5.symbol","name":"symbol","line":858,"lineEnd":862,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"crooked-5.svg"},"children":{}}}},"elliott3":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.crookedLines.elliott3","name":"elliott3","line":865,"lineEnd":865,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"elliott-3.svg"},"meta":{"fullname":"stockTools.gui.definitions.crookedLines.elliott3.symbol","name":"symbol","line":866,"lineEnd":870,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"elliott-3.svg"},"children":{}}}},"elliott5":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.crookedLines.elliott5","name":"elliott5","line":873,"lineEnd":873,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"elliott-5.svg"},"meta":{"fullname":"stockTools.gui.definitions.crookedLines.elliott5.symbol","name":"symbol","line":874,"lineEnd":878,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"elliott-5.svg"},"children":{}}}},"items":{"doclet":{"description":"A collection of strings pointing to config options for\nthe items.","type":{"names":["Array.<string>"]},"defaultvalue":"[\n  'elliott3',\n  'elliott5',\n  'crooked3',\n  'crooked5'\n]"},"meta":{"fullname":"stockTools.gui.definitions.crookedLines.items","name":"items","line":830,"lineEnd":842,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}}}},"currentPriceIndicator":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.currentPriceIndicator","name":"currentPriceIndicator","line":1036,"lineEnd":1036,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"current-price-show.svg"},"meta":{"fullname":"stockTools.gui.definitions.currentPriceIndicator.symbol","name":"symbol","line":1037,"lineEnd":1041,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"current-price-show.svg"},"children":{}}}},"flags":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.flags","name":"flags","line":682,"lineEnd":682,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"flagCirclepin":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.flags.flagCirclepin","name":"flagCirclepin","line":728,"lineEnd":728,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"flag-elipse.svg"},"meta":{"fullname":"stockTools.gui.definitions.flags.flagCirclepin.symbol","name":"symbol","line":729,"lineEnd":733,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"flag-elipse.svg"},"children":{}}}},"flagDiamondpin":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.flags.flagDiamondpin","name":"flagDiamondpin","line":711,"lineEnd":711,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"flag-diamond.svg"},"meta":{"fullname":"stockTools.gui.definitions.flags.flagDiamondpin.symbol","name":"symbol","line":712,"lineEnd":717,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"flag-diamond.svg"},"children":{}}}},"flagSimplepin":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.flags.flagSimplepin","name":"flagSimplepin","line":702,"lineEnd":702,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"flag-basic.svg"},"meta":{"fullname":"stockTools.gui.definitions.flags.flagSimplepin.symbol","name":"symbol","line":703,"lineEnd":708,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"flag-basic.svg"},"children":{}}}},"flagSquarepin":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.flags.flagSquarepin","name":"flagSquarepin","line":720,"lineEnd":720,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"flag-trapeze.svg"},"meta":{"fullname":"stockTools.gui.definitions.flags.flagSquarepin.symbol","name":"symbol","line":721,"lineEnd":725,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"flag-trapeze.svg"},"children":{}}}},"items":{"doclet":{"description":"A collection of strings pointing to config options for\nthe items.","type":{"names":["Array.<string>"]},"defaultvalue":"[\n  'flagCirclepin',\n  'flagDiamondpin',\n  'flagSquarepin',\n  'flagSimplepin'\n]"},"meta":{"fullname":"stockTools.gui.definitions.flags.items","name":"items","line":683,"lineEnd":695,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}}}},"fullScreen":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.fullScreen","name":"fullScreen","line":1164,"lineEnd":1164,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"fullscreen.svg"},"meta":{"fullname":"stockTools.gui.definitions.fullScreen.symbol","name":"symbol","line":1165,"lineEnd":1169,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"fullscreen.svg"},"children":{}}}},"indicators":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.indicators","name":"indicators","line":1044,"lineEnd":1044,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"indicators.svg"},"meta":{"fullname":"stockTools.gui.definitions.indicators.symbol","name":"symbol","line":1045,"lineEnd":1049,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"indicators.svg"},"children":{}}}},"lines":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.lines","name":"lines","line":737,"lineEnd":737,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"arrowInfinityLine":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.lines.arrowInfinityLine","name":"arrowInfinityLine","line":804,"lineEnd":804,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"arrow-line.svg"},"meta":{"fullname":"stockTools.gui.definitions.lines.arrowInfinityLine.symbol","name":"symbol","line":805,"lineEnd":809,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"arrow-line.svg"},"children":{}}}},"arrowRay":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.lines.arrowRay","name":"arrowRay","line":788,"lineEnd":788,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"arrow-ray.svg"},"meta":{"fullname":"stockTools.gui.definitions.lines.arrowRay.symbol","name":"symbol","line":789,"lineEnd":793,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"arrow-ray.svg"},"children":{}}}},"arrowSegment":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.lines.arrowSegment","name":"arrowSegment","line":772,"lineEnd":772,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"arrow-segment.svg"},"meta":{"fullname":"stockTools.gui.definitions.lines.arrowSegment.symbol","name":"symbol","line":773,"lineEnd":777,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"arrow-segment.svg"},"children":{}}}},"horizontalLine":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.lines.horizontalLine","name":"horizontalLine","line":820,"lineEnd":820,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"horizontal-line.svg"},"meta":{"fullname":"stockTools.gui.definitions.lines.horizontalLine.symbol","name":"symbol","line":821,"lineEnd":825,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"horizontal-line.svg"},"children":{}}}},"items":{"doclet":{"description":"A collection of strings pointing to config options for\nthe items.","type":{"names":["Array.<string>"]},"defaultvalue":"[\n  'segment',\n  'arrowSegment',\n  'ray',\n  'arrowRay',\n  'line',\n  'arrowInfinityLine',\n  'horizontalLine',\n  'verticalLine'\n]"},"meta":{"fullname":"stockTools.gui.definitions.lines.items","name":"items","line":738,"lineEnd":753,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"line":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.lines.line","name":"line","line":796,"lineEnd":796,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"line.svg"},"meta":{"fullname":"stockTools.gui.definitions.lines.line.symbol","name":"symbol","line":797,"lineEnd":801,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"line.svg"},"children":{}}}},"ray":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.lines.ray","name":"ray","line":780,"lineEnd":780,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"ray.svg"},"meta":{"fullname":"stockTools.gui.definitions.lines.ray.symbol","name":"symbol","line":781,"lineEnd":785,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"ray.svg"},"children":{}}}},"segment":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.lines.segment","name":"segment","line":764,"lineEnd":764,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"segment.svg"},"meta":{"fullname":"stockTools.gui.definitions.lines.segment.symbol","name":"symbol","line":765,"lineEnd":769,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"segment.svg"},"children":{}}}},"verticalLine":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.lines.verticalLine","name":"verticalLine","line":812,"lineEnd":812,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"vertical-line.svg"},"meta":{"fullname":"stockTools.gui.definitions.lines.verticalLine.symbol","name":"symbol","line":813,"lineEnd":817,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"vertical-line.svg"},"children":{}}}}}},"measure":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.measure","name":"measure","line":986,"lineEnd":986,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"items":{"doclet":{"description":"A collection of strings pointing to config options for\nthe items.","type":{"names":["Array.<string>"]},"defaultvalue":"[\n  'measureXY',\n  'measureX',\n  'measureY'\n]"},"meta":{"fullname":"stockTools.gui.definitions.measure.items","name":"items","line":987,"lineEnd":997,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"measureX":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.measure.measureX","name":"measureX","line":1003,"lineEnd":1003,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"measure-x.svg"},"meta":{"fullname":"stockTools.gui.definitions.measure.measureX.symbol","name":"symbol","line":1004,"lineEnd":1008,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"measure-x.svg"},"children":{}}}},"measureXY":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.measure.measureXY","name":"measureXY","line":1019,"lineEnd":1019,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"measure-xy.svg"},"meta":{"fullname":"stockTools.gui.definitions.measure.measureXY.symbol","name":"symbol","line":1020,"lineEnd":1024,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"measure-xy.svg"},"children":{}}}},"measureY":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.measure.measureY","name":"measureY","line":1011,"lineEnd":1011,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"measure-y.svg"},"meta":{"fullname":"stockTools.gui.definitions.measure.measureY.symbol","name":"symbol","line":1012,"lineEnd":1016,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"measure-y.svg"},"children":{}}}}}},"saveChart":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.saveChart","name":"saveChart","line":1172,"lineEnd":1172,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"save-chart.svg"},"meta":{"fullname":"stockTools.gui.definitions.saveChart.symbol","name":"symbol","line":1173,"lineEnd":1177,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"save-chart.svg"},"children":{}}}},"separator":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.separator","name":"separator","line":618,"lineEnd":618,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"elementType":{"doclet":{"type":{"names":["string"]},"defaultvalue":"span"},"meta":{"fullname":"stockTools.gui.definitions.separator.elementType","name":"elementType","line":619,"lineEnd":619,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"span"},"children":{}},"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"separator.svg"},"meta":{"fullname":"stockTools.gui.definitions.separator.symbol","name":"symbol","line":620,"lineEnd":622,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"separator.svg"},"children":{}}}},"simpleShapes":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.simpleShapes","name":"simpleShapes","line":625,"lineEnd":625,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"circle":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.simpleShapes.circle","name":"circle","line":645,"lineEnd":645,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"circle.svg"},"meta":{"fullname":"stockTools.gui.definitions.simpleShapes.circle.symbol","name":"symbol","line":646,"lineEnd":651,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"circle.svg"},"children":{}}}},"ellipse":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.simpleShapes.ellipse","name":"ellipse","line":654,"lineEnd":654,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"ellipse.svg"},"meta":{"fullname":"stockTools.gui.definitions.simpleShapes.ellipse.symbol","name":"symbol","line":655,"lineEnd":660,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"ellipse.svg"},"children":{}}}},"items":{"doclet":{"description":"A collection of strings pointing to config options for\nthe items.","type":{"names":["Array.<string>"]},"defaultvalue":"[\n  'label',\n  'circle',\n  'ellipse',\n  'rectangle'\n]"},"meta":{"fullname":"stockTools.gui.definitions.simpleShapes.items","name":"items","line":626,"lineEnd":638,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"label":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.simpleShapes.label","name":"label","line":672,"lineEnd":672,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"label.svg"},"meta":{"fullname":"stockTools.gui.definitions.simpleShapes.label.symbol","name":"symbol","line":673,"lineEnd":678,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"label.svg"},"children":{}}}},"rectangle":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.simpleShapes.rectangle","name":"rectangle","line":663,"lineEnd":663,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"rectangle.svg"},"meta":{"fullname":"stockTools.gui.definitions.simpleShapes.rectangle.symbol","name":"symbol","line":664,"lineEnd":669,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"rectangle.svg"},"children":{}}}}}},"toggleAnnotations":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.toggleAnnotations","name":"toggleAnnotations","line":1028,"lineEnd":1028,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"annotations-visible.svg"},"meta":{"fullname":"stockTools.gui.definitions.toggleAnnotations.symbol","name":"symbol","line":1029,"lineEnd":1033,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"annotations-visible.svg"},"children":{}}}},"typeChange":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.typeChange","name":"typeChange","line":1094,"lineEnd":1094,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"items":{"doclet":{"description":"A collection of strings pointing to config options for\nthe items.","type":{"names":["Array.<string>"]},"defaultvalue":"[\n  'typeOHLC',\n  'typeLine',\n  'typeCandlestick'\n  'typeHollowCandlestick'\n]"},"meta":{"fullname":"stockTools.gui.definitions.typeChange.items","name":"items","line":1095,"lineEnd":1106,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"typeCandlestick":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeCandlestick","name":"typeCandlestick","line":1131,"lineEnd":1131,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"series-candlestick.svg"},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeCandlestick.symbol","name":"symbol","line":1132,"lineEnd":1136,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"series-candlestick.svg"},"children":{}}}},"typeHLC":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeHLC","name":"typeHLC","line":1139,"lineEnd":1139,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"series-hlc.svg"},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeHLC.symbol","name":"symbol","line":1140,"lineEnd":1144,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"series-hlc.svg"},"children":{}}}},"typeHeikinAshi":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeHeikinAshi","name":"typeHeikinAshi","line":1147,"lineEnd":1147,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"series-heikin-ashi.svg"},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeHeikinAshi.symbol","name":"symbol","line":1148,"lineEnd":1152,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"series-heikin-ashi.svg"},"children":{}}}},"typeHollowCandlestick":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeHollowCandlestick","name":"typeHollowCandlestick","line":1155,"lineEnd":1155,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"series-hollow-candlestick.svg"},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeHollowCandlestick.symbol","name":"symbol","line":1156,"lineEnd":1160,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"series-hollow-candlestick.svg"},"children":{}}}},"typeLine":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeLine","name":"typeLine","line":1123,"lineEnd":1123,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"series-line.svg"},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeLine.symbol","name":"symbol","line":1124,"lineEnd":1128,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"series-line.svg"},"children":{}}}},"typeOHLC":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeOHLC","name":"typeOHLC","line":1115,"lineEnd":1115,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"series-ohlc.svg"},"meta":{"fullname":"stockTools.gui.definitions.typeChange.typeOHLC.symbol","name":"symbol","line":1116,"lineEnd":1120,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"series-ohlc.svg"},"children":{}}}}}},"verticalLabels":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.verticalLabels","name":"verticalLabels","line":882,"lineEnd":882,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"items":{"doclet":{"description":"A collection of strings pointing to config options for\nthe items.","type":{"names":["Array.<string>"]},"defaultvalue":"[\n  'verticalCounter',\n  'verticalLabel',\n  'verticalArrow'\n]"},"meta":{"fullname":"stockTools.gui.definitions.verticalLabels.items","name":"items","line":883,"lineEnd":893,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"verticalArrow":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.verticalLabels.verticalArrow","name":"verticalArrow","line":915,"lineEnd":915,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"vertical-arrow.svg"},"meta":{"fullname":"stockTools.gui.definitions.verticalLabels.verticalArrow.symbol","name":"symbol","line":916,"lineEnd":920,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"vertical-arrow.svg"},"children":{}}}},"verticalCounter":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.verticalLabels.verticalCounter","name":"verticalCounter","line":899,"lineEnd":899,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"vertical-counter.svg"},"meta":{"fullname":"stockTools.gui.definitions.verticalLabels.verticalCounter.symbol","name":"symbol","line":900,"lineEnd":904,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"vertical-counter.svg"},"children":{}}}},"verticalLabel":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.verticalLabels.verticalLabel","name":"verticalLabel","line":907,"lineEnd":907,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"vertical-label.svg"},"meta":{"fullname":"stockTools.gui.definitions.verticalLabels.verticalLabel.symbol","name":"symbol","line":908,"lineEnd":912,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"vertical-label.svg"},"children":{}}}}}},"zoomChange":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.zoomChange","name":"zoomChange","line":1052,"lineEnd":1052,"column":12,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"items":{"doclet":{"description":"A collection of strings pointing to config options for\nthe items.","type":{"names":["Array.<string>"]},"defaultvalue":"[\n  'zoomX',\n  'zoomY',\n  'zoomXY'\n]"},"meta":{"fullname":"stockTools.gui.definitions.zoomChange.items","name":"items","line":1053,"lineEnd":1063,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"zoomX":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.zoomChange.zoomX","name":"zoomX","line":1069,"lineEnd":1069,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"zoom-x.svg"},"meta":{"fullname":"stockTools.gui.definitions.zoomChange.zoomX.symbol","name":"symbol","line":1070,"lineEnd":1074,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"zoom-x.svg"},"children":{}}}},"zoomXY":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.zoomChange.zoomXY","name":"zoomXY","line":1085,"lineEnd":1085,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"zoom-xy.svg"},"meta":{"fullname":"stockTools.gui.definitions.zoomChange.zoomXY.symbol","name":"symbol","line":1086,"lineEnd":1090,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"zoom-xy.svg"},"children":{}}}},"zoomY":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"stockTools.gui.definitions.zoomChange.zoomY","name":"zoomY","line":1077,"lineEnd":1077,"column":16,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{"symbol":{"doclet":{"description":"A predefined background symbol for the button.","type":{"names":["string"]},"defaultvalue":"zoom-y.svg"},"meta":{"fullname":"stockTools.gui.definitions.zoomChange.zoomY.symbol","name":"symbol","line":1078,"lineEnd":1082,"column":20,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"zoom-y.svg"},"children":{}}}}}}}},"enabled":{"doclet":{"description":"Enable or disable the stockTools gui.","since":"7.0.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"stockTools.gui.enabled","name":"enabled","line":541,"lineEnd":551,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":true},"children":{}},"iconsURL":{"doclet":{"description":"Path where Highcharts will look for icons. Change this to use\nicons from a different server.\n\nSince 7.1.3 use [iconsURL](#navigation.iconsURL) for popup and\nstock tools.","deprecated":true,"since":"7.0.0"},"meta":{"fullname":"stockTools.gui.iconsURL","name":"iconsURL","line":541,"lineEnd":551,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js"},"children":{}},"toolbarClassName":{"doclet":{"description":"A CSS class name to apply to the container of buttons,\nallowing unique CSS styling for each chart.","since":"7.0.0","type":{"names":["string"]},"defaultvalue":"stocktools-toolbar"},"meta":{"fullname":"stockTools.gui.toolbarClassName","name":"toolbarClassName","line":561,"lineEnd":564,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":"stocktools-toolbar"},"children":{}},"visible":{"doclet":{"description":"Whether the stock tools toolbar is visible.","since":"11.4.4","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"stockTools.gui.visible","name":"visible","line":1181,"lineEnd":1185,"column":8,"filename":"code/es-modules/Stock/StockTools/StockToolsDefaults.js","default":true},"children":{}}}}}},"subtitle":{"doclet":{"description":"The chart's subtitle. This can be used both to display a subtitle below\nthe main title, and to display random text anywhere in the chart. The\nsubtitle can be updated after chart initialization through the\n`Chart.setTitle` method.","samples":[{"name":"Default title alignment","value":"highcharts/title/align-auto/","products":["highcharts"]},{"name":"Subtitle options demonstrated","value":"maps/title/subtitle/","products":["highmaps"]}],"type":{"names":["*"]}},"meta":{"fullname":"subtitle","name":"subtitle","line":671,"lineEnd":681,"column":4,"filename":"code/es-modules/Core/Defaults.js"},"children":{"align":{"doclet":{"description":"The horizontal alignment of the subtitle. Can be one of \"left\",\n\"center\" and \"right\". Since v12, it defaults to `undefined`, meaning\nthe actual alignment is inherited from the alignment of the main\ntitle.","samples":[{"name":"Default title and subtitle alignment, dynamic","value":"highcharts/title/align-auto/","products":["highcharts"]},{"name":"Footnote at right of plot area","value":"highcharts/subtitle/align/","products":["highcharts"]},{"name":"Footnote at bottom right of plot area","value":"stock/chart/subtitle-footnote","products":["highstock"]}],"type":{"names":["Highcharts.AlignValue"]},"defaultvalue":"undefined","since":"2.0.0"},"meta":{"fullname":"subtitle.align","name":"align","line":683,"lineEnd":700,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"floating":{"doclet":{"description":"When the subtitle is floating, the plot area will not move to make\nspace for it.","samples":[{"name":"Floating title and subtitle","value":"highcharts/subtitle/floating/","products":["highcharts"]},{"name":"Footnote floating at bottom right of plot area","value":"stock/chart/subtitle-footnote","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"2.1.0"},"meta":{"fullname":"subtitle.floating","name":"floating","line":701,"lineEnd":714,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"style":{"doclet":{"description":"CSS styles for the title.\n\nIn styled mode, the subtitle style is given in the\n`.highcharts-subtitle` class.","samples":[{"name":"Custom color and weight","value":"highcharts/subtitle/style/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/css/titles/","products":["highcharts"]},{"name":"Custom color and weight","value":"stock/chart/subtitle-style","products":["highstock"]},{"name":"Styled mode","value":"highcharts/css/titles/","products":["highstock"]},{"name":"Styled mode","value":"highcharts/css/titles/","products":["highmaps"]}],"type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"color\": \"#666666\"}"},"meta":{"fullname":"subtitle.style","name":"style","line":683,"lineEnd":700,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#666666"},"meta":{"fullname":"subtitle.style.color","name":"color","line":787,"lineEnd":787,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"#666666"},"children":{}},"fontSize":{"doclet":{"type":{"names":["number","string"]},"defaultvalue":"0.8em"},"meta":{"fullname":"subtitle.style.fontSize","name":"fontSize","line":788,"lineEnd":790,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"0.8em"},"children":{}}}},"text":{"doclet":{"description":"The subtitle of the chart.","samples":[{"name":"Custom subtitle","value":"highcharts/subtitle/text/","products":["highcharts","highstock"]},{"name":"Formatted and linked text.","value":"highcharts/subtitle/text-formatted/","products":["highcharts","highstock"]}],"type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"subtitle.text","name":"text","line":793,"lineEnd":800,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":""},"children":{}},"useHTML":{"doclet":{"description":"Whether to\n[use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the text.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"subtitle.useHTML","name":"useHTML","line":715,"lineEnd":723,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of the title. Can be one of `\"top\"`,\n`\"middle\"` and `\"bottom\"`. When middle, the subtitle behaves as\nfloating.","samples":[{"name":"Footnote at the bottom right of plot area","value":"highcharts/subtitle/verticalalign/","products":["highcharts"]},{"name":"Footnote at the bottom right of plot area","value":"stock/chart/subtitle-footnote","products":["highstock"]}],"type":{"names":["Highcharts.VerticalAlignValue"]},"since":"2.1.0"},"meta":{"fullname":"subtitle.verticalAlign","name":"verticalAlign","line":724,"lineEnd":737,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"x":{"doclet":{"description":"The x position of the subtitle relative to the alignment within\n`chart.spacingLeft` and `chart.spacingRight`.","samples":[{"name":"Footnote at right of plot area","value":"highcharts/subtitle/align/","products":["highcharts"]},{"name":"Footnote at the bottom right of plot area","value":"stock/chart/subtitle-footnote","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"2.0.0"},"meta":{"fullname":"subtitle.x","name":"x","line":738,"lineEnd":751,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"y":{"doclet":{"description":"The y position of the subtitle relative to the alignment within\n`chart.spacingTop` and `chart.spacingBottom`. By default the subtitle\nis laid out below the title unless the title is floating.","samples":[{"name":"Footnote at the bottom right of plot area","value":"highcharts/subtitle/verticalalign/","products":["highcharts"]},{"name":"Footnote at the bottom right of plot area","value":"stock/chart/subtitle-footnote","products":["highstock"]}],"type":{"names":["number"]},"since":"2.0.0"},"meta":{"fullname":"subtitle.y","name":"y","line":752,"lineEnd":765,"filename":"code/es-modules/Core/Defaults.js"},"children":{}}}},"time":{"doclet":{"description":"Time options that can apply globally or to individual charts. These\nsettings affect how `datetime` axes are laid out, how tooltips are\nformatted, how series\n[pointIntervalUnit](#plotOptions.series.pointIntervalUnit) works and how\nthe Highcharts Stock range selector handles time.\n\nThe common use case is that all charts in the same Highcharts object\nshare the same time settings, in which case the global settings are set\nusing `setOptions`.\n\n```js\n// Apply time settings globally\nHighcharts.setOptions({\n    time: {\n        timezone: 'Europe/London'\n    }\n});\n// Apply time settings by instance\nconst chart = Highcharts.chart('container', {\n    time: {\n        timezone: 'America/New_York'\n    },\n    series: [{\n        data: [1, 4, 3, 5]\n    }]\n});\n\n// Use the Time object\nconsole.log(\n       'Current time in New York',\n       chart.time.dateFormat('%Y-%m-%d %H:%M:%S', Date.now())\n);\n```\n\nSince v6.0.5, the time options were moved from the `global` object to the\n`time` object, and time options can be set on each individual chart.","samples":[{"name":"Set the timezone globally","value":"highcharts/time/timezone/","products":["highcharts","highstock"]},{"name":"Set the timezone per chart instance","value":"highcharts/time/individual/","products":["highcharts"]},{"name":"Set the timezone per chart instance","value":"stock/time/individual/","products":["highstock"]}],"since":"6.0.5","type":{"names":["*"]}},"meta":{"fullname":"time","name":"time","line":370,"lineEnd":420,"column":4,"filename":"code/es-modules/Core/Defaults.js"},"children":{"Date":{"doclet":{"description":"A custom `Date` class for advanced date handling. For example,\n[JDate](https://github.com/tahajahangir/jdate) can be hooked in to\nhandle Jalali dates.","type":{"names":["*"]},"since":"6.0.5","products":["highcharts","highstock","gantt"],"defaultvalue":"undefined"},"meta":{"fullname":"time.Date","name":"Date","line":422,"lineEnd":430,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"undefined"},"children":{}},"timezone":{"doclet":{"description":"A named time zone. Supported time zone names rely on the browser\nimplementations, as described in the [mdn\ndocs](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#timezone).\nIf the given time zone is not recognized by the browser, Highcharts\nprovides a warning and falls back to returning a 0 offset,\ncorresponding to the UTC time zone.\n\nThe time zone affects axis scaling, tickmark placement and\ntime display in `Highcharts.dateFormat`.\n\nSetting `timezone` to `undefined` falls back to the default browser\ntimezone setting.\n\nUntil v11.2.0, this option depended on moment.js.","samples":[{"name":"Europe/Oslo","value":"highcharts/time/timezone/","products":["highcharts","highstock"]}],"type":{"names":["string"]},"since":"6.0.5","products":["highcharts","highstock","gantt"],"defaultvalue":"UTC"},"meta":{"fullname":"time.timezone","name":"timezone","line":432,"lineEnd":453,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"UTC"},"children":{}},"timezoneOffset":{"doclet":{"description":"The timezone offset in minutes. Positive values are west, negative\nvalues are east of UTC, as in the ECMAScript\n[getTimezoneOffset](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTimezoneOffset)\nmethod. Use this to display UTC based data in a predefined time zone.\n\nThis option is deprecated as of v11.4.1 and will be removed in a\nfuture release. Use the [time.timezone](#time.timezone) option\ninstead.","see":["[time.getTimezoneOffset](#time.getTimezoneOffset)"],"samples":[{"name":"Timezone offset","value":"highcharts/time/timezoneoffset/","products":["highcharts","highstock"]}],"since":"6.0.5","deprecated":"11.4.2","products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"time.timezoneOffset","name":"timezoneOffset","line":455,"lineEnd":473,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":0},"children":{}},"useUTC":{"doclet":{"description":"Whether to use UTC time for axis scaling, tickmark placement and\ntime display in `Highcharts.dateFormat`. Advantages of using UTC\nis that the time displays equally regardless of the user agent's\ntime zone settings. Local time can be used when the data is loaded\nin real time or when correct Daylight Saving Time transitions are\nrequired.\n\nSetting `useUTC` to true is equivalent to setting `time.timezone` to\n`\"UTC\"`. Setting `useUTC` to false is equivalent to setting\n`time.timezone` to `undefined`.","see":["[timezone](#time.timezone)"],"samples":[{"name":"True by default","value":"highcharts/time/useutc-true/","products":["highcharts"]},{"name":"False","value":"highcharts/time/useutc-false/","products":["highcharts"]}],"deprecated":true,"since":"6.0.5","type":{"names":["string"]},"defaultvalue":"undefined"},"meta":{"fullname":"time.useUTC","name":"useUTC","line":475,"lineEnd":495,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"undefined"},"children":{}}}},"title":{"doclet":{"description":"The chart's main title.","samples":[{"name":"Title options demonstrated","value":"maps/title/title/","products":["highmaps"]},{"name":"Default title alignment","value":"highcharts/title/align-auto/","products":["highcharts"]}],"type":{"names":["*"]}},"meta":{"fullname":"title","name":"title","line":499,"lineEnd":506,"column":4,"filename":"code/es-modules/Core/Defaults.js"},"children":{"align":{"doclet":{"description":"The horizontal alignment of the title. Can be one of \"left\", \"center\"\nand \"right\".\n\nSince v12 it defaults to `undefined`, meaning the alignment is\ncomputed for best fit. If the text fits in one line, it aligned to\nthe center, but if it is wrapped into multiple lines, it is aligned\nto the left.","samples":[{"name":"Default alignment, dynamic","value":"highcharts/title/align-auto/","products":["highcharts"]},{"name":"Aligned to the plot area (x = 70px = margin left - spacing left)","value":"highcharts/title/align/","products":["highcharts"]},{"name":"Aligned to the plot area (x = 50px = margin left - spacing left)","value":"stock/chart/title-align/","products":["highstock"]}],"type":{"names":["Highcharts.AlignValue"]},"defaultvalue":"undefined","since":"2.0.0"},"meta":{"fullname":"title.align","name":"align","line":616,"lineEnd":638,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"floating":{"doclet":{"description":"When the title is floating, the plot area will not move to make space\nfor it.","samples":[{"name":"False by default","value":"highcharts/chart/zoomtype-none/","products":["highcharts"]},{"name":"True - title on top of the plot area","value":"highcharts/title/floating/","products":["highcharts"]},{"name":"True - title on top of the plot area","value":"stock/chart/title-floating/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"2.1.0"},"meta":{"fullname":"title.floating","name":"floating","line":508,"lineEnd":523,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"margin":{"doclet":{"description":"The margin between the title and the plot area, or if a subtitle\nis present, the margin between the subtitle and the plot area.","samples":[{"name":"A chart title margin of 50","value":"highcharts/title/margin-50/","products":["highcharts"]},{"name":"The same margin applied with a subtitle","value":"highcharts/title/margin-subtitle/","products":["highcharts"]},{"name":"A chart title margin of 50","value":"stock/chart/title-margin/","products":["highstock"]}],"since":"2.1.0","type":{"names":["number"]},"defaultvalue":15},"meta":{"fullname":"title.margin","name":"margin","line":616,"lineEnd":638,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":15},"children":{}},"minScale":{"doclet":{"description":"When the title is too wide to fit in the chart, the default behavior\nis to scale it down to fit, or apply word wrap if it is scaled down\nto `minScale` and still doesn't fit.\n\nThe default value reflects the scale, when using default font sizes,\nwhen the title font size matches that of the subtitle. The title\nstill stands out as it is bold by default.\n\nSet `minScale` to 1 to avoid downscaling.","samples":[{"name":"Downscaling demonstrated","value":"highcharts/title/align-auto/","products":["highcharts"]}],"since":"12.0.0","type":{"names":["number"]},"defaultvalue":0.67},"meta":{"fullname":"title.minScale","name":"minScale","line":653,"lineEnd":668,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":0.67},"children":{}},"style":{"doclet":{"description":"CSS styles for the title. Use this for font styling, but use `align`,\n`x` and `y` for text alignment.\n\nNote that the default [title.minScale](#title.minScale) option also\naffects the rendered font size. In order to keep the font size fixed\nregardless of title length, set `minScale` to 1.\n\nIn styled mode, the title style is given in the `.highcharts-title`\nclass.","samples":[{"name":"Custom color and weight","value":"highcharts/title/style/","products":["highcharts"]},{"name":"Custom color and weight","value":"stock/chart/title-style/","products":["highstock"]},{"name":"Styled mode","value":"highcharts/css/titles/"}],"type":{"names":["Highcharts.CSSObject"]},"defaultByProduct":{"highcharts":"{ \"color\": \"#333333\", \"fontSize\": \"18px\" }","highmaps":"{ \"color\": \"#333333\", \"fontSize\": \"18px\" }","highstock":"{ \"color\": \"#333333\", \"fontSize\": \"16px\" }"}},"meta":{"fullname":"title.style","name":"style","line":508,"lineEnd":523,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{"color":{"doclet":{"type":{"names":["string"]},"defaultvalue":"#333333"},"meta":{"fullname":"title.style.color","name":"color","line":600,"lineEnd":600,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"#333333"},"children":{}},"fontWeight":{"doclet":{"type":{"names":["string"]},"defaultvalue":"bold"},"meta":{"fullname":"title.style.fontWeight","name":"fontWeight","line":601,"lineEnd":601,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"bold"},"children":{}}}},"text":{"doclet":{"description":"The title of the chart. To disable the title, set the `text` to\n`undefined`.","samples":[{"name":"Custom title","value":"highcharts/title/text/","products":["highcharts"]},{"name":"Custom title","value":"stock/chart/title-text/","products":["highstock"]}],"defaultByProduct":{"highcharts":"Chart title","highmaps":"Chart title","highstock":"undefined"},"type":{"names":["string"]},"defaultvalue":"Chart title"},"meta":{"fullname":"title.text","name":"text","line":603,"lineEnd":614,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"Chart title"},"children":{}},"useHTML":{"doclet":{"description":"Whether to\n[use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the text.","type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"title.useHTML","name":"useHTML","line":524,"lineEnd":532,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of the title. Can be one of `\"top\"`,\n`\"middle\"` and `\"bottom\"`. When a value is given, the title behaves\nas if [floating](#title.floating) were `true`.","samples":[{"name":"Chart title in bottom right corner","value":"highcharts/title/verticalalign/","products":["highcharts"]},{"name":"Chart title in bottom right corner","value":"stock/chart/title-verticalalign/","products":["highstock"]}],"type":{"names":["Highcharts.VerticalAlignValue"]},"since":"2.1.0"},"meta":{"fullname":"title.verticalAlign","name":"verticalAlign","line":533,"lineEnd":546,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"x":{"doclet":{"description":"The x position of the title relative to the alignment within\n`chart.spacingLeft` and `chart.spacingRight`.","samples":[{"name":"Aligned to the plot area (x = 70px = margin left - spacing left)","value":"highcharts/title/align/","products":["highcharts"]},{"name":"Aligned to the plot area (x = 50px = margin left - spacing left)","value":"stock/chart/title-align/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"2.0.0"},"meta":{"fullname":"title.x","name":"x","line":547,"lineEnd":562,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"y":{"doclet":{"description":"The y position of the title relative to the alignment within\n[chart.spacingTop](#chart.spacingTop) and [chart.spacingBottom](#chart.spacingBottom). By default it depends on the font size.","samples":[{"name":"Title inside the plot area","value":"highcharts/title/y/","products":["highcharts"]},{"name":"Chart title in bottom right corner","value":"stock/chart/title-verticalalign/","products":["highstock"]}],"type":{"names":["number"]},"since":"2.0.0"},"meta":{"fullname":"title.y","name":"y","line":563,"lineEnd":576,"filename":"code/es-modules/Core/Defaults.js"},"children":{}}}},"tooltip":{"doclet":{"description":"Options for the tooltip that appears when the user hovers over a\nseries or point.","declare":"Highcharts.TooltipOptions","type":{"names":["*"]}},"meta":{"fullname":"tooltip","name":"tooltip","line":1839,"lineEnd":1844,"column":4,"filename":"code/es-modules/Core/Defaults.js"},"children":{"animation":{"doclet":{"description":"Enable or disable animation of the tooltip.","type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"since":"2.3.0"},"meta":{"fullname":"tooltip.animation","name":"animation","line":2232,"lineEnd":2237,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{"duration":{"doclet":{"type":{"names":["number"]},"defaultvalue":300},"meta":{"fullname":"tooltip.animation.duration","name":"duration","line":2239,"lineEnd":2239,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":300},"children":{}}}},"backgroundColor":{"doclet":{"description":"The background color or gradient for the tooltip.\n\nIn styled mode, the stroke width is set in the\n`.highcharts-tooltip-box` class.","samples":[{"name":"Yellowish background","value":"highcharts/tooltip/backgroundcolor-solid/","products":["highcharts"]},{"name":"Gradient","value":"highcharts/tooltip/backgroundcolor-gradient/","products":["highcharts"]},{"name":"Tooltip in styled mode","value":"highcharts/css/tooltip-border-background/","products":["highcharts"]},{"name":"Custom tooltip","value":"stock/tooltip/general/","products":["highstock"]},{"name":"Tooltip in styled mode","value":"highcharts/css/tooltip-border-background/","products":["highstock"]},{"name":"Background and border demo","value":"maps/tooltip/background-border/","products":["highmaps"]},{"name":"Tooltip in styled mode","value":"highcharts/css/tooltip-border-background/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#ffffff"},"meta":{"fullname":"tooltip.backgroundColor","name":"backgroundColor","line":2542,"lineEnd":2564,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"#ffffff"},"children":{}},"borderColor":{"doclet":{"description":"The color of the tooltip border. When `undefined`, the border takes\nthe color of the corresponding series or point.\n\nNote that the [borderWidth](#tooltip.borderWidth) is usually 0 by\ndefault, so the border color may not be visible until a border width\nis set.","samples":[{"name":"Follow series by default","value":"highcharts/tooltip/bordercolor-default/","products":["highcharts"]},{"name":"Black border","value":"highcharts/tooltip/bordercolor-black/","products":["highcharts"]},{"name":"Styled tooltip","value":"stock/tooltip/general/","products":["highstock"]},{"name":"Background and border demo","value":"maps/tooltip/background-border/","products":["highmaps"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"tooltip.borderColor","name":"borderColor","line":1846,"lineEnd":1864,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"borderRadius":{"doclet":{"description":"The radius of the rounded border corners.","samples":[{"name":"Default border radius","value":"highcharts/tooltip/bordercolor-default/","products":["highcharts"]},{"name":"Square borders","value":"highcharts/tooltip/borderradius-0/","products":["highcharts"]},{"name":"Background and border demo","value":"maps/tooltip/background-border/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"tooltip.borderRadius","name":"borderRadius","line":2243,"lineEnd":2252,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":3},"children":{}},"borderWidth":{"doclet":{"description":"The pixel width of the tooltip border. Defaults to 0 for single\ntooltips and fixed tooltips, otherwise 1 for split tooltips.\n\nIn styled mode, the stroke width is set in the\n`.highcharts-tooltip-box` class.","samples":[{"name":"2 pixels","value":"highcharts/tooltip/bordercolor-default/","products":["highcharts"]},{"name":"No border (shadow only)","value":"highcharts/tooltip/borderwidth/","products":["highcharts"]},{"name":"Tooltip in styled mode","value":"highcharts/css/tooltip-border-background/","products":["highcharts"]},{"name":"Custom tooltip","value":"stock/tooltip/general/","products":["highstock"]},{"name":"Tooltip in styled mode","value":"highcharts/css/tooltip-border-background/","products":["highstock"]},{"name":"Background and border demo","value":"maps/tooltip/background-border/","products":["highmaps"]},{"name":"Tooltip in styled mode","value":"highcharts/css/tooltip-border-background/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"tooltip.borderWidth","name":"borderWidth","line":2566,"lineEnd":2589,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"undefined"},"children":{}},"changeDecimals":{"doclet":{"description":"How many decimals to show for the `point.change`\nor the `point.cumulativeSum` value when the `series.compare`\nor the `series.cumulative` option is set.\nThis is overridable in each series' tooltip options object.","type":{"names":["number"]},"defaultvalue":"2","since":"1.0.1","products":["highstock"]},"meta":{"fullname":"tooltip.changeDecimals","name":"changeDecimals","line":2211,"lineEnd":2222,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"className":{"doclet":{"description":"A CSS class name to apply to the tooltip, allowing unique CSS\nstyling for each chart.\n\n**Note:** The class is applied to the SVG element of the tooltip\n(the tooltip label group), not to a container div. This allows you\nto style the tooltip using CSS applicable to SVG elements.\n\nWhen [tooltip.outside](#tooltip.outside) is `true`, a separate\ncontainer div with class `highcharts-tooltip-container` is created\nas the parent to the SVG tooltip element, but the `className` option\nis still applied to the SVG element itself, not to the container.","type":{"names":["string"]}},"meta":{"fullname":"tooltip.className","name":"className","line":1865,"lineEnd":1880,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"clusterFormat":{"doclet":{"description":"The HTML of the cluster point's in the tooltip. Works only with\nmarker-clusters module and analogously to\n[pointFormat](#tooltip.pointFormat).\n\nThe cluster tooltip can be also formatted using\n`tooltip.formatter` callback function and `point.isCluster` flag.","samples":[{"name":"Format tooltip for cluster points.","value":"highcharts/marker-clusters/grid"},{"name":"Format tooltip for clusters using tooltip.formatter","value":"maps/marker-clusters/europe/"}],"type":{"names":["string"]},"defaultvalue":"Clustered points: {point.clusterPointsAmount}","requires":["module:modules/marker-clusters"]},"meta":{"fullname":"tooltip.clusterFormat","name":"clusterFormat","line":332,"lineEnd":350,"filename":"code/es-modules/Extensions/MarkerClusters/MarkerClusterDefaults.js"},"children":{}},"crosshairs":{"doclet":{"description":"Since 4.1, the crosshair definitions are moved to the Axis object\nin order for a better separation from the tooltip. See\n[xAxis.crosshair](#xAxis.crosshair).","samples":[{"name":"Enable a crosshair for the x value","value":"highcharts/tooltip/crosshairs-x/","products":["highcharts"]}],"deprecated":true,"type":{"names":["*"]},"defaultvalue":"true"},"meta":{"fullname":"tooltip.crosshairs","name":"crosshairs","line":1881,"lineEnd":1894,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"dateTimeLabelFormats":{"doclet":{"description":"For series on datetime axes, the date format in the tooltip's\nheader will by default be guessed based on the closest data points.\nThis member gives the default string representations used for\neach unit. For an overview of the string or object configuration, see\n[dateFormat](/class-reference/Highcharts.Time#dateFormat).","see":["[xAxis.dateTimeLabelFormats](#xAxis.dateTimeLabelFormats)"],"type":{"names":["Highcharts.Dictionary.<(string|Highcharts.DateTimeFormatOptions)>"]},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"tooltip.dateTimeLabelFormats","name":"dateTimeLabelFormats","line":2254,"lineEnd":2265,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"distance":{"doclet":{"description":"Distance from point to tooltip in pixels.","type":{"names":["number"]},"defaultvalue":"16"},"meta":{"fullname":"tooltip.distance","name":"distance","line":1895,"lineEnd":1901,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the tooltip.","samples":[{"name":"Disabled","value":"highcharts/tooltip/enabled/","products":["highcharts"]},{"name":"Disable tooltip and show values on chart instead","value":"highcharts/plotoptions/series-point-events-mouseover/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"tooltip.enabled","name":"enabled","line":1846,"lineEnd":1864,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":true},"children":{}},"fixed":{"doclet":{"description":"Whether the tooltip should be fixed to one position in the chart, or\nlocated next to the point or mouse. When the tooltip is fixed, the\nposition can be further specified with the\n[tooltip.position](#tooltip.position) options set.","samples":[{"name":"Fixed tooltip and position options","value":"highcharts/tooltip/fixed/"},{"name":"Stock chart with fixed tooltip","value":"stock/tooltip/fixed/","products":["highstock"]},{"name":"Map with fixed tooltip","value":"maps/tooltip/fixed/","products":["highmaps"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"12.2.0"},"meta":{"fullname":"tooltip.fixed","name":"fixed","line":1902,"lineEnd":1919,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"followPointer":{"doclet":{"description":"Whether the tooltip should follow the mouse as it moves across\ncolumns, pie slices and other point types with an extent.\nBy default it behaves this way for pie, polygon, map, sankey\nand wordcloud series by override in the `plotOptions`\nfor those series types.\n\nDoes not apply if [split](#tooltip.split) is `true`.\n\nFor touch moves to behave the same way, [followTouchMove](#tooltip.followTouchMove) must be `true` also.","samples":[{"name":"Tooltip follow pointer comparison","value":"highcharts/tooltip/followpointer/"}],"type":{"names":["boolean"]},"defaultByProduct":{"highcharts":false,"highstock":false,"highmaps":true},"since":"3.0.0"},"meta":{"fullname":"tooltip.followPointer","name":"followPointer","line":1920,"lineEnd":1941,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"followTouchMove":{"doclet":{"description":"Whether the tooltip should update as the finger moves on a touch\ndevice. If this is `true` and [chart.panning](#chart.panning) is\nset,`followTouchMove` will take over one-finger touches, so the user\nneeds to use two fingers for zooming and panning.\n\nNote the difference to [followPointer](#tooltip.followPointer) that\nonly defines the _position_ of the tooltip. If `followPointer` is\nfalse in for example a column series, the tooltip will show above or\nbelow the column, but as `followTouchMove` is true, the tooltip will\njump from column to column as the user swipes across the plot area.","type":{"names":["boolean"]},"defaultByProduct":{"highcharts":true,"highstock":true,"highmaps":false},"since":"3.0.1"},"meta":{"fullname":"tooltip.followTouchMove","name":"followTouchMove","line":1942,"lineEnd":1960,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"footerFormat":{"doclet":{"description":"A string to append to the tooltip format.","samples":[{"name":"A table for value alignment","value":"highcharts/tooltip/footerformat/","products":["highcharts"]},{"name":"Format demo","value":"maps/tooltip/format/","products":["highmaps"]}],"since":"2.2.0","type":{"names":["string"]},"defaultvalue":""},"meta":{"fullname":"tooltip.footerFormat","name":"footerFormat","line":2284,"lineEnd":2293,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":""},"children":{}},"format":{"doclet":{"description":"A [format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nfor the whole shared tooltip. When format strings are a requirement,\nit is usually more convenient to use `headerFormat`, `pointFormat`\nand `footerFormat`, but the `format` option allows combining them\ninto one setting.\n\nThe context of the format string is the same as that of the\n`tooltip.formatter` callback.","samples":[{"name":"Format for shared tooltip","value":"highcharts/tooltip/format-shared/","products":["highcharts"]}],"type":{"names":["string"]},"defaultvalue":"undefined","since":"11.1.0"},"meta":{"fullname":"tooltip.format","name":"format","line":1961,"lineEnd":1978,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"formatter":{"doclet":{"description":"Callback function to format the text of the tooltip from scratch. In\ncase of single or [shared](#tooltip.shared) tooltips, a string should\nbe returned. In case of [split](#tooltip.split) tooltips, it should\nreturn an array where the first item is the header, and subsequent\nitems are mapped to the points. Return `false` to disable tooltip for\na specific point on series.\n\nA subset of HTML is supported. Unless `useHTML` is true, the HTML of\nthe tooltip is parsed and converted to SVG, therefore this isn't a\ncomplete HTML renderer. The following HTML tags are supported: `b`,\n`br`, `em`, `i`, `span`, `strong`. Spans can be styled with a `style`\nattribute, but only text-related CSS, that is shared with SVG, is\nhandled.\n\nThe context of the formatter (since v12) is the\n[Point](https://api.highcharts.com/class-reference/Highcharts.Point)\ninstance. If the tooltip is shared or split, an array `this.points`\ncontains all points of the hovered x-value.\n\nCommon properties from the Point to use in the formatter include:\n\n- **Point.percentage**:\n  Stacked series and pies only. The point's percentage of the total.\n\n- **Point.points**:\n  In a shared or split tooltip, this is an array containing all the\n  hovered points.\n\n- **this.series**:\n  The series object. The series name is available through\n  `this.series.name`.\n\n- **this.total**:\n  The total value at this point's x value in a stacked series, or the\n  sum of all slices in a pie series.\n\n- **this.x**:\n  The x value.\n\n- **this.y**:\n  The y value.","samples":[{"name":"Simple string formatting","value":"highcharts/tooltip/formatter-simple/","products":["highcharts"]},{"name":"Formatting with shared tooltip","value":"highcharts/tooltip/formatter-shared/","products":["highcharts"]},{"name":"Formatting with split tooltip","value":"highcharts/tooltip/formatter-split/","products":["highcharts","highstock"]},{"name":"Extending default formatter","value":"highcharts/tooltip/formatter-conditional-default/"},{"name":"Formatting with shared tooltip","value":"stock/tooltip/formatter/","products":["highstock"]},{"name":"String formatting Since v12.6.0, the callback also receives `ctx` as the second\nargument, so that arrow functions can access the same context as\nregular functions using `this`.","value":"maps/tooltip/formatter/","products":["highmaps"]}],"type":{"names":["Highcharts.TooltipFormatterCallbackFunction"]}},"meta":{"fullname":"tooltip.formatter","name":"formatter","line":1979,"lineEnd":2041,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"headerFormat":{"doclet":{"description":"The HTML of the tooltip header line. The context is the\n[Point class](https://api.highcharts.com/class-reference/Highcharts.Point).\nVariables are enclosed in curly brackets. Examples of common\nvariables to include are `x`, `y`, `series.name` and `series.color`\nand other properties on the same form. The `point.key` variable\ncontains the category name, x value or datetime string depending on\nthe type of axis. For datetime axes, the `point.key` date format can\nbe set using `tooltip.xDateFormat`.\nIn v12+, locale-aware date names follow the browser's casing and can\nbe lower-case, so use the `ucfirst` helper (for example\n`{ucfirst point.key}`) if you want a capitalized header.","samples":[{"name":"An HTML table in the tooltip","value":"highcharts/tooltip/footerformat/","products":["highcharts"]},{"name":"An HTML table in the tooltip","value":"highcharts/tooltip/footerformat/","products":["highstock"]},{"name":"Format demo","value":"maps/tooltip/format/","products":["highmaps"]}],"type":{"names":["string"]}},"meta":{"fullname":"tooltip.headerFormat","name":"headerFormat","line":2481,"lineEnd":2503,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"headerShape":{"doclet":{"description":"The name of a symbol to use for the border around the tooltip\nheader. Applies only when [tooltip.split](#tooltip.split) is\nenabled.\n\nCustom callbacks for symbol path generation can also be added to\n`Highcharts.SVGRenderer.prototype.symbols` the same way as for\n[series.marker.symbol](plotOptions.line.marker.symbol).","see":["[tooltip.shape](#tooltip.shape)"],"samples":[{"name":"Different shapes for header and split boxes","value":"stock/tooltip/split-positioner/","products":["highstock"]}],"type":{"names":["Highcharts.TooltipShapeValue"]},"values":"[\"callout\", \"rect\"]","since":"7.0.0","defaultvalue":"callout"},"meta":{"fullname":"tooltip.headerShape","name":"headerShape","line":2295,"lineEnd":2312,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":"callout"},"children":{}},"hideDelay":{"doclet":{"description":"The number of milliseconds to wait until the tooltip is hidden when\nmouse out from a point or chart.","since":"3.0.0","type":{"names":["number"]},"defaultvalue":500},"meta":{"fullname":"tooltip.hideDelay","name":"hideDelay","line":2314,"lineEnd":2319,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":500},"children":{}},"nullFormat":{"doclet":{"description":"The HTML of the null point's line in the tooltip. Works analogously\nto [pointFormat](#tooltip.pointFormat).","samples":[{"name":"Line chart with null interaction","value":"highcharts/series/null-interaction","products":["highcharts"]},{"name":"Heatmap with null interaction","value":"highcharts/plotoptions/series-nullformat","products":["highcharts"]}],"type":{"names":["string"]}},"meta":{"fullname":"tooltip.nullFormat","name":"nullFormat","line":2505,"lineEnd":2516,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"nullFormatter":{"doclet":{"description":"Callback function to format the text of the tooltip for\nvisible null points.\nWorks analogously to [formatter](#tooltip.formatter), including the\n`ctx` callback argument added in v12.5.0.","samples":[{"name":"Format data label and tooltip for null point.","value":"highcharts/plotoptions/series-nullformat"}],"type":{"names":["Highcharts.TooltipFormatterCallbackFunction"]}},"meta":{"fullname":"tooltip.nullFormatter","name":"nullFormatter","line":2042,"lineEnd":2053,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"outside":{"doclet":{"description":"Whether to allow the tooltip to render outside the chart's SVG\nelement box. By default (`false`), the tooltip is rendered within the\nchart's SVG element, which results in the tooltip being aligned\ninside the chart area. For small charts, this may result in clipping\nor overlapping. When `true`, a separate SVG element is created and\noverlaid on the page, allowing the tooltip to be aligned inside the\npage itself. Beware that with this option active, CSS classes on the\nchart's target container, with classnames matching the pattern\n'highcharts-*', will be set on the tooltip as well. This is done to\nsupport theming for tooltips with this option.\n\nDefaults to `true` if `chart.scrollablePlotArea` is activated,\notherwise `false`.","samples":[{"name":"Small charts with tooltips outside","value":"highcharts/tooltip/outside"}],"type":{"names":["boolean","undefined"]},"defaultvalue":"undefined","since":"6.1.1"},"meta":{"fullname":"tooltip.outside","name":"outside","line":2054,"lineEnd":2076,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"padding":{"doclet":{"description":"Padding inside the tooltip, in pixels.","since":"5.0.0","type":{"names":["number"]},"defaultvalue":8},"meta":{"fullname":"tooltip.padding","name":"padding","line":2330,"lineEnd":2334,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":8},"children":{}},"pointFormat":{"doclet":{"description":"The HTML of the point's line in the tooltip. The context is the\n[Point class](https://api.highcharts.com/class-reference/Highcharts.Point).\nVariables are enclosed in curly brackets. Examples of common\nvariables to include are `x`, `y`, `series.name` and `series.color`\nand other properties on the same form. Furthermore, `y` can be\nextended by the `tooltip.valuePrefix` and `tooltip.valueSuffix`\nvariables. This can also be overridden for each series, which makes\nit a good hook for displaying units.\n\nIn styled mode, the dot is colored by a class name rather than the\npoint color.","samples":[{"name":"A different point format with value suffix","value":"highcharts/tooltip/pointformat/","products":["highcharts"]},{"name":"Show extra information about points in the tooltip","value":"highcharts/tooltip/pointformat-extra-information/","products":["highcharts","highstock"]},{"name":"Format demo","value":"maps/tooltip/format/","products":["highmaps"]}],"type":{"names":["string"]},"since":"2.2.0"},"meta":{"fullname":"tooltip.pointFormat","name":"pointFormat","line":2517,"lineEnd":2540,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"pointFormatter":{"doclet":{"description":"A callback function for formatting the HTML output for a single point\nin the tooltip. Like the `pointFormat` string, but with more\nflexibility. Since v12.6.0, the callback also receives `ctx` as the\nfirst argument, so that arrow functions can access the same context\nas regular functions using `this`.","type":{"names":["Highcharts.FormatterCallbackFunction.<Highcharts.Point>"]},"since":"4.1.0","context":"Highcharts.Point"},"meta":{"fullname":"tooltip.pointFormatter","name":"pointFormatter","line":2077,"lineEnd":2088,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"position":{"doclet":{"description":"Positioning options for fixed tooltip, taking effect only when\n[tooltip.fixed](#tooltip.fixed) is `true`.","samples":[{"name":"Fixed tooltip and position options","value":"highcharts/tooltip/fixed/","products":["highcharts"]},{"name":"Stock chart with fixed tooltip","value":"stock/tooltip/fixed/","products":["highstock"]},{"name":"Map with fixed tooltip","value":"maps/tooltip/fixed/","products":["highmaps"]}],"since":"12.2.0","type":{"names":["*"]}},"meta":{"fullname":"tooltip.position","name":"position","line":2336,"lineEnd":2348,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{"align":{"doclet":{"description":"The horizontal alignment of the fixed tooltip.","samples":[{"name":"Fixed tooltip","value":"highcharts/tooltip/fixed/"},{"name":"Stock chart with fixed tooltip","value":"stock/tooltip/fixed/","products":["highstock"]}],"type":{"names":["Highcharts.AlignValue"]},"defaultvalue":"left","since":"12.2.0"},"meta":{"fullname":"tooltip.position.align","name":"align","line":2350,"lineEnd":2361,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"relativeTo":{"doclet":{"description":"What the fixed tooltip alignment should be relative to.\n\nThe default, `pane`, means that it is aligned within the plot\narea for that given series. If the tooltip is split (as default\nin Stock charts), each partial tooltip is aligned within the\nseries' pane.","samples":[{"name":"Fixed tooltip","value":"highcharts/tooltip/fixed/"},{"name":"Stock chart with fixed tooltip","value":"stock/tooltip/fixed/","products":["highstock"]}],"type":{"names":["\"pane\"","\"chart\"","\"plotBox\"","\"spacingBox\""]},"defaultvalue":"pane","since":"12.2.0"},"meta":{"fullname":"tooltip.position.relativeTo","name":"relativeTo","line":2374,"lineEnd":2391,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"The vertical alignment of the fixed tooltip.","samples":[{"name":"Fixed tooltip","value":"highcharts/tooltip/fixed/"},{"name":"Stock chart with fixed tooltip","value":"stock/tooltip/fixed/","products":["highstock"]}],"type":{"names":["Highcharts.VerticalAlignValue"]},"defaultvalue":"top","since":"12.2.0"},"meta":{"fullname":"tooltip.position.verticalAlign","name":"verticalAlign","line":2362,"lineEnd":2373,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"x":{"doclet":{"description":"X pixel offset from the given position. Can be used to shy away\nfrom axis lines, grid lines etc to avoid the tooltip overlapping\nother elements.","samples":[{"name":"Fixed tooltip","value":"highcharts/tooltip/fixed/"},{"name":"Stock chart with fixed tooltip","value":"stock/tooltip/fixed/","products":["highstock"]}],"since":"12.2.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"tooltip.position.x","name":"x","line":2350,"lineEnd":2361,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":0},"children":{}},"y":{"doclet":{"description":"Y pixel offset from the given position. Can be used to shy away\nfrom axis lines, grid lines etc to avoid the tooltip overlapping\nother elements.","samples":[{"name":"Fixed tooltip","value":"highcharts/tooltip/fixed/"},{"name":"Stock chart with fixed tooltip","value":"stock/tooltip/fixed/","products":["highstock"]}],"since":"12.2.0","type":{"names":["number"]},"defaultvalue":3},"meta":{"fullname":"tooltip.position.y","name":"y","line":2403,"lineEnd":2412,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":3},"children":{}}}},"positioner":{"doclet":{"description":"A callback function to place the tooltip in a custom position. The\ncallback receives four parameters: `labelWidth`, `labelHeight`,\n`point`, and `ctx`, where point contains values for `plotX` and\n`plotY` telling where the reference point is in the plot area, and\n`ctx` is the tooltip context (so that arrow-functions can access the\nsame context as a normal function using `this`). Add\n`chart.plotLeft` and `chart.plotTop` to get the full coordinates.\nSince v12.6.0, the callback receives `ctx`.\n\nTo find the actual hovered `Point` instance, use\n`this.chart.hoverPoint`. For shared or split tooltips, all the hover\npoints are available in `this.chart.hoverPoints`.\n\nSince v7, when [tooltip.split](#tooltip.split) option is enabled,\npositioner is called for each of the boxes separately, including\nxAxis header. xAxis header is not a point, instead `point` argument\ncontains info: `{ plotX: Number, plotY: Number, isHeader: Boolean }`\n\nSince v12.2, the [tooltip.fixed](#tooltip.fixed) option combined with\n[tooltip.position](#tooltip.position) covers most of the use cases\nfor custom tooltip positioning.\n\nThe return should be an object containing x and y values, for example\n`{ x: 100, y: 100 }`.","samples":[{"name":"A fixed tooltip position","value":"highcharts/tooltip/positioner/","products":["highcharts"]},{"name":"A fixed tooltip position on top of the chart","value":"stock/tooltip/positioner/","products":["highstock"]},{"name":"A fixed tooltip position","value":"maps/tooltip/positioner/","products":["highmaps"]},{"name":"Split tooltip with fixed positions","value":"stock/tooltip/split-positioner/","products":["highstock"]},{"name":"Scrollable plot area combined with tooltip positioner","value":"stock/tooltip/positioner-scrollable-plotarea/","products":["highstock"]}],"see":["[position](#tooltip.position)"],"type":{"names":["Highcharts.TooltipPositionerCallbackFunction"]},"since":"2.2.4"},"meta":{"fullname":"tooltip.positioner","name":"positioner","line":2089,"lineEnd":2131,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"shadow":{"doclet":{"description":"Whether to apply a drop shadow to the tooltip. Defaults to true,\nunless the tooltip is [fixed](#tooltip.fixed).","samples":[{"name":"True by default","value":"highcharts/tooltip/bordercolor-default/","products":["highcharts"]},{"name":"False","value":"highcharts/tooltip/shadow/","products":["highcharts"]},{"name":"Fixed tooltip position, border and shadow disabled","value":"maps/tooltip/positioner/","products":["highmaps"]}],"type":{"names":["boolean","Highcharts.ShadowOptionsObject"]},"defaultvalue":"undefined"},"meta":{"fullname":"tooltip.shadow","name":"shadow","line":2591,"lineEnd":2605,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"shape":{"doclet":{"description":"The name of a symbol to use for the border around the tooltip. Can\nbe one of: `\"callout\"`, `\"circle\"` or `\"rect\"`. When\n[tooltip.split](#tooltip.split)\noption is enabled, shape is applied to all boxes except header, which\nis controlled by\n[tooltip.headerShape](#tooltip.headerShape).\n\nCustom callbacks for symbol path generation can also be added to\n`Highcharts.SVGRenderer.prototype.symbols` the same way as for\n[series.marker.symbol](plotOptions.line.marker.symbol).\n\nDefaults to `callout` for floating tooltip, `rect` for\n[fixed](#tooltip.fixed) tooltip.","type":{"names":["Highcharts.TooltipShapeValue"]},"since":"4.0.0","defaultvalue":"undefined"},"meta":{"fullname":"tooltip.shape","name":"shape","line":2415,"lineEnd":2434,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"shared":{"doclet":{"description":"Shows information in the tooltip for all points with the same X\nvalue. When the tooltip is shared, the entire plot area will capture\nmouse movement or touch events. Tooltip texts for series types with\nordered data (not pie, scatter, flags etc) will be shown in a single\nbubble. This is recommended for single series charts and for\ntablet/mobile optimized charts.\n\nSee also [tooltip.split](#tooltip.split), that is better suited for\ncharts with many series, especially line-type series. The\n`tooltip.split` option takes precedence over `tooltip.shared`.","samples":[{"name":"False by default","value":"highcharts/tooltip/shared-false/","products":["highcharts"]},{"name":"True","value":"highcharts/tooltip/shared-true/","products":["highcharts"]},{"name":"True with x axis crosshair","value":"highcharts/tooltip/shared-x-crosshair/","products":["highcharts"]},{"name":"True with mixed series types","value":"highcharts/tooltip/shared-true-mixed-types/","products":["highcharts"]}],"since":"2.1.0","products":["highcharts","highstock"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"tooltip.shared","name":"shared","line":2415,"lineEnd":2434,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":false},"children":{}},"showDelay":{"doclet":{"description":"The number of milliseconds to wait until the tooltip is shown when\nmouse over a point. Works on initial hover.","samples":[{"name":"/","value":"","products":["highcharts","highstock"]}],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"tooltip.showDelay","name":"showDelay","line":2321,"lineEnd":2328,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":0},"children":{}},"snap":{"doclet":{"description":"Proximity snap for graphs or single points. It defaults to 10 for\nmouse-powered devices and 25 for touch devices.\n\nNote that in most cases the whole plot area captures the mouse\nmovement, and in these cases `tooltip.snap` doesn't make sense. This\napplies when [stickyTracking](#plotOptions.series.stickyTracking)\nis `true` (default) and when the tooltip is [shared](#tooltip.shared)\nor [split](#tooltip.split).","samples":[{"name":"10 px by default","value":"highcharts/tooltip/bordercolor-default/","products":["highcharts"]},{"name":"50 px on graph","value":"highcharts/tooltip/snap-50/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"10/25","since":"1.2.0","products":["highcharts","highstock"]},"meta":{"fullname":"tooltip.snap","name":"snap","line":2460,"lineEnd":2479,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"split":{"doclet":{"description":"Shows tooltip for all points with the same X value. Splits the\ntooltip into one label per series, with the header close to the axis.\nThis is recommended over [shared](#tooltip.shared)\ntooltips for charts with multiple line series, generally making them\neasier to read. This option takes precedence over `tooltip.shared`.\n\nNot supported for [polar](#chart.polar) and [inverted](#chart.inverted) charts.","productdesc":[{"value":"In Highcharts Stock, tooltips are split\nby default since v6.0.0. Stock charts typically contain\nmulti-dimension points and multiple panes, making split tooltips\nthe preferred layout over\nthe previous `shared` tooltip.","products":["highstock"]}],"samples":[{"name":"Split tooltip","value":"highcharts/tooltip/split/"},{"name":"Split tooltip and custom formatter callback","value":"highcharts/tooltip/formatter-split/","products":["highcharts","highstock"]}],"type":{"names":["boolean"]},"defaultByProduct":{"highcharts":false,"highstock":true},"since":"5.0.0","products":["highcharts","highstock"]},"meta":{"fullname":"tooltip.split","name":"split","line":2132,"lineEnd":2158,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"stickOnContact":{"doclet":{"description":"Prevents the tooltip from switching or closing, when touched or\npointed.","samples":[{"name":"Tooltip sticks on pointer contact","value":"highcharts/tooltip/stickoncontact/"}],"type":{"names":["boolean"]},"since":"8.0.1","defaultvalue":false},"meta":{"fullname":"tooltip.stickOnContact","name":"stickOnContact","line":2591,"lineEnd":2605,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":false},"children":{}},"style":{"doclet":{"description":"CSS styles for the tooltip. The tooltip can also be styled through\nthe CSS class `.highcharts-tooltip`.\n\nNote that the default `pointerEvents` style makes the tooltip ignore\nmouse events, so in order to use clickable tooltips, this value must\nbe set to `auto`.","samples":[{"name":"Greater padding, bold text","value":"highcharts/tooltip/style/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]}},"meta":{"fullname":"tooltip.style","name":"style","line":2617,"lineEnd":2629,"column":8,"filename":"code/es-modules/Core/Defaults.js"},"children":{"fontSize":{"doclet":{"type":{"names":["number","string"]},"defaultvalue":"0.8em"},"meta":{"fullname":"tooltip.style.fontSize","name":"fontSize","line":2635,"lineEnd":2637,"column":12,"filename":"code/es-modules/Core/Defaults.js","default":"0.8em"},"children":{}}}},"useHTML":{"doclet":{"description":"Use HTML to render the contents of the tooltip instead of SVG. Using\nHTML allows advanced formatting like tables and images in the\ntooltip. It is also recommended for rtl languages as it works around\nrtl bugs in early Firefox.","samples":[{"name":"A table for value alignment","value":"highcharts/tooltip/footerformat/","products":["highcharts","highstock"]},{"name":"Full HTML tooltip","value":"highcharts/tooltip/fullhtml/","products":["highcharts","highstock"]},{"name":"Pure HTML tooltip","value":"maps/tooltip/usehtml/","products":["highmaps"]}],"since":"2.2.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"tooltip.useHTML","name":"useHTML","line":2640,"lineEnd":2654,"column":8,"filename":"code/es-modules/Core/Defaults.js","default":false},"children":{}},"valueDecimals":{"doclet":{"description":"How many decimals to show in each series' y value. This is\noverridable in each series' tooltip options object. The default is to\npreserve all decimals.","samples":[{"name":"Set decimals, prefix and suffix for the value","value":"highcharts/tooltip/valuedecimals/","products":["highcharts","highstock"]},{"name":"Set decimals, prefix and suffix for the value","value":"maps/tooltip/valuedecimals/","products":["highmaps"]}],"type":{"names":["number","undefined"]},"since":"2.2.0"},"meta":{"fullname":"tooltip.valueDecimals","name":"valueDecimals","line":2159,"lineEnd":2172,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"valuePrefix":{"doclet":{"description":"A string to prepend to each series' y value. Overridable in each\nseries' tooltip options object.","samples":[{"name":"Set decimals, prefix and suffix for the value","value":"highcharts/tooltip/valuedecimals/","products":["highcharts","highstock"]},{"name":"Set decimals, prefix and suffix for the value","value":"maps/tooltip/valuedecimals/","products":["highmaps"]}],"type":{"names":["string"]},"since":"2.2.0"},"meta":{"fullname":"tooltip.valuePrefix","name":"valuePrefix","line":2173,"lineEnd":2185,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"valueSuffix":{"doclet":{"description":"A string to append to each series' y value. Overridable in each\nseries' tooltip options object.","samples":[{"name":"Set decimals, prefix and suffix for the value","value":"highcharts/tooltip/valuedecimals/","products":["highcharts","highstock"]},{"name":"Set decimals, prefix and suffix for the value","value":"maps/tooltip/valuedecimals/","products":["highmaps"]}],"type":{"names":["string"]},"since":"2.2.0"},"meta":{"fullname":"tooltip.valueSuffix","name":"valueSuffix","line":2186,"lineEnd":2198,"filename":"code/es-modules/Core/Defaults.js"},"children":{}},"xDateFormat":{"doclet":{"description":"The format for the date in the tooltip header if the X axis is a\ndatetime axis. The default is a best guess based on the smallest\ndistance between points in the chart.","samples":[{"name":"A different format","value":"highcharts/tooltip/xdateformat/","products":["highcharts"]}],"type":{"names":["string","Highcharts.DateTimeFormatOptions"]},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"tooltip.xDateFormat","name":"xDateFormat","line":2199,"lineEnd":2210,"filename":"code/es-modules/Core/Defaults.js"},"children":{}}}},"xAxis":{"doclet":{"description":"The X axis or category axis. Normally this is the horizontal axis,\nthough if the chart is inverted this is the vertical axis. In case of\nmultiple axes, the xAxis node is an array of configuration objects.\n\nSee the [Axis class](/class-reference/Highcharts.Axis) for programmatic\naccess to the axis.","productdesc":[{"value":"In Highmaps, the axis is hidden, but it is used behind the scenes to\ncontrol features like zooming and panning. Zooming is in effect the same\nas setting the extremes of one of the exes.","products":["highmaps"]}],"type":{"names":["*","Array.<*>"]}},"meta":{"filename":"code/es-modules/Core/Axis/AxisDefaults.js","name":"xAxis","fullname":"xAxis","line":19,"lineEnd":23,"column":4},"children":{"accessibility":{"doclet":{"description":"Accessibility options for an axis. Requires the accessibility module.","declare":"Highcharts.AxisAccessibilityOptionsObject","since":"7.1.0","requires":["module:modules/accessibility"],"type":{"names":["*"]}},"meta":{"fullname":"xAxis.accessibility","name":"accessibility","line":873,"lineEnd":880,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{"description":{"doclet":{"description":"Description for an axis to expose to screen reader users.","type":{"names":["string"]},"since":"7.1.0"},"meta":{"fullname":"xAxis.accessibility.description","name":"description","line":891,"lineEnd":897,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Enable axis accessibility features, including axis information in the\nscreen reader information region. If this is disabled on the xAxis, the\nx values are not exposed to screen readers for the individual data points\nby default.","type":{"names":["boolean"]},"since":"7.1.0"},"meta":{"fullname":"xAxis.accessibility.enabled","name":"enabled","line":881,"lineEnd":890,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}},"rangeDescription":{"doclet":{"description":"Range description for an axis. Overrides the default range description.\nSet to empty to disable range description for this axis.","type":{"names":["string"]},"since":"7.1.0"},"meta":{"fullname":"xAxis.accessibility.rangeDescription","name":"rangeDescription","line":898,"lineEnd":905,"filename":"code/es-modules/Accessibility/Options/A11yDefaults.js"},"children":{}}}},"alignTicks":{"doclet":{"description":"When using multiple axis, the ticks of two or more opposite axes\nwill automatically be aligned by adding ticks to the axis or axes\nwith the least ticks, as if `tickAmount` were specified.\n\nThis can be prevented by setting `alignTicks` to false. If the grid\nlines look messy, it's a good idea to hide them for the secondary\naxis by setting `gridLineWidth` to 0.\n\nIf `startOnTick` or `endOnTick` in an Axis options are set to false,\nthen the `alignTicks ` will be disabled for the Axis.\n\nDisabled for logarithmic axes.","products":["highcharts","highstock","gantt"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"xAxis.alignTicks","name":"alignTicks","line":41,"lineEnd":56,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"allowDecimals":{"doclet":{"description":"Whether to allow decimals in this axis' ticks. When counting\nintegers, like persons or hits on a web page, decimals should\nbe avoided in the labels. By default, decimals are allowed on small\nscale axes.","see":["[minTickInterval](#xAxis.minTickInterval)"],"samples":[{"name":"True by default","value":"highcharts/yaxis/allowdecimals-true/","products":["highcharts","highstock"]},{"name":"False","value":"highcharts/yaxis/allowdecimals-false/","products":["highcharts","highstock"]}],"type":{"names":["boolean","undefined"]},"defaultvalue":"undefined","since":"2.0.0"},"meta":{"fullname":"xAxis.allowDecimals","name":"allowDecimals","line":58,"lineEnd":74,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"undefined"},"children":{}},"alternateGridColor":{"doclet":{"description":"When using an alternate grid color, a band is painted across the\nplot area between every other grid line.","samples":[{"name":"Alternate grid color on the Y axis","value":"highcharts/yaxis/alternategridcolor/","products":["highcharts"]},{"name":"Alternate grid color on the Y axis","value":"stock/xaxis/alternategridcolor/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]}},"meta":{"fullname":"xAxis.alternateGridColor","name":"alternateGridColor","line":76,"lineEnd":87,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"angle":{"doclet":{"description":"In a polar chart, this is the angle of the Y axis in degrees, where\n0 is up and 90 is right. The angle determines the position of the\naxis line and the labels, though the coordinate system is unaffected.\nSince v8.0.0 this option is also applicable for X axis (inverted\npolar).","samples":[{"name":"Custom X axis' angle on inverted polar chart","value":"highcharts/xaxis/angle/","products":["highcharts"]},{"name":"Dual axis polar chart","value":"highcharts/yaxis/angle/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"4.2.7","products":["highcharts"]},"meta":{"fullname":"xAxis.angle","name":"angle","line":65,"lineEnd":82,"filename":"code/es-modules/Core/Axis/RadialAxisDefaults.js"},"children":{}},"breaks":{"doclet":{"description":"An array defining breaks in the axis, the sections defined will be\nleft out and all the points shifted closer to each other.","productdesc":[{"value":"Requires that the broken-axis.js module is loaded.","products":["highcharts"]}],"samples":[{"name":"Simple break","value":"highcharts/axisbreak/break-simple/","products":["highcharts"]},{"name":"Advanced with callback","value":"highcharts/axisbreak/break-visualized/","products":["highcharts","highstock"]},{"name":"Break on nights and weekends","value":"stock/demo/intraday-breaks/","products":["highstock"]}],"type":{"names":["Array.<*>"]},"since":"4.1.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.breaks","name":"breaks","line":88,"lineEnd":106,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"breakSize":{"doclet":{"description":"A number indicating how much space should be left between the start\nand the end of the break. The break size is given in axis units,\nso for instance on a `datetime` axis, a break size of 3600000 would\nindicate the equivalent of an hour.","type":{"names":["number"]},"defaultvalue":"0","since":"4.1.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.breaks.breakSize","name":"breakSize","line":107,"lineEnd":118,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"from":{"doclet":{"description":"The axis value where the break starts. On datetime axes, this may be\na date string.","type":{"names":["number","string"]},"since":"4.1.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.breaks.from","name":"from","line":119,"lineEnd":127,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"repeat":{"doclet":{"description":"Defines an interval after which the break appears again. By default\nthe breaks do not repeat.","type":{"names":["number"]},"defaultvalue":"0","since":"4.1.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.breaks.repeat","name":"repeat","line":128,"lineEnd":137,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"to":{"doclet":{"description":"The axis value where the break ends. On datetime axes, this may be\na date string.","type":{"names":["number","string"]},"since":"4.1.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.breaks.to","name":"to","line":138,"lineEnd":146,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"categories":{"doclet":{"description":"If categories are present for the xAxis, names are used instead of\nnumbers for that axis.\n\nSince Highcharts 3.0, categories can also\nbe extracted by giving each point a [name](#series.data) and setting\naxis [type](#xAxis.type) to `category`. However, if you have multiple\nseries, best practice remains defining the `categories` array.\n\nExample: `categories: ['Apples', 'Bananas', 'Oranges']`","samples":[{"name":"With","value":"highcharts/demo/line-labels/","products":["highcharts"]},{"name":"Without","value":"highcharts/xaxis/categories/","products":["highcharts"]}],"type":{"names":["Array.<string>"]},"products":["highcharts","gantt"]},"meta":{"fullname":"xAxis.categories","name":"categories","line":147,"lineEnd":166,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"ceiling":{"doclet":{"description":"The highest allowed value for automatically computed axis extremes.","see":["[floor](#xAxis.floor)"],"samples":[{"name":"Floor and ceiling","value":"highcharts/yaxis/floor-ceiling/","products":["highcharts","highstock"]}],"type":{"names":["number"]},"since":"4.0.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.ceiling","name":"ceiling","line":167,"lineEnd":179,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"className":{"doclet":{"description":"A class name that opens for styling the axis by CSS, especially in\nHighcharts styled mode. The class name is applied to group elements\nfor the grid, axis elements and labels.","samples":[{"name":"Multiple axes with separate styling","value":"highcharts/css/axis/","products":["highcharts","highstock","highmaps"]}],"type":{"names":["string"]},"since":"5.0.0"},"meta":{"fullname":"xAxis.className","name":"className","line":180,"lineEnd":191,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"crosshair":{"doclet":{"description":"Configure a crosshair that follows either the mouse pointer or the\nhovered point.\n\nSupport boolean or object definition. If `true`, a crosshair with\ndefault settings will be displayed.\n\nIn styled mode, the crosshairs are styled in the\n`.highcharts-crosshair`, `.highcharts-crosshair-thin` or\n`.highcharts-xaxis-category` classes.","productdesc":[{"value":"In Highcharts stock, by default, the crosshair is enabled on the\nX axis and disabled on the Y axis.","products":["highstock"]}],"samples":[{"name":"Crosshair on both axes","value":"highcharts/xaxis/crosshair-both/","products":["highcharts"]},{"name":"Crosshair on both axes, with y axis label","value":"stock/xaxis/crosshairs-xy/","products":["highstock"]},{"name":"Crosshair on both axes","value":"highcharts/xaxis/crosshair-both/","products":["highmaps"]}],"declare":"Highcharts.AxisCrosshairOptions","type":{"names":["boolean","*"]},"defaultvalue":"false","since":"4.1.0"},"meta":{"fullname":"xAxis.crosshair","name":"crosshair","line":192,"lineEnd":219,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"className":{"doclet":{"description":"A class name for the crosshair, especially as a hook for styling.","type":{"names":["string"]},"since":"5.0.0"},"meta":{"fullname":"xAxis.crosshair.className","name":"className","line":220,"lineEnd":226,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"color":{"doclet":{"description":"The color of the crosshair. Defaults to `#cccccc` for numeric and\ndatetime axes, and `rgba(204,214,235,0.25)` for category axes, where\nthe crosshair by default highlights the whole category.","samples":[{"name":"Customized crosshairs","value":"highcharts/xaxis/crosshair-customized/","products":["highcharts","highstock","highmaps"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#cccccc","since":"4.1.0"},"meta":{"fullname":"xAxis.crosshair.color","name":"color","line":227,"lineEnd":239,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"dashStyle":{"doclet":{"description":"The dash style for the crosshair. See\n[plotOptions.series.dashStyle](#plotOptions.series.dashStyle)\nfor possible values.","samples":[{"name":"Dotted crosshair","value":"highcharts/xaxis/crosshair-dotted/","products":["highcharts","highmaps"]},{"name":"Dashed X axis crosshair","value":"stock/xaxis/crosshair-dashed/","products":["highstock"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"4.1.0"},"meta":{"fullname":"xAxis.crosshair.dashStyle","name":"dashStyle","line":240,"lineEnd":254,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"label":{"doclet":{"description":"A label on the axis next to the crosshair.\n\nIn styled mode, the label is styled with the\n`.highcharts-crosshair-label` class.","samples":[{"name":"Crosshair labels","value":"stock/xaxis/crosshair-label/","products":["highstock"]},{"name":"Style mode","value":"highcharts/css/crosshair-label/","products":["highstock"]}],"declare":"Highcharts.AxisCrosshairLabelOptions","since":"4.1.0","products":["highstock"],"type":{"names":["*"]}},"meta":{"fullname":"xAxis.crosshair.label","name":"label","line":255,"lineEnd":270,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"align":{"doclet":{"description":"Alignment of the label compared to the axis. Defaults to `\"left\"` for\nright-side axes, `\"right\"` for left-side axes and `\"center\"` for\nhorizontal axes.","type":{"names":["Highcharts.AlignValue"]},"since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.align","name":"align","line":271,"lineEnd":280,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"backgroundColor":{"doclet":{"description":"The background color for the label. Defaults to the related series\ncolor, or `#666666` if that is not available.","type":{"names":["Highcharts.ColorType"]},"since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.backgroundColor","name":"backgroundColor","line":281,"lineEnd":289,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"borderColor":{"doclet":{"description":"The border color for the crosshair label","type":{"names":["Highcharts.ColorType"]},"since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.borderColor","name":"borderColor","line":290,"lineEnd":297,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"borderRadius":{"doclet":{"description":"The border corner radius of the crosshair label.","type":{"names":["number"]},"defaultvalue":"3","since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.borderRadius","name":"borderRadius","line":298,"lineEnd":306,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"borderWidth":{"doclet":{"description":"The border width for the crosshair label.","type":{"names":["number"]},"defaultvalue":"0","since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.borderWidth","name":"borderWidth","line":307,"lineEnd":315,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"enabled":{"doclet":{"description":"Flag to enable crosshair's label.","samples":[{"name":"Enabled label for yAxis' crosshair","value":"stock/xaxis/crosshairs-xy/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.enabled","name":"enabled","line":316,"lineEnd":327,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"format":{"doclet":{"description":"A format string for the crosshair label. Defaults to `{value}` for\nnumeric axes and `{value:%b %d, %Y}` for datetime axes.","type":{"names":["string"]},"since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.format","name":"format","line":328,"lineEnd":336,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"formatter":{"doclet":{"description":"Formatter function for the label text.\nSince v12.6.0, the callback also receives `ctx` as the second\nargument, so that arrow functions can access the same context as\nregular functions using `this`.","type":{"names":["Highcharts.XAxisCrosshairLabelFormatterCallbackFunction"]},"since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.formatter","name":"formatter","line":337,"lineEnd":347,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"padding":{"doclet":{"description":"Padding inside the crosshair label.","type":{"names":["number"]},"defaultvalue":"8","since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.padding","name":"padding","line":348,"lineEnd":356,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"shape":{"doclet":{"description":"The shape to use for the label box.","type":{"names":["string"]},"defaultvalue":"callout","since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.shape","name":"shape","line":357,"lineEnd":365,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"style":{"doclet":{"description":"Text styles for the crosshair label.","type":{"names":["Highcharts.CSSObject"]},"defaultvalue":"{\"color\": \"white\", \"fontWeight\": \"normal\", \"fontSize\": \"11px\", \"textAlign\": \"center\"}","since":"4.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.crosshair.label.style","name":"style","line":366,"lineEnd":374,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"showDelay":{"doclet":{"description":"The number of milliseconds to wait until the crosshair is shown when\nthe mouse is over a point. Works on initial hover.","samples":[{"name":"/","value":"","products":["highcharts","highstock"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"4.1.0"},"meta":{"fullname":"xAxis.crosshair.showDelay","name":"showDelay","line":375,"lineEnd":385,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"snap":{"doclet":{"description":"Whether the crosshair should snap to the point or follow the pointer\nindependent of points.","samples":[{"name":"True by default","value":"highcharts/xaxis/crosshair-snap-false/","products":["highcharts","highstock"]},{"name":"Snap is false","value":"maps/demo/latlon-advanced/","products":["highmaps"]}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"4.1.0"},"meta":{"fullname":"xAxis.crosshair.snap","name":"snap","line":386,"lineEnd":399,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"width":{"doclet":{"description":"The pixel width of the crosshair. Defaults to 1 for numeric or\ndatetime axes, and for one category width for category axes.","samples":[{"name":"Customized crosshairs","value":"highcharts/xaxis/crosshair-customized/","products":["highcharts"]},{"name":"Customized crosshairs","value":"highcharts/xaxis/crosshair-customized/","products":["highstock"]},{"name":"Customized crosshairs","value":"highcharts/xaxis/crosshair-customized/","products":["highmaps"]}],"type":{"names":["number"]},"defaultvalue":"1","since":"4.1.0"},"meta":{"fullname":"xAxis.crosshair.width","name":"width","line":400,"lineEnd":415,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"zIndex":{"doclet":{"description":"The Z index of the crosshair. Higher Z indices allow drawing the\ncrosshair on top of the series or behind the grid lines.","type":{"names":["number"]},"defaultvalue":"2","since":"4.1.0"},"meta":{"fullname":"xAxis.crosshair.zIndex","name":"zIndex","line":416,"lineEnd":424,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"crossing":{"doclet":{"description":"The value on a perpendicular axis where this axis should cross. This\nis typically used on mathematical plots where the axes cross at 0.\nWhen `crossing` is set, space will not be reserved at the sides of\nthe chart for axis labels and title, so those may be clipped. In this\ncase it is better to place the axes without the `crossing` option.","type":{"names":["number"]},"samples":[{"name":"Function plot with axes crossing at 0","value":"highcharts/xaxis/crossing"}],"since":"11.0.1"},"meta":{"fullname":"xAxis.crossing","name":"crossing","line":425,"lineEnd":437,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"currentDateIndicator":{"doclet":{"description":"Show an indicator on the axis for the current date and time. Can be a\nboolean or a configuration object similar to\n[xAxis.plotLines](#xAxis.plotLines).","samples":[{"name":"Current date indicator enabled","value":"gantt/current-date-indicator/demo"},{"name":"Current date indicator with custom options","value":"gantt/current-date-indicator/object-config"}],"declare":"Highcharts.CurrentDateIndicatorOptions","type":{"names":["boolean","CurrentDateIndicatorOptions"]},"defaultvalue":"true","extends":"xAxis.plotLines","exclude":["value"],"products":["gantt"]},"meta":{"fullname":"xAxis.currentDateIndicator","name":"currentDateIndicator","line":21,"lineEnd":38,"filename":"code/es-modules/Extensions/CurrentDateIndication.js"},"children":{"label":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"format":{"doclet":{"description":"Format of the label. This options is passed as the first argument to\n[dateFormat](/class-reference/Highcharts.Time#dateFormat) function.","type":{"names":["string","Intl.DateTimeFormatOptions"]},"products":["gantt"]},"meta":{"fullname":"xAxis.currentDateIndicator.label.format","name":"format","line":46,"lineEnd":53,"filename":"code/es-modules/Extensions/CurrentDateIndication.js"},"children":{}}}}}},"dateTimeLabelFormats":{"doclet":{"description":"For a datetime axis, the scale will automatically adjust to the\nappropriate unit. This member gives the default string\nrepresentations used for each unit. For intermediate values,\ndifferent units may be used, for example the `day` unit can be used\non midnight and `hour` unit be used for intermediate values on the\nsame axis.\n\nFor an overview of the string or object configuration, see\n[dateFormat](/class-reference/Highcharts.Time#dateFormat).\n\nDefaults to:\n```js\n{\n    millisecond: '%[HMSL]',\n    second: '%[HMS]',\n    minute: '%[HM]',\n    hour: '%[HM]',\n    day: '%[eb]',\n    week: '%[eb]',\n    month: '%[bY]',\n    year: '%Y'\n}\n```","samples":[{"name":"Gantt chart with custom axis date format.","value":"gantt/grid-axis/date-time-label-formats","products":["gantt"]}],"declare":"Highcharts.AxisDateTimeLabelFormatsOptions","products":["highcharts","highstock","gantt"],"productdesc":[{"value":"For grid axes (like in Gantt charts),\nit is possible to declare as a list to provide different\nformats depending on available space.\n\nDefaults to:\n```js\n{\n    hour: { list: ['%H:%M', '%H'] },\n    day: { list: ['%A, %e. %B', '%a, %e. %b', '%E'] },\n    week: { list: ['Week %W', 'W%W'] },\n    month: { list: ['%B', '%b', '%o'] }\n}\n```","products":["gantt"]}],"type":{"names":["*"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats","name":"dateTimeLabelFormats","line":458,"lineEnd":492,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"day":{"doclet":{"declare":"Highcharts.AxisDateTimeLabelFormatsOptionsObject","type":{"names":["string","*"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.day","name":"day","line":562,"lineEnd":565,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"list":{"doclet":{"type":{"names":["Array.<(string|Highcharts.DateTimeFormatOptions)>"]},"defaultvalue":"undefined"},"meta":{"fullname":"xAxis.dateTimeLabelFormats.day.list","name":"list","line":567,"lineEnd":571,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"main":{"doclet":{"type":{"names":["string","Highcharts.DateTimeFormatOptions"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.day.main","name":"main","line":572,"lineEnd":575,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"hour":{"doclet":{"declare":"Highcharts.AxisDateTimeLabelFormatsOptionsObject","type":{"names":["string","*"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.hour","name":"hour","line":545,"lineEnd":548,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"list":{"doclet":{"type":{"names":["Array.<(string|Highcharts.DateTimeFormatOptions)>"]},"defaultvalue":"undefined"},"meta":{"fullname":"xAxis.dateTimeLabelFormats.hour.list","name":"list","line":550,"lineEnd":554,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"main":{"doclet":{"type":{"names":["string","Highcharts.DateTimeFormatOptions"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.hour.main","name":"main","line":555,"lineEnd":558,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"range":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"xAxis.dateTimeLabelFormats.hour.range","name":"range","line":560,"lineEnd":560,"column":16,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}}}},"millisecond":{"doclet":{"declare":"Highcharts.AxisDateTimeLabelFormatsOptionsObject","type":{"names":["string","*"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.millisecond","name":"millisecond","line":494,"lineEnd":497,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"list":{"doclet":{"type":{"names":["Array.<(string|Highcharts.DateTimeFormatOptions)>"]},"defaultvalue":"undefined"},"meta":{"fullname":"xAxis.dateTimeLabelFormats.millisecond.list","name":"list","line":499,"lineEnd":503,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"main":{"doclet":{"type":{"names":["string","Highcharts.DateTimeFormatOptions"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.millisecond.main","name":"main","line":504,"lineEnd":507,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"range":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"xAxis.dateTimeLabelFormats.millisecond.range","name":"range","line":509,"lineEnd":509,"column":16,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}}}},"minute":{"doclet":{"declare":"Highcharts.AxisDateTimeLabelFormatsOptionsObject","type":{"names":["string","*"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.minute","name":"minute","line":528,"lineEnd":531,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"list":{"doclet":{"type":{"names":["Array.<(string|Highcharts.DateTimeFormatOptions)>"]},"defaultvalue":"undefined"},"meta":{"fullname":"xAxis.dateTimeLabelFormats.minute.list","name":"list","line":533,"lineEnd":537,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"main":{"doclet":{"type":{"names":["string","Highcharts.DateTimeFormatOptions"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.minute.main","name":"main","line":538,"lineEnd":541,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"range":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"xAxis.dateTimeLabelFormats.minute.range","name":"range","line":543,"lineEnd":543,"column":16,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}}}},"month":{"doclet":{"declare":"Highcharts.AxisDateTimeLabelFormatsOptionsObject","type":{"names":["string","*"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.month","name":"month","line":594,"lineEnd":597,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"list":{"doclet":{"type":{"names":["Array.<(string|Highcharts.DateTimeFormatOptions)>"]},"defaultvalue":"undefined"},"meta":{"fullname":"xAxis.dateTimeLabelFormats.month.list","name":"list","line":599,"lineEnd":603,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"main":{"doclet":{"type":{"names":["string","Highcharts.DateTimeFormatOptions"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.month.main","name":"main","line":604,"lineEnd":607,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"second":{"doclet":{"declare":"Highcharts.AxisDateTimeLabelFormatsOptionsObject","type":{"names":["string","*"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.second","name":"second","line":511,"lineEnd":514,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"list":{"doclet":{"type":{"names":["Array.<(string|Highcharts.DateTimeFormatOptions)>"]},"defaultvalue":"undefined"},"meta":{"fullname":"xAxis.dateTimeLabelFormats.second.list","name":"list","line":516,"lineEnd":520,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"main":{"doclet":{"type":{"names":["string","Highcharts.DateTimeFormatOptions"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.second.main","name":"main","line":521,"lineEnd":524,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"range":{"doclet":{"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"xAxis.dateTimeLabelFormats.second.range","name":"range","line":526,"lineEnd":526,"column":16,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}}}},"week":{"doclet":{"declare":"Highcharts.AxisDateTimeLabelFormatsOptionsObject","type":{"names":["string","*"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.week","name":"week","line":578,"lineEnd":581,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"list":{"doclet":{"type":{"names":["Array.<(string|Highcharts.DateTimeFormatOptions)>"]},"defaultvalue":"undefined"},"meta":{"fullname":"xAxis.dateTimeLabelFormats.week.list","name":"list","line":583,"lineEnd":587,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"main":{"doclet":{"type":{"names":["string","Highcharts.DateTimeFormatOptions"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.week.main","name":"main","line":588,"lineEnd":591,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"year":{"doclet":{"declare":"Highcharts.AxisDateTimeLabelFormatsOptionsObject","type":{"names":["string","*"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.year","name":"year","line":610,"lineEnd":613,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"list":{"doclet":{"type":{"names":["Array.<(string|Highcharts.DateTimeFormatOptions)>"]},"defaultvalue":"undefined"},"meta":{"fullname":"xAxis.dateTimeLabelFormats.year.list","name":"list","line":615,"lineEnd":619,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"main":{"doclet":{"type":{"names":["string","Highcharts.DateTimeFormatOptions"]}},"meta":{"fullname":"xAxis.dateTimeLabelFormats.year.main","name":"main","line":620,"lineEnd":623,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}}}},"endOnTick":{"doclet":{"description":"Whether to force the axis to end on a tick. Use this option with\nthe `maxPadding` option to control the axis end.","productdesc":[{"value":"In Highcharts Stock, `endOnTick` is always `false` when the navigator\nis enabled, to prevent jumpy scrolling. With disabled navigator\nenabling `endOnTick` may lead to extending the xAxis to show the last\ntick, therefore range selector buttons may not have an active state\nif the axis gets extended.","products":["highstock"]}],"samples":[{"name":"True by default","value":"highcharts/yaxis/endontick/","products":["highcharts"]},{"name":"False","value":"highcharts/yaxis/endontick-false/","products":["highcharts"]},{"name":"True by default","value":"stock/demo/basic-line/","products":["highstock"]},{"name":"False","value":"stock/xaxis/endontick/","products":["highstock"]}],"since":"1.2.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"xAxis.endOnTick","name":"endOnTick","line":627,"lineEnd":648,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}},"events":{"doclet":{"description":"Event handlers for the axis.","type":{"names":["*"]}},"meta":{"fullname":"xAxis.events","name":"events","line":650,"lineEnd":655,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"afterBreaks":{"doclet":{"description":"An event fired after the breaks have rendered.","see":["[breaks](#xAxis.breaks)"],"samples":[{"name":"AfterBreak Event","value":"highcharts/axisbreak/break-event/","products":["highcharts"]}],"type":{"names":["Highcharts.AxisEventCallbackFunction"]},"since":"4.1.0","products":["highcharts","gantt"]},"meta":{"fullname":"xAxis.events.afterBreaks","name":"afterBreaks","line":656,"lineEnd":668,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"afterSetExtremes":{"doclet":{"description":"As opposed to the `setExtremes` event, this event fires after the\nfinal min and max values are computed and corrected for `minRange`.\n\nFires when the minimum and maximum is set for the axis, either by\ncalling the `.setExtremes()` method or by selecting an area in the\nchart. One parameter, `event`, is passed to the function, containing\ncommon event information.\n\nThe new user set minimum and maximum values can be found by\n`event.min` and `event.max`. These reflect the axis minimum and\nmaximum in axis values. The actual data extremes are found in\n`event.dataMin` and `event.dataMax`.","type":{"names":["Highcharts.AxisSetExtremesEventCallbackFunction"]},"since":"2.3.0","context":"Highcharts.Axis"},"meta":{"fullname":"xAxis.events.afterSetExtremes","name":"afterSetExtremes","line":669,"lineEnd":687,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"pointBreak":{"doclet":{"description":"An event fired when a break from this axis occurs on a point.","see":["[breaks](#xAxis.breaks)"],"samples":[{"name":"Visualization of a Break","value":"highcharts/axisbreak/break-visualized/","products":["highcharts"]}],"type":{"names":["Highcharts.AxisPointBreakEventCallbackFunction"]},"since":"4.1.0","products":["highcharts","gantt"],"context":"Highcharts.Axis"},"meta":{"fullname":"xAxis.events.pointBreak","name":"pointBreak","line":688,"lineEnd":701,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"pointInBreak":{"doclet":{"description":"An event fired when a point falls inside a break from this axis.","type":{"names":["Highcharts.AxisPointBreakEventCallbackFunction"]},"products":["highcharts","highstock","gantt"],"context":"Highcharts.Axis"},"meta":{"fullname":"xAxis.events.pointInBreak","name":"pointInBreak","line":702,"lineEnd":709,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"setExtremes":{"doclet":{"description":"Fires when the minimum and maximum is set for the axis, either by\ncalling the `.setExtremes()` method or by selecting an area in the\nchart. One parameter, `event`, is passed to the function,\ncontaining common event information.\n\nThe new user set minimum and maximum values can be found by\n`event.min` and `event.max`. These reflect the axis minimum and\nmaximum in data values. When an axis is zoomed all the way out from\nthe \"Reset zoom\" button, `event.min` and `event.max` are null, and\nthe new extremes are set based on `this.dataMin` and `this.dataMax`.","samples":[{"name":"Log new extremes on x axis","value":"stock/xaxis/events-setextremes/","products":["highstock"]}],"type":{"names":["Highcharts.AxisSetExtremesEventCallbackFunction"]},"since":"1.2.0","context":"Highcharts.Axis"},"meta":{"fullname":"xAxis.events.setExtremes","name":"setExtremes","line":710,"lineEnd":729,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"floor":{"doclet":{"description":"The lowest allowed value for automatically computed axis extremes.","see":["[ceiling](#yAxis.ceiling)"],"samples":[{"name":"Floor and ceiling","value":"highcharts/yaxis/floor-ceiling/","products":["highcharts"]},{"name":"Prevent negative stock price on Y axis","value":"stock/demo/lazy-loading/","products":["highstock"]}],"type":{"names":["number"]},"since":"4.0.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.floor","name":"floor","line":730,"lineEnd":744,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"grid":{"doclet":{"description":"Set grid options for the axis labels. Requires Highcharts Gantt.","since":"6.2.0","products":["gantt"],"type":{"names":["*"]}},"meta":{"fullname":"xAxis.grid","name":"grid","line":992,"lineEnd":998,"filename":"code/es-modules/Core/Axis/GridAxis.js"},"children":{"borderColor":{"doclet":{"description":"Set border color for the label grid lines.","type":{"names":["Highcharts.ColorString"]},"defaultvalue":"#e6e6e6","since":"6.2.0"},"meta":{"fullname":"xAxis.grid.borderColor","name":"borderColor","line":1023,"lineEnd":1029,"filename":"code/es-modules/Core/Axis/GridAxis.js"},"children":{}},"borderWidth":{"doclet":{"description":"Set border width of the label grid lines.","type":{"names":["number"]},"defaultvalue":"1","since":"6.2.0"},"meta":{"fullname":"xAxis.grid.borderWidth","name":"borderWidth","line":1030,"lineEnd":1036,"filename":"code/es-modules/Core/Axis/GridAxis.js"},"children":{}},"cellHeight":{"doclet":{"description":"Set cell height for grid axis labels. By default this is calculated from font\nsize. This option only applies to horizontal axes. For vertical axes, check\nthe [#yAxis.staticScale](yAxis.staticScale) option.","samples":[{"name":"Gantt chart with custom cell height","value":"gantt/grid-axis/cellheight"}],"type":{"names":["number"]},"since":"6.2.0"},"meta":{"fullname":"xAxis.grid.cellHeight","name":"cellHeight","line":1037,"lineEnd":1046,"filename":"code/es-modules/Core/Axis/GridAxis.js"},"children":{}},"columns":{"doclet":{"description":"Set specific options for each column (or row for horizontal axes) in the\ngrid. Each extra column/row is its own axis, and the axis options can be set\nhere.","samples":[{"name":"Left axis as a table","value":"gantt/demo/left-axis-table"},{"name":"Collapsible tree grid with columns","value":"gantt/demo/treegrid-columns"},{"name":"Horizontal grid axis with columns rendered as rows","value":"gantt/grid-axis/horizontal-columns"}],"type":{"names":["Array.<Highcharts.XAxisOptions>"]},"since":"6.2.0"},"meta":{"fullname":"xAxis.grid.columns","name":"columns","line":1008,"lineEnd":1022,"filename":"code/es-modules/Core/Axis/GridAxis.js"},"children":{}},"enabled":{"doclet":{"description":"Enable grid on the axis labels. Defaults to true for Gantt charts.","type":{"names":["boolean"]},"defaultvalue":"true","since":"6.2.0","products":["gantt"]},"meta":{"fullname":"xAxis.grid.enabled","name":"enabled","line":999,"lineEnd":1007,"filename":"code/es-modules/Core/Axis/GridAxis.js"},"children":{}}}},"gridLineColor":{"doclet":{"description":"Color of the grid lines extending the ticks across the plot area.\n\nIn styled mode, the stroke is given in the `.highcharts-grid-line`\nclass.","productdesc":[{"value":"In Highmaps, the grid lines are hidden by default.","products":["highmaps"]}],"samples":[{"name":"Green lines","value":"highcharts/yaxis/gridlinecolor/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/css/axis-grid/","products":["highcharts","highstock"]},{"name":"Green lines","value":"stock/xaxis/gridlinecolor/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#e6e6e6"},"meta":{"fullname":"xAxis.gridLineColor","name":"gridLineColor","line":2165,"lineEnd":2183,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"#e6e6e6"},"children":{}},"gridLineDashStyle":{"doclet":{"description":"The dash or dot style of the grid lines. For possible values, see\n[this demonstration](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/).","samples":[{"name":"Long dashes","value":"highcharts/yaxis/gridlinedashstyle/","products":["highcharts"]},{"name":"Long dashes","value":"stock/xaxis/gridlinedashstyle/","products":["highstock"]}],"type":{"names":["Highcharts.DashStyleValue"]},"since":"1.2.0","defaultvalue":"Solid"},"meta":{"fullname":"xAxis.gridLineDashStyle","name":"gridLineDashStyle","line":650,"lineEnd":655,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"Solid"},"children":{}},"gridLineInterpolation":{"doclet":{"description":"Polar charts only. Whether the grid lines should draw as a polygon\nwith straight lines between categories, or as circles. Can be either\n`circle` or `polygon`. Since v8.0.0 this option is also applicable\nfor X axis (inverted polar).","samples":[{"name":"Polygon grid lines","value":"highcharts/demo/polar-spider/","products":["highcharts"]},{"name":"Circle and polygon on inverted polar","value":"highcharts/xaxis/gridlineinterpolation/","products":["highcharts"]},{"name":"Circle and polygon","value":"highcharts/yaxis/gridlineinterpolation/","products":["highcharts"]}],"type":{"names":["\"circle\"","\"polygon\""]},"products":["highcharts"]},"meta":{"fullname":"xAxis.gridLineInterpolation","name":"gridLineInterpolation","line":128,"lineEnd":145,"filename":"code/es-modules/Core/Axis/RadialAxisDefaults.js"},"children":{}},"gridLineWidth":{"doclet":{"description":"The width of the grid lines extending the ticks across the plot area.\nDefaults to 1 on the Y axis and 0 on the X axis, except for 3d\ncharts.\n\nIn styled mode, the stroke width is given in the\n`.highcharts-grid-line` class.","samples":[{"name":"2px lines","value":"highcharts/yaxis/gridlinewidth/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/css/axis-grid/","products":["highcharts","highstock"]},{"name":"2px lines","value":"stock/xaxis/gridlinewidth/","products":["highstock"]}],"type":{"names":["number"]}},"meta":{"fullname":"xAxis.gridLineWidth","name":"gridLineWidth","line":2185,"lineEnd":2202,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"gridZIndex":{"doclet":{"description":"The Z index of the grid lines.","samples":[{"name":"A Z index of 4 renders the grid above the graph","value":"highcharts/xaxis/gridzindex/","products":["highcharts","highstock"]}],"products":["highcharts","highstock","gantt"],"see":["[axis.zIndex](#xAxis.zIndex)","[axis.labels.zIndex](#xAxis.labels.zIndex)"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"xAxis.gridZIndex","name":"gridZIndex","line":758,"lineEnd":768,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":1},"children":{}},"height":{"doclet":{"description":"The height as the vertical axis. If it's a number, it is\ninterpreted as pixels.\n\nSince Highcharts 2: If it's a percentage string, it is interpreted\nas percentages of the total plot height.","samples":[{"name":"Different axis position properties","value":"highcharts/xaxis/axis-position-properties","products":["highcharts"]}],"type":{"names":["number","string"]},"products":["highcharts","highstock"]},"meta":{"fullname":"xAxis.height","name":"height","line":2204,"lineEnd":2217,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"id":{"doclet":{"description":"An id for the axis. This can be used after render time to get\na pointer to the axis object through `chart.get()`.","samples":[{"name":"Get the object","value":"highcharts/xaxis/id/","products":["highcharts"]},{"name":"Get the object","value":"stock/xaxis/id/","products":["highstock"]}],"type":{"names":["string"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.id","name":"id","line":770,"lineEnd":782,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"labels":{"doclet":{"description":"The axis labels show the number or category for each tick.\n\nSince v8.0.0: Labels are animated in categorized x-axis with\nupdating data if `tickInterval` and `step` is set to 1.","productdesc":[{"value":"X and Y axis labels are by default disabled in Highmaps, but the\nfunctionality is inherited from Highcharts and used on `colorAxis`,\nand can be enabled on X and Y axes too.","products":["highmaps"]}],"type":{"names":["*"]}},"meta":{"fullname":"xAxis.labels","name":"labels","line":770,"lineEnd":782,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"align":{"doclet":{"description":"What part of the string the given position is anchored to.\nIf `left`, the left side of the string is at the axis position.\nCan be one of `\"left\"`, `\"center\"` or `\"right\"`. Defaults to\nan intelligent guess based on which side of the chart the axis\nis on and the rotation of the label.","see":["[reserveSpace](#xAxis.labels.reserveSpace)"],"samples":[{"name":"Left","value":"highcharts/xaxis/labels-align-left/","products":["highcharts"]},{"name":"Right","value":"highcharts/xaxis/labels-align-right/","products":["highcharts"]},{"name":"Left-aligned labels on a vertical category axis","value":"highcharts/xaxis/labels-reservespace-true/","products":["highcharts"]}],"type":{"names":["Highcharts.AlignValue"]}},"meta":{"fullname":"xAxis.labels.align","name":"align","line":795,"lineEnd":813,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"allowOverlap":{"doclet":{"description":"Whether to allow the axis labels to overlap. When false,\noverlapping labels are hidden.","samples":[{"name":"X axis labels overlap enabled","value":"highcharts/xaxis/labels-allowoverlap-true/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false"},"meta":{"fullname":"xAxis.labels.allowOverlap","name":"allowOverlap","line":814,"lineEnd":824,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"autoRotation":{"doclet":{"description":"For horizontal axes, the allowed degrees of label rotation\nto prevent overlapping labels. If there is enough space,\nlabels are not rotated. As the chart gets narrower, it\nwill start rotating the labels -45 degrees, then remove\nevery second label and try again with rotations 0 and -45 etc.\nSet it to `undefined` to disable rotation, which will\ncause the labels to word-wrap if possible. Defaults to `[-45]``\non bottom and top axes, `undefined` on left and right axes.","samples":[{"name":"Default auto rotation of 0 or -45","value":"highcharts/xaxis/labels-autorotation-default/","products":["highcharts","highstock"]},{"name":"Custom graded auto rotation","value":"highcharts/xaxis/labels-autorotation-0-90/","products":["highcharts","highstock"]}],"type":{"names":["Array.<number>"]},"defaultvalue":"undefined","since":"4.1.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.labels.autoRotation","name":"autoRotation","line":825,"lineEnd":845,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"autoRotationLimit":{"doclet":{"description":"When each category width is more than this many pixels, we don't\napply auto rotation. Instead, we lay out the axis label with word\nwrap. A lower limit makes sense when the label contains multiple\nshort words that don't extend the available horizontal space for\neach label.","samples":[{"name":"Lower limit","value":"highcharts/xaxis/labels-autorotationlimit/","products":["highcharts"]}],"since":"4.1.5","products":["highcharts","gantt"],"type":{"names":["number"]},"defaultvalue":80},"meta":{"fullname":"xAxis.labels.autoRotationLimit","name":"autoRotationLimit","line":795,"lineEnd":813,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":80},"children":{}},"distance":{"doclet":{"description":"The label's pixel distance from the perimeter of the plot area.\nOn cartesian charts, this is overridden if the `labels.y` setting\nis set.","samples":[{"name":"Polar chart, labels centered under the arc","value":"highcharts/yaxis/labels-distance/","products":["highcharts"]}],"type":{"names":["number"]},"products":["highcharts","gantt"],"defaultvalue":15},"meta":{"fullname":"xAxis.labels.distance","name":"distance","line":860,"lineEnd":870,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":15},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the axis labels.","samples":[{"name":"X axis labels disabled","value":"highcharts/xaxis/labels-enabled/","products":["highcharts"]},{"name":"X axis labels disabled","value":"stock/xaxis/labels-enabled/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"xAxis.labels.enabled","name":"enabled","line":872,"lineEnd":880,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"format":{"doclet":{"description":"A format string for the axis label. The context is available as\nformat string variables. For example, you can use `{text}` to\ninsert the default formatted text. The recommended way of adding\nunits for the label is using `text`, for example `{text} km`.\n\nTo add custom numeric or datetime formatting, use `{value}` with\nformatting, for example `{value:.1f}` or `{value:%Y-%m-%d}`.\n\nSee\n[format string](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting)\nfor more examples of formatting.\n\nThe default value is not specified due to the dynamic\nnature of the default implementation.","samples":[{"name":"Add units to Y axis label","value":"highcharts/yaxis/labels-format/","products":["highcharts","highstock"]},{"name":"Linked category names","value":"highcharts/xaxis/labels-format-linked/","products":["highcharts"]},{"name":"Custom number format","value":"highcharts/xaxis/labels-format-custom/","products":["highcharts"]},{"name":"Added units on Y axis","value":"stock/xaxis/labels-format/","products":["highstock"]}],"type":{"names":["string"]},"since":"3.0.0"},"meta":{"fullname":"xAxis.labels.format","name":"format","line":882,"lineEnd":910,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"formatter":{"doclet":{"description":"Callback JavaScript function to format the label. The value\nis given by `this.value`. Additional properties for `this` are\n`axis`, `chart`, `isFirst`, `isLast` and `text` which holds the\nvalue of the default formatter. Since v12.6.0, the callback also\nreceives `ctx` as the first argument, so that arrow functions can\naccess the same context as regular functions using `this`.\n\nDefaults to a built in function returning a formatted string\ndepending on whether the axis is `category`, `datetime`,\n`numeric` or other.","samples":[{"name":"Linked category names","value":"highcharts/xaxis/labels-formatter-linked/","products":["highcharts"]},{"name":"Modified numeric labels","value":"highcharts/xaxis/labels-formatter-extended/","products":["highcharts"]},{"name":"Added units on Y axis","value":"stock/xaxis/labels-formatter/","products":["highstock"]}],"type":{"names":["Highcharts.AxisLabelsFormatterCallbackFunction"]}},"meta":{"fullname":"xAxis.labels.formatter","name":"formatter","line":911,"lineEnd":932,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"indentation":{"doclet":{"description":"The number of pixels to indent the labels per level in a treegrid\naxis.","samples":[{"name":"Indentation 10px by default.","value":"gantt/treegrid-axis/demo"},{"name":"Indentation set to 0px.","value":"gantt/treegrid-axis/indentation-0px"}],"products":["gantt"],"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"xAxis.labels.indentation","name":"indentation","line":882,"lineEnd":910,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":10},"children":{}},"maxStaggerLines":{"doclet":{"description":"Horizontal axis only. When `staggerLines` is not set,\n`maxStaggerLines` defines how many lines the axis is allowed to\nadd to automatically avoid overlapping X labels. Set to `1` to\ndisable overlap detection.","deprecated":true,"type":{"names":["number"]},"defaultvalue":"5","since":"1.3.3"},"meta":{"fullname":"xAxis.labels.maxStaggerLines","name":"maxStaggerLines","line":945,"lineEnd":956,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"overflow":{"doclet":{"description":"How to handle overflowing labels on horizontal axis. If set to\n`\"allow\"`, it will not be aligned at all. By default it\n`\"justify\"` labels inside the chart area. If there is room to\nmove it, it will be aligned to the edge, else it will be removed.","since":"2.2.5","values":"[\"allow\", \"justify\"]","type":{"names":["string"]},"defaultvalue":"justify"},"meta":{"fullname":"xAxis.labels.overflow","name":"overflow","line":945,"lineEnd":956,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"justify"},"children":{}},"padding":{"doclet":{"description":"The pixel padding for axis labels, to ensure white space between\nthem. Defaults to 4 for horizontal axes, 1 for vertical.","type":{"names":["number"]},"defaultvalue":"undefined","products":["highcharts","gantt"]},"meta":{"fullname":"xAxis.labels.padding","name":"padding","line":967,"lineEnd":975,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"position3d":{"doclet":{"description":"Defines how the labels are be repositioned according to the 3D\nchart orientation.\n\n- `'offset'`: Maintain a fixed horizontal/vertical distance from\n  the tick marks, despite the chart orientation. This is the\n  backwards compatible behavior, and causes skewing of X and Z\n  axes.\n\n- `'chart'`: Preserve 3D position relative to the chart. This\n  looks nice, but hard to read if the text isn't forward-facing.\n\n- `'flap'`: Rotated text along the axis to compensate for the\n  chart orientation. This tries to maintain text as legible as\n  possible on all orientations.\n\n- `'ortho'`: Rotated text along the axis direction so that the\n  labels are orthogonal to the axis. This is very similar to\n  `'flap'`, but prevents skewing the labels (X and Y scaling are\n  still present).","samples":[{"name":"Skewed labels","value":"highcharts/3d/skewed-labels/"}],"since":"5.0.15","values":"['offset', 'chart', 'flap', 'ortho']","products":["highcharts"],"requires":["module:highcharts-3d"],"type":{"names":["string"]},"defaultvalue":"offset"},"meta":{"fullname":"xAxis.labels.position3d","name":"position3d","line":24,"lineEnd":52,"column":8,"filename":"code/es-modules/Core/Axis/Axis3DDefaults.js","default":"offset"},"children":{}},"reserveSpace":{"doclet":{"description":"Whether to reserve space for the labels. By default, space is\nreserved for the labels in these cases:\n\n* On all horizontal axes.\n* On vertical axes if `label.align` is `right` on a left-side\naxis or `left` on a right-side axis.\n* On vertical axes if `label.align` is `center`.\n\nThis can be turned off when for example the labels are rendered\ninside the plot area instead of outside.","see":["[labels.align](#xAxis.labels.align)"],"samples":[{"name":"No reserved space, labels inside plot","value":"highcharts/xaxis/labels-reservespace/","products":["highcharts"]},{"name":"Left-aligned labels on a vertical category axis","value":"highcharts/xaxis/labels-reservespace-true/","products":["highcharts"]}],"type":{"names":["boolean"]},"since":"4.1.10","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.labels.reserveSpace","name":"reserveSpace","line":976,"lineEnd":999,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"rotation":{"doclet":{"description":"Rotation of the labels in degrees. When `undefined`, the\n`autoRotation` option takes precedence.","samples":[{"name":"X axis labels rotated 90°","value":"highcharts/xaxis/labels-rotation/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"xAxis.labels.rotation","name":"rotation","line":1001,"lineEnd":1011,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"skew3d":{"doclet":{"description":"If enabled, the axis labels will skewed to follow the\nperspective.\n\nThis will fix overlapping labels and titles, but texts become\nless legible due to the distortion.\n\nThe final appearance depends heavily on `labels.position3d`.","samples":[{"name":"Skewed labels","value":"highcharts/3d/skewed-labels/"}],"since":"5.0.15","products":["highcharts"],"requires":["module:highcharts-3d"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"xAxis.labels.skew3d","name":"skew3d","line":54,"lineEnd":69,"column":8,"filename":"code/es-modules/Core/Axis/Axis3DDefaults.js","default":false},"children":{}},"staggerLines":{"doclet":{"description":"Horizontal axes only. The number of lines to spread the labels\nover to make room or tighter labels. 0 disables staggering.","samples":[{"name":"Show labels over two lines","value":"highcharts/xaxis/labels-staggerlines/","products":["highcharts"]},{"name":"Show labels over two lines","value":"stock/xaxis/labels-staggerlines/","products":["highstock"]}],"since":"2.1.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"xAxis.labels.staggerLines","name":"staggerLines","line":1013,"lineEnd":1023,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":0},"children":{}},"step":{"doclet":{"description":"To show only every _n_'th label on the axis, set the step to _n_.\nSetting the step to 2 shows every other label.\n\nBy default, when 0, the step is calculated automatically to avoid\noverlap. To prevent this, set it to 1\\. This usually only\nhappens on a category axis, and is often a sign that you have\nchosen the wrong axis type.\n\nRead more at\n[Axis docs](https://www.highcharts.com/docs/chart-concepts/axes)\n=> What axis should I use?","samples":[{"name":"Showing only every other axis label on a categorized x-axis","value":"highcharts/xaxis/labels-step/","products":["highcharts"]},{"name":"Auto steps on a category axis","value":"highcharts/xaxis/labels-step-auto/","products":["highcharts"]}],"since":"2.1.0","type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"xAxis.labels.step","name":"step","line":1025,"lineEnd":1045,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":0},"children":{}},"style":{"doclet":{"description":"CSS styles for the label. Use `lineClamp` to control wrapping of\ncategory labels. Use `textOverflow: 'none'` to prevent ellipsis\n(dots).\n\nIn styled mode, the labels are styled with the\n`.highcharts-axis-labels` class.","samples":[{"name":"Red X axis labels","value":"highcharts/xaxis/labels-style/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]}},"meta":{"fullname":"xAxis.labels.style","name":"style","line":1076,"lineEnd":1088,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"fontSize":{"doclet":{"type":{"names":["number","string"]},"defaultvalue":"0.8em"},"meta":{"fullname":"xAxis.labels.style.fontSize","name":"fontSize","line":1094,"lineEnd":1096,"column":16,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"0.8em"},"children":{}}}},"useHTML":{"doclet":{"description":"Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the labels.","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"xAxis.labels.useHTML","name":"useHTML","line":1047,"lineEnd":1050,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}},"x":{"doclet":{"description":"The x position offset of all labels relative to the tick\npositions on the axis. Overrides the `labels.distance` option.","type":{"names":["number"]}},"meta":{"fullname":"xAxis.labels.x","name":"x","line":1052,"lineEnd":1058,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"y":{"doclet":{"description":"The y position offset of all labels relative to the tick\npositions on the axis. Overrides the `labels.distance` option.","samples":[{"name":"X axis labels placed on grid lines","value":"highcharts/xaxis/labels-x/","products":["highcharts"]}],"type":{"names":["number"]}},"meta":{"fullname":"xAxis.labels.y","name":"y","line":1059,"lineEnd":1068,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"zIndex":{"doclet":{"description":"The Z index for the axis labels.","see":["[axis.zIndex](#xAxis.zIndex)","[axis.gridZIndex](#xAxis.gridZIndex)"],"type":{"names":["number"]},"defaultvalue":7},"meta":{"fullname":"xAxis.labels.zIndex","name":"zIndex","line":1052,"lineEnd":1058,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":7},"children":{}}}},"left":{"doclet":{"description":"The left position as the horizontal axis. If it's a number, it is\ninterpreted as pixel position relative to the chart.\n\nSince Highcharts v5.0.13: If it's a percentage string, it is\ninterpreted as percentages of the plot width, offset from plot area\nleft.","samples":[{"name":"Different axis position properties","value":"highcharts/xaxis/axis-position-properties","products":["highcharts"]}],"type":{"names":["number","string"]},"products":["highcharts","highstock"]},"meta":{"fullname":"xAxis.left","name":"left","line":1102,"lineEnd":1116,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"lineColor":{"doclet":{"description":"The color of the line marking the axis itself.\n\nIn styled mode, the line stroke is given in the\n`.highcharts-axis-line` or `.highcharts-xaxis-line` class.","samples":[{"name":"A red line on Y axis","value":"highcharts/yaxis/linecolor/","products":["highcharts"]},{"name":"Axes in styled mode","value":"highcharts/css/axis/","products":["highcharts","highstock"]},{"name":"A red line on X axis","value":"stock/xaxis/linecolor/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#333333"},"meta":{"fullname":"xAxis.lineColor","name":"lineColor","line":2132,"lineEnd":2146,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"#333333"},"children":{}},"lineWidth":{"doclet":{"description":"The width of the line marking the axis itself.\n\nIn styled mode, the stroke width is given in the\n`.highcharts-axis-line` or `.highcharts-xaxis-line` class.","samples":[{"name":"A 1px line on Y axis","value":"highcharts/yaxis/linecolor/","products":["highcharts"]},{"name":"Axes in styled mode","value":"highcharts/css/axis/","products":["highcharts","highstock"]},{"name":"A 2px line on X axis","value":"stock/xaxis/linewidth/","products":["highstock"]}],"defaultByProduct":{"highcharts":1,"highstock":1,"highmaps":0},"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"xAxis.lineWidth","name":"lineWidth","line":2148,"lineEnd":2163,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":1},"children":{}},"linkedTo":{"doclet":{"description":"Index of another axis that this axis is linked to. When an axis is\nlinked to a master axis, it will take the same extremes as\nthe master, but as assigned by min or max or by setExtremes.\nIt can be used to show additional info, or to ease reading the\nchart by duplicating the scales.","samples":[{"name":"Different string formats of the same date","value":"highcharts/xaxis/linkedto/","products":["highcharts"]},{"name":"Y values on both sides","value":"highcharts/yaxis/linkedto/","products":["highcharts"]}],"type":{"names":["number"]},"since":"2.0.2","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.linkedTo","name":"linkedTo","line":1131,"lineEnd":1147,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"margin":{"doclet":{"description":"If there are multiple axes on the same side of the chart, the pixel\nmargin between the axes. Defaults to 0 on vertical axes, 15 on\nhorizontal axes.","type":{"names":["number"]},"since":"7.0.3"},"meta":{"fullname":"xAxis.margin","name":"margin","line":2010,"lineEnd":2018,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"max":{"doclet":{"description":"The maximum value of the axis. If `undefined`, the max value is\nautomatically calculated.\n\nIf a datetime string is passed, it is parsed into epoch time\naccording to the time zone given in [time.timezone](#time.timezone).\n\nIf the [endOnTick](#yAxis.endOnTick) option is true, the `max` value\nmight be rounded up.\n\nIf a [tickAmount](#yAxis.tickAmount) is set, the axis may be extended\nbeyond the set max in order to reach the given number of ticks. The\nsame may happen in a chart with multiple axes, determined by [chart.\nalignTicks](#chart), where a `tickAmount` is applied internally.","samples":[{"name":"Y axis max of 200","value":"highcharts/yaxis/max-200/","products":["highcharts"]},{"name":"Y axis max on logarithmic axis","value":"highcharts/yaxis/max-logarithmic/","products":["highcharts"]},{"name":"Fixed min and max on X axis","value":"stock/xaxis/min-max/","products":["highstock"]}],"type":{"names":["number","string","null"]}},"meta":{"fullname":"xAxis.max","name":"max","line":1148,"lineEnd":1172,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"maxPadding":{"doclet":{"description":"Padding of the max value relative to the length of the axis. A\npadding of 0.05 will make a 100px axis 5px longer. This is useful\nwhen you don't want the highest data value to appear on the edge\nof the plot area. When the axis' `max` option is set or a max extreme\nis set using `axis.setExtremes()`, the maxPadding will be ignored.","productdesc":[{"value":"For an [ordinal](#xAxis.ordinal) axis, `minPadding` and `maxPadding`\nare ignored. Use [overscroll](#xAxis.overscroll) instead.","products":["highstock"]}],"samples":[{"name":"Max padding of 0.25 on y axis","value":"highcharts/yaxis/maxpadding/","products":["highcharts"]},{"name":"Greater min- and maxPadding","value":"stock/xaxis/minpadding-maxpadding/","products":["highstock"]},{"name":"Add some padding","value":"maps/chart/plotbackgroundcolor-gradient/","products":["highmaps"]}],"defaultByProduct":{"highcharts":0.01,"highstock":0,"highmaps":0},"since":"1.2.0","type":{"names":["number"]},"defaultvalue":0.01},"meta":{"fullname":"xAxis.maxPadding","name":"maxPadding","line":1102,"lineEnd":1116,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":0.01},"children":{}},"maxRange":{"doclet":{"description":"Maximum range which can be set using the navigator's handles.\nOpposite of [xAxis.minRange](#xAxis.minRange).","samples":[{"name":"Defined max and min range","value":"stock/navigator/maxrange/","products":["highstock"]}],"type":{"names":["number"]},"since":"6.0.0","products":["highstock","gantt"]},"meta":{"fullname":"xAxis.maxRange","name":"maxRange","line":515,"lineEnd":526,"filename":"code/es-modules/Stock/Navigator/NavigatorDefaults.js"},"children":{}},"maxZoom":{"doclet":{"description":"Deprecated. Use `minRange` instead.","deprecated":true,"type":{"names":["number"]},"products":["highcharts","highstock"]},"meta":{"fullname":"xAxis.maxZoom","name":"maxZoom","line":1196,"lineEnd":1203,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"min":{"doclet":{"description":"The minimum value of the axis. If `undefined`, the min value is\nautomatically calculated.\n\nIf a datetime string is passed, it is parsed into epoch time\naccording to the time zone given in [time.timezone](#time.timezone).\n\nIf the [startOnTick](#yAxis.startOnTick) option is true (default),\nthe `min` value might be rounded down.\n\nThe automatically calculated minimum value is also affected by\n[floor](#yAxis.floor), [softMin](#yAxis.softMin),\n[minPadding](#yAxis.minPadding), [minRange](#yAxis.minRange)\nas well as [series.threshold](#plotOptions.series.threshold)\nand [series.softThreshold](#plotOptions.series.softThreshold).","samples":[{"name":"-50 with startOnTick to false","value":"highcharts/yaxis/min-startontick-false/","products":["highcharts"]},{"name":"-50 with startOnTick true by default","value":"highcharts/yaxis/min-startontick-true/","products":["highcharts"]},{"name":"Set min and max on X axis","value":"stock/xaxis/min-max/","products":["highstock"]}],"type":{"names":["number","string","null"]}},"meta":{"fullname":"xAxis.min","name":"min","line":1204,"lineEnd":1229,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"minPadding":{"doclet":{"description":"Padding of the min value relative to the length of the axis. A\npadding of 0.05 will make a 100px axis 5px longer. This is useful\nwhen you don't want the lowest data value to appear on the edge\nof the plot area. When the axis' `min` option is set or a min extreme\nis set using `axis.setExtremes()`, the minPadding will be ignored.","productdesc":[{"value":"For an [ordinal](#xAxis.ordinal) axis, `minPadding` and `maxPadding`\nare ignored. Use [overscroll](#xAxis.overscroll) instead.","products":["highstock"]}],"samples":[{"name":"Min padding of 0.2","value":"highcharts/yaxis/minpadding/","products":["highcharts"]},{"name":"Greater min- and maxPadding","value":"stock/xaxis/minpadding-maxpadding/","products":["highstock"]},{"name":"Add some padding","value":"maps/chart/plotbackgroundcolor-gradient/","products":["highmaps"]}],"defaultByProduct":{"highcharts":0.01,"highstock":0,"highmaps":0},"since":"1.2.0","products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":0.01},"meta":{"fullname":"xAxis.minPadding","name":"minPadding","line":1328,"lineEnd":1339,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":0.01},"children":{}},"minRange":{"doclet":{"description":"The minimum range to display on this axis. The entire axis will not\nbe allowed to span over a smaller interval than this. For example,\nfor a datetime axis the main unit is milliseconds. If minRange is\nset to 3600000, you can't zoom in more than to one hour.\n\nThe default minRange for the x axis is five times the smallest\ninterval between any of the data points.\n\nOn a logarithmic axis, the unit for the minimum range is the power.\nSo a minRange of 1 means that the axis can be zoomed to 10-100,\n100-1000, 1000-10000 etc.\n\n**Note**: The `minPadding`, `maxPadding`, `startOnTick` and\n`endOnTick` settings also affect how the extremes of the axis\nare computed.","samples":[{"name":"Minimum range of 5","value":"highcharts/xaxis/minrange/","products":["highcharts"]},{"name":"Max zoom of 6 months overrides user selections","value":"stock/xaxis/minrange/","products":["highstock"]}],"type":{"names":["number"]}},"meta":{"fullname":"xAxis.minRange","name":"minRange","line":1364,"lineEnd":1388,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"minTickInterval":{"doclet":{"description":"The minimum tick interval allowed in axis values. For example on\nzooming in on an axis with daily data, this can be used to prevent\nthe axis from showing hours. Defaults to the closest distance between\ntwo points on the axis.","type":{"names":["number"]},"since":"2.3.0"},"meta":{"fullname":"xAxis.minTickInterval","name":"minTickInterval","line":1389,"lineEnd":1398,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"minorGridLineColor":{"doclet":{"description":"Color of the minor, secondary grid lines.\n\nIn styled mode, the stroke width is given in the\n`.highcharts-minor-grid-line` class.","samples":[{"name":"Bright grey lines from Y axis","value":"highcharts/yaxis/minorgridlinecolor/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/css/axis-grid/","products":["highcharts","highstock"]},{"name":"Bright grey lines from Y axis","value":"stock/xaxis/minorgridlinecolor/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#f2f2f2"},"meta":{"fullname":"xAxis.minorGridLineColor","name":"minorGridLineColor","line":2089,"lineEnd":2104,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"#f2f2f2"},"children":{}},"minorGridLineDashStyle":{"doclet":{"description":"The dash or dot style of the minor grid lines. For possible values,\nsee [this demonstration](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/).","samples":[{"name":"Long dashes on minor grid lines","value":"highcharts/yaxis/minorgridlinedashstyle/","products":["highcharts"]},{"name":"Long dashes on minor grid lines","value":"stock/xaxis/minorgridlinedashstyle/","products":["highstock"]}],"type":{"names":["Highcharts.DashStyleValue"]},"since":"1.2.0","defaultvalue":"Solid"},"meta":{"fullname":"xAxis.minorGridLineDashStyle","name":"minorGridLineDashStyle","line":1196,"lineEnd":1203,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"Solid"},"children":{}},"minorGridLineWidth":{"doclet":{"description":"Width of the minor, secondary grid lines.\n\nIn styled mode, the stroke width is given in the\n`.highcharts-grid-line` class.","samples":[{"name":"2px lines from Y axis","value":"highcharts/yaxis/minorgridlinewidth/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/css/axis-grid/","products":["highcharts","highstock"]},{"name":"2px lines from Y axis","value":"stock/xaxis/minorgridlinewidth/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"xAxis.minorGridLineWidth","name":"minorGridLineWidth","line":2106,"lineEnd":2118,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":1},"children":{}},"minorTickColor":{"doclet":{"description":"Color for the minor tick marks.","samples":[{"name":"Black tick marks on Y axis","value":"highcharts/yaxis/minortickcolor/","products":["highcharts"]},{"name":"Black tick marks on Y axis","value":"stock/xaxis/minorticks/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#999999"},"meta":{"fullname":"xAxis.minorTickColor","name":"minorTickColor","line":2120,"lineEnd":2130,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"#999999"},"children":{}},"minorTickInterval":{"doclet":{"description":"Specific tick interval in axis units for the minor ticks. On a linear\naxis, if `\"auto\"`, the minor tick interval is calculated as a fifth\nof the tickInterval. If `undefined`, minor ticks are not shown.\n\nOn logarithmic axes, the unit is the power of the value. For example,\nsetting the minorTickInterval to 1 puts one tick on each of 0.1, 1,\n10, 100 etc. Setting the minorTickInterval to 0.1 produces 9 ticks\nbetween 1 and 10, 10 and 100 etc.\n\nIf user settings dictate minor ticks to become too dense, they don't\nmake sense, and will be ignored to prevent performance problems.","samples":[{"name":"Undefined by default","value":"highcharts/yaxis/minortickinterval-null/","products":["highcharts"]},{"name":"5 units","value":"highcharts/yaxis/minortickinterval-5/","products":["highcharts"]},{"name":"\"auto\"","value":"highcharts/yaxis/minortickinterval-log-auto/","products":["highcharts"]},{"name":"0.1","value":"highcharts/yaxis/minortickinterval-log/","products":["highcharts"]},{"name":"Null by default","value":"stock/demo/basic-line/","products":["highstock"]},{"name":"\"auto\"","value":"stock/xaxis/minortickinterval-auto/","products":["highstock"]}],"type":{"names":["number","'auto'"]}},"meta":{"fullname":"xAxis.minorTickInterval","name":"minorTickInterval","line":1243,"lineEnd":1267,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"minorTickLength":{"doclet":{"description":"The pixel length of the minor tick marks.","samples":[{"name":"10px on Y axis","value":"highcharts/yaxis/minorticklength/","products":["highcharts"]},{"name":"10px on Y axis","value":"stock/xaxis/minorticks/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"xAxis.minorTickLength","name":"minorTickLength","line":1243,"lineEnd":1267,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":2},"children":{}},"minorTickPosition":{"doclet":{"description":"The position of the minor tick marks relative to the axis line.\n Can be one of `inside` and `outside`.","samples":[{"name":"Outside by default","value":"highcharts/yaxis/minortickposition-outside/","products":["highcharts"]},{"name":"Inside","value":"highcharts/yaxis/minortickposition-inside/","products":["highcharts"]},{"name":"Inside","value":"stock/xaxis/minorticks/","products":["highstock"]}],"values":"[\"inside\", \"outside\"]","type":{"names":["string"]},"defaultvalue":"outside"},"meta":{"fullname":"xAxis.minorTickPosition","name":"minorTickPosition","line":1277,"lineEnd":1289,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"outside"},"children":{}},"minorTickWidth":{"doclet":{"description":"The pixel width of the minor tick mark.","samples":[{"name":"3px width","value":"highcharts/yaxis/minortickwidth/","products":["highcharts"]},{"name":"1px width","value":"stock/xaxis/minorticks/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"xAxis.minorTickWidth","name":"minorTickWidth","line":1328,"lineEnd":1339,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"minorTicks":{"doclet":{"description":"Enable or disable minor ticks. The interval between the minor ticks\ncan be controlled either by the\n[minorTicksPerMajor](#xAxis.minorTicksPerMajor) setting, or as an\nabsolute [minorTickInterval](#xAxis.minorTickInterval) value.\n\nOn a logarithmic axis, minor ticks are laid out based on a best\nguess, attempting to enter an approximate number of minor ticks\nbetween each major tick based on\n[minorTicksPerMajor](#xAxis.minorTicksPerMajor).\n\nPrior to v6.0.0, ticks were enabled in auto layout by setting\n`minorTickInterval` to `\"auto\"`.","productdesc":[{"value":"On axes using\n[categories](#xAxis.categories), minor ticks are not supported.","products":["highcharts"]}],"samples":[{"name":"Enabled on linear Y axis","value":"highcharts/yaxis/minorticks-true/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"6.0.0"},"meta":{"fullname":"xAxis.minorTicks","name":"minorTicks","line":1291,"lineEnd":1315,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"minorTicksPerMajor":{"doclet":{"description":"The number of minor ticks per major tick. Works for `linear`,\n`logarithmic` and `datetime` axes.","samples":[{"name":"2 minor ticks per major tick on Y axis","value":"highcharts/yaxis/minortickspermajor/","products":["highcharts"]}],"since":"11.0.0","type":{"names":["number"]},"defaultvalue":5},"meta":{"fullname":"xAxis.minorTicksPerMajor","name":"minorTicksPerMajor","line":1291,"lineEnd":1315,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":5},"children":{}},"offset":{"doclet":{"description":"The distance in pixels from the plot area to the axis line.\nA positive offset moves the axis with it's line, labels and ticks\naway from the plot area. This is typically used when two or more\naxes are displayed on the same side of the plot. With multiple\naxes the offset is dynamically adjusted to avoid collision, this\ncan be overridden by setting offset explicitly.","samples":[{"name":"Y axis offset of 70","value":"highcharts/yaxis/offset/","products":["highcharts"]},{"name":"Axes positioned in the center of the plot","value":"highcharts/yaxis/offset-centered/","products":["highcharts"]},{"name":"Y axis offset by 70 px","value":"stock/xaxis/offset/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"xAxis.offset","name":"offset","line":1364,"lineEnd":1388,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"undefined"},"children":{}},"opposite":{"doclet":{"description":"Whether to display the axis on the opposite side of the normal. The\nnormal is on the left side for vertical axes and bottom for\nhorizontal, so the opposite sides will be right and top respectively.\nThis is typically used with dual or multiple axes.","samples":[{"name":"Secondary Y axis opposite","value":"highcharts/yaxis/opposite/","products":["highcharts"]},{"name":"Y axis on left side","value":"stock/xaxis/opposite/","products":["highstock"]}],"defaultByProduct":{"highcharts":false,"highstock":false,"highmaps":false,"gantt":true},"type":{"names":["boolean"]}},"meta":{"fullname":"xAxis.opposite","name":"opposite","line":1417,"lineEnd":1432,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"ordinal":{"doclet":{"description":"In an ordinal axis, the points are equally spaced in the chart\nregardless of the actual time or x distance between them. This means\nthat missing data periods (e.g. nights or weekends for a stock chart)\nwill not take up space in the chart.\nHaving `ordinal: false` will show any gaps created by the `gapSize`\nsetting proportionate to their duration.\n\nIn stock charts the X axis is ordinal by default, unless\nthe boost module is used and at least one of the series' data length\nexceeds the [boostThreshold](#series.line.boostThreshold).\n\nFor an ordinal axis, `minPadding` and `maxPadding` are ignored. Use\n[overscroll](#xAxis.overscroll) instead.","samples":[{"name":"True by default","value":"stock/xaxis/ordinal-true/","products":["highstock"]},{"name":"False","value":"stock/xaxis/ordinal-false/","products":["highstock"]}],"see":["[overscroll](#xAxis.overscroll)"],"type":{"names":["boolean"]},"defaultvalue":"true","since":"1.1.0","products":["highstock"]},"meta":{"fullname":"xAxis.ordinal","name":"ordinal","line":1433,"lineEnd":1460,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"overscroll":{"doclet":{"description":"Additional range on the right side of the xAxis. Works similar to\n`xAxis.maxPadding`, but the value is set in terms of axis values,\npercentage or pixels.\n\nIf it's a number, it is interpreted as axis values, which in a\ndatetime axis equals milliseconds.\n\nIf it's a percentage string, is interpreted as percentages of axis\nlength. An overscroll of 50% will make a 100px axis 50px longer.\n\nIf it's a pixel string, it is interpreted as a fixed pixel value, but\nlimited to 90% of the axis length.","samples":[{"name":"One minute overscroll with live data","value":"stock/xaxis/overscroll/","products":["highstock"]},{"name":"Overscroll set in percentage","value":"stock/xaxis/overscroll-percent/","products":["highstock"]},{"name":"Overscroll set in pixels","value":"stock/xaxis/overscroll-pixel/","products":["highstock"]}],"type":{"names":["number","string"]},"defaultvalue":"0","since":"6.0.0","products":["highstock"]},"meta":{"fullname":"xAxis.overscroll","name":"overscroll","line":1461,"lineEnd":1487,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"pane":{"doclet":{"description":"Refers to the index in the [panes](#panes) array. Used for circular\ngauges and polar charts. When the option is not set then first pane\nwill be used.","samples":[{"name":"Two gauges with different center","value":"highcharts/demo/gauge-vu-meter"}],"type":{"names":["number"]},"products":["highcharts"]},"meta":{"fullname":"xAxis.pane","name":"pane","line":1488,"lineEnd":1499,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"panningEnabled":{"doclet":{"description":"Whether to pan axis. If `chart.panning` is enabled, the option\nallows to disable panning on an individual axis.","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"xAxis.panningEnabled","name":"panningEnabled","line":76,"lineEnd":87,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"plotBands":{"doclet":{"description":"An array of colored bands stretching across the plot area marking an\ninterval on the axis.\n\nIn styled mode, the plot bands are styled by the `.highcharts-plot-band`\nclass in addition to the `className` option.","productdesc":[{"value":"In a gauge, a plot band on the Y axis (value axis) will stretch along the\nperimeter of the gauge.","products":["highcharts"]}],"type":{"names":["Array.<*>"]},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.plotBands","name":"plotBands","line":336,"lineEnd":350,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{"acrossPanes":{"doclet":{"description":"Flag to decide if plotBand should be rendered across all panes.","since":"7.1.2","products":["highstock"],"type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"xAxis.plotBands.acrossPanes","name":"acrossPanes","line":351,"lineEnd":359,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"borderColor":{"doclet":{"description":"Border color for the plot band. Also requires `borderWidth` to be set.","type":{"names":["Highcharts.ColorString"]}},"meta":{"fullname":"xAxis.plotBands.borderColor","name":"borderColor","line":360,"lineEnd":365,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"borderRadius":{"doclet":{"description":"Border radius for the plot band. Applies only to gauges. Can be a pixel\nvalue or a percentage, for example `50%`.","type":{"names":["number","string"]},"since":"11.4.2","samples":[{"name":"Angular gauge with rounded plot bands","value":"highcharts/xaxis/plotbands-gauge-borderradius","products":["highcharts"]}]},"meta":{"fullname":"xAxis.plotBands.borderRadius","name":"borderRadius","line":366,"lineEnd":375,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"borderWidth":{"doclet":{"description":"Border width for the plot band. Also requires `borderColor` to be set.","type":{"names":["number"]},"defaultvalue":"0"},"meta":{"fullname":"xAxis.plotBands.borderWidth","name":"borderWidth","line":376,"lineEnd":382,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"className":{"doclet":{"description":"A custom class name, in addition to the default `highcharts-plot-band`,\nto apply to each individual band.","type":{"names":["string"]},"since":"5.0.0"},"meta":{"fullname":"xAxis.plotBands.className","name":"className","line":383,"lineEnd":390,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"color":{"doclet":{"description":"The color of the plot band.","samples":[{"name":"Color band","value":"highcharts/xaxis/plotbands-color/","products":["highcharts"]},{"name":"Plot band on Y axis","value":"stock/xaxis/plotbands/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#e6e9ff"},"meta":{"fullname":"xAxis.plotBands.color","name":"color","line":391,"lineEnd":402,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"events":{"doclet":{"description":"An object defining mouse events for the plot band. Supported properties\nare `click`, `mouseover`, `mouseout`, `mousemove`.","samples":[{"name":"Mouse events demonstrated","value":"highcharts/xaxis/plotbands-events/","products":["highcharts"]}],"since":"1.2.0","type":{"names":["*"]}},"meta":{"fullname":"xAxis.plotBands.events","name":"events","line":403,"lineEnd":412,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{"click":{"doclet":{"description":"Click event on a plot band.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.PlotLineOrBand>"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.plotBands.events.click","name":"click","line":413,"lineEnd":418,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"mousemove":{"doclet":{"description":"Mouse move event on a plot band.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.PlotLineOrBand>"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.plotBands.events.mousemove","name":"mousemove","line":419,"lineEnd":424,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"mouseout":{"doclet":{"description":"Mouse out event on the corner of a plot band.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.PlotLineOrBand>"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.plotBands.events.mouseout","name":"mouseout","line":425,"lineEnd":430,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"mouseover":{"doclet":{"description":"Mouse over event on a plot band.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.PlotLineOrBand>"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.plotBands.events.mouseover","name":"mouseover","line":431,"lineEnd":436,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}}}},"from":{"doclet":{"description":"The start position of the plot band in axis units.\n\nOn datetime axes, the value can be given as a timestamp or a date string.","samples":[{"name":"Datetime axis","value":"highcharts/xaxis/plotbands-color/","products":["highcharts"]},{"name":"Categorized axis","value":"highcharts/xaxis/plotbands-from/","products":["highcharts"]},{"name":"Plot band on Y axis","value":"stock/xaxis/plotbands/","products":["highstock"]}],"type":{"names":["number","string"]}},"meta":{"fullname":"xAxis.plotBands.from","name":"from","line":437,"lineEnd":451,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"id":{"doclet":{"description":"An id used for identifying the plot band in Axis.removePlotBand.","samples":[{"name":"Remove plot band by id","value":"highcharts/xaxis/plotbands-id/","products":["highcharts"]},{"name":"Remove plot band by id","value":"highcharts/xaxis/plotbands-id/","products":["highstock"]}],"type":{"names":["string"]}},"meta":{"fullname":"xAxis.plotBands.id","name":"id","line":452,"lineEnd":462,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"label":{"doclet":{"description":"Text labels for the plot bands","products":["highcharts","highstock","gantt"],"type":{"names":["*"]}},"meta":{"fullname":"xAxis.plotBands.label","name":"label","line":495,"lineEnd":500,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{"align":{"doclet":{"description":"Horizontal alignment of the label. Can be one of \"left\", \"center\" or\n\"right\".","samples":[{"name":"Aligned to the right","value":"highcharts/xaxis/plotbands-label-align/","products":["highcharts"]},{"name":"Plot band with labels","value":"stock/xaxis/plotbands-label/","products":["highstock"]}],"type":{"names":["Highcharts.AlignValue"]},"defaultvalue":"center","since":"2.1.0"},"meta":{"fullname":"xAxis.plotBands.label.align","name":"align","line":501,"lineEnd":514,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"allowOverlap":{"doclet":{"description":"Whether or not the label can be hidden if it overlaps with another label.","samples":[{"name":"A Plotband label overlapping another","value":"highcharts/xaxis/plotbands-label-allowoverlap/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":"undefined","since":"11.4.8"},"meta":{"fullname":"xAxis.plotBands.label.allowOverlap","name":"allowOverlap","line":515,"lineEnd":525,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"inside":{"doclet":{"description":"Wether or not the text of the label can exceed the width of the label.","type":{"names":["boolean"]},"products":["highcharts","highstock","gantt"],"samples":[{"name":"Displaying text with text-wrapping/ellipsis, or the full text.","value":"highcharts/xaxis/plotbands-label-textwidth/","products":["highcharts"]}],"defaultvalue":"true","since":"11.4.6"},"meta":{"fullname":"xAxis.plotBands.label.inside","name":"inside","line":526,"lineEnd":537,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"rotation":{"doclet":{"description":"Rotation of the text label in degrees .","samples":[{"name":"Vertical text","value":"highcharts/xaxis/plotbands-label-rotation/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"2.1.0"},"meta":{"fullname":"xAxis.plotBands.label.rotation","name":"rotation","line":538,"lineEnd":548,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"style":{"doclet":{"description":"CSS styles for the text label.\n\nIn styled mode, the labels are styled by the\n`.highcharts-plot-band-label` class.","samples":[{"name":"Blue and bold label","value":"highcharts/xaxis/plotbands-label-style/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotBands.label.style","name":"style","line":549,"lineEnd":561,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"text":{"doclet":{"description":"The string text itself. A subset of HTML is supported.","type":{"names":["string"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotBands.label.text","name":"text","line":562,"lineEnd":568,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"textAlign":{"doclet":{"description":"The text alignment for the label. While `align` determines where the\ntexts anchor point is placed within the plot band, `textAlign` determines\nhow the text is aligned against its anchor point. Possible values are\n\"left\", \"center\" and \"right\". Defaults to the same as the `align` option.","samples":[{"name":"Vertical text in center position but text-aligned left","value":"highcharts/xaxis/plotbands-label-rotation/","products":["highcharts"]}],"type":{"names":["Highcharts.AlignValue"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotBands.label.textAlign","name":"textAlign","line":569,"lineEnd":581,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"useHTML":{"doclet":{"description":"Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the labels.","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.3"},"meta":{"fullname":"xAxis.plotBands.label.useHTML","name":"useHTML","line":582,"lineEnd":590,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"verticalAlign":{"doclet":{"description":"Vertical alignment of the label relative to the plot band. Can be one of\n\"top\", \"middle\" or \"bottom\".","samples":[{"name":"Vertically centered label","value":"highcharts/xaxis/plotbands-label-verticalalign/","products":["highcharts"]},{"name":"Plot band with labels","value":"stock/xaxis/plotbands-label/","products":["highstock"]}],"type":{"names":["Highcharts.VerticalAlignValue"]},"defaultvalue":"top","since":"2.1.0"},"meta":{"fullname":"xAxis.plotBands.label.verticalAlign","name":"verticalAlign","line":591,"lineEnd":604,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"x":{"doclet":{"description":"Horizontal position relative the alignment. Default varies by\norientation.","samples":[{"name":"Aligned 10px from the right edge","value":"highcharts/xaxis/plotbands-label-align/","products":["highcharts"]},{"name":"Plot band with labels","value":"stock/xaxis/plotbands-label/","products":["highstock"]}],"type":{"names":["number"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotBands.label.x","name":"x","line":605,"lineEnd":617,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"y":{"doclet":{"description":"Vertical position of the text baseline relative to the alignment. Default\nvaries by orientation.","samples":[{"name":"Label on x axis","value":"highcharts/xaxis/plotbands-label-y/","products":["highcharts"]},{"name":"Plot band with labels","value":"stock/xaxis/plotbands-label/","products":["highstock"]}],"type":{"names":["number"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotBands.label.y","name":"y","line":618,"lineEnd":630,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}}}},"to":{"doclet":{"description":"The end position of the plot band in axis units.\n\nOn datetime axes, the value can be given as a timestamp or a date string.","samples":[{"name":"Datetime axis","value":"highcharts/xaxis/plotbands-color/","products":["highcharts"]},{"name":"Categorized axis","value":"highcharts/xaxis/plotbands-from/","products":["highcharts"]},{"name":"Plot band on Y axis","value":"stock/xaxis/plotbands/","products":["highstock"]}],"type":{"names":["number","string"]}},"meta":{"fullname":"xAxis.plotBands.to","name":"to","line":463,"lineEnd":477,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"zIndex":{"doclet":{"description":"The z index of the plot band within the chart, relative to other\nelements. Using the same z index as another element may give\nunpredictable results, as the last rendered element will be on top.\nValues from 0 to 20 make sense.","samples":[{"name":"Behind plot lines by default","value":"highcharts/xaxis/plotbands-color/","products":["highcharts"]},{"name":"Above plot lines","value":"highcharts/xaxis/plotbands-zindex/","products":["highcharts"]},{"name":"Above plot lines and series","value":"highcharts/xaxis/plotbands-zindex-above-series/","products":["highcharts"]}],"type":{"names":["number"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.plotBands.zIndex","name":"zIndex","line":478,"lineEnd":494,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}}}},"plotLines":{"doclet":{"description":"An array of lines stretching across the plot area, marking a specific\nvalue on one of the axes.\n\nIn styled mode, the plot lines are styled by the\n`.highcharts-plot-line` class in addition to the `className` option.","type":{"names":["Array.<*>"]},"products":["highcharts","highstock","gantt"],"samples":[{"name":"Basic plot line","value":"highcharts/xaxis/plotlines-color/","products":["highcharts"]},{"name":"Solid gauge plot line","value":"highcharts/series-solidgauge/labels-auto-aligned/","products":["highcharts"]}]},"meta":{"fullname":"xAxis.plotLines","name":"plotLines","line":631,"lineEnd":645,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{"acrossPanes":{"doclet":{"description":"Flag to decide if plotLine should be rendered across all panes.","samples":[{"name":"Plot lines on different panes","value":"stock/xaxis/plotlines-acrosspanes/","products":["highstock"]}],"since":"7.1.2","products":["highstock"],"type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"xAxis.plotLines.acrossPanes","name":"acrossPanes","line":646,"lineEnd":657,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"className":{"doclet":{"description":"A custom class name, in addition to the default `highcharts-plot-line`,\nto apply to each individual line.","type":{"names":["string"]},"since":"5.0.0"},"meta":{"fullname":"xAxis.plotLines.className","name":"className","line":658,"lineEnd":665,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"color":{"doclet":{"description":"The color of the line.","samples":[{"name":"A red line from X axis","value":"highcharts/xaxis/plotlines-color/","products":["highcharts"]},{"name":"Plot line on Y axis","value":"stock/xaxis/plotlines/","products":["highstock"]}],"type":{"names":["Highcharts.ColorString"]},"defaultvalue":"#999999"},"meta":{"fullname":"xAxis.plotLines.color","name":"color","line":666,"lineEnd":677,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"dashStyle":{"doclet":{"description":"The dashing or dot style for the plot line. For possible values see\n[this overview](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-dashstyle-all/).","samples":[{"name":"Dash and dot pattern","value":"highcharts/xaxis/plotlines-dashstyle/","products":["highcharts"]},{"name":"Plot line on Y axis","value":"stock/xaxis/plotlines/","products":["highstock"]}],"type":{"names":["Highcharts.DashStyleValue"]},"defaultvalue":"Solid","since":"1.2.0"},"meta":{"fullname":"xAxis.plotLines.dashStyle","name":"dashStyle","line":678,"lineEnd":691,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"events":{"doclet":{"description":"An object defining mouse events for the plot line. Supported\nproperties are `click`, `mouseover`, `mouseout`, `mousemove`.","samples":[{"name":"Mouse events demonstrated","value":"highcharts/xaxis/plotlines-events/","products":["highcharts"]}],"since":"1.2.0","type":{"names":["*"]}},"meta":{"fullname":"xAxis.plotLines.events","name":"events","line":692,"lineEnd":701,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{"click":{"doclet":{"description":"Click event on a plot band.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.PlotLineOrBand>"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.plotLines.events.click","name":"click","line":702,"lineEnd":707,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"mousemove":{"doclet":{"description":"Mouse move event on a plot band.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.PlotLineOrBand>"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.plotLines.events.mousemove","name":"mousemove","line":708,"lineEnd":713,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"mouseout":{"doclet":{"description":"Mouse out event on the corner of a plot band.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.PlotLineOrBand>"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.plotLines.events.mouseout","name":"mouseout","line":714,"lineEnd":719,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"mouseover":{"doclet":{"description":"Mouse over event on a plot band.","type":{"names":["Highcharts.EventCallbackFunction.<Highcharts.PlotLineOrBand>"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.plotLines.events.mouseover","name":"mouseover","line":720,"lineEnd":725,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}}}},"id":{"doclet":{"description":"An id used for identifying the plot line in Axis.removePlotLine.","samples":[{"name":"Remove plot line by id","value":"highcharts/xaxis/plotlines-id/","products":["highcharts"]}],"type":{"names":["string"]}},"meta":{"fullname":"xAxis.plotLines.id","name":"id","line":726,"lineEnd":734,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"label":{"doclet":{"description":"Text labels for the plot lines","type":{"names":["*"]}},"meta":{"fullname":"xAxis.plotLines.label","name":"label","line":774,"lineEnd":778,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{"align":{"doclet":{"description":"Horizontal alignment of the label. Can be one of \"left\", \"center\" or\n\"right\".","samples":[{"name":"Aligned to the right","value":"highcharts/xaxis/plotlines-label-align-right/","products":["highcharts"]},{"name":"Plot line on Y axis","value":"stock/xaxis/plotlines/","products":["highstock"]}],"type":{"names":["Highcharts.AlignValue"]},"defaultvalue":"left","since":"2.1.0"},"meta":{"fullname":"xAxis.plotLines.label.align","name":"align","line":779,"lineEnd":792,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"formatter":{"doclet":{"description":"Callback JavaScript function to format the label. Useful properties like\nthe value of plot line or the range of plot band (`from` & `to`\nproperties) can be found in `this.options` object. Since v12.6.0, the\ncallback also receives `ctx` as the first argument, so that arrow functions\ncan access the same context as regular functions using `this`.","samples":[{"name":"Label formatters for plot line and plot band.","value":"highcharts/xaxis/plotlines-plotbands-label-formatter","products":["highcharts"]}],"type":{"names":["Highcharts.FormatterCallbackFunction.<Highcharts.PlotLineOrBand>"]}},"meta":{"fullname":"xAxis.plotLines.label.formatter","name":"formatter","line":809,"lineEnd":820,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"rotation":{"doclet":{"description":"Rotation of the text label in degrees. Defaults to 0 for horizontal plot\nlines and 90 for vertical lines.","samples":[{"name":"Slanted text","value":"highcharts/xaxis/plotlines-label-verticalalign-middle/","products":["highcharts"]}],"type":{"names":["number"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotLines.label.rotation","name":"rotation","line":821,"lineEnd":831,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"style":{"doclet":{"description":"CSS styles for the text label.\n\nIn styled mode, the labels are styled by the\n`.highcharts-plot-line-label` class.","samples":[{"name":"Blue and bold label","value":"highcharts/xaxis/plotlines-label-style/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotLines.label.style","name":"style","line":832,"lineEnd":844,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"text":{"doclet":{"description":"The text itself. A subset of HTML is supported.","type":{"names":["string"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotLines.label.text","name":"text","line":845,"lineEnd":851,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"textAlign":{"doclet":{"description":"The text alignment for the label. While `align` determines where the\ntexts anchor point is placed within the plot band, `textAlign` determines\nhow the text is aligned against its anchor point. Possible values are\n\"left\", \"center\" and \"right\". Defaults to the same as the `align` option.","samples":[{"name":"Text label in bottom position","value":"highcharts/xaxis/plotlines-label-textalign/","products":["highcharts"]}],"type":{"names":["Highcharts.AlignValue"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotLines.label.textAlign","name":"textAlign","line":852,"lineEnd":864,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"useHTML":{"doclet":{"description":"Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the labels.","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.3"},"meta":{"fullname":"xAxis.plotLines.label.useHTML","name":"useHTML","line":865,"lineEnd":873,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"verticalAlign":{"doclet":{"description":"Vertical alignment of the label relative to the plot line. Can be\none of \"top\", \"middle\" or \"bottom\".","samples":[{"name":"Vertically centered label","value":"highcharts/xaxis/plotlines-label-verticalalign-middle/","products":["highcharts"]}],"type":{"names":["Highcharts.VerticalAlignValue"]},"defaultByProduct":{"highcharts":"top","highstock":"top"},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotLines.label.verticalAlign","name":"verticalAlign","line":874,"lineEnd":886,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"x":{"doclet":{"description":"Horizontal position relative the alignment. Default varies by\norientation.","samples":[{"name":"Aligned 10px from the right edge","value":"highcharts/xaxis/plotlines-label-align-right/","products":["highcharts"]},{"name":"Plot line on Y axis","value":"stock/xaxis/plotlines/","products":["highstock"]}],"type":{"names":["number"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotLines.label.x","name":"x","line":887,"lineEnd":899,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"y":{"doclet":{"description":"Vertical position of the text baseline relative to the alignment. Default\nvaries by orientation.","samples":[{"name":"Label below the plot line","value":"highcharts/xaxis/plotlines-label-y/","products":["highcharts"]},{"name":"Plot line on Y axis","value":"stock/xaxis/plotlines/","products":["highstock"]}],"type":{"names":["number"]},"since":"2.1.0"},"meta":{"fullname":"xAxis.plotLines.label.y","name":"y","line":900,"lineEnd":912,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}}}},"labels":{"doclet":{"type":{"names":["*"]}},"meta":{},"children":{"clip":{"doclet":{"description":"Whether to hide labels that are outside the plot area.","type":{"names":["boolean"]},"defaultvalue":"false","since":"10.3.3"},"meta":{"fullname":"xAxis.plotLines.labels.clip","name":"clip","line":801,"lineEnd":808,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}}}},"value":{"doclet":{"description":"The position of the line in axis units.\n\nOn datetime axes, the value can be given as a timestamp or a date string.","samples":[{"name":"Between two categories on X axis","value":"highcharts/xaxis/plotlines-color/","products":["highcharts"]},{"name":"Plot line on Y axis","value":"stock/xaxis/plotlines/","products":["highstock"]}],"type":{"names":["number","string"]}},"meta":{"fullname":"xAxis.plotLines.value","name":"value","line":735,"lineEnd":747,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"width":{"doclet":{"description":"The width or thickness of the plot line.","samples":[{"name":"2px wide line from X axis","value":"highcharts/xaxis/plotlines-color/","products":["highcharts"]},{"name":"Plot line on Y axis","value":"stock/xaxis/plotlines/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"2"},"meta":{"fullname":"xAxis.plotLines.width","name":"width","line":748,"lineEnd":759,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"zIndex":{"doclet":{"description":"The z index of the plot line within the chart.","samples":[{"name":"Behind plot lines by default","value":"highcharts/xaxis/plotlines-zindex-behind/","products":["highcharts"]},{"name":"Above plot lines","value":"highcharts/xaxis/plotlines-zindex-above/","products":["highcharts"]},{"name":"Above plot lines and series","value":"highcharts/xaxis/plotlines-zindex-above-all/","products":["highcharts"]}],"type":{"names":["number"]},"since":"1.2.0"},"meta":{"fullname":"xAxis.plotLines.zIndex","name":"zIndex","line":760,"lineEnd":773,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}}}},"range":{"doclet":{"description":"The zoomed range to display when only defining one or none of `min`\nor `max`. For example, to show the latest month, a range of one month\ncan be set.","samples":[{"name":"Setting a zoomed range when the rangeSelector is disabled","value":"stock/xaxis/range/","products":["highstock"]}],"type":{"names":["number"]},"products":["highstock"]},"meta":{"fullname":"xAxis.range","name":"range","line":1500,"lineEnd":1511,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"reversed":{"doclet":{"description":"Whether to reverse the axis so that the highest number is closest\nto the origin. If the chart is inverted, the x axis is reversed by\ndefault.","samples":[{"name":"Reversed Y axis","value":"highcharts/yaxis/reversed/","products":["highcharts"]},{"name":"Reversed Y axis","value":"stock/xaxis/reversed/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"undefined"},"meta":{"fullname":"xAxis.reversed","name":"reversed","line":1512,"lineEnd":1525,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"reversedStacks":{"doclet":{"description":"This option determines how stacks should be ordered within a group.\nFor example reversed xAxis also reverses stacks, so first series\ncomes last in a group. To keep order like for non-reversed xAxis\nenable this option.","samples":[{"name":"Reversed stacks comparison","value":"highcharts/xaxis/reversedstacks/","products":["highcharts"]},{"name":"Reversed stacks comparison","value":"highcharts/xaxis/reversedstacks/","products":["highstock"]}],"since":"6.1.1","products":["highcharts","highstock"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"xAxis.reversedStacks","name":"reversedStacks","line":1527,"lineEnd":1540,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}},"scrollbar":{"doclet":{"description":"An optional scrollbar to display on the X axis in response to\nlimiting the minimum and maximum of the axis values.\n\nIn styled mode, all the presentational options for the scrollbar are\nreplaced by the classes `.highcharts-scrollbar-thumb`,\n`.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`,\n`.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`.","samples":[{"name":"Heatmap with both scrollbars","value":"stock/yaxis/heatmap-scrollbars/","products":["highstock"]}],"extends":"scrollbar","since":"4.2.6","products":["highstock"]},"meta":{"fullname":"xAxis.scrollbar","name":"scrollbar","line":1542,"lineEnd":1558,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"opposite":{"doclet":{"description":"Defines the position of the scrollbar. By default, it is positioned\non the opposite of the main axis (right side of the chart).\nHowever, in the case of RTL languages could be set to `false`\nwhich positions the scrollbar on the left.\n\nWorks only for vertical axes.\nThis means yAxis in a non-inverted chart and xAxis in the inverted.","samples":[{"name":"A scrollbar not on the opposite side","value":"stock/yaxis/scrollbar-opposite/"}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"9.3.0"},"meta":{"fullname":"xAxis.scrollbar.opposite","name":"opposite","line":2637,"lineEnd":2656,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"showEmpty":{"doclet":{"description":"Whether to show the axis line and title when the axis has no data.","samples":[{"name":"When clicking the legend to hide series, one axis preserves line and title, the other doesn't","value":"highcharts/yaxis/showempty/","products":["highcharts"]},{"name":"When clicking the legend to hide series, one axis preserves line and title, the other doesn't","value":"highcharts/yaxis/showempty/","products":["highstock"]}],"since":"1.1.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"xAxis.showEmpty","name":"showEmpty","line":1542,"lineEnd":1558,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"showFirstLabel":{"doclet":{"description":"Whether to show the first tick label.","samples":[{"name":"Set to false on X axis","value":"highcharts/xaxis/showfirstlabel-false/","products":["highcharts"]},{"name":"Labels below plot lines on Y axis","value":"stock/xaxis/showfirstlabel/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"xAxis.showFirstLabel","name":"showFirstLabel","line":1572,"lineEnd":1579,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"showLastLabel":{"doclet":{"description":"Whether to show the last tick label. Defaults to `true` on cartesian\ncharts, and `false` on polar charts.","samples":[{"name":"Set to true on X axis","value":"highcharts/xaxis/showlastlabel-true/","products":["highcharts"]},{"name":"Labels below plot lines on Y axis","value":"stock/xaxis/showfirstlabel/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"undefined","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.showLastLabel","name":"showLastLabel","line":1581,"lineEnd":1593,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"softMax":{"doclet":{"description":"A soft maximum for the axis. If the series data maximum is less than\nthis, the axis will stay at this maximum, but if the series data\nmaximum is higher, the axis will flex to show all data.","samples":[{"name":"Soft min and max","value":"highcharts/yaxis/softmin-softmax/"}],"type":{"names":["number"]},"since":"5.0.1","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.softMax","name":"softMax","line":1595,"lineEnd":1607,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"softMin":{"doclet":{"description":"A soft minimum for the axis. If the series data minimum is greater\nthan this, the axis will stay at this minimum, but if the series\ndata minimum is lower, the axis will flex to show all data.","samples":[{"name":"Soft min and max","value":"highcharts/yaxis/softmin-softmax/"}],"type":{"names":["number"]},"since":"5.0.1","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.softMin","name":"softMin","line":1608,"lineEnd":1620,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"startOfWeek":{"doclet":{"description":"For datetime axes, this decides where to put the tick between weeks.\n 0 = Sunday, 1 = Monday.","samples":[{"name":"Monday by default","value":"highcharts/xaxis/startofweek-monday/","products":["highcharts"]},{"name":"Sunday","value":"highcharts/xaxis/startofweek-sunday/","products":["highcharts"]},{"name":"Monday by default","value":"stock/xaxis/startofweek-1","products":["highstock"]},{"name":"Sunday","value":"stock/xaxis/startofweek-0","products":["highstock"]}],"products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"xAxis.startOfWeek","name":"startOfWeek","line":1595,"lineEnd":1607,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":1},"children":{}},"startOnTick":{"doclet":{"description":"Whether to force the axis to start on a tick. Use this option with\nthe `minPadding` option to control the axis start.","productdesc":[{"value":"In Highcharts Stock, `startOnTick` is always `false` when\nthe navigator is enabled, to prevent jumpy scrolling.","products":["highstock"]}],"samples":[{"name":"False by default","value":"highcharts/xaxis/startontick-false/","products":["highcharts"]},{"name":"True","value":"highcharts/xaxis/startontick-true/","products":["highcharts"]}],"since":"1.2.0","type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"xAxis.startOnTick","name":"startOnTick","line":1637,"lineEnd":1651,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}},"staticScale":{"doclet":{"description":"For vertical axes only. Setting the static scale ensures that each tick unit\nis translated into a fixed pixel height. For example, setting the static\nscale to 24 results in each Y axis category taking up 24 pixels, and the\nheight of the chart adjusts. Adding or removing items will make the chart\nresize.","samples":[{"name":"X-range series with static scale","value":"gantt/xrange-series/demo/","products":["gantt"]},{"name":"Static scale on X axis (horizontal bar chart)","value":"highcharts/xaxis/staticscale","products":["highcharts"]}],"requires":["module:modules/static-scale"],"type":{"names":["number"]},"defaultvalue":"50","since":"6.2.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.staticScale","name":"staticScale","line":90,"lineEnd":108,"filename":"code/es-modules/Extensions/StaticScale.js"},"children":{}},"tickAmount":{"doclet":{"description":"The amount of ticks to draw on the axis. This opens up for aligning\nthe ticks of multiple charts or panes within a chart. This option\noverrides the `tickPixelInterval` option.\n\nThis option only has an effect on linear axes. Datetime, logarithmic\nor category axes are not affected.","samples":[{"name":"8 ticks on Y axis","value":"highcharts/yaxis/tickamount/","products":["highcharts"]},{"name":"8 ticks on Y axis","value":"highcharts/yaxis/tickamount/","products":["highstock"]}],"type":{"names":["number"]},"since":"4.1.0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.tickAmount","name":"tickAmount","line":1653,"lineEnd":1670,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"tickColor":{"doclet":{"description":"Color for the main tick marks.\n\nIn styled mode, the stroke is given in the `.highcharts-tick`\nclass.","samples":[{"name":"Red ticks on X axis","value":"highcharts/xaxis/tickcolor/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/css/axis-grid/","products":["highcharts","highstock"]},{"name":"Formatted ticks on X axis","value":"stock/xaxis/ticks/","products":["highstock"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#333333"},"meta":{"fullname":"xAxis.tickColor","name":"tickColor","line":2204,"lineEnd":2217,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"#333333"},"children":{}},"tickInterval":{"doclet":{"description":"The interval of the tick marks in axis units. When `undefined`, the\ntick interval is computed to approximately follow the\n[tickPixelInterval](#xAxis.tickPixelInterval) on linear and datetime\naxes. On categorized axes, a `undefined` tickInterval will default to\n1, one category. Note that datetime axes are based on milliseconds,\nso for example an interval of one day is expressed as\n`24 * 3600 * 1000`.\n\nOn logarithmic axes, the tickInterval is based on powers, so a\ntickInterval of 1 means one tick on each of 0.1, 1, 10, 100 etc. A\ntickInterval of 2 means a tick of 0.1, 10, 1000 etc. A tickInterval\nof 0.2 puts a tick on 0.1, 0.2, 0.4, 0.6, 0.8, 1, 2, 4, 6, 8, 10, 20,\n40 etc.\n\n\nIf the tickInterval is too dense for labels to be drawn, Highcharts\nmay remove ticks.\n\nIf the chart has multiple axes, the [alignTicks](#chart.alignTicks)\noption may interfere with the `tickInterval` setting.","see":["[tickPixelInterval](#xAxis.tickPixelInterval)","[tickPositions](#xAxis.tickPositions)","[tickPositioner](#xAxis.tickPositioner)"],"samples":[{"name":"Tick interval of 5 on a linear axis","value":"highcharts/xaxis/tickinterval-5/","products":["highcharts"]},{"name":"Tick interval of 0.01 on Y axis","value":"stock/xaxis/tickinterval/","products":["highstock"]}],"type":{"names":["number"]}},"meta":{"fullname":"xAxis.tickInterval","name":"tickInterval","line":1671,"lineEnd":1704,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"tickLength":{"doclet":{"description":"The pixel length of the main tick marks.","samples":[{"name":"20 px tick length on the X axis","value":"highcharts/xaxis/ticklength/","products":["highcharts"]},{"name":"Formatted ticks on X axis","value":"stock/xaxis/ticks/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"xAxis.tickLength","name":"tickLength","line":1653,"lineEnd":1670,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":10},"children":{}},"tickPixelInterval":{"doclet":{"description":"If tickInterval is `null` this option sets the approximate pixel\ninterval of the tick marks. Not applicable to categorized axis.\n\nThe tick interval is also influenced by the [minTickInterval](#xAxis.minTickInterval) option, that, by default prevents ticks from\nbeing denser than the data points.","see":["[tickInterval](#xAxis.tickInterval)","[tickPositioner](#xAxis.tickPositioner)","[tickPositions](#xAxis.tickPositions)"],"samples":[{"name":"50 px on X axis","value":"highcharts/xaxis/tickpixelinterval-50/","products":["highcharts"]},{"name":"200 px on X axis","value":"stock/xaxis/tickpixelinterval/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":100},"meta":{"fullname":"xAxis.tickPixelInterval","name":"tickPixelInterval","line":1730,"lineEnd":1746,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":100},"children":{}},"tickPosition":{"doclet":{"description":"The position of the major tick marks relative to the axis line.\nCan be one of `inside` and `outside`.","samples":[{"name":"\"outside\" by default","value":"highcharts/xaxis/tickposition-outside/","products":["highcharts"]},{"name":"\"inside\"","value":"highcharts/xaxis/tickposition-inside/","products":["highcharts"]},{"name":"Formatted ticks on X axis","value":"stock/xaxis/ticks/","products":["highstock"]}],"values":"[\"inside\", \"outside\"]","type":{"names":["string"]},"defaultvalue":"outside"},"meta":{"fullname":"xAxis.tickPosition","name":"tickPosition","line":1748,"lineEnd":1760,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"outside"},"children":{}},"tickPositioner":{"doclet":{"description":"A callback function returning array defining where the ticks are\nlaid out on the axis. This overrides the default behavior of\n[tickPixelInterval](#xAxis.tickPixelInterval) and [tickInterval](#xAxis.tickInterval). The automatic tick positions are accessible\nthrough `this.tickPositions` and can be modified by the callback.\nSince v12.6.0, the callback also receives `ctx` as the third\nargument, so that arrow functions can access the same context as\nregular functions using `this`.","see":["[tickPositions](#xAxis.tickPositions)"],"samples":[{"name":"Demo of tickPositions and tickPositioner","value":"highcharts/xaxis/tickpositions-tickpositioner/","products":["highcharts"]},{"name":"Demo of tickPositions and tickPositioner","value":"highcharts/xaxis/tickpositions-tickpositioner/","products":["highstock"]}],"type":{"names":["Highcharts.AxisTickPositionerCallbackFunction"]}},"meta":{"fullname":"xAxis.tickPositioner","name":"tickPositioner","line":1762,"lineEnd":1781,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"tickPositions":{"doclet":{"description":"An array defining where the ticks are laid out on the axis. This\noverrides the default behavior of [tickPixelInterval](#xAxis.tickPixelInterval) and [tickInterval](#xAxis.tickInterval).\n\nNote: When working with date-time axes, be aware of time zone\nhandling. See the [documentation on time options](https://www.highcharts.com/docs/chart-concepts/axes#datetime)\nfor best practices.","see":["[tickPositioner](#xAxis.tickPositioner)"],"samples":[{"name":"Demo of tickPositions and tickPositioner","value":"highcharts/xaxis/tickpositions-tickpositioner/","products":["highcharts"]},{"name":"Demo of tickPositions and tickPositioner","value":"highcharts/xaxis/tickpositions-tickpositioner/","products":["highstock"]}],"type":{"names":["Array.<number>"]}},"meta":{"fullname":"xAxis.tickPositions","name":"tickPositions","line":1782,"lineEnd":1800,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"tickWidth":{"doclet":{"description":"The pixel width of the major tick marks. Defaults to 0 on category\naxes, otherwise 1.\n\nIn styled mode, the stroke width is given in the `.highcharts-tick`\nclass, but in order for the element to be generated on category axes,\nthe option must be explicitly set to 1.","samples":[{"name":"10 px width","value":"highcharts/xaxis/tickwidth/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/css/axis-grid/","products":["highcharts"]},{"name":"Formatted ticks on X axis","value":"stock/xaxis/ticks/","products":["highstock"]},{"name":"Styled mode","value":"highcharts/css/axis-grid/","products":["highstock"]}],"type":{"names":["undefined","number"]},"defaultByProduct":{"highstock":1,"highmaps":0}},"meta":{"fullname":"xAxis.tickWidth","name":"tickWidth","line":1801,"lineEnd":1822,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"tickmarkPlacement":{"doclet":{"description":"For categorized axes only. If `on` the tick mark is placed in the\ncenter of the category, if `between` the tick mark is placed between\ncategories. The default is `between` if the `tickInterval` is 1, else\n`on`. In order to render tick marks on a category axis it is necessary\nto provide a [tickWidth](#xAxis.tickWidth).","samples":[{"name":"\"between\" by default","value":"highcharts/xaxis/tickmarkplacement-between/","products":["highcharts"]},{"name":"\"on\"","value":"highcharts/xaxis/tickmarkplacement-on/","products":["highcharts"]}],"products":["highcharts","gantt"],"values":"[\"on\", \"between\"]","type":{"names":["string"]},"defaultvalue":"between"},"meta":{"fullname":"xAxis.tickmarkPlacement","name":"tickmarkPlacement","line":1714,"lineEnd":1728,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"between"},"children":{}},"title":{"doclet":{"description":"The axis title, showing next to the axis line.","productdesc":[{"value":"In Highmaps, the axis is hidden by default, but adding an axis title\nis still possible. X axis and Y axis titles will appear at the bottom\nand left by default.","products":["highmaps"]}],"type":{"names":["*"]}},"meta":{"fullname":"xAxis.title","name":"title","line":1762,"lineEnd":1781,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"align":{"doclet":{"description":"Alignment of the title relative to the axis values. Possible\nvalues are \"low\", \"middle\" or \"high\".","samples":[{"name":"\"low\"","value":"highcharts/xaxis/title-align-low/","products":["highcharts"]},{"name":"\"middle\" by default","value":"highcharts/xaxis/title-align-center/","products":["highcharts"]},{"name":"\"high\"","value":"highcharts/xaxis/title-align-high/","products":["highcharts"]},{"name":"Place the Y axis title on top of the axis","value":"highcharts/yaxis/title-offset/","products":["highcharts"]},{"name":"Aligned to \"high\" value","value":"stock/xaxis/title-align/","products":["highstock"]}],"type":{"names":["Highcharts.AxisTitleAlignValue"]},"defaultvalue":"middle"},"meta":{"fullname":"xAxis.title.align","name":"align","line":1832,"lineEnd":1848,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"middle"},"children":{}},"enabled":{"doclet":{"description":"Deprecated. Set the `text` to `undefined` to disable the title.","deprecated":true,"type":{"names":["boolean"]},"products":["highcharts"]},"meta":{"fullname":"xAxis.title.enabled","name":"enabled","line":1850,"lineEnd":1857,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"margin":{"doclet":{"description":"The pixel distance between the axis labels or line and the title.\nDefaults to 0 for horizontal axes, 10 for vertical","samples":[{"name":"Y axis title margin of 60","value":"highcharts/xaxis/title-margin/","products":["highcharts"]}],"type":{"names":["number"]}},"meta":{"fullname":"xAxis.title.margin","name":"margin","line":1858,"lineEnd":1867,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"offset":{"doclet":{"description":"The distance of the axis title from the axis line. By default,\nthis distance is computed from the offset width of the labels,\nthe labels' distance from the axis and the title's margin.\nHowever when the offset option is set, it overrides all this.","samples":[{"name":"Place the axis title on top of the axis","value":"highcharts/yaxis/title-offset/","products":["highcharts"]},{"name":"Place the axis title on top of the Y axis","value":"highcharts/yaxis/title-offset/","products":["highstock"]}],"type":{"names":["number"]},"since":"2.2.0"},"meta":{"fullname":"xAxis.title.offset","name":"offset","line":1868,"lineEnd":1882,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"position3d":{"doclet":{"description":"Defines how the title is repositioned according to the 3D chart\norientation.\n\n- `'offset'`: Maintain a fixed horizontal/vertical distance from\n  the tick marks, despite the chart orientation. This is the\n  backwards compatible behavior, and causes skewing of X and Z\n  axes.\n\n- `'chart'`: Preserve 3D position relative to the chart. This\n  looks nice, but hard to read if the text isn't forward-facing.\n\n- `'flap'`: Rotated text along the axis to compensate for the\n  chart orientation. This tries to maintain text as legible as\n  possible on all orientations.\n\n- `'ortho'`: Rotated text along the axis direction so that the\n  labels are orthogonal to the axis. This is very similar to\n  `'flap'`, but prevents skewing the labels (X and Y scaling are\n  still present).\n\n- `undefined`: Will use the config from `labels.position3d`","samples":[{"name":"Skewed labels","value":"highcharts/3d/skewed-labels/"}],"type":{"names":["\"offset\"","\"chart\"","\"flap\"","\"ortho\"","null"]},"since":"5.0.15","products":["highcharts"],"requires":["module:highcharts-3d"],"defaultvalue":null},"meta":{"fullname":"xAxis.title.position3d","name":"position3d","line":73,"lineEnd":103,"column":8,"filename":"code/es-modules/Core/Axis/Axis3DDefaults.js","default":null},"children":{}},"reserveSpace":{"doclet":{"description":"Whether to reserve space for the title when laying out the axis.","type":{"names":["boolean"]},"defaultvalue":"true","since":"5.0.11","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.title.reserveSpace","name":"reserveSpace","line":1883,"lineEnd":1891,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"rotation":{"doclet":{"description":"The rotation of the text in degrees. 0 is horizontal, 270 is\nvertical reading from bottom to top. Defaults to 0 for horizontal\naxes, 270 for left-side axes and 90 for right-side axes.","samples":[{"name":"Horizontal","value":"highcharts/yaxis/title-offset/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"undefined"},"meta":{"fullname":"xAxis.title.rotation","name":"rotation","line":1892,"lineEnd":1903,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"skew3d":{"doclet":{"description":"If enabled, the axis title will skewed to follow the perspective.\n\nThis will fix overlapping labels and titles, but texts become\nless legible due to the distortion.\n\nThe final appearance depends heavily on `title.position3d`.\n\nA `null` value will use the config from `labels.skew3d`.","samples":[{"name":"Skewed labels","value":"highcharts/3d/skewed-labels/"}],"type":{"names":["boolean","null"]},"since":"5.0.15","products":["highcharts"],"requires":["module:highcharts-3d"],"defaultvalue":null},"meta":{"fullname":"xAxis.title.skew3d","name":"skew3d","line":105,"lineEnd":122,"column":8,"filename":"code/es-modules/Core/Axis/Axis3DDefaults.js","default":null},"children":{}},"style":{"doclet":{"description":"CSS styles for the title. If the title text is longer than the\naxis length, it will wrap to multiple lines by default. This can\nbe customized by setting the `lineClamp` property, by setting a\nspecific `width` or by setting `whiteSpace: 'nowrap'`.\n\nIn styled mode, the stroke width is given in the\n`.highcharts-axis-title` class.","samples":[{"name":"Red","value":"highcharts/xaxis/title-style/","products":["highcharts"]},{"name":"Styled mode","value":"highcharts/css/axis/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]}},"meta":{"fullname":"xAxis.title.style","name":"style","line":1960,"lineEnd":1975,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"fontSize":{"doclet":{"type":{"names":["number","string"]},"defaultvalue":"0.8em"},"meta":{"fullname":"xAxis.title.style.fontSize","name":"fontSize","line":1979,"lineEnd":1981,"column":16,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"0.8em"},"children":{}}}},"text":{"doclet":{"description":"The actual text of the axis title. It can contain basic HTML tags\nlike `b`, `i` and `span` with style.","samples":[{"name":"Custom HTML","value":"highcharts/xaxis/title-text/","products":["highcharts"]},{"name":"Titles for both axes","value":"stock/xaxis/title-text/","products":["highstock"]}],"type":{"names":["string","null"]}},"meta":{"fullname":"xAxis.title.text","name":"text","line":1904,"lineEnd":1915,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"textAlign":{"doclet":{"description":"Alignment of the text, can be `\"left\"`, `\"right\"` or `\"center\"`.\nDefault alignment depends on the\n[title.align](xAxis.title.align):\n\nHorizontal axes:\n- for `align` = `\"low\"`, `textAlign` is set to `left`\n- for `align` = `\"middle\"`, `textAlign` is set to `center`\n- for `align` = `\"high\"`, `textAlign` is set to `right`\n\nVertical axes:\n- for `align` = `\"low\"` and `opposite` = `true`, `textAlign` is\n  set to `right`\n- for `align` = `\"low\"` and `opposite` = `false`, `textAlign` is\n  set to `left`\n- for `align` = `\"middle\"`, `textAlign` is set to `center`\n- for `align` = `\"high\"` and `opposite` = `true` `textAlign` is\n  set to `left`\n- for `align` = `\"high\"` and `opposite` = `false` `textAlign` is\n  set to `right`","type":{"names":["Highcharts.AlignValue"]}},"meta":{"fullname":"xAxis.title.textAlign","name":"textAlign","line":1916,"lineEnd":1939,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"useHTML":{"doclet":{"description":"Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the axis title.","products":["highcharts","highstock","gantt"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"xAxis.title.useHTML","name":"useHTML","line":1850,"lineEnd":1857,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}},"x":{"doclet":{"description":"Horizontal pixel offset of the title position.","since":"4.1.6","products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"xAxis.title.x","name":"x","line":1947,"lineEnd":1952,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"Vertical pixel offset of the title position.","products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"xAxis.title.y","name":"y","line":1954,"lineEnd":1958,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":0},"children":{}}}},"top":{"doclet":{"description":"The top position as the vertical axis. If it's a number, it is\ninterpreted as pixel position relative to the chart.\n\nSince Highcharts 2: If it's a percentage string, it is interpreted\nas percentages of the plot height, offset from plot area top.","samples":[{"name":"Different axis position properties","value":"highcharts/xaxis/axis-position-properties","products":["highcharts"]}],"type":{"names":["number","string"]},"products":["highcharts","highstock"]},"meta":{"fullname":"xAxis.top","name":"top","line":1117,"lineEnd":1130,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"type":{"doclet":{"description":"The type of axis. Can be one of `linear`, `logarithmic`, `datetime`\nor `category`. In a datetime axis, the numbers are given in\nmilliseconds, and tick marks are placed on appropriate values like\nfull hours or days. In a category axis, the\n[point names](#series.line.data.name) of the chart's series are used\nfor categories, if not a [categories](#xAxis.categories) array is\ndefined.","samples":[{"name":"Linear","value":"highcharts/xaxis/type-linear/","products":["highcharts"]},{"name":"Logarithmic","value":"highcharts/yaxis/type-log/","products":["highcharts"]},{"name":"Logarithmic with minor grid lines","value":"highcharts/yaxis/type-log-minorgrid/","products":["highcharts"]},{"name":"Logarithmic on two axes","value":"highcharts/xaxis/type-log-both/","products":["highcharts"]},{"name":"Logarithmic with extension to emulate negative values","value":"highcharts/yaxis/type-log-negative/","products":["highcharts"]}],"type":{"names":["Highcharts.AxisTypeValue"]},"defaultvalue":"linear","products":["highcharts","gantt"]},"meta":{"fullname":"xAxis.type","name":"type","line":1985,"lineEnd":2009,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"uniqueNames":{"doclet":{"description":"Applies only when the axis `type` is `category`. When `uniqueNames`\nis true, points are placed on the X axis according to their names.\nIf the same point name is repeated in the same or another series,\nthe point is placed on the same X position as other points of the\nsame name. When `uniqueNames` is false, the points are laid out in\nincreasing X positions regardless of their names, and the X axis\ncategory will take the name of the last point in each position.","samples":[{"name":"True by default","value":"highcharts/xaxis/uniquenames-true/","products":["highcharts"]},{"name":"False","value":"highcharts/xaxis/uniquenames-false/","products":["highcharts"]}],"since":"4.2.7","products":["highcharts","gantt"],"type":{"names":["boolean"]},"defaultvalue":"true"},"meta":{"fullname":"xAxis.uniqueNames","name":"uniqueNames","line":2019,"lineEnd":2038,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"units":{"doclet":{"description":"Datetime axis only. An array determining what time intervals the\nticks are allowed to fall on. Each array item is an array where the\nfirst value is the time unit and the second value another array of\nallowed multiples.\n\nDefaults to:\n```js\nunits: [[\n    'millisecond', // unit name\n    [1, 2, 5, 10, 20, 25, 50, 100, 200, 500] // allowed multiples\n], [\n    'second',\n    [1, 2, 5, 10, 15, 30]\n], [\n    'minute',\n    [1, 2, 5, 10, 15, 30]\n], [\n    'hour',\n    [1, 2, 3, 4, 6, 8, 12]\n], [\n    'day',\n    [1, 2]\n], [\n    'week',\n    [1, 2]\n], [\n    'month',\n    [1, 2, 3, 4, 6]\n], [\n    'year',\n    null\n]]\n```","samples":[{"name":"Axis units demonstrated","value":"highcharts/xaxis/units/","products":["highcharts"]}],"type":{"names":["Array.<Array.<string, (Array.<number>|null)>>"]},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"xAxis.units","name":"units","line":2039,"lineEnd":2080,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"visible":{"doclet":{"description":"Whether axis, including axis title, line, ticks and labels, should\nbe visible.","since":"4.1.9","products":["highcharts","highstock","gantt"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"xAxis.visible","name":"visible","line":1985,"lineEnd":2009,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"width":{"doclet":{"description":"The width as the horizontal axis. If it's a number, it is interpreted\nas pixels.\n\nSince Highcharts v5.0.13: If it's a percentage string, it is\ninterpreted as percentages of the total plot width.","samples":[{"name":"Different axis position properties","value":"highcharts/xaxis/axis-position-properties","products":["highcharts"]}],"type":{"names":["number","string"]},"products":["highcharts","highstock"]},"meta":{"fullname":"xAxis.width","name":"width","line":2218,"lineEnd":2231,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"zIndex":{"doclet":{"description":"The Z index for the axis group.","see":["[axis.gridZIndex](#xAxis.gridZIndex)","[axis.labels.zIndex](#xAxis.labels.zIndex)"],"type":{"names":["number"]},"defaultvalue":2},"meta":{"fullname":"xAxis.zIndex","name":"zIndex","line":443,"lineEnd":448,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":2},"children":{}},"zoomEnabled":{"doclet":{"description":"Whether to zoom axis. If `chart.zoomType` is set, the option allows\nto disable zooming on an individual axis.","samples":[{"name":"Zoom enabled is false","value":"highcharts/xaxis/zoomenabled/","products":["highcharts"]}],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"xAxis.zoomEnabled","name":"zoomEnabled","line":450,"lineEnd":456,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}}}},"yAxis":{"doclet":{"description":"The Y axis or value axis. Normally this is the vertical axis,\nthough if the chart is inverted this is the horizontal axis.\nIn case of multiple axes, the yAxis node is an array of\nconfiguration objects.\n\nSee [the Axis object](/class-reference/Highcharts.Axis) for programmatic\naccess to the axis.","type":{"names":["*","Array.<*>"]},"extends":"xAxis","exclude":["currentDateIndicator","ordinal","overscroll"]},"meta":{"filename":"code/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js","name":"yAxis","fullname":"yAxis","line":431,"lineEnd":439,"column":16},"children":{"endOnTick":{"doclet":{"description":"Whether to force the axis to end on a tick. Use this option with\nthe `maxPadding` option to control the axis end.\n\nThis option is always disabled, when panning type is\neither `y` or `xy`.","see":["[type](#chart.panning.type)"],"samples":[{"name":"True by default","value":"highcharts/yaxis/endontick/","products":["highcharts"]},{"name":"False","value":"highcharts/yaxis/endontick-false/","products":["highcharts"]},{"name":"True by default","value":"stock/demo/basic-line/","products":["highstock"]},{"name":"False for Y axis","value":"stock/xaxis/endontick/","products":["highstock"]}],"since":"1.2.0","type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"yAxis.endOnTick","name":"endOnTick","line":2383,"lineEnd":2404,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"gridLineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":1},"meta":{"fullname":"yAxis.gridLineWidth","name":"gridLineWidth","line":3064,"lineEnd":3064,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":1},"children":{}},"height":{"doclet":{"description":"The height of the Y axis. If it's a number, it is interpreted as\npixels.\n\nSince Highcharts 2: If it's a percentage string, it is interpreted as\npercentages of the total plot height.","see":["[yAxis.top](#yAxis.top)"],"samples":[{"name":"Percentage height panes","value":"stock/demo/candlestick-and-volume/","products":["highstock"]}],"type":{"names":["number","string"]},"products":["highcharts","highstock"]},"meta":{"fullname":"yAxis.height","name":"height","line":2308,"lineEnd":2323,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"labels":{"doclet":{"extends":"xAxis.labels"},"meta":{"filename":"code/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js","name":"labels","fullname":"yAxis.labels","line":431,"lineEnd":439,"column":16},"children":{"align":{"doclet":{"description":"What part of the string the given position is anchored to. Can\nbe one of `\"left\"`, `\"center\"` or `\"right\"`. The exact position\nalso depends on the `labels.x` setting.\n\nAngular gauges and solid gauges defaults to `\"center\"`.\nSolid gauges with two labels have additional option `\"auto\"`\nfor automatic horizontal and vertical alignment.","samples":[{"name":"Left","value":"highcharts/yaxis/labels-align-left/","products":["highcharts"]},{"name":"Solid gauge labels auto aligned","value":"highcharts/series-solidgauge/labels-auto-aligned/","products":["highcharts"]}],"type":{"names":["Highcharts.AlignValue"]},"defaultByProduct":{"highstock":"right"}},"meta":{"fullname":"yAxis.labels.align","name":"align","line":2547,"lineEnd":2564,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"distance":{"doclet":{"description":"The label's pixel distance from the perimeter of the plot area.\nOn cartesian charts, this is overridden if the `labels.y` setting\nis set.\n\nOn polar charts, if it's a percentage string, it is interpreted\nthe same as [series.radius](#plotOptions.gauge.radius), so the\nlabel can be aligned under the gauge's shape.","samples":[{"name":"Polar chart, labels centered under the arc","value":"highcharts/yaxis/labels-distance/","products":["highcharts"]}],"type":{"names":["number","string"]},"products":["highcharts"]},"meta":{"fullname":"yAxis.labels.distance","name":"distance","line":2517,"lineEnd":2532,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"levels":{"doclet":{"description":"Set options on specific levels in a tree grid axis. Takes\nprecedence over labels options.","samples":[{"name":"Levels on TreeGrid Labels","value":"gantt/treegrid-axis/labels-levels","products":["gantt"]}],"type":{"names":["Array.<*>"]},"products":["gantt"]},"meta":{"fullname":"yAxis.labels.levels","name":"levels","line":394,"lineEnd":404,"filename":"code/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js"},"children":{"level":{"doclet":{"description":"Specify the level which the options within this object\napplies to.","type":{"names":["number"]},"products":["gantt"]},"meta":{"fullname":"yAxis.labels.levels.level","name":"level","line":406,"lineEnd":415,"filename":"code/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js"},"children":{}},"style":{"doclet":{"type":{"names":["Highcharts.CSSObject"]},"products":["gantt"]},"meta":{"fullname":"yAxis.labels.levels.style","name":"style","line":419,"lineEnd":425,"filename":"code/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js"},"children":{}}}},"symbol":{"doclet":{"description":"The symbol for the collapse and expand icon in a\ntreegrid.","products":["gantt"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js","name":"symbol","fullname":"yAxis.labels.symbol","line":431,"lineEnd":439,"column":16},"children":{"height":{"doclet":{"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"yAxis.labels.symbol.height","name":"height","line":452,"lineEnd":452,"column":20,"filename":"code/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js","default":10},"children":{}},"width":{"doclet":{"type":{"names":["number"]},"defaultvalue":10},"meta":{"fullname":"yAxis.labels.symbol.width","name":"width","line":453,"lineEnd":453,"column":20,"filename":"code/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js","default":10},"children":{}},"x":{"doclet":{"type":{"names":["number"]},"defaultvalue":-5},"meta":{"fullname":"yAxis.labels.symbol.x","name":"x","line":450,"lineEnd":450,"column":20,"filename":"code/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js","default":-5},"children":{}},"y":{"doclet":{"type":{"names":["number"]},"defaultvalue":-5},"meta":{"fullname":"yAxis.labels.symbol.y","name":"y","line":451,"lineEnd":451,"column":20,"filename":"code/es-modules/Core/Axis/TreeGrid/TreeGridAxis.js","default":-5},"children":{}}}},"x":{"doclet":{"description":"The x position offset of all labels relative to the tick\npositions on the axis. Defaults to -15 for left axis, 15 for\nright axis.","samples":[{"name":"Y axis labels placed on grid lines","value":"highcharts/xaxis/labels-x/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":null},"meta":{"fullname":"yAxis.labels.x","name":"x","line":2517,"lineEnd":2532,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"undefined"},"children":{}},"y":{"doclet":{"description":"The y position offset of all labels relative to the tick\npositions on the axis. For polar and radial axis consider the use\nof the [distance](#yAxis.labels.distance) option.","samples":[{"name":"Y axis labels placed on grid lines","value":"highcharts/xaxis/labels-x/","products":["highcharts"]}],"type":{"names":["number"]},"defaultByProduct":{"highcharts":3,"highstock":-2,"highmaps":3}},"meta":{"fullname":"yAxis.labels.y","name":"y","line":2533,"lineEnd":2546,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"lineWidth":{"doclet":{"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"yAxis.lineWidth","name":"lineWidth","line":3065,"lineEnd":3065,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":0},"children":{}},"max":{"doclet":{"samples":[{"name":"Y axis max of 200","value":"highcharts/yaxis/max-200/","products":["highcharts"]},{"name":"Y axis max on logarithmic axis","value":"highcharts/yaxis/max-logarithmic/","products":["highcharts"]},{"name":"Fixed min and max on Y axis","value":"stock/yaxis/min-max/","products":["highstock"]}]},"meta":{"fullname":"yAxis.max","name":"max","line":2577,"lineEnd":2586,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"maxColor":{"doclet":{"description":"Solid gauge only. Unless [stops](#yAxis.stops) are set, the color\nto represent the maximum value of the Y axis.","samples":[{"name":"Min and max colors","value":"highcharts/yaxis/mincolor-maxcolor/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#003399","since":"4.0.0","products":["highcharts"]},"meta":{"fullname":"yAxis.maxColor","name":"maxColor","line":2324,"lineEnd":2336,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"maxLength":{"doclet":{"description":"Maximal size of a resizable axis. Could be set as a percent\nof plot area or pixel size.","samples":[{"name":"minLength and maxLength","value":"stock/yaxis/resize-min-max-length","products":["highstock"]}],"type":{"names":["number","string"]},"products":["highstock"],"requires":["module:modules/drag-panes"]},"meta":{"fullname":"yAxis.maxLength","name":"maxLength","line":34,"lineEnd":45,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js"},"children":{}},"maxPadding":{"doclet":{"description":"Padding of the max value relative to the length of the axis. A\npadding of 0.05 will make a 100px axis 5px longer. This is useful\nwhen you don't want the highest data value to appear on the edge\nof the plot area. When the axis' `max` option is set or a max extreme\nis set using `axis.setExtremes()`, the maxPadding will be ignored.\n\nAlso the `softThreshold` option takes precedence over `maxPadding`,\nso if the data is tangent to the threshold, `maxPadding` may not\napply unless `softThreshold` is set to false.","samples":[{"name":"Max padding of 0.2","value":"highcharts/yaxis/maxpadding-02/","products":["highcharts"]},{"name":"Greater min- and maxPadding","value":"stock/xaxis/minpadding-maxpadding/","products":["highstock"]}],"since":"1.2.0","products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":0.05},"meta":{"fullname":"yAxis.maxPadding","name":"maxPadding","line":2438,"lineEnd":2456,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":0.05},"children":{}},"min":{"doclet":{"samples":[{"name":"-50 with startOnTick to false","value":"highcharts/yaxis/min-startontick-false/","products":["highcharts"]},{"name":"-50 with startOnTick true by default","value":"highcharts/yaxis/min-startontick-true/","products":["highcharts"]},{"name":"Fixed min and max on Y axis","value":"stock/yaxis/min-max/","products":["highstock"]}]},"meta":{"fullname":"yAxis.min","name":"min","line":2587,"lineEnd":2596,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"minColor":{"doclet":{"description":"Solid gauge only. Unless [stops](#yAxis.stops) are set, the color\nto represent the minimum value of the Y axis.","samples":[{"name":"Min and max color","value":"highcharts/yaxis/mincolor-maxcolor/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#e6ebf5","since":"4.0.0","products":["highcharts"]},"meta":{"fullname":"yAxis.minColor","name":"minColor","line":2337,"lineEnd":2349,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"minLength":{"doclet":{"description":"Minimal size of a resizable axis. Could be set as a percent\nof plot area or pixel size.","samples":[{"name":"minLength and maxLength","value":"stock/yaxis/resize-min-max-length","products":["highstock"]}],"type":{"names":["number","string"]},"products":["highstock"],"requires":["module:modules/drag-panes"]},"meta":{"fullname":"yAxis.minLength","name":"minLength","line":21,"lineEnd":32,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js"},"children":{}},"minPadding":{"doclet":{"description":"Padding of the min value relative to the length of the axis. A\npadding of 0.05 will make a 100px axis 5px longer. This is useful\nwhen you don't want the lowest data value to appear on the edge\nof the plot area. When the axis' `min` option is set or a max extreme\nis set using `axis.setExtremes()`, the maxPadding will be ignored.\n\nAlso the `softThreshold` option takes precedence over `minPadding`,\nso if the data is tangent to the threshold, `minPadding` may not\napply unless `softThreshold` is set to false.","samples":[{"name":"Min padding of 0.2","value":"highcharts/yaxis/minpadding/","products":["highcharts"]},{"name":"Greater min- and maxPadding","value":"stock/xaxis/minpadding-maxpadding/","products":["highstock"]}],"since":"1.2.0","products":["highcharts","highstock","gantt"],"type":{"names":["number"]},"defaultvalue":0.05},"meta":{"fullname":"yAxis.minPadding","name":"minPadding","line":2458,"lineEnd":2476,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":0.05},"children":{}},"opposite":{"doclet":{"productdesc":[{"value":"In Highcharts Stock 1.x, the Y axis was placed\non the left side by default.","products":["highstock"]}],"samples":[{"name":"Secondary Y axis opposite","value":"highcharts/yaxis/opposite/","products":["highcharts"]},{"name":"Y axis on left side","value":"stock/xaxis/opposite/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultByProduct":{"highstock":true,"highcharts":false},"products":["highstock","highcharts","gantt"]},"meta":{"fullname":"yAxis.opposite","name":"opposite","line":2478,"lineEnd":2493,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"plotBands":{"doclet":{"type":{"names":["Array.<*>"]},"extends":"xAxis.plotBands"},"meta":{"fullname":"yAxis.plotBands","name":"plotBands","line":913,"lineEnd":917,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{"innerRadius":{"doclet":{"description":"In a gauge chart, this option determines the inner radius of the\nplot band that stretches along the perimeter. It can be given as\na percentage string, like `\"100%\"`, or as a pixel number, like `100`.\nBy default, the inner radius is controlled by the [thickness](#yAxis.plotBands.thickness) option.","samples":[{"name":"Gauge plot band","value":"highcharts/xaxis/plotbands-gauge","products":["highcharts"]}],"type":{"names":["number","string"]},"since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"yAxis.plotBands.innerRadius","name":"innerRadius","line":83,"lineEnd":97,"filename":"code/es-modules/Core/Axis/RadialAxisDefaults.js"},"children":{}},"outerRadius":{"doclet":{"description":"In a gauge chart, this option determines the outer radius of the\nplot band that stretches along the perimeter. It can be given as\na percentage string, like `\"100%\"`, or as a pixel number, like `100`.","samples":[{"name":"Gauge plot band","value":"highcharts/xaxis/plotbands-gauge","products":["highcharts"]}],"type":{"names":["number","string"]},"defaultvalue":"100%","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"yAxis.plotBands.outerRadius","name":"outerRadius","line":98,"lineEnd":111,"filename":"code/es-modules/Core/Axis/RadialAxisDefaults.js"},"children":{}},"thickness":{"doclet":{"description":"In a gauge chart, this option sets the width of the plot band\nstretching along the perimeter. It can be given as a percentage\nstring, like `\"10%\"`, or as a pixel number, like `10`. The default\nvalue 10 is the same as the default [tickLength](#yAxis.tickLength),\nthus making the plot band act as a background for the tick markers.","samples":[{"name":"Gauge plot band","value":"highcharts/xaxis/plotbands-gauge","products":["highcharts"]}],"type":{"names":["number","string"]},"defaultvalue":"10","since":"2.3.0","products":["highcharts"]},"meta":{"fullname":"yAxis.plotBands.thickness","name":"thickness","line":112,"lineEnd":127,"filename":"code/es-modules/Core/Axis/RadialAxisDefaults.js"},"children":{}}}},"plotLines":{"doclet":{"type":{"names":["Array.<*>"]},"extends":"xAxis.plotLines"},"meta":{"fullname":"yAxis.plotLines","name":"plotLines","line":918,"lineEnd":922,"filename":"code/es-modules/Core/Axis/PlotLineOrBand/PlotLineOrBand.js"},"children":{}},"resize":{"doclet":{"description":"Options for axis resizing. It adds a thick line between panes which\nthe user can drag in order to resize the panes.","samples":[{"name":"Axis resizing enabled","value":"stock/demo/candlestick-and-volume","products":["highstock"]}],"products":["highstock"],"requires":["module:modules/drag-panes"],"type":{"names":["*"]}},"meta":{"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js","name":"resize","fullname":"yAxis.resize","line":47,"lineEnd":57,"column":4},"children":{"controlledAxis":{"doclet":{"description":"Contains two arrays of axes that are controlled by control line\nof the axis.","requires":["module:modules/drag-panes"],"type":{"names":["*"]}},"meta":{"fullname":"yAxis.resize.controlledAxis","name":"controlledAxis","line":59,"lineEnd":64,"column":8,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js"},"children":{"next":{"doclet":{"description":"Array of axes that should move out of the way of resizing\nbeing done for the current axis. If not set, the next axis\nwill be used.","samples":[{"name":"Three panes with resizers","value":"stock/yaxis/multiple-resizers","products":["highstock"]},{"name":"One resizer controlling multiple axes","value":"stock/yaxis/resize-multiple-axes","products":["highstock"]}],"type":{"names":["Array.<(number|string)>"]},"defaultvalue":"[]","requires":["module:modules/drag-panes"]},"meta":{"fullname":"yAxis.resize.controlledAxis.next","name":"next","line":66,"lineEnd":79,"column":12,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js"},"children":{}},"prev":{"doclet":{"description":"Array of axes that should move with the current axis\nwhile resizing.","samples":[{"name":"Three panes with resizers","value":"stock/yaxis/multiple-resizers","products":["highstock"]},{"name":"One resizer controlling multiple axes","value":"stock/yaxis/resize-multiple-axes","products":["highstock"]}],"type":{"names":["Array.<(number|string)>"]},"defaultvalue":"[]","requires":["module:modules/drag-panes"]},"meta":{"fullname":"yAxis.resize.controlledAxis.prev","name":"prev","line":81,"lineEnd":93,"column":12,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js"},"children":{}}}},"cursor":{"doclet":{"description":"Cursor style for the control line.\n\nIn styled mode use class `highcharts-axis-resizer` instead.","requires":["module:modules/drag-panes"],"type":{"names":["string"]},"defaultvalue":"ns-resize"},"meta":{"fullname":"yAxis.resize.cursor","name":"cursor","line":105,"lineEnd":111,"column":8,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js","default":"ns-resize"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable resize by drag for the axis.","samples":[{"name":"Enabled resizer","value":"stock/demo/candlestick-and-volume","products":["highstock"]}],"requires":["module:modules/drag-panes"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"yAxis.resize.enabled","name":"enabled","line":96,"lineEnd":103,"column":8,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js","default":false},"children":{}},"lineColor":{"doclet":{"description":"Color of the control line.\n\nIn styled mode use class `highcharts-axis-resizer` instead.","samples":[{"name":"Styled resizer","value":"stock/yaxis/styled-resizer","products":["highstock"]}],"type":{"names":["Highcharts.ColorString"]},"requires":["module:modules/drag-panes"],"defaultvalue":"#cccccc"},"meta":{"fullname":"yAxis.resize.lineColor","name":"lineColor","line":113,"lineEnd":123,"column":8,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js","default":"#cccccc"},"children":{}},"lineDashStyle":{"doclet":{"description":"Dash style of the control line.\n\nIn styled mode use class `highcharts-axis-resizer` instead.","see":["For supported options check [dashStyle](#plotOptions.series.dashStyle)"],"samples":[{"name":"Styled resizer","value":"stock/yaxis/styled-resizer","products":["highstock"]}],"requires":["module:modules/drag-panes"],"type":{"names":["string"]},"defaultvalue":"Solid"},"meta":{"fullname":"yAxis.resize.lineDashStyle","name":"lineDashStyle","line":125,"lineEnd":136,"column":8,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js","default":"Solid"},"children":{}},"lineWidth":{"doclet":{"description":"Width of the control line.\n\nIn styled mode use class `highcharts-axis-resizer` instead.","samples":[{"name":"Styled resizer","value":"stock/yaxis/styled-resizer","products":["highstock"]}],"requires":["module:modules/drag-panes"],"type":{"names":["number"]},"defaultvalue":4},"meta":{"fullname":"yAxis.resize.lineWidth","name":"lineWidth","line":138,"lineEnd":147,"column":8,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js","default":4},"children":{}},"x":{"doclet":{"description":"Horizontal offset of the control line.","samples":[{"name":"Styled resizer","value":"stock/yaxis/styled-resizer","products":["highstock"]}],"requires":["module:modules/drag-panes"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"yAxis.resize.x","name":"x","line":149,"lineEnd":156,"column":8,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js","default":0},"children":{}},"y":{"doclet":{"description":"Vertical offset of the control line.","samples":[{"name":"Styled resizer","value":"stock/yaxis/styled-resizer","products":["highstock"]}],"requires":["module:modules/drag-panes"],"type":{"names":["number"]},"defaultvalue":0},"meta":{"fullname":"yAxis.resize.y","name":"y","line":158,"lineEnd":165,"column":8,"filename":"code/es-modules/Extensions/DragPanes/AxisResizerDefaults.js","default":0},"children":{}}}},"reversed":{"doclet":{"description":"Whether to reverse the axis so that the highest number is closest\nto the origin.","samples":[{"name":"Reversed Y axis","value":"highcharts/yaxis/reversed/","products":["highcharts"]},{"name":"Reversed Y axis","value":"stock/xaxis/reversed/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultByProduct":{"highcharts":false,"highstock":false,"highmaps":true,"gantt":true}},"meta":{"fullname":"yAxis.reversed","name":"reversed","line":2350,"lineEnd":2365,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"reversedStacks":{"doclet":{"description":"If `true`, the first series in a stack will be drawn on top in a\npositive, non-reversed Y axis. If `false`, the first series is in\nthe base of the stack.","samples":[{"name":"Non-reversed stacks","value":"highcharts/yaxis/reversedstacks-false/","products":["highcharts"]},{"name":"Non-reversed stacks","value":"highcharts/yaxis/reversedstacks-false/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"3.0.10","products":["highcharts","highstock"]},"meta":{"fullname":"yAxis.reversedStacks","name":"reversedStacks","line":2366,"lineEnd":2381,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"scrollbar":{"doclet":{"description":"An optional scrollbar to display on the Y axis in response to\nlimiting the minimum an maximum of the axis values.\n\nIn styled mode, all the presentational options for the scrollbar\nare replaced by the classes `.highcharts-scrollbar-thumb`,\n`.highcharts-scrollbar-arrow`, `.highcharts-scrollbar-button`,\n`.highcharts-scrollbar-rifles` and `.highcharts-scrollbar-track`.","samples":[{"name":"Scrollbar on the Y axis","value":"stock/yaxis/scrollbar/","products":["highstock"]}],"extends":"scrollbar","since":"4.2.6","products":["highstock"],"exclude":["height"]},"meta":{"fullname":"yAxis.scrollbar","name":"scrollbar","line":2597,"lineEnd":2614,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"enabled":{"doclet":{"description":"Enable the scrollbar on the Y axis.","samples":[{"name":"Enabled on Y axis","value":"stock/yaxis/scrollbar/","products":["highstock"]}],"type":{"names":["boolean"]},"defaultvalue":"false","since":"4.2.6","products":["highstock"]},"meta":{"fullname":"yAxis.scrollbar.enabled","name":"enabled","line":2615,"lineEnd":2626,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"margin":{"doclet":{"description":"Pixel margin between the scrollbar and the axis elements.","type":{"names":["number"]},"defaultvalue":"10","since":"4.2.6","products":["highstock"]},"meta":{"fullname":"yAxis.scrollbar.margin","name":"margin","line":2627,"lineEnd":2635,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"opposite":{"doclet":{"description":"Defines the position of the scrollbar. By default, it is positioned\non the opposite of the main axis (right side of the chart).\nHowever, in the case of RTL languages could be set to `false`\nwhich positions the scrollbar on the left.\n\nWorks only for vertical axes.\nThis means yAxis in a non-inverted chart and xAxis in the inverted.","samples":[{"name":"A scrollbar not on the opposite side","value":"stock/yaxis/scrollbar-opposite/"}],"type":{"names":["boolean"]},"defaultvalue":"true","since":"9.3.0"},"meta":{"fullname":"yAxis.scrollbar.opposite","name":"opposite","line":2637,"lineEnd":2656,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"showFull":{"doclet":{"description":"Whether to show the scrollbar when it is fully zoomed out at max\nrange. Setting it to `false` on the Y axis makes the scrollbar stay\nhidden until the user zooms in, like common in browsers.","type":{"names":["boolean"]},"defaultvalue":"true","since":"4.2.6","products":["highstock"]},"meta":{"fullname":"yAxis.scrollbar.showFull","name":"showFull","line":2658,"lineEnd":2668,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"size":{"doclet":{"description":"The width of a vertical scrollbar or height of a horizontal\nscrollbar. Defaults to 20 on touch devices.","type":{"names":["number"]},"defaultvalue":"14","since":"4.2.6","products":["highstock"]},"meta":{"fullname":"yAxis.scrollbar.size","name":"size","line":2669,"lineEnd":2678,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"zIndex":{"doclet":{"description":"Z index of the scrollbar elements.","type":{"names":["number"]},"defaultvalue":"3","since":"4.2.6","products":["highstock"]},"meta":{"fullname":"yAxis.scrollbar.zIndex","name":"zIndex","line":2679,"lineEnd":2687,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"showLastLabel":{"doclet":{"description":"Whether to show the last tick label.","productdesc":[{"value":"Defaults to `true` on cartesian charts, and `false` on polar charts.","products":["highcharts","gantt"]},{"value":"Defaults to `true` for categorized yAxis and `false` for other types\nof yAxis.","products":["highstock"]}],"defaultvalue":"undefined","type":{"names":["boolean"]}},"meta":{"fullname":"yAxis.showLastLabel","name":"showLastLabel","line":2500,"lineEnd":2511,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"softMax":{"doclet":{"description":"A soft maximum for the axis. If the series data maximum is less\nthan this, the axis will stay at this maximum, but if the series\ndata maximum is higher, the axis will flex to show all data.\n\n**Note**: The [series.softThreshold](#plotOptions.series.softThreshold) option takes precedence over this\noption.","samples":[{"name":"Soft min and max","value":"highcharts/yaxis/softmin-softmax/"}],"type":{"names":["number"]},"since":"5.0.1","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"yAxis.softMax","name":"softMax","line":2688,"lineEnd":2704,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"softMin":{"doclet":{"description":"A soft minimum for the axis. If the series data minimum is greater\nthan this, the axis will stay at this minimum, but if the series\ndata minimum is lower, the axis will flex to show all data.\n\n**Note**: The [series.softThreshold](#plotOptions.series.softThreshold) option takes precedence over this\noption.","samples":[{"name":"Soft min and max","value":"highcharts/yaxis/softmin-softmax/"}],"type":{"names":["number"]},"since":"5.0.1","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"yAxis.softMin","name":"softMin","line":2705,"lineEnd":2721,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"stackLabels":{"doclet":{"description":"The stack labels show the total value for each bar in a stacked\ncolumn or bar chart. The label will be placed on top of positive\ncolumns and below negative columns. In case of an inverted column\nchart or a bar chart the label is placed to the right of positive\nbars and to the left of negative bars.","products":["highcharts"],"type":{"names":["*"]}},"meta":{"fullname":"yAxis.stackLabels","name":"stackLabels","line":2771,"lineEnd":2786,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"align":{"doclet":{"description":"Defines the horizontal alignment of the stack total label. Can be\none of `\"left\"`, `\"center\"` or `\"right\"`. The default value is\ncalculated at runtime and depends on orientation and whether the\nstack is positive or negative.","samples":[{"name":"Aligned to the left","value":"highcharts/yaxis/stacklabels-align-left/","products":["highcharts"]},{"name":"Aligned in center","value":"highcharts/yaxis/stacklabels-align-center/","products":["highcharts"]},{"name":"Aligned to the right","value":"highcharts/yaxis/stacklabels-align-right/","products":["highcharts"]}],"type":{"names":["Highcharts.AlignValue"]},"since":"2.1.5","products":["highcharts"]},"meta":{"fullname":"yAxis.stackLabels.align","name":"align","line":2797,"lineEnd":2814,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"allowOverlap":{"doclet":{"description":"Allow the stack labels to overlap.","samples":[{"name":"Default false","value":"highcharts/yaxis/stacklabels-allowoverlap-false/","products":["highcharts"]}],"since":"5.0.13","products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"yAxis.stackLabels.allowOverlap","name":"allowOverlap","line":2927,"lineEnd":2935,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}},"animation":{"doclet":{"description":"Enable or disable the initial animation when a series is\ndisplayed for the `stackLabels`. The animation can also be set as\na configuration object. Please note that this option only\napplies to the initial animation.\nFor other animations, see [chart.animation](#chart.animation)\nand the animation parameter under the API methods.\nThe following properties are supported:\n\n- `defer`: The animation delay time in milliseconds.","samples":[{"name":"Animation defer settings","value":"highcharts/plotoptions/animation-defer/","products":["highcharts"]}],"type":{"names":["boolean","Partial.<Highcharts.AnimationOptionsObject>"]},"since":"8.2.0"},"meta":{"fullname":"yAxis.stackLabels.animation","name":"animation","line":2909,"lineEnd":2925,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"defer":{"doclet":{"description":"The animation delay time in milliseconds.\nSet to `0` renders stackLabel immediately.\nAs `undefined` inherits defer time from the [series.animation.defer](#plotOptions.series.animation.defer).","type":{"names":["number"]},"since":"8.2.0"},"meta":{"fullname":"yAxis.stackLabels.animation.defer","name":"defer","line":2927,"lineEnd":2935,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"backgroundColor":{"doclet":{"description":"The background color or gradient for the stack label.","samples":[{"name":"Stack labels box options","value":"highcharts/yaxis/stacklabels-box/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"since":"8.1.0"},"meta":{"fullname":"yAxis.stackLabels.backgroundColor","name":"backgroundColor","line":2946,"lineEnd":2954,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"borderColor":{"doclet":{"description":"The border color for the stack label. Defaults to `undefined`.","samples":[{"name":"Stack labels box options","value":"highcharts/yaxis/stacklabels-box/","products":["highcharts"]}],"type":{"names":["Highcharts.ColorType"]},"since":"8.1.0"},"meta":{"fullname":"yAxis.stackLabels.borderColor","name":"borderColor","line":2955,"lineEnd":2963,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"borderRadius":{"doclet":{"description":"The border radius in pixels for the stack label.","samples":[{"name":"Stack labels box options","value":"highcharts/yaxis/stacklabels-box/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"8.1.0"},"meta":{"fullname":"yAxis.stackLabels.borderRadius","name":"borderRadius","line":2964,"lineEnd":2973,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"borderWidth":{"doclet":{"description":"The border width in pixels for the stack label.","samples":[{"name":"Stack labels box options","value":"highcharts/yaxis/stacklabels-box/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"8.1.0"},"meta":{"fullname":"yAxis.stackLabels.borderWidth","name":"borderWidth","line":2974,"lineEnd":2983,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"crop":{"doclet":{"description":"Whether to hide stack labels that are outside the plot area.\nBy default, the stack label is moved\ninside the plot area according to the\n[overflow](/highcharts/#yAxis/stackLabels/overflow)\noption.","type":{"names":["boolean"]},"since":"7.1.3","defaultvalue":true},"meta":{"fullname":"yAxis.stackLabels.crop","name":"crop","line":2996,"lineEnd":3005,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"enabled":{"doclet":{"description":"Enable or disable the stack total labels.","samples":[{"name":"Enabled stack total labels","value":"highcharts/yaxis/stacklabels-enabled/","products":["highcharts"]},{"name":"Enabled stack labels in waterfall chart","value":"highcharts/yaxis/stacklabels-enabled-waterfall/","products":["highcharts"]}],"since":"2.1.5","products":["highcharts"],"type":{"names":["boolean"]},"defaultvalue":false},"meta":{"fullname":"yAxis.stackLabels.enabled","name":"enabled","line":2946,"lineEnd":2954,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":false},"children":{}},"format":{"doclet":{"description":"A format string for the data label. Available variables are the\nsame as for `formatter`.","type":{"names":["string"]},"defaultvalue":"{total}","since":"3.0.2","products":["highcharts","highstock"]},"meta":{"fullname":"yAxis.stackLabels.format","name":"format","line":2815,"lineEnd":2824,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"formatter":{"doclet":{"description":"Callback JavaScript function to format the label. The value is\ngiven by `this.total`. Since v12.6.0, the callback also receives\n`ctx` as the first argument, so that arrow functions can access\nthe same context as regular functions using `this`.","samples":[{"name":"Added units to stack total value","value":"highcharts/yaxis/stacklabels-formatter/","products":["highcharts"]}],"type":{"names":["Highcharts.FormatterCallbackFunction.<Highcharts.StackItemObject>"]},"since":"2.1.5","products":["highcharts"]},"meta":{"fullname":"yAxis.stackLabels.formatter","name":"formatter","line":3022,"lineEnd":3034,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"overflow":{"doclet":{"description":"How to handle stack total labels that flow outside the plot area.\nThe default is set to `\"justify\"`,\nwhich aligns them inside the plot area.\nFor columns and bars, this means it will be moved inside the bar.\nTo display stack labels outside the plot area,\nset `crop` to `false` and `overflow` to `\"allow\"`.","samples":[{"name":"Stack labels flows outside the plot area.","value":"highcharts/yaxis/stacklabels-overflow/"}],"type":{"names":["Highcharts.DataLabelsOverflowValue"]},"since":"7.1.3","defaultvalue":"justify"},"meta":{"fullname":"yAxis.stackLabels.overflow","name":"overflow","line":3007,"lineEnd":3020,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"justify"},"children":{}},"rotation":{"doclet":{"description":"Rotation of the labels in degrees.","samples":[{"name":"Labels rotated 45°","value":"highcharts/yaxis/stacklabels-rotation/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"0","since":"2.1.5","products":["highcharts"]},"meta":{"fullname":"yAxis.stackLabels.rotation","name":"rotation","line":2825,"lineEnd":2836,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"style":{"doclet":{"description":"CSS styles for the label.\n\nIn styled mode, the styles are set in the\n`.highcharts-stack-label` class.","samples":[{"name":"Red stack total labels","value":"highcharts/yaxis/stacklabels-style/","products":["highcharts"]}],"type":{"names":["Highcharts.CSSObject"]},"since":"2.1.5","products":["highcharts"]},"meta":{"fullname":"yAxis.stackLabels.style","name":"style","line":3038,"lineEnd":3050,"column":12,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"fontSize":{"doclet":{"type":{"names":["number","string"]},"defaultvalue":"0.7em"},"meta":{"fullname":"yAxis.stackLabels.style.fontSize","name":"fontSize","line":3054,"lineEnd":3056,"column":16,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":"0.7em"},"children":{}}}},"textAlign":{"doclet":{"description":"The text alignment for the label. While `align` determines where\nthe texts anchor point is placed with regards to the stack,\n`textAlign` determines how the text is aligned against its anchor\npoint. Possible values are `\"left\"`, `\"center\"` and `\"right\"`.\nThe default value is calculated at runtime and depends on\norientation and whether the stack is positive or negative.","samples":[{"name":"Label in center position but text-aligned left","value":"highcharts/yaxis/stacklabels-textalign-left/","products":["highcharts"]}],"type":{"names":["Highcharts.AlignValue"]},"since":"2.1.5","products":["highcharts"]},"meta":{"fullname":"yAxis.stackLabels.textAlign","name":"textAlign","line":2837,"lineEnd":2852,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"useHTML":{"doclet":{"description":"Whether to [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)\nto render the labels.","type":{"names":["boolean"]},"defaultvalue":"false","since":"3.0.0","products":["highcharts","highstock"]},"meta":{"fullname":"yAxis.stackLabels.useHTML","name":"useHTML","line":2853,"lineEnd":2862,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"verticalAlign":{"doclet":{"description":"Defines the vertical alignment of the stack total label. Can be\none of `\"top\"`, `\"middle\"` or `\"bottom\"`. The default value is\ncalculated at runtime and depends on orientation and whether the\nstack is positive or negative.","samples":[{"name":"Vertically aligned top","value":"highcharts/yaxis/stacklabels-verticalalign-top/","products":["highcharts"]},{"name":"Vertically aligned middle","value":"highcharts/yaxis/stacklabels-verticalalign-middle/","products":["highcharts"]},{"name":"Vertically aligned bottom","value":"highcharts/yaxis/stacklabels-verticalalign-bottom/","products":["highcharts"]}],"type":{"names":["Highcharts.VerticalAlignValue"]},"since":"2.1.5","products":["highcharts"]},"meta":{"fullname":"yAxis.stackLabels.verticalAlign","name":"verticalAlign","line":2863,"lineEnd":2880,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"x":{"doclet":{"description":"The x position offset of the label relative to the left of the\nstacked bar. The default value is calculated at runtime and\ndepends on orientation and whether the stack is positive or\nnegative.","samples":[{"name":"Stack total labels with x offset","value":"highcharts/yaxis/stacklabels-x/","products":["highcharts"]}],"type":{"names":["number"]},"since":"2.1.5","products":["highcharts"]},"meta":{"fullname":"yAxis.stackLabels.x","name":"x","line":2881,"lineEnd":2894,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"y":{"doclet":{"description":"The y position offset of the label relative to the tick position\non the axis. The default value is calculated at runtime and\ndepends on orientation and whether the stack is positive or\nnegative.","samples":[{"name":"Stack total labels with y offset","value":"highcharts/yaxis/stacklabels-y/","products":["highcharts"]}],"type":{"names":["number"]},"since":"2.1.5","products":["highcharts"]},"meta":{"fullname":"yAxis.stackLabels.y","name":"y","line":2895,"lineEnd":2908,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"stackShadow":{"doclet":{"description":"Relevant only for pictorial series. The `stackShadow` forms the background of\nstacked points. Requires `series.stacking` to be defined.","samples":[{"name":"Pictorial stackShadow option","value":"highcharts/demo/pictorial-stackshadow/","products":["highcharts"]}],"declare":"Highcharts.YAxisOptions","type":{"names":["*"]},"since":"11.0.0","products":["highcharts"],"requires":["module:modules/pictorial"]},"meta":{"fullname":"yAxis.stackShadow","name":"stackShadow","line":468,"lineEnd":481,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js"},"children":{"borderColor":{"doclet":{"description":"The color of the `stackShadow` border.","declare":"Highcharts.YAxisOptions","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"transparent","products":["highcharts"],"requires":["module:modules/pictorial"],"since":"11.0.0"},"meta":{"fullname":"yAxis.stackShadow.borderColor","name":"borderColor","line":482,"lineEnd":491,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js"},"children":{}},"borderWidth":{"doclet":{"description":"The width of the `stackShadow` border.","declare":"Highcharts.YAxisOptions","type":{"names":["number"]},"defaultvalue":"0","products":["highcharts"],"requires":["module:modules/pictorial"],"since":"11.0.0"},"meta":{"fullname":"yAxis.stackShadow.borderWidth","name":"borderWidth","line":492,"lineEnd":501,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js"},"children":{}},"color":{"doclet":{"description":"The color of the `stackShadow`.","declare":"Highcharts.YAxisOptions","type":{"names":["Highcharts.ColorType"]},"defaultvalue":"#dedede","products":["highcharts"],"requires":["module:modules/pictorial"],"since":"11.0.0"},"meta":{"fullname":"yAxis.stackShadow.color","name":"color","line":502,"lineEnd":511,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js"},"children":{}},"enabled":{"doclet":{"description":"Enable or disable `stackShadow`.","declare":"Highcharts.YAxisOptions","type":{"names":["boolean"]},"defaultvalue":"undefined","products":["highcharts"],"requires":["module:modules/pictorial"],"since":"11.0.0"},"meta":{"fullname":"yAxis.stackShadow.enabled","name":"enabled","line":512,"lineEnd":521,"filename":"code/es-modules/Series/Pictorial/PictorialSeries.js"},"children":{}}}},"startOnTick":{"doclet":{"description":"Whether to force the axis to start on a tick. Use this option with\nthe `maxPadding` option to control the axis start.\n\nThis option is always disabled, when panning type is\neither `y` or `xy`.","see":["[type](#chart.panning.type)"],"samples":[{"name":"False by default","value":"highcharts/xaxis/startontick-false/","products":["highcharts"]},{"name":"True","value":"highcharts/xaxis/startontick-true/","products":["highcharts"]},{"name":"False for Y axis","value":"stock/xaxis/endontick/","products":["highstock"]}],"since":"1.2.0","products":["highcharts","highstock","gantt"],"type":{"names":["boolean"]},"defaultvalue":true},"meta":{"fullname":"yAxis.startOnTick","name":"startOnTick","line":2577,"lineEnd":2586,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":true},"children":{}},"stops":{"doclet":{"description":"Solid gauge series only. Color stops for the solid gauge. Use this\nin cases where a linear gradient between a `minColor` and `maxColor`\nis not sufficient. The stops is an array of tuples, where the first\nitem is a float between 0 and 1 assigning the relative position in\nthe gradient, and the second item is the color.\n\nFor solid gauges, the Y axis also inherits the concept of\n[data classes](https://api.highcharts.com/highmaps#colorAxis.dataClasses)\nfrom the Highmaps color axis.","samples":[{"name":"Gauge with stops","value":"highcharts/demo/gauge-solid/","products":["highcharts"]}],"see":["[minColor](#yAxis.minColor)","[maxColor](#yAxis.maxColor)"],"type":{"names":["Array.<Array.<number, Highcharts.ColorType>>"]},"since":"4.0.0","products":["highcharts"]},"meta":{"fullname":"yAxis.stops","name":"stops","line":2383,"lineEnd":2404,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"tickPixelInterval":{"doclet":{"see":["[tickInterval](#xAxis.tickInterval)","[tickPositioner](#xAxis.tickPositioner)","[tickPositions](#xAxis.tickPositions)"],"type":{"names":["number"]},"defaultvalue":72},"meta":{"fullname":"yAxis.tickPixelInterval","name":"tickPixelInterval","line":2478,"lineEnd":2493,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js","default":72},"children":{}},"tickWidth":{"doclet":{"description":"The pixel width of the major tick marks.","samples":[{"name":"10 px width","value":"highcharts/xaxis/tickwidth/","products":["highcharts"]},{"name":"Formatted ticks on X axis","value":"stock/xaxis/ticks/","products":["highstock"]}],"type":{"names":["number"]},"defaultvalue":"0","products":["highcharts","highstock","gantt"]},"meta":{"fullname":"yAxis.tickWidth","name":"tickWidth","line":2405,"lineEnd":2415,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"title":{"doclet":{"type":{"names":["*"]}},"meta":{"fullname":"yAxis.title","name":"title","line":2742,"lineEnd":2742,"column":8,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{"margin":{"doclet":{"description":"The pixel distance between the axis labels and the title.\nPositive values are outside the axis line, negative are inside.","samples":[{"name":"Y axis title margin of 60","value":"highcharts/xaxis/title-margin/","products":["highcharts"]}],"type":{"names":["number"]},"defaultvalue":"40"},"meta":{"fullname":"yAxis.title.margin","name":"margin","line":2743,"lineEnd":2753,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"text":{"doclet":{"description":"The actual text of the axis title. Horizontal texts can contain\nHTML, but rotated texts are painted using vector techniques and\nmust be clean text. The Y axis title is disabled by setting the\n`text` option to `undefined`. The default value is overridden by\nthe `lang.yAxisTitle` language option.","samples":[{"name":"Custom HTML","value":"highcharts/xaxis/title-text/","products":["highcharts"]}],"type":{"names":["string","undefined"]},"defaultByProduct":{"highcharts":"Values","highstock":"undefined"},"products":["highcharts","highstock","gantt"]},"meta":{"fullname":"yAxis.title.text","name":"text","line":2754,"lineEnd":2769,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"tooltipValueFormat":{"doclet":{"description":"Parallel coordinates only. Format that will be used for point.y\nand available in [tooltip.pointFormat](#tooltip.pointFormat) as\n`{point.formattedValue}`. If not set, `{point.formattedValue}`\nwill use other options, in this order:\n\n1. [yAxis.labels.format](#yAxis.labels.format) will be used if\n   set\n\n2. If yAxis is a category, then category name will be displayed\n\n3. If yAxis is a datetime, then value will use the same format as\n   yAxis labels\n\n4. If yAxis is linear/logarithmic type, then simple value will be\n   used","samples":[{"name":"Different tooltipValueFormats's","value":"/highcharts/parallel-coordinates/tooltipvalueformat/","products":["highcharts"]}],"type":{"names":["string"]},"since":"6.0.0","products":["highcharts"],"requires":["module:modules/parallel-coordinates"]},"meta":{"fullname":"yAxis.tooltipValueFormat","name":"tooltipValueFormat","line":102,"lineEnd":128,"filename":"code/es-modules/Extensions/ParallelCoordinates/ParallelCoordinatesDefaults.js"},"children":{}},"top":{"doclet":{"description":"The top position of the Y axis. If it's a number, it is interpreted\nas pixel position relative to the chart.\n\nSince Highcharts 2: If it's a percentage string, it is interpreted as\npercentages of the plot height, offset from plot area top.","see":["[yAxis.height](#yAxis.height)"],"samples":[{"name":"Percentage height panes","value":"stock/demo/candlestick-and-volume/","products":["highstock"]}],"type":{"names":["number","string"]},"products":["highcharts","highstock"]},"meta":{"fullname":"yAxis.top","name":"top","line":2771,"lineEnd":2786,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}},"type":{"doclet":{"description":"The type of axis. Can be one of `linear`, `logarithmic`, `datetime`,\n`category` or `treegrid`. Defaults to `treegrid` for Gantt charts,\n`linear` for other chart types.\n\nIn a datetime axis, the numbers are given in milliseconds, and tick\nmarks are placed on appropriate values, like full hours or days. In a\ncategory or treegrid axis, the [point names](#series.line.data.name)\nof the chart's series are used for categories, if a\n[categories](#xAxis.categories) array is not defined.","samples":[{"name":"Logarithmic with minor grid lines","value":"highcharts/yaxis/type-log-minorgrid/","products":["highcharts"]},{"name":"Logarithmic with extension to emulate negative values","value":"highcharts/yaxis/type-log-negative/","products":["highcharts"]},{"name":"Treegrid axis","value":"gantt/treegrid-axis/demo","products":["gantt"]}],"type":{"names":["Highcharts.AxisTypeValue"]},"defaultByProduct":{"highcharts":"linear","gantt":"treegrid"},"products":["highcharts","gantt"]},"meta":{"fullname":"yAxis.type","name":"type","line":2284,"lineEnd":2307,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}},"zAxis":{"doclet":{"description":"The Z axis or depth axis for 3D plots.\n\nSee the [Axis class](/class-reference/Highcharts.Axis) for programmatic\naccess to the axis.","samples":[{"name":"Z-Axis with Categories","value":"highcharts/3d/scatter-zaxis-categories/","products":["highcharts"]},{"name":"Z-Axis with styling","value":"highcharts/3d/scatter-zaxis-grid/","products":["highcharts"]}],"type":{"names":["*","Array.<*>"]},"extends":"xAxis","since":"5.0.0","products":["highcharts"],"exclude":["breaks","crosshair","height","left","lineColor","lineWidth","nameToX","showEmpty","top","width"]},"meta":{"fullname":"zAxis","name":"zAxis","line":2250,"lineEnd":2268,"filename":"code/es-modules/Core/Axis/AxisDefaults.js"},"children":{}}}