IRadialLabelSettings – amCharts 5 Documentation

Type interface

Inheritance

IRadialLabelSettings extends ILabelSettings.

IRadialLabelSettings is extended by IAxisLabelRadialSettings.

Properties

active #	Type `undefined` \| `false` \| `true` Inherited from `ISpriteSettings` Indicates if element is currently active.
background #	Type `Graphics` Inherited from `IContainerSettings` Background element. Click here for more info
baseRadius #	Type `number` \| `Percent` Default `100%` Radius of the label's position. Can be either set in absolute pixel value, or percent. Relative value, depending on the situation, will most often mean its position within certain circular object, like a slice: 0% meaning inner edge, and 100% - the outer edge.
baselineRatio #	Type `undefined` \| `number` Default `0.19` Inherited from `ILabelSettings` How mouch of the height should be considered to go below baseline.
blur #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Apply blur filter. Ranges of values in pixels: `0` to `X`. IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
breakWords #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `ILabelSettings` Whether words can be broken when truncating or wrapping text.
brightness #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Modifty visual brightness. Range of values: `0` to `1`. IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
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.
contrast #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Modify contrast. Range of values: `0` to `1`. 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` 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
direction #	Type `"ltr"` \| `"rtl"` Default `"ltr"` Inherited from `ILabelSettings` Text direction.
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.
ellipsis #	Type `undefined` \| `string` Default `"…"` Inherited from `ILabelSettings` Ellipsis characters to use when truncating text. Will use Unicode ellipsis symbol (`"…"`) by default, which might not be available in all fonts. If ellipsis looks broken, use different characters. E.g.: label.set("ellipsis", "..."); label.set("ellipsis", "...");
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 `ILabelSettings` Text color.
fillGradient #	Type `Gradient` Inherited from `ILabelSettings` Fill gradient. Click here for more information @since 5.10.1
fillOpacity #	Type `undefined` \| `number` Default `1` Inherited from `ILabelSettings` Text opacity. @ince 5.2.39
fontFamily #	Type `undefined` \| `string` Inherited from `ILabelSettings` Font family to use for the label. Multiple fonts can be separated by commas.
fontSize #	Type `string` \| `number` Inherited from `ILabelSettings` Font size in misc any supported CSS format (pixel, point, em, etc.).
fontStyle #	Type `"normal"` \| `"italic"` \| `"oblique"` Inherited from `ILabelSettings` Font style.
fontVariant #	Type `"normal"` \| `"small-caps"` Inherited from `ILabelSettings` Font variant.
fontWeight #	Type `"normal"` \| `"bold"` \| `"bolder"` \| `"lighter"` \| `"100"` \| `"200"` \| `"300"` \| `"400"` \| `"500"` \| `"600"` \| `"700"` \| `"800"` \| `"900"` Inherited from `ILabelSettings` Font weight.
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
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
hue #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Rotate HUE colors in degrees. Range of values: `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 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.
ignoreFormatting #	Type `undefined` \| `false` \| `true` Default `false` Inherited from `ILabelSettings` If set to `true`, will ignore in-line formatting blocks and will display text exactly as it is.
inside #	Type `undefined` \| `false` \| `true` Default `false` Should label be drawn inside (`true`) or outside (`false`) the arc.
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".
invert #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Invert colors. Range of values: `0` (no changes) to `1` (completely 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` Inherited from `ISpriteSettings` If set to `false` element will not be measured and cannot participate in layout schemes.
kerning #	Type `undefined` \| `number` Default `0` Extra spacing between characters, in pixels.
labelAngle #	Type `undefined` \| `number` Label anngle in degrees. In most cases it will be set by the chart/series and does not need to be set manually.
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
lineHeight #	Type `Percent` \| `number` Inherited from `ILabelSettings` Line height in percent or absolute pixels.
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.
maxChars #	Type `undefined` \| `number` Inherited from `ILabelSettings` Maximum number of characters to allow in label. If the `text` is longer than `maxChars`, the text will be truncated using the `breakWords` and `ellipsis` settings. @since 5.7.2
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.
minScale #	Type `undefined` \| `number` Inherited from `ILabelSettings` Minimum relative scale allowed for label when scaling down when `oversizedBehavior` is set to `"fit"`. If fitting the label would require it to scale beyond `minScale` it would be hidden instead.
minWidth #	Type `number` \| `null` Inherited from `ISpriteSettings` Minimum allowed width in pixels.
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 `ILabelSettings` Opacity of the label. 0 - fully transparent; 1 - fully opaque.
orientation #	Type `"inward"` \| `"outward"` \| `"auto"` Default `"auto"` Should the text "face" inward or outward from the arc the text is following. `"auto"` means that facing will be chosen automatically based on the angle to enhance readbility. Only applies if `type = "circluar"`.
oversizedBehavior #	Type `"none"` \| `"hide"` \| `"fit"` \| `"wrap"` \| `"wrap-no-break"` \| `"truncate"` Inherited from `ILabelSettings` How to handle labels that do not fit into its designated space. LIMITATIONS: on circular labels, the only values supported are `"hide"` and `"truncate"`. The latter will ignore `breakWords` setting. 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.
populateText #	Type `undefined` \| `false` \| `true` Inherited from `ILabelSettings` If set to `true` the label will parse `text` for data placeholders and will try to populate them with actual data. Click here for more info
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.
radius #	Type `undefined` \| `number` Pixel value to adjust radius with. Will add to (or subtract from if negative) whatever value `baseRadius` evaluates to.
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.
saturate #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Modify saturation. Range of values in pixels: `0` to `X`. `0` - grayscale `1` - no changes `>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` Inherited from `ISpriteSettings` Scale. Setting to a value less than 1 will shrink object.
sepia #	Type `undefined` \| `number` Inherited from `ISpriteSettings` Apply sepia filter. Range of values: `0` (no changes) to `1` (complete sepia). IMPORTANT: This setting is not supported in Safari browsers. Click here for more info @since 5.5.0
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
shadowBlur #	Type `undefined` \| `number` Inherited from `ILabelSettings` Blurriness of the the shadow. The bigger the number, the more blurry shadow will be. Click here for more info
shadowColor #	Type `Color` \| `null` Inherited from `ILabelSettings` Color of the element's shadow. For this to work at least one of the following needs to be set as well: `shadowBlur`, `shadowOffsetX`, `shadowOffsetY`. Click here for more info
shadowOffsetX #	Type `undefined` \| `number` Inherited from `ILabelSettings` Horizontal shadow offset in pixels. Click here for more info
shadowOffsetY #	Type `undefined` \| `number` Inherited from `ILabelSettings` Vertical shadow offset in pixels. Click here for more info
shadowOpacity #	Type `undefined` \| `number` Inherited from `ILabelSettings` Opacity of the shadow (0-1). If not set, will use the same as `fillOpacity` of the element. 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
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.
templateField #	Type `undefined` \| `string` Inherited from `ISpriteSettings` Allows binding element's settings to data. Click here for more info
text #	Type `undefined` \| `string` Inherited from `ILabelSettings` Labels' text. Click here for text styling info
textAlign #	Type `"start"` \| `"end"` \| `"left"` \| `"right"` \| `"center"` Inherited from `ILabelSettings` Alignment.
textBaseline #	Type `"top"` \| `"hanging"` \| `"middle"` \| `"alphabetic"` \| `"ideographic"` \| `"bottom"` Inherited from `ILabelSettings` A base line to use when aligning text chunks vertically.
textDecoration #	Type `"underline"` \| `"line-through"` Inherited from `ILabelSettings` Text decoration. Supported options `"underline"`, `"line-through"`. @since 5.0.15
textType #	Type `"regular"` \| `"circular"` \| `"radial"` \| `"aligned"` \| `"adjusted"` Default `"regular"` Label type. `"regular"` (default) - normal horizontal label. `"circular"` - arched label. `"radial"` - label radiating from the center of the arc. `"aligned"` - horizontal label aligned with other labels horizontally. `"adjusted"` - horizontal label adjusted in postion. IMPORTANT!** If the label is used in a `PieSeries`, its `alignLabels` setting (default: `true`) takes precedence over `textType`. If you need to set this to anything else than `regular`, make sure you also set `alignLabels: falese` on `PieSeries`.
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.
userData #	Type `any` Inherited from `IEntitySettings` A storage for any custom user data that needs to be associated with the element.
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 100 inherited items currently hidden from this list.