IPictorialStackedSeriesSettings – amCharts 5 Documentation

Type interface

Inheritance

IPictorialStackedSeriesSettings extends IPyramidSeriesSettings.

IPictorialStackedSeriesSettings is not extended by any other symbol.

Properties

active #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Indicates if element is currently active.
alignLabels #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IFunnelSeriesSettings` Should labels be aligned into columns/rows?
background #	Type `Graphics` Inherited from `IContainerSettings` Background element. Click here for more info
bottomRatio #	Type `undefined` \| `number` Default `1` Inherited from `IFunnelSeriesSettings` Width of the bottom edge of the slice relative to the top edge of the next slice. `1` - means the full width of the slice, resulting in a rectangle. `0` - means using width of the next slice, resulting in a trapezoid. Click here for more info
bottomWidth #	Type `number` \| `Percent` Default `0` Inherited from `IPyramidSeriesSettings` The width of the base of the pyramid. Can either be a fixed pixel value or percent relative to the space available to the series. Click here for more info
calculateAggregates #	Type `undefined` \| `false` \| `true` Inherited from `ISeriesSettings` 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.
categoryField #	Type `undefined` \| `string` Inherited from `IPercentSeriesSettings` A field in data that holds category names.
centerX #	Type `number` \| `Percent` Inherited from `ISpriteSettings` X coordinate of the center of the element relative to itself. Center coordinates will affect placement as well as rotation pivot point.
centerY #	Type `number` \| `Percent` Inherited from `ISpriteSettings` Y coordinate of the center of the element relative to itself. Center coordinates will affect placement as well as rotation pivot point.
colors #	Type `ColorSet` Inherited from `IPercentSeriesSettings` A `ColorSet` to use when asigning colors for slices.
crisp #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `ISpriteSettings` If set to `true`, an element will try to draw itself in such way, that it looks crisp on screen, with minimal anti-aliasing. It will round x/y position so it is positioned fine "on pixel". It will also adjust `strokeWidth` based on device pixel ratio or zoom, so the line might look thinner than expected. NOTE: this is might not universally work, especially when set on several objects that are supposed to fit perfectly with each other. @since 5.3.0
cursorOverStyle #	Type `undefined` \| `string` Inherited from `ISpriteSettings` A named mouse cursor style to show when hovering this element. Click here for more info
dateFormatter #	Type `DateFormatter` \| `undefined` Inherited from `ISpriteSettings` An instance of `DateFormatter` that should be used instead of global formatter object. Click here for more info
disabled #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Indicates if element is disabled.
draggable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `true`, user will be able to drag this element. It will also disable default drag events over the area of this element.
durationFormatter #	Type `DurationFormatter` \| `undefined` Inherited from `ISpriteSettings` An instance of `DurationFormatter` that should be used instead of global formatter object. Click here for more info
dx #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Horizontal shift in pixels. Can be negative to shift leftward.
dy #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Vertical shift in pixels. Can be negative to shift upward.
endLocation #	Type `undefined` \| `number` Default `0` Inherited from `IFunnelSeriesSettings` Relative location within area available to series where it should start. `0` - beginning, `1` - end, or any intermediate value. Click here for more info
exportable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `false` this element will not appear in exported snapshots of the chart.
fill #	Type `Color` Inherited from `ISeriesSettings` Series fill color. Click here for more info
fillField #	Type `undefined` \| `string` Inherited from `IPercentSeriesSettings` A field that holds color for slice fill.
forceHidden #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `true` the element will be hidden regardless of `visible` or even if `show()` is called.
forceInactive #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `true` the element will be inactive - absolutely oblivious to all interactions, even if there are related events set, or the `interactive: true` is set. @since 5.0.21
heatRules #	Type `IHeatRule[]` Inherited from `ISeriesSettings` A list of heat rules to apply on series elements. Click here for more info
height #	Type `number` \| `Percent` \| `null` Inherited from `ISpriteSettings` Element's absolute height in pixels (numeric value) or relative height to parent (`Percent`);
html #	Type `undefined` \| `string` Inherited from `IContainerSettings` HTML content of the container. Click here for more info @since 5.2.11
id #	Type `undefined` \| `string` Inherited from `IEntitySettings` A custom string ID for the element. If set, element can be looked up via `am5.registry.entitiesById`. Will raise error if an element with the same ID already exists.
idField #	Type `undefined` \| `string` Inherited from `ISeriesSettings` A key to look up in data for an id of the data item.
ignoreZeroValues #	Type `undefined` \| `false` \| `true` Inherited from `IFunnelSeriesSettings` If set to `true`, series will not create slices for data items with zero value.
interactive #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Should this element accept user interaction events?
interactiveChildren #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` If set to `true` all descendants - not just direct children, but every element in it - will become "interactive".
interpolationDuration #	Type `undefined` \| `number` Inherited from `IComponentSettings` A duration of the animation from one setting value to another, in milliseconds. Click here for more info
interpolationEasing #	Type `$ease.Easing` Inherited from `IComponentSettings` Easing function to use for cross setting value animations. Click here for more info
isMeasured #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `false` element will not be measured and cannot participate in layout schemes.
layer #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Numeric layer to put element in. Elements with higher number will appear in front of the ones with lower numer. If not set, will inherit layer from its ascendants.
layerMargin #	Type `IMargin` Inherited from `ISpriteSettings` Margins for the layer. Can be used to make the layer larger/or smaller than default chart size. @since @5.2.39
layout #	Type `Layout` \| `null` Inherited from `IContainerSettings` A method to layout Click here for more info
legendDataItem #	Type `DataItem` Inherited from `ISeriesSettings` A data item representing series in a `Legend`. @readonly
legendLabelText #	Type `undefined` \| `string` Inherited from `ISeriesSettings` A text template to be used for label in legend.
legendValueText #	Type `undefined` \| `string` Inherited from `ISeriesSettings` A text template to be used for value label in legend.
marginBottom #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Bottom margin in pixels.
marginLeft #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Left margin in pixels.
marginRight #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Right margin in pixels.
marginTop #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Top margin in pixels.
mask #	Type `Graphics` \| `null` Inherited from `IContainerSettings` An element to use as a container's mask (clipping region). Click here for more info
maskContent #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` If set to `true` all content going outside the bounds of the container will be clipped.
maxHeight #	Type `number` \| `null` Inherited from `ISpriteSettings` Maximum allowed height in pixels.
maxWidth #	Type `number` \| `null` Inherited from `ISpriteSettings` Maximum allowed width in pixels.
minHeight #	Type `number` \| `null` Inherited from `ISpriteSettings` Minimum allowed height in pixels.
minWidth #	Type `number` \| `null` Inherited from `ISpriteSettings` Minimum allowed width in pixels.
name #	Type `undefined` \| `string` Inherited from `ISeriesSettings` Name of the series.
numberFormatter #	Type `NumberFormatter` \| `undefined` Inherited from `ISpriteSettings` An instance of `NumberFormatter` that should be used instead of global formatter object. Click here for more info
opacity #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Opacity. 0 - fully transparent; 1 - fully opaque.
orientation #	Type `"horizontal"` \| `"vertical"` Default `"vertical"` Inherited from `IFunnelSeriesSettings` Orientation of the series. Click here for more info
paddingBottom #	Type `undefined` \| `number` Inherited from `IContainerSettings` Bottom padding in pixels.
paddingLeft #	Type `undefined` \| `number` Inherited from `IContainerSettings` Left padding in pixels.
paddingRight #	Type `undefined` \| `number` Inherited from `IContainerSettings` Right padding in pixels.
paddingTop #	Type `undefined` \| `number` Inherited from `IContainerSettings` Top padding in pixels.
position #	Type `"absolute"` \| `"relative"` Inherited from `ISpriteSettings` Positioning of the element. `"absolute"` means element will not participate in parent layout scheme, and will be positioned solely accoridng its `x` and `y` settings.
reverseChildren #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` If set to `true` its children will be laid out in opposite order. @since 5.1.1
rotation #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Rotation in degrees.
scale #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Scale. Setting to a value less than 1 will shrink object.
sequencedDelay #	Type `undefined` \| `number` Inherited from `ISeriesSettings` A delay in milliseconds to wait before starting animation of next data item. Click here for more info
sequencedInterpolation #	Type `undefined` \| `false` \| `true` Inherited from `ISeriesSettings` If set to `true` the series initial animation will be played item by item rather than all at once. Click here for more info
setStateOnChildren #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` If set to `true`, applying a state on a container will also apply the same state on its children. Click here for more info
showTooltipOn #	Type `"hover"` \| `"always"` \| `"click"` Default `"hover"` Inherited from `ISpriteSettings` Defines when tooltip is shown over the element. Available options: `"hover"` (default) - tooltip is shown when element is hovered by a pointer or touched. It is hidden as soon as element is not hovered anymore, or touch occurs outside it. `"always"` - a tooltip will always be shown over the element, without any interactions. Please note that if you need to show tooltips for multiple elements at the same time, you need to explicitly create a `Tooltip` instance and set element's `tooltip` setting with it. '"click"' - a tooltip will only appear when target element is clicked/tapped. Tooltip will hide when clicking anywhere else on the page. Click here for more info @since 5.0.16
startLocation #	Type `undefined` \| `number` Default `0` Inherited from `IFunnelSeriesSettings` Relative location within area available to series where it should start. `0` - beginning, `1` - end, or any intermediate value. Click here for more info
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.
stroke #	Type `Color` Inherited from `ISeriesSettings` Series stroke color. Click here for more info
svgPath #	Type `undefined` \| `string` An SVG path that will define the shape of the pictorial series. Click here for more info
templateField #	Type `undefined` \| `string` Inherited from `ISpriteSettings` Allows binding element's settings to data. Click here for more info
themeTags #	Type `Array` Inherited from `IEntitySettings` Tags which can be used by the theme rules. Click here for more info
themeTagsSelf #	Type `Array` Inherited from `IEntitySettings` Tags which can be used by the theme rules. These tags only apply to this object, not any children. Click here for more info
themes #	Type `Array` Inherited from `IEntitySettings` A list of themes applied to the element.
toggleKey #	Type `"disabled"` \| `"active"` \| `"none"` \| `undefined` Inherited from `ISpriteSettings` If set, element will toggle specified boolean setting between `true` and `false` when clicked/touched.
tooltip #	Type `Tooltip` Inherited from `ISpriteSettings` `Tooltip` instance.
tooltipHTML #	Type `undefined` \| `string` Inherited from `ISpriteSettings` HTML content to show in a tooltip when hovered. @since 5.2.11
tooltipPosition #	Type `"fixed"` \| `"pointer"` Inherited from `ISpriteSettings` Tooltip position.
tooltipText #	Type `undefined` \| `string` Inherited from `ISpriteSettings` Text to show in a tooltip when hovered.
tooltipX #	Type `number` \| `Percent` Inherited from `ISpriteSettings` Tooltip pointer X coordinate relative to the element itself.
tooltipY #	Type `number` \| `Percent` Inherited from `ISpriteSettings` Tooltip pointer Y coordinate relative to the element itself.
topWidth #	Type `number` \| `Percent` Default `0` Inherited from `IPyramidSeriesSettings` The width of the tip of the pyramid. Can either be a fixed pixel value or percent relative to the space available to the series. Click here for more info
userData #	Type `any` Inherited from `IEntitySettings` A storage for any custom user data that needs to be associated with the element.
valueField #	Type `undefined` \| `string` Inherited from `ISeriesSettings` 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.
valueIs #	Type `"area"` \| `"height"` Default `"area"` Inherited from `IPyramidSeriesSettings` Determines calculation mechanism for the slice area based on value. Click here for more info
verticalScrollbar #	Type `Scrollbar` Inherited from `IContainerSettings` Setting this to an instance of `Scrollbar` will enable vertical scrolling of content if it does not fit into the Container. Click here for more info
visible #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Is element visible?
wheelable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If set to `true`, mouse wheel events will be triggered over the element. It will also disable page scrolling using mouse wheel when pointer is over the element.
width #	Type `number` \| `Percent` \| `null` Inherited from `ISpriteSettings` Element's absolute width in pixels (numeric value) or relative width to parent (`Percent`);
x #	Type `number` \| `Percent` \| `null` Inherited from `ISpriteSettings` X position relative to parent.
y #	Type `number` \| `Percent` \| `null` Inherited from `ISpriteSettings` Y position relative to parent.
There are 92 inherited items currently hidden from this list.