Type interface
Inheritance
IWordCloudSettings extends ISeriesSettings
.
IWordCloudSettings is not extended by any other symbol.
Properties
active # |
Type Inherited from Indicates if element is currently active. |
---|---|
angles # |
Type An array of possible rotation angles for words. |
animationDuration # |
Type Duration of word animation when chart resizes. |
animationEasing # |
Type Default An easing function to use for word animations. Click here for more info |
autoFit # |
Type Default |
background # |
Type Inherited from Background element. Click here for more info |
blur # |
Type Inherited from Apply blur filter. Ranges of values in pixels: IMPORTANT: This setting is not supported in Safari browsers. Click here for more info |
brightness # |
Type Inherited from Modifty visual brightness. Range of values: IMPORTANT: This setting is not supported in Safari browsers. Click here for more info |
calculateAggregates # |
Type Inherited from If set to Do not enable unless you are using such aggregate values in tooltips, display data fields, heat rules, or similar. |
categoryField # |
Type A field in data that holds category names. |
centerX # |
Type Inherited from X coordinate of the center of the element relative to itself. Center coordinates will affect placement as well as rotation pivot point. |
centerY # |
Type Inherited from Y coordinate of the center of the element relative to itself. Center coordinates will affect placement as well as rotation pivot point. |
colors # |
Type A |
contrast # |
Type Inherited from Modify contrast. Range of values: IMPORTANT: This setting is not supported in Safari browsers. Click here for more info |
crisp # |
Type Default Inherited from If set to It will round x/y position so it is positioned fine "on pixel". It will also adjust 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 Inherited from A named mouse cursor style to show when hovering this element. Click here for more info |
customValueField # |
Type Inherited from 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. |
dateFormatter # |
Type Inherited from An instance of Click here for more info |
disabled # |
Type Inherited from Indicates if element is disabled. |
draggable # |
Type Inherited from If set to |
durationFormatter # |
Type Inherited from An instance of Click here for more info |
dx # |
Type Inherited from Horizontal shift in pixels. Can be negative to shift leftward. |
dy # |
Type Inherited from Vertical shift in pixels. Can be negative to shift upward. |
excludeWords # |
Type Array of words exclude from cloud. |
exportable # |
Type Inherited from If set to |
fill # |
Type Inherited from Series fill color. Click here for more info |
fillField # |
Type A field that holds color for label fill. |
fillPattern # |
Type Inherited from Series fill pattern. Click here for more info |
forceHidden # |
Type Inherited from If set to |
forceInactive # |
Type Inherited from If set to @since 5.0.21 |
heatRules # |
Type Inherited from A list of heat rules to apply on series elements. Click here for more info |
height # |
Type Inherited from Element's absolute height in pixels (numeric value) or relative height to parent ( |
html # |
Type Inherited from HTML content of the container. Click here for more info |
hue # |
Type Inherited from Rotate HUE colors in degrees. Range of values: IMPORTANT: This setting is not supported in Safari browsers. Click here for more info |
id # |
Type Inherited from A custom string ID for the element. If set, element can be looked up via Will raise error if an element with the same ID already exists. |
idField # |
Type Inherited from A key to look up in data for an id of the data item. |
interactive # |
Type Inherited from Should this element accept user interaction events? |
interactiveChildren # |
Type Inherited from If set to |
interpolationDuration # |
Type Inherited from A duration of the animation from one setting value to another, in milliseconds. Click here for more info |
interpolationEasing # |
Type Inherited from Easing function to use for cross setting value animations. Click here for more info |
invert # |
Type Inherited from Invert colors. Range of values: IMPORTANT: This setting is not supported in Safari browsers. Click here for more info |
isMeasured # |
Type Inherited from If set to |
layer # |
Type Inherited from 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 Inherited from Margins for the layer. Can be used to make the layer larger/or smaller than default chart size. @since @5.2.39 |
layout # |
Type Inherited from A method to layout Click here for more info |
legendDataItem # |
Type Inherited from A data item representing series in a @readonly |
legendLabelText # |
Type Inherited from A text template to be used for label in legend. |
legendValueText # |
Type Inherited from A text template to be used for value label in legend. |
marginBottom # |
Type Inherited from Bottom margin in pixels. |
marginLeft # |
Type Inherited from Left margin in pixels. |
marginRight # |
Type Inherited from Right margin in pixels. |
marginTop # |
Type Inherited from Top margin in pixels. |
mask # |
Type Inherited from An element to use as a container's mask (clipping region). Click here for more info |
maskContent # |
Type Inherited from If set to |
maxCount # |
Type Maximum number of words to show. |
maxFontSize # |
Type Absolute or relative font size for the biggest words. |
maxHeight # |
Type Inherited from Maximum allowed height in pixels. |
maxWidth # |
Type Inherited from Maximum allowed width in pixels. |
minFontSize # |
Type Absolute or relative font size for the smallest words. |
minHeight # |
Type Inherited from Minimum allowed height in pixels. |
minValue # |
Type Minimum occurances for a word to be included into cloud. |
minWidth # |
Type Inherited from Minimum allowed width in pixels. |
minWordLength # |
Type Minimum number of characters for a word to be included in the cloud. |
name # |
Type Inherited from Name of the series. |
numberFormatter # |
Type Inherited from An instance of Click here for more info |
opacity # |
Type Inherited from Opacity. 0 - fully transparent; 1 - fully opaque. |
paddingBottom # |
Type Inherited from Bottom padding in pixels. |
paddingLeft # |
Type Inherited from Left padding in pixels. |
paddingRight # |
Type Inherited from Right padding in pixels. |
paddingTop # |
Type Inherited from Top padding in pixels. |
position # |
Type Inherited from Positioning of the element. |
progress # |
Type Progress of current word layout animation. (0-1) @readonly |
randomness # |
Type Randomness of word placement (0-1). |
reverseChildren # |
Type Inherited from If set to @since 5.1.1 |
rotation # |
Type Inherited from Rotation in degrees. |
saturate # |
Type Inherited from Modify saturation. Range of values in pixels:
Click here for more info |
scale # |
Type Inherited from Scale. Setting to a value less than 1 will shrink object. |
sepia # |
Type Inherited from Apply sepia filter. Range of values: IMPORTANT: This setting is not supported in Safari browsers. Click here for more info |
sequencedDelay # |
Type Inherited from A delay in milliseconds to wait before starting animation of next data item. Click here for more info |
sequencedInterpolation # |
Type Inherited from If set to Click here for more info |
setStateOnChildren # |
Type Inherited from If set to Click here for more info |
showTooltipOn # |
Type Default Inherited from Defines when tooltip is shown over the element. Available options:
Click here for more info |
stateAnimationDuration # |
Type Inherited from Duration of transition from one state to another. |
stateAnimationEasing # |
Type Inherited from Easing of transition from one state to another. |
step # |
Type Step for next word placement. |
stroke # |
Type Inherited from Series stroke color. Click here for more info |
templateField # |
Type Inherited from Allows binding element's settings to data. Click here for more info |
text # |
Type Source text from which words are extracted. |
themeTags # |
Type Inherited from Tags which can be used by the theme rules. Click here for more info |
themeTagsSelf # |
Type Inherited from 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 Inherited from A list of themes applied to the element. |
toggleKey # |
Type Inherited from If set, element will toggle specified boolean setting between |
tooltip # |
Type Inherited from
|
tooltipHTML # |
Type Inherited from HTML content to show in a tooltip when hovered. @since 5.2.11 |
tooltipPosition # |
Type Inherited from Tooltip position. |
tooltipText # |
Type Inherited from Text to show in a tooltip when hovered. |
tooltipX # |
Type Inherited from Tooltip pointer X coordinate relative to the element itself. |
tooltipY # |
Type Inherited from Tooltip pointer Y coordinate relative to the element itself. |
userData # |
Type Inherited from A storage for any custom user data that needs to be associated with the element. |
valueField # |
Type Inherited from 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. |
verticalScrollbar # |
Type Inherited from Setting this to an instance of Click here for more info |
visible # |
Type Inherited from Is element visible? |
wheelable # |
Type Inherited from If set to |
width # |
Type Inherited from Element's absolute width in pixels (numeric value) or relative width to parent ( |
x # |
Type Inherited from X position relative to parent. |
y # |
Type Inherited from Y position relative to parent. |
There are 89 inherited items currently hidden from this list. |