Type interface
Inheritance
IWavedShape extends Sprite
.
IWavedShape is not extended by any other symbol.
Properties
adapter # |
Type Inherited from Holds Adapter. Click here for more info about Adapters |
---|---|
align # |
Type Inherited from Controls horizontal alignment of the element. This is used by parent |
alwaysShowTooltip # |
Type Default Inherited from DEPRECATION NOTICE: This setting is deprecated in favor of a more flexible setting: Indicates if this element should display a tooltip permanently. Useful, if you want to show permanent tooltips on some items. @since 4.5.4 |
animations # |
Type Inherited from Returns a list elements's animations currently being played. If the list has not been initialized it is created. |
appeared # |
Type Default Inherited from A read-only flag which indicates if a sprite has completed its initial animation (if In case @readonly |
applyOnClones # |
Type Default Inherited from Specifies if property changes on this object should be propagated to the objects cloned from this object. This setting affects property changes *after* cloning, since at the moment of cloning all of properties from source object are copied to the clone anyway. |
baseSprite # |
Type Inherited from Returns the mail chart object that this element belongs to. In most cases it will mean the chart object. Can be used to retrieve chart object in various events and adapters. chart.seriesContainer.events.on("hit", function(ev) { console.log(ev.target.baseSprite); }); chart.seriesContainer.events.on("hit", function(ev) { console.log(ev.target.baseSprite); }); { // ... "seriesContainer": { "events": { "hit": function(ev) { console.log(ev.target.baseSprite); } } } } @readonly |
clickable # |
Type Inherited from Indicates if the element is clickable. Some type of the elements, like buttons are clickable by default. Most of the elements are not clickable by default. Use |
cloneTooltip # |
Type Default Inherited from When cloning a sprite, if the template has it's own tooltip assigned, this tooltip is also cloned by default. This is not good for cpu and sometimes you might only need one single tooltip for all clones. Set this to false in order not to clone tooltip. |
clonedFrom # |
Type Inherited from Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed. |
config # |
Type Inherited from Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc. Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations. |
configField # |
Type Inherited from A field in data context of element's This is a very powerful feature, allowing changing virtually any setting, including those for element's children, for the element via data. Example data: { "value": 100, "config": { "fill": "#F00" } } If you set element's |
contextMenuDisabled # |
Type Default Inherited from Should element prevent context menu to be displayed, e.g. when right-clicked? |
cursorDownStyle # |
Type Inherited from A shortcut to setting mouse cursor when button is pressed down. Example: series.slices.template.cursorDownStyle = am4core.MouseCursorStyle.grabbing; series.slices.template.cursorDownStyle = am4core.MouseCursorStyle.grabbing; { // ... "series": { // ... "slices": { "cursorDownStyle": "grabbing" } } } |
cursorOptions # |
Type Inherited from Returns element's cursor options. Cursor options usually define cursor style for various states of the hovered element. Elements inherit
|
cursorOverStyle # |
Type Inherited from A shortcut to setting mouse cursor on hover. Example: series.slices.template.cursorOverStyle = am4core.MouseCursorStyle.pointer; series.slices.template.cursorOverStyle = am4core.MouseCursorStyle.pointer; { // ... "series": { // ... "slices": { "cursorOverStyle": "pointer" } } } |
dataItem # |
Type Inherited from A @todo Review type |
dateFormatter # |
Type Inherited from A This is used to format dates, e.g. on a date axes, balloons, etc. chart.dateFormatter.dateFormat = "yyyy-MM-dd"; chart.dateFormatter.dateFormat = "yyyy-MM-dd"; { // ... "dateFormatter": { "dateFormat": "yyyy-MM-dd" } } You can set a separate instance of formatter for each individual element. However that would be unnecessary overhead as all elements would automatically inherit formatter from their parents, all the way up to the chart itself.
|
defaultState # |
Type Inherited from Returns a This is a shortcut to |
disabled # |
Type Inherited from Controls if element is disabled. A disabled element is hidden, and is removed from any processing, layout calculations, and generally treated as if it does not exist. The element itself is not destroyed, though. Setting this back to |
dom # |
Type Inherited from Returns DOM element reference associated with this element. @readonly |
draggable # |
Type Inherited from Controls if the element is draggable. |
dummyData # |
Type Inherited from A property which you can use to store any data you want. |
durationFormatter # |
Type Inherited from A This is used to format numbers as durations, e.g. on a value axes. You can set a separate instance of formatter for each individual element. However that would be unnecessary overhead as all elements would automatically inherit formatter from their parents, all the way up to the chart itself.
|
dx # |
Type Inherited from A horizontal offset for the element in pixels. Can be negative value for offset to the left. |
dy # |
Type Inherited from A vertical offset for the element in pixels. Can be negative value for offset upwards. |
element # |
Inherited from The main element for this Sprite, usually an SVG All other sub-elements are created in it. |
events # |
Type Inherited from Event dispatcher. Click here for more info about Events |
exportable # |
Type Default Inherited from If set to |
exporting # |
Type Inherited from An Used to access API of the chart export functionality. If Upon request, if no parent has such instance, a new one is created, using default settings, what in most cases is just enough. Click here for more info about exporting |
fill # |
Type Inherited from Element's fill color or pattern. |
fillModifier # |
Type Inherited from
|
fillOpacity # |
Type Inherited from Element's fill opacity. Opacity ranges from 0 (fully transparent) to 1 (fully opaque). |
filters # |
Inherited from Returns list of SVG filters (effects) applied to element. If the filter list is not yet initilized, creates and returns an empty one. Note, not all filters combine well with one another. We recommend using one filter per sprite. |
focusable # |
Type Default Inherited from Controls if the element can gain focus. Focusable element will be selectable via TAB key. Please note, clicking it with a mouse or touching will not add focus to it. Focused element will show a system-specific highlight, which might ruin the overal look. This is why we don't focus element on click/touch. A default setting varies for different elements. By default all elements are not focusable, except certain items like buttons, legend items, etc. |
globalScale # |
Type Inherited from Returns element's current "global" scale. Scale values accumulate over hierarchy of elements. E.g. if a @readonly |
group # |
Type Inherited from Holds Sprite's main SVG group ( |
height # |
Type Inherited from Element's absolute or relative height. The height can either be absolute, set in numeric pixels, or relative, set in Relative height will be calculated using closest measured ancestor NOTE: |
Type Inherited from If a sprite has |
|
Type Inherited from Returns a This is a shortcut to |
|
hitOptions # |
Type Inherited from Returns Sprite's click (hit) options. Click (hit) options control things like double-click, timeouts, etc.
|
horizontalCenter # |
Type Inherited from Controls which part of the element to treat as a horizontal center. The setting will be used when positioning, resizing and rotating the element. |
hoverOnFocus # |
Type Default Inherited from If set to Useful as an accessibility feature to display rollover tooltips on items selected via keyboard. |
hoverOptions # |
Type Inherited from Returns Sprite's hover options.
|
hoverable # |
Type Default Inherited from Controls if the element is hoverable (hover events are registered). Use |
htmlContainer # |
Type Inherited from An HTML element to be used when placing wrapper element ( This is the same for all elements within the same chart. |
id # |
Type Inherited from Element's user-defined ID. Will throw an Error if there already is an object with the same ID. Please note that above check will be performed withing the scope of the current chart instance. It will not do checks across other chart instances or in globally in DOM. Make sure the IDs are unique. |
inert # |
Type Default Inherited from Controls if the element should use inertia when interacted with. "Inert" element, when dragged and released, will carry the momentum of the movement, and will continue moving in the same drag direction, gradually reducing in speed until finally stops. |
inertiaOptions # |
Type Inherited from Returns element's options to be used for inertia. This setting is inheritable, meaning that if not set directly, it will search in all its ascendants until very top. Inertia is used only if element's "Inert" element, when dragged and released, will carry the momentum of the movement, and will continue moving in the same drag direction, gradually reducing in speed until finally stops. Check |
inited # |
Type Inherited from Returns |
innerHeight # |
Type Inherited from Returns element's measured inner height in pixels. Inner height is actual available space for content, e.g. element's height minus vertical padding. @readonly |
innerWidth # |
Type Inherited from Returns element's measured inner width in pixels. Inner width is actual available space for content, e.g. element's width minus horizontal padding. @readonly |
interactions # |
Type Inherited from Returns (creates if necessary) an |
interactionsEnabled # |
Type Inherited from Setting this to |
isActive # |
Type Inherited from Indicates if this element is currently active (toggled on) or not (toggled off). |
isDown # |
Type Inherited from Indicates if this element has any pointers (mouse or touch) pressing down on it. |
isDragged # |
Type Inherited from Returns indicator if this element is being dragged at the moment. |
isFocused # |
Type Inherited from Indicates if this element is focused (possibly by tab navigation). |
isHidden # |
Type Inherited from If This was added becaus hidden state might have visibility set to true and so there would not be possible to find out if a sprite is technically hidden or not. |
isHiding # |
Type Default Inherited from If |
isHover # |
Type Inherited from Indicates if this element has a mouse pointer currently hovering over it, or if it has any touch pointers pressed on it. You can force element to be "hovered" manually, by setting this property to |
isResized # |
Type Inherited from Returns indicator if this element is being resized at the moment. |
isShowing # |
Type Default Inherited from This property indicates if Sprite is currently being revealed from hidden state. This is used to prevent multiple calls to |
keyboardOptions # |
Type Inherited from Returns elements keyboard options. |
language # |
Type Inherited from A Normally it is enough to set language for the top-most element - chart. All other element child elements will automatically re-use that language object. |
map # |
Type Inherited from Returns a Can be used to retrieve any object by id, e.g.: console.log(mySprite.map.getKey("myid")); console.log(mySprite.map.getKey("myid")); |
marginBottom # |
Type Inherited from Bottom margin - absolute (px) or relative ( |
marginLeft # |
Type Inherited from Left margin - absolute (px) or relative ( |
marginRight # |
Type Inherited from Right margin - absolute (px) or relative ( |
marginTop # |
Type Inherited from Top margin - absolute (px) or relative ( |
maxHeight # |
Type Inherited from Maximum allowed height for the element in pixels. |
maxWidth # |
Type Inherited from Maximum allowed width for the element in pixels. |
measuredHeight # |
Type Inherited from Returns elements's measured height in pixels. A measured height is actual height of contents plus @readonly |
measuredWidth # |
Type Inherited from Returns element's measured width in pixels. A measured width is actual width of contents plus @readonly |
minHeight # |
Type Inherited from Minimum height for the element in pixels. Set to |
minWidth # |
Type Inherited from Minimum width of the element in pixels. Set to |
modal # |
Inherited from Returns a (elements top parent)Accessing modal does not make it appear. To make a modal appear, use
|
mouseOptions # |
Type Inherited from Mouse options. Enables controlling options related to the mouse, for example sensitivity of its mouse wheel. E.g. the below will reduce chart's wheel-zoom speed to half its default speed: chart.plotContainer.mouseOptions.sensitivity = 0.5; chart.plotContainer.mouseOptions.sensitivity = 0.5; { // ... "plotContainer": { "mouseOptions": { "sensitivity": 0.5 } } } |
nonScaling # |
Type Inherited from Controls if element should keep constant size and not scale even if there is space available, or it does not fit. |
nonScalingStroke # |
Type Inherited from Controls if the element's stroke (outline) should remain keep constant thicnkess and do not scale when the whole element is resized. |
numberFormatter # |
Type Inherited from A This is used to format numbers. chart.numberFormatter.numberFormat = "#,###.#####"; chart.numberFormatter.numberFormat = "#,###.#####"; { // ... "numberFormatter": { "numberFormat": "#,###.#####" } } You can set a separate instance of formatter for each individual element. However that would be unnecessary overhead as all elements would automatically inherit formatter from their parents, all the way up to the chart itself.
|
opacity # |
Type Inherited from Element's opacity. Opacity setting can range from 0 (fully transparent) to 1 (fully opaque). ATTENTION: It is highly not recommended to use Instead use methods Or, use properties |
outerHeight # |
Type Inherited from Returns element's measured height plus its top and bottom margins in pixels. @readonly |
outerWidth # |
Type Inherited from Returns element's measured width plus its left and right margins in pixels. @readonly |
paddingBottom # |
Type Inherited from Bottom padding - absolute (px) or relative ( |
paddingLeft # |
Type Inherited from Left padding - absolute (px) or relative ( |
paddingRight # |
Type Inherited from Right padding - absolute (px) or relative ( |
paddingTop # |
Type Inherited from Top padding - absolute (px) or relative ( |
parent # |
Inherited from Elements' parent |
path # |
Type Inherited from Path of Sprite element |
pixelHeight # |
Type Inherited from Returns element's height in pixels. For actual height use measuredHeight property. @readonly |
pixelMarginBottom # |
Type Inherited from Returns current bottom margin in pixels. @readonly |
pixelMarginLeft # |
Type Inherited from Returns current left margin in pixels. @readonly |
pixelMarginRight # |
Type Inherited from Returns current right margin in pixels. @readonly |
pixelMarginTop # |
Type Inherited from Returns current top margin in pixels. @readonly |
pixelPaddingBottom # |
Type Inherited from Returns current bottom padding in pixels. @readonly |
pixelPaddingLeft # |
Type Inherited from Returns current left padding in pixels. @readonly |
pixelPaddingRight # |
Type Inherited from Returns current right padding in pixels. @readonly |
pixelPaddingTop # |
Type Inherited from Returns current top padding in pixels. @readonly |
pixelPerfect # |
Type Inherited from Controls if SVG vectors should be drawn with "pixel" precision, producing perfectly crisp lines on retina displays. Setting this to Different elements use different default setting for We recommend leaving this at their default settings, unless there's a specific need. |
pixelWidth # |
Type Inherited from Returns element's width in pixels, if width was set. For actual width use measuredWidth property. @readonly |
pixelX # |
Type Inherited from Returns element's current absolute X coordinate in pixels. @readonly |
pixelY # |
Type Inherited from Returns element's current absolute Y coordinate in pixels. @readonly |
plugins # |
Type Inherited from A list of plugins (objects that implement @since 4.2.2 |
popups # |
Type Inherited from A list of popups for this chart. |
properties # |
Type Inherited from Holds values for Sprite's properties. |
propertyFields # |
Type Inherited from A collection of key/value pairs that can be used to bind specific Sprite properties to For example: Can be set for each |
readerDescription # |
Type Inherited from Screen reader description of the element. |
readerHidden # |
Type Inherited from Controls if element should be hidden from screen readers. Click here for more information |
readerOrientation # |
Type Inherited from Orientation of the element. @since 4.7.16 |
readerTitle # |
Type Inherited from Screen reader title of the element. |
readerValueNow # |
Type Inherited from Current value of the element. @since 4.7.16 |
readerValueText # |
Type Inherited from Text representation of the current value of the element. @since 4.7.16 |
realFill # |
Type Inherited from A reference to a real fill object. Sometimes might be useful to modify gradient (when fill is color but we have FillModifier). |
realStroke # |
Type Inherited from A reference to a real stroke object. Sometimes might be useful to modify gradient (when fill is color but we have a FillModifier). |
relativeMarginBottom # |
Type Inherited from Returns current relative bottom margin. @readonly |
relativeMarginLeft # |
Type Inherited from Returns current relative left margin. @readonly |
relativeMarginRight # |
Type Inherited from Returns current relative right margin. @readonly |
relativeMarginTop # |
Type Inherited from Returns current relative top margin. @readonly |
relativePaddingBottom # |
Type Inherited from Returns current relative bottom padding. @readonly |
relativePaddingLeft # |
Type Inherited from Returns current relative left padding. @readonly |
relativePaddingRight # |
Type Inherited from Returns current relative right padding. @readonly |
relativePaddingTop # |
Type Inherited from Returns current relative top padding. @readonly |
relativeX # |
Type Inherited from Returns element's current relative X coordinate in |
relativeY # |
Type Inherited from Returns element's current relative Y coordinate in @readonly |
resizable # |
Type Inherited from Indicates if this element is resizable. Enabling resize will turn on various interactions on the element. Their actual functionality will depend on other properties. If the element also If the element is not draggable, resize can be performed with just one point of contact, touch or mouse. Will invoke |
role # |
Type Inherited from A WAI-ARIA role for the element. Click here for more information on WAI-ARIA roles |
rollOutDelay # |
Type Default Inherited from Time in milliseconds after which rollout event happens when user rolls-out of the sprite. This helps to avoid flickering in some cases. |
rotation # |
Type Inherited from Rotation of the element in degrees. (0-360)Note: For convenience purposes, negative values (for counter-clockwise rotation) and values exceeding 360 can also be used. |
rtl # |
Type Inherited from An RTL (right-to-left) setting. RTL may affect alignment, text, and other visual properties. If you set this on a top-level chart object, it will be used for all child elements, e.g. labels, unless they have their own |
scale # |
Type Inherited from Scale of the element. The scale is set from 0 (element reduced to nothing) to 1 (default size).
Etc. |
shapeRendering # |
Type Default Inherited from An SVG-specific Click here for more information about |
shouldClone # |
Type Default Inherited from Indicates whether this sprite should be cloned when cloning its parent container. We set this to |
showOnInit # |
Type Inherited from If this is set to If your "default" state's If you need a Sprite which has |
showSystemTooltip # |
Type Inherited from Indicates whether the element should attempt to construct itself in a way so that system tooltip is shown if its |
showTooltipOn # |
Type Default Inherited from Indicates when tooltip needs to be shown on this element:
For example, if you would like to show tooltips on all of the columns of a series.columns.template.showTooltipOn = "always"; series.columns.template.showTooltipOn = "always"; { // ... "series": [{ // ... "columns": { "showTooltipOn": "always" } }] } It can even be set to display on a selected columns via series.columns.template.propertyFields.showTooltipOn = "tooltip"; series.columns.template.propertyFields.showTooltipOn = "tooltip"; { // ... "series": [{ // ... "columns": { "propertyFields": { "showTooltipOn": "tooltip" } } }] } @since 4.7.9 |
states # |
Type Inherited from Returns a collection of element's available |
stroke # |
Type Inherited from Element's stroke (outline) color or pattern. |
strokeDasharray # |
Type Inherited from A "Dasharray" allows setting rules to make lines dashed, dotted, etc. Click here for more info on |
strokeDashoffset # |
Type Inherited from A "Dashoffset" allows setting the start position of the dashes if Click here for more info on |
strokeLinecap # |
Type Inherited from A Click here for more info on |
strokeLinejoin # |
Type Inherited from A Click here for more info on |
strokeModifier # |
Type Inherited from
|
strokeOpacity # |
Type Inherited from Stroke (outline) opacity. The values may range from 0 (fully transparent) to 1 (fully opaque). |
strokeWidth # |
Type Inherited from Stroke (outline) thickness in pixels. |
svgContainer # |
Type Inherited from HTML container ( Sets HTML container to add SVG and other chart elements to. |
swipeOptions # |
Type Inherited from Returns element's swipe gesture options. |
swipeable # |
Type Inherited from Controls if element is swipeable. Swipable element will invoke Please note that combining swipe and drag is possible, however will incur a slight but noticeable delay in drag start. |
tabindex # |
Type Inherited from Sets or returns TAB index. Tab index maintains the order in which focusable elements gain focus when TAB key is pressed. Please note, tab index is not local to the chart. It affects the whole of the page, including non-SVG elements. Maintain extreme causion when setting tab indexes, as it affects the user experience for the whole web page. |
tension # |
Type |
togglable # |
Type Inherited from Indicates if element can be toggled on and off by subsequent clicks/taps. Togglable element will alternate its |
tooltip # |
Type Inherited from A |
tooltipColorSource # |
Type Inherited from A |
tooltipDataItem # |
Type Inherited from A |
tooltipHTML # |
Type Inherited from An HTML template to be used to populate If element has |
tooltipPosition # |
Type Inherited from Specifies if Position |
tooltipText # |
Type Inherited from A text template to be used to populate Tooltip's contents. If element has This template will also be parsed for any special formatting tags. |
tooltipX # |
Type Inherited from X coordinate the |
tooltipY # |
Type Inherited from Y coordinate the |
trackable # |
Type Inherited from Indicates if the element is trackable (mouse position over it is reported to event listeners). Will invoke Please note, touch devices will also invoke |
uid # |
Type Inherited from Returns object's internal unique ID. |
url # |
Type Inherited from Click-through URL for this element. If set, clicking/tapping this element will open the new URL in a target window/tab as set by Please note that URL will be parsed by data placeholders in curly brackets, to be populated from data. E.g.: series.columns.template.url = "https://www.google.com/search?q={category.urlEncode()}"; series.columns.template.url = "https://www.google.com/search?q={category.urlEncode()}"; { // ... "series": [{ // ... "columns": { "url": "https://www.google.com/search?q={category.urlEncode()}" } }] } |
urlTarget # |
Type Inherited from Target to use for URL clicks:
|
userClassName # |
Type Inherited from A custom class name to set on the element. If set, the value will be added to element's @since 4.9.11 |
valign # |
Type Inherited from Controls vertical alignment of the element. This is used by parent |
verticalCenter # |
Type Inherited from Controls which part of the element to treat as a vertical center. The setting will be used when positioning, resizing and rotating the element. |
visible # |
Type Inherited from Indicates if element is current visible ( |
waveHeight # |
Type |
waveLength # |
Type |
wheelable # |
Type Inherited from Indicates if the element can be interacted with mouse wheel. Will invoke |
width # |
Type Inherited from Element's absolute or relative width. The width can either be absolute, set in numeric pixels, or relative, set in Relative width will be calculated using closest measured ancestor NOTE: |
x # |
Type Inherited from Element's absolute or relative X coordinate. If setting both X and Y, please consider using |
y # |
Type Inherited from Element's absolute or relative Y coordinate. If setting both X and Y, please consider using |
zIndex # |
Type Inherited from A "zIndex" of the element. "zIndex" determines the order of how elements are placed over each other. Higher "zIndex" will mean the element will be draw on top of elements with lower "zIndexes". |
There are 171 inherited items currently hidden from this list. |