ISankeySettings – amCharts 5 Documentation

Type interface

Inheritance

ISankeySettings extends IFlowSettings.

ISankeySettings is not extended by any other symbol.

Properties

active #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Applies the element's `"active"` state while `true`.
animations #	Type `Array` Inherited from `IEntitySettings` Animations the element plays on its own, described as data - so they can be set from a JSON config and saved with it. Each one animates a setting of the element (or, with `target: "dataItem"`, a value of its data item - a map point's `positionOnLine`, say). They start when the setting is applied, restart when it changes, and stop when the element is disposed. A saved config keeps what was configured, never a value caught half way through an animation. sprite.set("animations", [ { key: "rotation", to: 360, duration: 4000, loops: 0 }, { key: "scale", from: 1, to: 1.3, duration: 800, loops: 0, yoyo: true, easing: "sine" } ]); @since 5.20.8
appearDelay #	Type `undefined` \| `number` Default `0` Inherited from `ISpriteSettings` Milliseconds to wait before the `autoAppear` animation starts. The element stays hidden until then. @since 5.21.0
appearDuration #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Duration of the `autoAppear` animation, in milliseconds. Without it, the element's `stateAnimationDuration` is used. @since 5.21.0
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"` On a toggle `"button"` (one with `toggleKey`) it is exposed as `aria-pressed`.
ariaControls #	Type `undefined` \| `string` Inherited from `ISpriteSettings` `aria-controls` setting.
ariaCurrent #	Type `undefined` \| `string` Inherited from `ISpriteSettings` `aria-current` setting. Click here for more info @since 5.9.8
ariaExpanded #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` `aria-expanded` setting: whether the content the element shows or hides (e.g. a task's subtasks, a node's children) is shown. Click here for more info @since 5.21.0
ariaHidden #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` `aria-hidden` setting.
ariaLabel #	Type `undefined` \| `string` Inherited from `ISpriteSettings` Label for the element to use for screen readers. Click here for more info
ariaLive #	Type `AriaLive` Inherited from `ISpriteSettings` `aria-live` setting.
ariaOrientation #	Type `undefined` \| `string` Inherited from `ISpriteSettings` `aria-orientation` setting.
ariaSelected #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` `aria-selected` setting. Click here for more info @since 5.9.8
ariaValueMax #	Type `undefined` \| `string` Inherited from `ISpriteSettings` `aria-valuemax` setting.
ariaValueMin #	Type `undefined` \| `string` Inherited from `ISpriteSettings` `aria-valuemin` setting.
ariaValueNow #	Type `undefined` \| `string` Inherited from `ISpriteSettings` `aria-valuenow` setting.
ariaValueText #	Type `undefined` \| `string` Inherited from `ISpriteSettings` `aria-valuetext` setting.
autoAppear #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `ISpriteSettings` Plays the element's reveal animation, as `appear()` does, when it is first drawn: a chart fades in, a series grows its columns or lines from the base. A series waits for its first data. It plays once: data updates do not replay it, but turning the setting off and on again does. Elements made from a template play as each one is made. An element that starts hidden (`visible: false`, or hidden in code before it is drawn) stays hidden. An `animations` entry on the same setting, such as a pulsing `opacity`, keeps playing. This is how a JSON config gets the opening animation, as a config cannot call `appear()`. chart.setAll({ autoAppear: true, appearDuration: 1000, appearDelay: 100 }); series.setAll({ autoAppear: true, appearDuration: 1000 }); chart.setAll({ autoAppear: true, appearDuration: 1000, appearDelay: 100 }); series.setAll({ autoAppear: true, appearDuration: 1000 }); Click here for more info @since 5.21.0
background #	Type `Graphics` Inherited from `IContainerSettings` Element drawn behind the container's content, sized to fill the container. Click here for more info
blur #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Blur radius in pixels, from `0` (no blur) up. IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
brightness #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Brightness. `0` - completely black `1` - no changes (default) `>1` - brighter IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
calculateAggregates #	Type `undefined` \| `false` \| `true` Inherited from `ISeriesSettings` 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.
centerX #	Type `number` \| `Percent` Inherited from `ISpriteSettings` The point of the element that is placed at its `x` position, and that it rotates and scales around: pixels from its left edge, or a percent of its width.
centerY #	Type `number` \| `Percent` Inherited from `ISpriteSettings` The point of the element that is placed at its `y` position, and that it rotates and scales around: pixels from its top edge, or a percent of its height.
clickAnnounceText #	Type `undefined` \| `string` Inherited from `ISpriteSettings` If set, the text will be read out (announced) by a screen reader when focused element is "clicked" (by pressing ENTER or SPACE). @since 5.10.8
contrast #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Contrast. `0` - completely gray `1` - no changes (default) `>1` - more contrast IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
crisp #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `ISpriteSettings` Draws the element sharply, with minimal anti-aliasing: its position is rounded to whole pixels, and `strokeWidth` is adjusted to the device pixel ratio, so lines may look thinner than expected. NOTE: it may not work well on several elements that are meant to fit together exactly. @since 5.3.0
cursorOverStyle #	Type `undefined` \| `string` Inherited from `ISpriteSettings` CSS cursor to show while the pointer is over the element, e.g. `"pointer"`. Click here for more info
customValueField #	Type `undefined` \| `string` Inherited from `ISeriesSettings` A key to look up in data for an extra numeric value of the data item (`customValue`), e.g. for heat rules.
dateFormatter #	Type `DateFormatter` \| `undefined` Inherited from `ISpriteSettings` A `DateFormatter` to use for this element instead of the root's. Click here for more info
disabled #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Applies the element's `"disabled"` state while `true`. It changes only the look: the element still responds to the pointer.
draggable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Lets the user drag the element. Touches that start on it no longer scroll the page.
durationFormatter #	Type `DurationFormatter` \| `undefined` Inherited from `ISpriteSettings` A `DurationFormatter` to use for this element instead of the root's. 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.
excludeFromAggregate #	Type `Array` Inherited from `ISeriesSettings` Fields to leave out of `calculateAggregates`, to save work where their aggregates are not needed. @since 5.14.4
exportable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` If `false`, the element is left out of exported images of the chart.
fill #	Type `Color` Inherited from `ISeriesSettings` Series fill color. Click here for more info
fillGradient #	Type `Gradient` Inherited from `ISeriesSettings` Series fill gradient. Click here for more info
fillPattern #	Type `Pattern` Inherited from `ISeriesSettings` Series fill pattern. Click here for more info @since 5.10.0
focusable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Can element be focused, i.e. selected using TAB key. Click here for more info
focusableGroup #	Type `string` \| `number` Inherited from `ISpriteSettings` An identifier by which to group common elements into focusable groups. If set, only the first element in he group will be focusable via TAB key. When it is selected, the rest of the elements in the same group can be selected using arrow keys. It allows users to TAB-through chart elements quickly without the need to TAB into each and every element. It's up to implementer of the charts to provide meaningful `ariaLabel` to the element, which advertises this capability and provides adequate instructions. Click here for more info @since 5.0.6
forceHidden #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Hides the element whatever its `visible` setting, even when `show()` is called.
forceInactive #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Makes the element and its children ignore the pointer, even with `interactive: true` or event listeners set. @since 5.0.21
heatRules #	Type `IHeatRule[]` Inherited from `ISeriesSettings` Heat rules to apply to the series' elements. A rule without `minValue` and `maxValue` needs `calculateAggregates` to find the value range. Click here for more info
height #	Type `number` \| `Percent` \| `null` Inherited 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.
hiddenSize #	Type `undefined` \| `number` Default `0.05` Inherited from `IFlowSettings` Size a hidden link keeps in the layout, as a fraction of its value. Links hide when their node is toggled off with a click (`toggleKey: "disabled"` on nodes); a small size keeps that node visible so it can be clicked back on. Click here for more info @since 5.4.1
hoverOnFocus #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Simulate hover on an element when it gains focus, including changing hover appearance and displaying a tooltip if applicable. Click here for more info
html #	Type `undefined` \| `string` Inherited from `IContainerSettings` HTML content of the container. It can hold data placeholders, such as `{category}`. Click here for more info @since 5.2.11
hue #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Rotates the hue of all colors by this many degrees, from `0` to `360`. IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
id #	Type `undefined` \| `string` Inherited from `IEntitySettings` A unique ID for looking the element up in `root.entitiesById`. Setting an ID that another element already has throws an error.
idField #	Type `undefined` \| `string` Inherited from `ISeriesSettings` A key to look up in data for an id of the data item.
ignoreThemes #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IEntitySettings` Ignores themes: no theme rule applies to the element, not even one of the default theme. @since 5.15.6
interactive #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Makes the element respond to the pointer. Adding a pointer event listener to it turns this on.
interactiveChildren #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `IContainerSettings` Makes every descendant, not just direct children, interactive when the container itself is interactive.
interpolationDuration #	Type `undefined` \| `number` Default `0` Inherited from `IComponentSettings` Duration in milliseconds of the animation from old values to new ones, e.g. when data changes. Click here for more info
interpolationEasing #	Type `$ease.Easing` Inherited from `IComponentSettings` Easing function of the animation from old values to new ones. Click here for more info
invert #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Color inversion, from `0` (no changes) to `1` (fully inverted colors). IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
isMeasured #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `ISpriteSettings` If `false`, the element's bounds are not measured, so it takes no part in its parent's layout or size.
layer #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Layer to draw the element on: elements on higher layers show in front of those on lower ones. If not set, the element is on its parent's layer.
layerMargin #	Type `IMargin` Inherited from `ISpriteSettings` Margins in pixels that make the element's layer larger than the chart, or, when negative, smaller. @since @5.2.39
layout #	Type `Layout` \| `null` Inherited from `IContainerSettings` How children are arranged, e.g. `root.horizontalLayout`, `root.verticalLayout` or `root.gridLayout`. Without a layout, children are placed by their own `x` and `y`. Click here for more info
legendDataItem #	Type `DataItem` Inherited from `ISeriesSettings` The series' data item in a `Legend`. @readonly
legendLabelText #	Type `undefined` \| `string` Inherited from `ISeriesSettings` Text template for the item's label in a `Legend`.
legendValueText #	Type `undefined` \| `string` Inherited from `ISeriesSettings` Text template for the item's value label in a `Legend`.
linkSort #	Type `null` \| ( a: `SankeyLinkMinimal`, b: `SankeyLinkMinimal`) => `number` \| `null` Function that orders the links where they meet a node. `null` keeps the order of the data; when not set, links are ordered by the position of the node at their other end. @since 5.4.4
linkTarget #	Type `undefined` \| `string` Default `"_self"` Inherited from `ISeriesSettings` 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
linkTension #	Type `undefined` \| `number` Default `0.5` Tension of the link curves, from `0` to `1`. `1` makes the links straight between their bend points.
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 whose shape clips the container's children. Click here for more info
maskContent #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` Clips all content that goes outside the container's bounds.
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.
minHiddenValue #	Type `undefined` \| `number` Default `0` Inherited from `IFlowSettings` Smallest value a hidden link shrinks to, whatever `hiddenSize` gives. Click here for more info @since 5.4.1
minSize #	Type `undefined` \| `number` Default `0` Inherited from `IFlowSettings` Smallest size a link is drawn at, as a fraction of the sum of all link values. For example, `0.01` draws every link at least as thick as one holding 1% of the total, so small links and their nodes stay visible. @since 5.1.5
minWidth #	Type `number` \| `null` Inherited from `ISpriteSettings` Minimum allowed width in pixels.
name #	Type `undefined` \| `string` Inherited from `ISeriesSettings` Name of the series.
nodeAlign #	Type `"left"` \| `"right"` \| `"justify"` \| `"center"` Default `"justify"` How nodes are spread across the columns. `"left"` puts each node in the earliest column its links allow, `"right"` in the latest. `"justify"` is like `"left"`, but moves nodes with no outgoing links to the last column; `"center"` is like `"left"`, but moves nodes with no incoming links to the column just before their nearest target.
nodePadding #	Type `undefined` \| `number` Inherited from `IFlowSettings` Gap between adjacent nodes, in pixels: `10` in a `Sankey`, `5` in an `ArcDiagram`. A `Chord` uses `padAngle` instead.
nodeWidth #	Type `undefined` \| `number` Default `10` Inherited from `IFlowSettings` Thickness of the node bars, in pixels. Not used by `ArcDiagram`.
numberFormatter #	Type `NumberFormatter` \| `undefined` Inherited from `ISpriteSettings` A `NumberFormatter` to use for this element instead of the root's. Click here for more info
opacity #	Type `undefined` \| `number` Default `1` Inherited from `ISpriteSettings` Opacity, from `0` (transparent) to `1` (opaque).
orientation #	Type `"horizontal"` \| `"vertical"` Default `"horizontal"` Direction of the flow: `"horizontal"` from left to right, `"vertical"` from top to bottom.
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"` Default `"relative"` Inherited from `ISpriteSettings` Positioning of the element. `"absolute"` leaves the element out of its parent's layout and size: it is placed by its `x` and `y` only.
reverseChildren #	Type `undefined` \| `false` \| `true` Inherited from `IContainerSettings` Lays out the children in reverse order. @since 5.1.1
role #	Type `Role` Inherited from `ISpriteSettings` Element's role. Click here for more info
rotation #	Type `undefined` \| `number` Default `0` Inherited from `ISpriteSettings` Rotation in degrees, clockwise, around the point set by `centerX` and `centerY`.
saturate #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Saturation. `0` - grayscale `1` - no changes (default) `>1` - more saturated IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
scale #	Type `undefined` \| `number` Default `1` Inherited from `ISpriteSettings` Scale, around the point set by `centerX` and `centerY`: below `1` shrinks the element, above `1` enlarges it.
sepia #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Sepia tone, from `0` (no changes) to `1` (full sepia). IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
sequencedDelay #	Type `undefined` \| `number` Inherited from `ISeriesSettings` Extra delay in milliseconds between the animations of consecutive data items, with `sequencedInterpolation`. Click here for more info
sequencedInterpolation #	Type `undefined` \| `false` \| `true` Inherited from `ISeriesSettings` 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. Click here for more info
setStateOnChildren #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `IContainerSettings` Applies every state set on the container to its children too. Click here for more info
showTooltipOn #	Type `"hover"` \| `"always"` \| `"click"` Default `"hover"` Inherited from `ISpriteSettings` When the element's tooltip shows: `"hover"` (default) - while the pointer is over the element, or after a tap on it until a tap elsewhere. `"always"` - all the time. To show tooltips of several elements at once, give each its own `Tooltip` (`tooltip`). `"click"` - after a click or tap on the element, until a click anywhere else on the page. Click here for more info @since 5.0.16
sourceIdField #	Type `undefined` \| `string` Inherited from `IFlowSettings` Field in data that holds the source node's ID.
stateAnimationDuration #	Type `undefined` \| `number` Default `0` Inherited from `IEntitySettings` How long, in milliseconds, a switch from one state to another animates. `0` switches at once.
stateAnimationEasing #	Type `$ease.Easing` Default `out(cubic)` Inherited from `IEntitySettings` Easing of the animated switch from one state to another.
stroke #	Type `Color` Inherited from `ISeriesSettings` Series stroke color. Click here for more info
strokeGradient #	Type `Gradient` Inherited from `ISeriesSettings` Series stroke gradient. Click here for more info
tabindexOrder #	Type `undefined` \| `number` Inherited from `ISpriteSettings` An internal order by which focusable elements will be selected within the chart. Click here for more info
targetIdField #	Type `undefined` \| `string` Inherited from `IFlowSettings` Field in data that holds the target node's ID.
templateField #	Type `undefined` \| `string` Inherited from `ISpriteSettings` Field in the data item's data object that holds settings for this element, applied over its template's. Click here for more info
themeTags #	Type `Array` Inherited from `IEntitySettings` Tags that theme rules can target. They also count for the element's children, so a rule can match a child by a tag of its parent. Click here for more info
themeTagsSelf #	Type `Array` Inherited from `IEntitySettings` Tags that theme rules can target, like `themeTags`, but only for this element, not its children. Click here for more info
themes #	Type `Array` Inherited from `IEntitySettings` Themes applied to the element and everything inside it.
toggleKey #	Type `"disabled"` \| `"active"` \| `"none"` \| `undefined` Inherited from `ISpriteSettings` Setting that a click or tap toggles between `true` and `false`: `"active"` or `"disabled"`. `"none"` turns toggling off.
tooltip #	Type `Tooltip` Inherited from `ISpriteSettings` The `Tooltip` to show for the element. If not set, the nearest parent's is used.
tooltipHTML #	Type `undefined` \| `string` Inherited from `ISpriteSettings` HTML content of the element's tooltip, shown in place of `tooltipText`. @since 5.2.11
tooltipPosition #	Type `"fixed"` \| `"pointer"` Default `"fixed"` Inherited from `ISpriteSettings` Where the tooltip points: `"fixed"` at `tooltipX` and `tooltipY`, or `"pointer"` at the pointer, following it.
tooltipText #	Type `undefined` \| `string` Inherited from `ISpriteSettings` Text of the element's tooltip. It can hold data placeholders, such as `{value}`.
tooltipX #	Type `number` \| `Percent` Default `am5.percent(50)` Inherited from `ISpriteSettings` Where on the element the tooltip points, horizontally: pixels from its left edge, or a percent of its width.
tooltipY #	Type `number` \| `Percent` Default `am5.percent(50)` Inherited from `ISpriteSettings` Where on the element the tooltip points, vertically: pixels from its top edge, or a percent of its height.
urlField #	Type `undefined` \| `string` Inherited from `ISeriesSettings` 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
userData #	Type `any` Inherited from `IEntitySettings` Any data of your own to keep 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 draw their elements by it; heat rules can use it too.
verticalScrollbar #	Type `Scrollbar` Inherited from `IContainerSettings` A `Scrollbar` that scrolls the content vertically when it does not fit in the container. Click here for more info
visible #	Type `undefined` \| `false` \| `true` Default `true` Inherited from `ISpriteSettings` Whether the element is shown. Unlike `show()` and `hide()`, it does not animate.
wheelable #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Makes the element receive mouse wheel events. While the pointer is over it, the wheel no longer scrolls the page.
width #	Type `number` \| `Percent` \| `null` Inherited 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.
x #	Type `number` \| `Percent` \| `null` Inherited from `ISpriteSettings` X position in the parent: pixels from its left edge, or a `Percent` of its inner width, measured from inside its left padding.
y #	Type `number` \| `Percent` \| `null` Inherited from `ISpriteSettings` Y position in the parent: pixels from its top edge, or a `Percent` of its inner height, measured from inside its top padding.
There are 125 inherited items currently hidden from this list.