@amcharts/amcharts5-mcp 1.6.0 → 1.7.0

package/extended/reference/iserialchartsettings.md

@@ -2,75 +2,31 @@
 title: "ISerialChartSettings"
 type: "interface"
 source: "https://www.amcharts.com/docs/v5/reference/iserialchartsettings/"
-scraped: "2026-03-15"
+generatedFrom: "@amcharts/amcharts5@5.21.0"
 ---
 
-Inheritance
-ISerialChartSettings extends IChartSettings.
-ISerialChartSettings is extended by IPercentChartSettings, IXYChartSettings, IMapChartSettings.
-Properties
-
-
-        active        
-        #
-      
-
-
-                          Type undefined | false | true                      
-Inherited from ISpriteSettings
-Indicates if element is currently active.
-
-
-        ariaChecked        
-        #
-      
-
-
-                          Type undefined | false | true                      
-Inherited from ISpriteSettings
-aria-checked setting.
- This setting is ignored unless role is one of the following:
-
-"checkbox"
-
-"option"
-
-"radio"
-
-"menuitemcheckbox"
-
-"menuitemradio"
-
-"treeitem"
-
-
-        ariaControls        
-        #
-      
-
-
-                          Type undefined | string                      
-Inherited from ISpriteSettings
-aria-controls setting.
+## Inheritance
 
+Extends: IChartSettings
+All ancestors: IChartSettings, IContainerSettings, ISpriteSettings, IEntitySettings
+Settings of: `am5.SerialChart` (see its page for the class)
+TypeScript: `am5.ISerialChartSettings` (`import type { ISerialChartSettings } from "@amcharts/amcharts5"`)
 
-        ariaCurrent        
-        #
-      
+## Settings
 
+- **colors** (`ColorSet`) — The `ColorSet` series take their colors from. Docs: https://www.amcharts.com/docs/v5/charts/xy-chart/series/#Series_colors
+- **patterns** (`PatternSet`) — The `PatternSet` series take their patterns from. _Since 5.10.0._ Docs: https://www.amcharts.com/docs/v5/concepts/colors-gradients-and-patterns/patterns/#Pattern_sets
 
-                          Type undefined | string                      
-Inherited from ISpriteSettings
-aria-current setting.
+## Inherited settings with a different default on SerialChart
 
-## Inheritance
-
-Extends: IChartSettings
-Extended by: IPercentChartSettings, IXYChartSettings, IMapChartSettings
+- **height** (`number | Percent`) — default `am5.p100` _(theme)_ — _from ISpriteSettings_ — Height in pixels, or a `Percent` of the parent's inner height. In a vertical layout, a percent height is a share of the height the other children leave.
+- **interactiveChildren** (`boolean`) — default `false` _(theme)_ — _from IContainerSettings_ — Makes every descendant, not just direct children, interactive when the container itself is interactive.
+- **width** (`number | Percent`) — default `am5.p100` _(theme)_ — _from ISpriteSettings_ — Width in pixels, or a `Percent` of the parent's inner width. In a horizontal layout, a percent width is a share of the width the other children leave.
 
-> **Note:** This class also inherits all settings, properties, methods, and events from IChartSettings (and its ancestors). Use `get_doc` or `get_core_reference` with the parent class name to see inherited members.
+## Other inherited settings
 
-## Properties
+Names only — see the declaring interface's page (e.g. `get_api_reference("IContainerSettings")`) for types, defaults and descriptions.
 
-- **colors** (`ColorSet`) — A ColorSet to use when asigning colors for series. Click here for more info
-- **patterns** (`PatternSet`) — A PatternSet to use when asigning patterns for series. Click here for more info @since 5.10.0
+- _IContainerSettings_: background, html, layout, mask, maskContent, paddingBottom, paddingLeft, paddingRight, paddingTop, reverseChildren, setStateOnChildren, verticalScrollbar
+- _ISpriteSettings_: active, appearDelay, appearDuration, ariaChecked, ariaControls, ariaCurrent, ariaExpanded, ariaHidden, ariaLabel, ariaLive, ariaOrientation, ariaSelected, ariaValueMax, ariaValueMin, ariaValueNow, ariaValueText, autoAppear, blur, brightness, centerX, centerY, clickAnnounceText, contrast, crisp, cursorOverStyle, dateFormatter, disabled, draggable, durationFormatter, dx, dy, exportable, filter, focusable, focusableGroup, forceHidden, forceInactive, hoverOnFocus, hue, interactive, invert, isMeasured, layer, layerMargin, marginBottom, marginLeft, marginRight, marginTop, maxHeight, maxWidth, minHeight, minWidth, numberFormatter, opacity, position, role, rotation, saturate, scale, sepia, showTooltipOn, tabindexOrder, templateField, toggleKey, tooltip, tooltipHTML, tooltipPosition, tooltipText, tooltipX, tooltipY, visible, wheelable, x, y
+- _IEntitySettings_: animations, id, ignoreThemes, stateAnimationDuration, stateAnimationEasing, themes, themeTags, themeTagsSelf, userData

package/extended/reference/iserializerevents.md

@@ -2,14 +2,14 @@
 title: "ISerializerEvents"
 type: "interface"
 source: "https://www.amcharts.com/docs/v5/reference/iserializerevents/"
-scraped: "2026-03-15"
+generatedFrom: "@amcharts/amcharts5@5.21.0"
 ---
 
-Inheritance
-
 ## Inheritance
 
 Extends: IEntityEvents
-Extended by: IChartSerializerEvents
+TypeScript: not exported by name from the package.
+
+## Events
 
-> **Note:** This class also inherits all settings, properties, methods, and events from IEntityEvents (and its ancestors). Use `get_doc` or `get_core_reference` with the parent class name to see inherited members.
+_(none)_

package/extended/reference/iserializerprivate.md

@@ -2,14 +2,14 @@
 title: "ISerializerPrivate"
 type: "interface"
 source: "https://www.amcharts.com/docs/v5/reference/iserializerprivate/"
-scraped: "2026-03-15"
+generatedFrom: "@amcharts/amcharts5@5.21.0"
 ---
 
-Inheritance
-
 ## Inheritance
 
 Extends: IEntityPrivate
-Extended by: IChartSerializerPrivate
+TypeScript: not exported by name from the package.
+
+## Private settings
 
-> **Note:** This class also inherits all settings, properties, methods, and events from IEntityPrivate (and its ancestors). Use `get_doc` or `get_core_reference` with the parent class name to see inherited members.
+_(none)_

package/extended/reference/iserializersettings.md

@@ -2,153 +2,31 @@
 title: "ISerializerSettings"
 type: "interface"
 source: "https://www.amcharts.com/docs/v5/reference/iserializersettings/"
-scraped: "2026-03-15"
+generatedFrom: "@amcharts/amcharts5@5.21.0"
 ---
 
-Inheritance
-ISerializerSettings extends IEntitySettings.
-ISerializerSettings is extended by IChartSerializerSettings.
-Properties
-
-
-        excludeProperties        
-        #
-      
-
-
-                          Type Array                      
-An array of properties to not include in the serialized data.
-@since 5.3.2
-
-
-        excludeSettings        
-        #
-      
-
-
-                          Type Array                      
-An array of settings to not include in the serialized data.
-
-
-        fullSettings        
-        #
-      
-
-
-                          Type Array                      
-Include full values of these settings.
-@since 6.4.3
-
-
-        functionsAs        
-        #
-      
-
-
-                          Type "string" | "function"                      
-Default "function"
-
-Serialize functions as strings or functions.
-
-
-        id        
-        #
-      
-
-
-                          Type undefined | string                      
-Inherited from IEntitySettings
-A custom string ID for the element.
- If set, element can be looked up via root.entitiesById.
- Will raise error if an element with the same ID already exists.
-
-
-        includeAdapters        
-        #
-      
-
-
-                          Type undefined | false | true                      
-Default false
-Include adapters in the output.
-@since 5.15.0
-
-
-        includeSettings        
-        #
-      
-
-
-                          Type Array                      
-An array of settings to include in the serialized data.
-
-
-        includeStates        
-        #
-      
-
-
-                          Type undefined | false | true                      
-Default false
-Include states in the output.
-@since 5.15.0
-
-
-        maxDepth        
-        #
-      
-
-
-                          Type undefined | number                      
-Default 2
-
-Maximum depth of recursion when traversing target object.
-
-
-        stateAnimationDuration        
-        #
-      
-
-
-                          Type undefined | number                      
-Inherited from IEntitySettings
-Duration of transition from one state to another.
-
-
-        stateAnimationEasing        
-        #
-      
-
-
-                          Type $ease.Easing                      
-Inherited from IEntitySettings
-Easing of transition from one state to another.
-
-
-        themeTags        
-        #
-      
-
-
-                          Type Array                      
-Inherited from IEntitySettings
-Tags which can be used by the theme rules.
-
 ## Inheritance
 
 Extends: IEntitySettings
-Extended by: IChartSerializerSettings
+Settings of: `am5plugins_json.Serializer` (see its page for the class)
+TypeScript: not exported by name from the package.
+
+## Settings
+
+- **excludeSettings** (`string[]`) — default `[]` _(code fallback)_ — Settings to leave out of the output. Ignored when `includeSettings` is set. _Note:_ ChartSerializer sets a default list; setting `excludeSettings` replaces that list rather than adding to it.
+- **includeSettings** (`string[]`) — default `[]` _(code fallback)_ — The only settings to write; all others are left out.
+- **fullSettings** (`string[]`) — default `[]` _(code fallback)_ — Settings whose plain-object values are written with all their keys. In other settings, a plain object comes out empty. _Since 5.7.0._
+- **excludeProperties** (`string[]`) — default `[]` _(code fallback)_ — Properties to leave out of the output, e.g. `"data"`. _Since 5.3.2._
+- **includeProperties** (`string[]`) — default `[]` _(code fallback)_ — _(internal)_ An array of properties to include in the serialized data. _Since 5.15.0._
+- **maxDepth** (`number`) — default `2` — How many levels of nested objects to write; deeper ones are left out.
+- **runningAnimations** (`boolean`) — default `true` — Write an animation started in code that loops forever - a globe that keeps turning, a marker that keeps pulsing - into the `animations` setting, so the saved chart plays it too. Animations that end (`appear()`, state changes, zooming) are never written, and neither is one whose easing is a function of its own rather than one of amCharts' easings. _Since 5.20.8._ _Note:_ Such an animation (`loops: Infinity` with a named easing) is written as an `animations` entry `{ key, from, to, duration, loops: 0, easing?, ease?, yoyo? }` (see IDeclaredAnimation), and the setting it animates is left out of the saved settings. Easings `am5.ease.easingInfo()` cannot name — e.g. one made with `am5.ease.pow`, or `am5.ease.out(am5.ease.yoyo(x))` — are not written. ChartSerializer also writes an endless animation of a bullet's data item value (e.g. `dataItem.animate({ key: "positionOnLine", loops: Infinity, … })`) on the bullet sprite, as an entry with `target: "dataItem"` (5.21.0; 5.20.8 did not). Turn it off with `am5plugins_json.ChartSerializer.new(root, { runningAnimations: false })`.
+- **includeStates** (`boolean`) — default `false` — Writes the elements' states. _Since 5.15.0._
+- **includeAdapters** (`boolean`) — default `false` — Writes the elements' adapters. _Since 5.15.0._
+- **includeEvents** (`boolean`) — default `false` — _(internal)_ Include events in the output. _Since 5.15.0._
+- **functionsAs** (`"string" | "function"`) — default `"string"` — How adapter callbacks are written (see `includeAdapters`): `"string"` as their source code, `"function"` as the functions themselves, which JSON can't hold. `ChartSerializer` uses `"function"` unless set.
 
-> **Note:** This class also inherits all settings, properties, methods, and events from IEntitySettings (and its ancestors). Use `get_doc` or `get_core_reference` with the parent class name to see inherited members.
+## Other inherited settings
 
-## Properties
+Names only — see the declaring interface's page (e.g. `get_api_reference("IEntitySettings")`) for types, defaults and descriptions.
 
-- **excludeProperties** (`Array`) — An array of properties to not include in the serialized data. @since 5.3.2
-- **excludeSettings** (`Array`) — An array of settings to not include in the serialized data.
-- **fullSettings** (`Array`) — Include full values of these settings. @since 6.4.3
-- **functionsAs** (`"string" | "function"`) — Default "string" Serialize functions as strings or functions. (`ChartSerializer` sets it to "function".)
-- **includeAdapters** (`undefined | false | true`) — Default false Include adapters in the output. @since 5.15.0
-- **includeSettings** (`Array`) — An array of settings to include in the serialized data.
-- **includeStates** (`undefined | false | true`) — Default false Include states in the output. @since 5.15.0
-- **maxDepth** (`undefined | number`) — Default 2 Maximum depth of recursion when traversing target object.
-- **runningAnimations** (`undefined | false | true`) — Default true Write an animation started in code that loops for ever - a globe that keeps turning, a marker that keeps pulsing - into the `animations` setting, so the saved chart plays it too. Animations that end (`appear()`, state changes, zooming) are never written, and neither is one whose easing is a function of its own rather than one of amCharts' easings. Such an animation (`loops: Infinity` with a named easing) is written as an `animations` entry `{ key, from, to, duration, loops: 0, easing?, ease?, yoyo? }` (see IDeclaredAnimation), and the setting it animates is left out of the saved settings. Also never written: easings made with `am5.ease.pow`, and easings `am5.ease.easingInfo()` cannot name (e.g. `am5.ease.out(am5.ease.yoyo(x))`); in 5.20.8, an endless animation started in code on a data item (e.g. `dataItem.animate({ key: "positionOnLine", loops: Infinity, ... })`) is not written either. Also applies to ChartSerializer. @since 5.20.8 (typings say 5.21.0)
+- _IEntitySettings_: animations, id, ignoreThemes, stateAnimationDuration, stateAnimationEasing, themes, themeTags, themeTagsSelf, userData

package/extended/reference/iseriesdataitem.md

@@ -2,37 +2,39 @@
 title: "ISeriesDataItem"
 type: "interface"
 source: "https://www.amcharts.com/docs/v5/reference/iseriesdataitem/"
-scraped: "2026-03-15"
+generatedFrom: "@amcharts/amcharts5@5.21.0"
 ---
 
-Inheritance
-
 ## Inheritance
 
 Extends: IComponentDataItem
-Extended by: IFlowDataItem, IFlowNodesDataItem, IPercentSeriesDataItem, ILegendDataItem, IXYSeriesDataItem, IHierarchyDataItem, IMapSeriesDataItem, IVennDataItem, IWordCloudDataItem
+TypeScript: not exported by name from the package.
+
+## Data item fields
+
+- **id** (`string`)
+- **url** (`string`) — A URL to open when the data item's element is clicked. _Since 5.20.7._ _Note:_ Filled from data by the series' `urlField`; opened in the series' `linkTarget`.
+- **value** (`number`)
+- **valueWorking** (`number`)
+- **valueChange** (`number`)
+- **valueChangePercent** (`number`)
+- **valueChangeSelection** (`number`)
+- **valueChangeSelectionPercent** (`number`)
+- **valueChangePrevious** (`number`)
+- **valueChangePreviousPercent** (`number`)
+- **valueWorkingOpen** (`number`)
+- **valueWorkingClose** (`number`)
+- **customValue** (`number`)
+- **customValueWorking** (`number`)
+- **customValueChange** (`number`)
+- **customValueChangePercent** (`number`)
+- **customValueChangeSelection** (`number`)
+- **customValueChangeSelectionPercent** (`number`)
+- **customValueChangePrevious** (`number`)
+- **customValueChangePreviousPercent** (`number`)
 
-> **Note:** This class also inherits all settings, properties, methods, and events from IComponentDataItem (and its ancestors). Use `get_doc` or `get_core_reference` with the parent class name to see inherited members.
+## Other inherited data item fields
 
-## Properties
+Names only — see the declaring interface's page (e.g. `get_api_reference("IComponentDataItem")`) for types, defaults and descriptions.
 
-- **customValue** (`undefined | number`) — (no description)
-- **customValueChange** (`undefined | number`) — (no description)
-- **customValueChangePercent** (`undefined | number`) — (no description)
-- **customValueChangePrevious** (`undefined | number`) — (no description)
-- **customValueChangePreviousPercent** (`undefined | number`) — (no description)
-- **customValueChangeSelection** (`undefined | number`) — (no description)
-- **customValueChangeSelectionPercent** (`undefined | number`) — (no description)
-- **customValueWorking** (`undefined | number`) — (no description)
-- **id** (`undefined | string`) — (no description)
-- **url** (`undefined | string`) — A URL to open when the data item's element is clicked. Filled from data by the series' urlField; opened in the series' linkTarget. @since 5.20.7
-- **value** (`undefined | number`) — (no description)
-- **valueChange** (`undefined | number`) — (no description)
-- **valueChangePercent** (`undefined | number`) — (no description)
-- **valueChangePrevious** (`undefined | number`) — (no description)
-- **valueChangePreviousPercent** (`undefined | number`) — (no description)
-- **valueChangeSelection** (`undefined | number`) — (no description)
-- **valueChangeSelectionPercent** (`undefined | number`) — (no description)
-- **valueWorking** (`undefined | number`) — (no description)
-- **valueWorkingClose** (`undefined | number`) — (no description)
-- **valueWorkingOpen** (`undefined | number`) — (no description)
+- _IComponentDataItem_: visible

package/extended/reference/iseriesevents.md

@@ -2,14 +2,22 @@
 title: "ISeriesEvents"
 type: "interface"
 source: "https://www.amcharts.com/docs/v5/reference/iseriesevents/"
-scraped: "2026-03-15"
+generatedFrom: "@amcharts/amcharts5@5.21.0"
 ---
 
-Inheritance
-
 ## Inheritance
 
 Extends: IComponentEvents
-Extended by: IFlowEvents, IFlowNodesEvents, ILegendEvents, IXYSeriesEvents, IHierarchyEvents, IMapSeriesEvents
+All ancestors: IComponentEvents, IContainerEvents, ISpriteEvents, IEntityEvents
+TypeScript: `am5.ISeriesEvents` (`import type { ISeriesEvents } from "@amcharts/amcharts5"`)
+
+## Events
+
+_(none declared here — all inherited)_
+
+## Other inherited events
+
+Names only — see the declaring interface's page (e.g. `get_api_reference("IComponentEvents")`) for types, defaults and descriptions.
 
-> **Note:** This class also inherits all settings, properties, methods, and events from IComponentEvents (and its ancestors). Use `get_doc` or `get_core_reference` with the parent class name to see inherited members.
+- _IComponentEvents_: datavalidated, valueschanged
+- _ISpriteEvents_: blur, boundschanged, click, dataitemchanged, dblclick, dragged, dragstart, dragstop, focus, globalpointerdown, globalpointermove, globalpointerup, middleclick, pointerdown, pointerout, pointerover, pointerup, positionchanged, rightclick, wheel

package/extended/reference/iseriesprivate.md

@@ -2,37 +2,42 @@
 title: "ISeriesPrivate"
 type: "interface"
 source: "https://www.amcharts.com/docs/v5/reference/iseriesprivate/"
-scraped: "2026-03-15"
+generatedFrom: "@amcharts/amcharts5@5.21.0"
 ---
 
-Inheritance
-
 ## Inheritance
 
 Extends: IComponentPrivate
-Extended by: IFlowPrivate, IFlowNodesPrivate, IPercentSeriesPrivate, ILegendPrivate, IXYSeriesPrivate, IHierarchyPrivate, IMapSeriesPrivate, IVennPrivate, IWordCloudPrivate
+All ancestors: IComponentPrivate, IContainerPrivate, ISpritePrivate, IEntityPrivate
+TypeScript: `am5.ISeriesPrivate` (`import type { ISeriesPrivate } from "@amcharts/amcharts5"`)
+
+## Private settings
 
-> **Note:** This class also inherits all settings, properties, methods, and events from IComponentPrivate (and its ancestors). Use `get_doc` or `get_core_reference` with the parent class name to see inherited members.
+- **chart** (`Chart`) — _(internal)_
+- **startIndex** (`number`)
+- **endIndex** (`number`)
+- **adjustedStartIndex** (`number`)
+- **valueAverage** (`number`) — Average of all data items' values (with `calculateAggregates`).
+- **valueCount** (`number`) — Number of data items with a value (with `calculateAggregates`).
+- **valueSum** (`number`) — Sum of all data items' values (with `calculateAggregates`).
+- **valueAbsoluteSum** (`number`) — Sum of the absolute values of all data items (with `calculateAggregates`).
+- **valueLow** (`number`) — Lowest value of all data items (with `calculateAggregates`).
+- **valueHigh** (`number`) — Highest value of all data items (with `calculateAggregates`).
+- **valueOpen** (`number`) — Value of the first data item that has one (with `calculateAggregates`).
+- **valueClose** (`number`) — Value of the last data item that has one (with `calculateAggregates`).
+- **customValueAverage** (`number`)
+- **customValueCount** (`number`)
+- **customValueSum** (`number`)
+- **customValueAbsoluteSum** (`number`)
+- **customValueLow** (`number`)
+- **customValueHigh** (`number`)
+- **customValueOpen** (`number`)
+- **customValueClose** (`number`)
+- **baseValueSeries** (`Series`)
 
-## Properties
+## Other inherited private settings
 
-- **adjustedStartIndex** (`undefined | number`) — (no description)
-- **baseValueSeries** (`Series`) — (no description)
-- **customValueAbsoluteSum** (`undefined | number`) — (no description)
-- **customValueAverage** (`undefined | number`) — (no description)
-- **customValueClose** (`undefined | number`) — (no description)
-- **customValueCount** (`undefined | number`) — (no description)
-- **customValueHigh** (`undefined | number`) — (no description)
-- **customValueLow** (`undefined | number`) — (no description)
-- **customValueOpen** (`undefined | number`) — (no description)
-- **customValueSum** (`undefined | number`) — (no description)
-- **endIndex** (`undefined | number`) — (no description)
-- **startIndex** (`undefined | number`) — (no description)
-- **valueAbsoluteSum** (`undefined | number`) — (no description)
-- **valueAverage** (`undefined | number`) — (no description)
-- **valueClose** (`undefined | number`) — (no description)
-- **valueCount** (`undefined | number`) — (no description)
-- **valueHigh** (`undefined | number`) — (no description)
-- **valueLow** (`undefined | number`) — (no description)
-- **valueOpen** (`undefined | number`) — (no description)
+Names only — see the declaring interface's page (e.g. `get_api_reference("IContainerPrivate")`) for types, defaults and descriptions.
 
+- _IContainerPrivate_: htmlElement, htmlElementWrapper, wrapperContainer
+- _ISpritePrivate_: customData, deform, focusable, focusElement, focusExcluded, focusOutOfView, height, lastTooltipCoords, list, maxHeight, maxWidth, minHeight, minWidth, showingTooltip, tooltipTarget, touchHovering, trustBounds, visible, width, x, y

package/extended/reference/iseriessettings.md

@@ -2,92 +2,43 @@
 title: "ISeriesSettings"
 type: "interface"
 source: "https://www.amcharts.com/docs/v5/reference/iseriessettings/"
-scraped: "2026-03-15"
+generatedFrom: "@amcharts/amcharts5@5.21.0"
 ---
 
-Inheritance
-ISeriesSettings extends IComponentSettings.
-ISeriesSettings is extended by IFlowSettings, IFlowNodesSettings, IPercentSeriesSettings, ILegendSettings, IXYSeriesSettings, IHierarchySettings, IMapSeriesSettings, IVennSettings, IWordCloudSettings.
-Properties
-
-
-        active        
-        #
-      
-
-
-                          Type undefined | false | true                      
-Inherited from ISpriteSettings
-Indicates if element is currently active.
-
-
-        ariaChecked        
-        #
-      
-
-
-                          Type undefined | false | true                      
-Inherited from ISpriteSettings
-aria-checked setting.
- This setting is ignored unless role is one of the following:
-
-"checkbox"
-
-"option"
-
-"radio"
-
-"menuitemcheckbox"
-
-"menuitemradio"
-
-"treeitem"
-
-
-        ariaControls        
-        #
-      
-
-
-                          Type undefined | string                      
-Inherited from ISpriteSettings
-aria-controls setting.
-
-
-        ariaCurrent        
-        #
-      
-
-
-                          Type undefined | string                      
-Inherited from ISpriteSettings
-aria-current setting.
-
 ## Inheritance
 
 Extends: IComponentSettings
-Extended by: IFlowSettings, IFlowNodesSettings, IPercentSeriesSettings, ILegendSettings, IXYSeriesSettings, IHierarchySettings, IMapSeriesSettings, IVennSettings, IWordCloudSettings
-
-> **Note:** This class also inherits all settings, properties, methods, and events from IComponentSettings (and its ancestors). Use `get_doc` or `get_core_reference` with the parent class name to see inherited members.
-
-## Properties
-
-- **calculateAggregates** (`undefined | false | true`) — If set to true, series will calculate aggregate values, e.g. change percent, high, low, etc. Do not enable unless you are using such aggregate values in tooltips, display data fields, heat rules, or similar.
-- **customValueField** (`undefined | string`) — A key to look up in data for a numeric customValue of the data item. Usually used for storing additional numeric information and heat rules.
-- **excludeFromAggregate** (`Array`) — A list of field names to exclude from automatic aggregation when calculateAggregates is enabled. Use it to optimize performance by disabling automatic aggregation for data fields where aggregate values are not needed. @since 5.14.4
-- **fill** (`Color`) — Series fill color. Click here for more info
-- **fillGradient** (`Gradient`) — *(since 5.20.0)* Series fill gradient.
-- **fillPattern** (`Pattern`) — Series fill pattern. Click here for more info @since 5.10.0
-- **strokeGradient** (`Gradient`) — *(since 5.20.0)* Series stroke gradient.
-- **heatRules** (`IHeatRule[]`) — A list of heat rules to apply on series elements. Click here for more info
-- **idField** (`undefined | string`) — A key to look up in data for an id of the data item.
-- **legendDataItem** (`DataItem`) — A data item representing series in a Legend. @readonly
-- **legendLabelText** (`undefined | string`) — A text template to be used for label in legend.
-- **legendValueText** (`undefined | string`) — A text template to be used for value label in legend.
-- **linkTarget** (`undefined | string`) — Default "_self" Where a data item's URL (see urlField) opens: `"_self"` for the same window, `"_blank"` for a new tab (opened with `noopener`), or a named window / frame. A chart embedded in an iframe usually wants `"_blank"` or `"_top"`. @since 5.20.7
-- **name** (`undefined | string`) — Name of the series.
-- **sequencedDelay** (`undefined | number`) — A delay in milliseconds to wait before starting animation of next data item. Click here for more info
-- **sequencedInterpolation** (`undefined | false | true`) — If set to true the series initial animation will be played item by item rather than all at once. Click here for more info
-- **stroke** (`Color`) — Series stroke color. Click here for more info
-- **urlField** (`undefined | string`) — A key to look up in data for a URL to open when the data item's element (a bullet, column, slice, map polygon or map line) is clicked. Links are off until this is set. Linked elements: bullet sprites of every series; BaseColumnSeries columns (column, candlestick, OHLC, Gantt…); PercentSeries slices (pie, funnel, pyramid, pictorial); Venn slices; MapPolygon; MapLine — not hierarchy nodes, flow nodes/links, word-cloud labels or MapSankey nodes. A linked element gets `cursorOverStyle: "pointer"` unless you set one yourself. Script URLs (`javascript:`, `data:`, `vbscript:`) are never opened. Can be set after the data; a URL added later (e.g. `data.setIndex()`) links too. Clicks go through the public `series.openUrl(dataItem)` method, which opens the data item's `url` in linkTarget — override it to intercept links. @since 5.20.7
-- **valueField** (`undefined | string`) — A key to look up in data for a numeric value of the data item. Some series use it to display its elements. It can also be used in heat rules.
+All ancestors: IComponentSettings, IContainerSettings, ISpriteSettings, IEntitySettings
+Settings of: `am5.Series` (see its page for the class)
+TypeScript: `am5.ISeriesSettings` (`import type { ISeriesSettings } from "@amcharts/amcharts5"`)
+
+## Settings
+
+- **name** (`string`) — Name of the series.
+- **idField** (`string`) — A key to look up in data for an id of the data item.
+- **urlField** (`string`) — A key to look up in data for a URL to open when the data item's element (a bullet, column, slice, map polygon or map line) is clicked. Links are off until this is set. _Since 5.20.7._ _Note:_ Linked elements: bullet sprites of every series, `BaseColumnSeries` columns (column, candlestick, OHLC, Gantt…), `PercentSeries` slices (pie, funnel, pyramid, pictorial), Venn slices, `MapPolygon` (also NightSeries polygons) and `MapLine` — not hierarchy nodes, flow nodes/links, word-cloud labels or MapSankey nodes. A linked element gets `cursorOverStyle: "pointer"` unless you set one yourself. Script URLs (`javascript:`, `data:`, `vbscript:`) are never opened. Can be set after the data; a URL added later (e.g. `data.setIndex()`) links too. Clicks go through the public `series.openUrl(dataItem)` method — override it to intercept links.
+- **linkTarget** (`string`) — default `"_self"` — Where a data item's URL opens: `"_self"` for the same window, `"_blank"` for a new tab, or a named window / frame. A chart embedded in an iframe usually wants `"_blank"` or `"_top"`. _Since 5.20.7._ _Note:_ `"_blank"` opens the page with `noopener`.
+- **valueField** (`string`) — A key to look up in data for a numeric value of the data item. Some series draw their elements by it; heat rules can use it too.
+- **customValueField** (`string`) — A key to look up in data for an extra numeric value of the data item (`customValue`), e.g. for heat rules.
+- **legendLabelText** (`string`) — Text template for the item's label in a `Legend`.
+- **legendValueText** (`string`) — Text template for the item's value label in a `Legend`.
+- **sequencedInterpolation** (`boolean`) — Shows and hides the data items one after another instead of all at once, including in the initial animation. Works in XY and percent series. Docs: https://www.amcharts.com/docs/v5/concepts/animations/#Animation_of_series
+- **sequencedDelay** (`number`) — Extra delay in milliseconds between the animations of consecutive data items, with `sequencedInterpolation`. Docs: https://www.amcharts.com/docs/v5/concepts/animations/#Animation_of_series
+- **heatRules** (`IHeatRule[]`) — Heat rules to apply to the series' elements. A rule without `minValue` and `maxValue` needs `calculateAggregates` to find the value range. Docs: https://www.amcharts.com/docs/v5/concepts/settings/heat-rules/
+- **calculateAggregates** (`boolean`) — Makes the series compute aggregate values, such as sums, averages, lows, highs and changes. Enable it only if they are used, e.g. in tooltips, data fields or heat rules.
+- **stroke** (`Color`) — Series stroke color. Docs: https://www.amcharts.com/docs/v5/charts/xy-chart/series/#Series_colors
+- **fill** (`Color`) — Series fill color. Docs: https://www.amcharts.com/docs/v5/charts/xy-chart/series/#Series_colors
+- **fillPattern** (`Pattern`) — Series fill pattern. _Since 5.10.0._ Docs: https://www.amcharts.com/docs/v5/concepts/colors-gradients-and-patterns/patterns/
+- **fillGradient** (`Gradient`) — Series fill gradient. Docs: https://www.amcharts.com/docs/v5/concepts/colors-gradients-and-patterns/gradients/
+- **strokeGradient** (`Gradient`) — Series stroke gradient. Docs: https://www.amcharts.com/docs/v5/concepts/colors-gradients-and-patterns/gradients/
+- **legendDataItem** (`DataItem<ILegendDataItem>`) — The series' data item in a `Legend`.
+- **excludeFromAggregate** (`string[]`) — Fields to leave out of `calculateAggregates`, to save work where their aggregates are not needed. _Since 5.14.4._
+
+## Other inherited settings
+
+Names only — see the declaring interface's page (e.g. `get_api_reference("IComponentSettings")`) for types, defaults and descriptions.
+
+- _IComponentSettings_: interpolationDuration, interpolationEasing
+- _IContainerSettings_: background, html, interactiveChildren, layout, mask, maskContent, paddingBottom, paddingLeft, paddingRight, paddingTop, reverseChildren, setStateOnChildren, verticalScrollbar
+- _ISpriteSettings_: active, appearDelay, appearDuration, ariaChecked, ariaControls, ariaCurrent, ariaExpanded, ariaHidden, ariaLabel, ariaLive, ariaOrientation, ariaSelected, ariaValueMax, ariaValueMin, ariaValueNow, ariaValueText, autoAppear, blur, brightness, centerX, centerY, clickAnnounceText, contrast, crisp, cursorOverStyle, dateFormatter, disabled, draggable, durationFormatter, dx, dy, exportable, filter, focusable, focusableGroup, forceHidden, forceInactive, height, hoverOnFocus, hue, interactive, invert, isMeasured, layer, layerMargin, marginBottom, marginLeft, marginRight, marginTop, maxHeight, maxWidth, minHeight, minWidth, numberFormatter, opacity, position, role, rotation, saturate, scale, sepia, showTooltipOn, tabindexOrder, templateField, toggleKey, tooltip, tooltipHTML, tooltipPosition, tooltipText, tooltipX, tooltipY, visible, wheelable, width, x, y
+- _IEntitySettings_: animations, id, ignoreThemes, stateAnimationDuration, stateAnimationEasing, themes, themeTags, themeTagsSelf, userData

package/extended/reference/iseriestypecontrolevents.md

@@ -2,13 +2,22 @@
 title: "ISeriesTypeControlEvents"
 type: "interface"
 source: "https://www.amcharts.com/docs/v5/reference/iseriestypecontrolevents/"
-scraped: "2026-03-15"
+generatedFrom: "@amcharts/amcharts5@5.21.0"
 ---
 
-Inheritance
-
 ## Inheritance
 
 Extends: IDropdownListControlEvents
+All ancestors: IDropdownListControlEvents, IStockControlEvents, IEntityEvents
+TypeScript: `am5stock.ISeriesTypeControlEvents` (`import type { ISeriesTypeControlEvents } from "@amcharts/amcharts5/stock"`)
+
+## Events
+
+_(none declared here — all inherited)_
+
+## Other inherited events
+
+Names only — see the declaring interface's page (e.g. `get_api_reference("IDropdownListControlEvents")`) for types, defaults and descriptions.
 
-> **Note:** This class also inherits all settings, properties, methods, and events from IDropdownListControlEvents (and its ancestors). Use `get_doc` or `get_core_reference` with the parent class name to see inherited members.
+- _IDropdownListControlEvents_: selected
+- _IStockControlEvents_: click