com.github.fluorumlabs.disconnect.highcharts

Interface SVGElement

All Superinterfaces:

Any, org.teavm.jso.JSObject

All Known Subinterfaces:

SubtitleObject, TitleObject

public interface SVGElement
extends Any

The SVGElement prototype is a JavaScript wrapper for SVG elements used in the rendering layer of Highcharts. Combined with the Highcharts.SVGRenderer object, these prototypes allow freeform annotation in the charts or even in HTML pages without instanciating a chart. The SVGElement can also wrap HTML labels, when text or label elements are created with the useHTML parameter. The SVGElement instances are created through factory functions on the Highcharts.SVGRenderer object, like rect, path, text, label, g and more.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SVGElement.AnimateComplete
static interface	SVGElement.AttrComplete
static interface	SVGElement.OnHandler

Method Summary

Modifier and Type	Method and Description
SVGElement	add() Add the element to the DOM.
SVGElement	add(SVGElement parent) Add the element to the DOM.
SVGElement	add(SVGElement parent) Add the element to the DOM.
SVGElement	addClass(String className) Add a class name to an element.
SVGElement	addClass(String className, boolean replace) Add a class name to an element.
SVGElement	align() Align the element relative to the chart or another box.
SVGElement	align(AlignObject alignOptions) Align the element relative to the chart or another box.
SVGElement	align(AlignObject alignOptions, boolean alignByTranslate) Align the element relative to the chart or another box.
SVGElement	align(AlignObject alignOptions, boolean alignByTranslate, BBoxObject box) Align the element relative to the chart or another box.
SVGElement	align(AlignObject alignOptions, boolean alignByTranslate, String box) Align the element relative to the chart or another box.
SVGElement	animate(SVGAttributes params) Animate to given attributes or CSS properties.
SVGElement	animate(SVGAttributes params, AnimationOptionsObject options) Animate to given attributes or CSS properties.
SVGElement	animate(SVGAttributes params, AnimationOptionsObject options, SVGElement.AnimateComplete complete) Animate to given attributes or CSS properties.
Unknown	attr() Apply native and custom attributes to the SVG elements.
Unknown	attr(String hash) Apply native and custom attributes to the SVG elements.
Unknown	attr(String hash, String val) Apply native and custom attributes to the SVG elements.
Unknown	attr(String hash, String val, SVGElement.AttrComplete complete) Apply native and custom attributes to the SVG elements.
Unknown	attr(String hash, String val, SVGElement.AttrComplete complete, boolean continueAnimation) Apply native and custom attributes to the SVG elements.
Unknown	attr(SVGAttributes hash, String val, SVGElement.AttrComplete complete, boolean continueAnimation) Apply native and custom attributes to the SVG elements.
SVGElement	clip() Apply a clipping rectangle to this element.
SVGElement	clip(SVGElement clipRect) Apply a clipping rectangle to this element.
RectangleObject	crisp(RectangleObject rect) Calculate the coordinates needed for drawing a rectangle crisply and return the calculated attributes.
RectangleObject	crisp(RectangleObject rect, double strokeWidth) Calculate the coordinates needed for drawing a rectangle crisply and return the calculated attributes.
SVGElement	css(CSSObject styles) Set styles for the element.
void	destroy() Destroy the element and element wrapper and clear up the DOM and event hooks.
void	fadeOut() Fade out an element by animating its opacity down to 0, and hide it on complete.
void	fadeOut(double duration) Fade out an element by animating its opacity down to 0, and hide it on complete.
BBoxObject	getBBox() Get the bounding box (width, height, x and y) for the element.
BBoxObject	getBBox(boolean reload) Get the bounding box (width, height, x and y) for the element.
BBoxObject	getBBox(boolean reload, double rot) Get the bounding box (width, height, x and y) for the element.
Unknown	getElement() The primary DOM node.
SVGRenderer	getRenderer() The renderer that the SVGElement belongs to.
boolean	hasClass(String className) Check if an element has the given class name.
SVGElement	hide() Hide the element, equivalent to setting the visibility attribute to hidden.
void	init(SVGRenderer renderer, String nodeName) Initialize the SVG element.
SVGElement	invert(boolean inverted) Invert a group, rotate and flip.
SVGElement	on(String eventType, SVGElement.OnHandler handler) Add an event listener.
SVGElement	removeClass(RegExp className) Remove a class name from the element.
SVGElement	removeClass(String className) Remove a class name from the element.
void	setElement(HTMLElement value) The primary DOM node.
void	setElement(SVGElement value) The primary DOM node.
SVGElement	setRadialReference(double[] coordinates) Set the coordinates needed to draw a consistent radial gradient across a shape regardless of positioning inside the chart.
void	setRenderer(SVGRenderer value) The renderer that the SVGElement belongs to.
SVGElement	shadow(boolean shadowOptions, SVGElement group, boolean cutOff) Add a shadow to the element.
SVGElement	shadow(ShadowOptionsObject shadowOptions) Add a shadow to the element.
SVGElement	shadow(ShadowOptionsObject shadowOptions, SVGElement group) Add a shadow to the element.
SVGElement	shadow(ShadowOptionsObject shadowOptions, SVGElement group, boolean cutOff) Add a shadow to the element.
SVGElement	show() Show the element after it has been hidden.
SVGElement	show(boolean inherit) Show the element after it has been hidden.
SVGElement	toFront() Bring the element to the front.
void	translate(double x, double y) Move an object and its children by x and y values.

Methods inherited from interface js.lang.Any

empty

Methods inherited from interface org.teavm.jso.JSObject

cast

Method Detail

getElement

Unknown getElement()

The primary DOM node. Each SVGElement instance wraps a main DOM node, but may also represent more nodes.

setElement

void setElement(SVGElement value)

The primary DOM node. Each SVGElement instance wraps a main DOM node, but may also represent more nodes.

setElement

void setElement(HTMLElement value)

The primary DOM node. Each SVGElement instance wraps a main DOM node, but may also represent more nodes.

getRenderer

SVGRenderer getRenderer()

The renderer that the SVGElement belongs to.

setRenderer

void setRenderer(SVGRenderer value)

The renderer that the SVGElement belongs to.

add

SVGElement add()

Add the element to the DOM. All elements must be added this way.

Parameters:

parent - The parent item to add it to. If undefined, the element is added to the Highcharts.SVGRenderer.box.

Returns:

Returns the SVGElement for chaining.

add

SVGElement add(SVGElement parent)

Add the element to the DOM. All elements must be added this way.

Parameters:

parent - The parent item to add it to. If undefined, the element is added to the Highcharts.SVGRenderer.box.

Returns:

Returns the SVGElement for chaining.

add

SVGElement add(SVGElement parent)

Add the element to the DOM. All elements must be added this way.

Parameters:

parent - The parent item to add it to. If undefined, the element is added to the Highcharts.SVGRenderer.box.

Returns:

Returns the SVGElement for chaining.

addClass

SVGElement addClass(String className)

Add a class name to an element.

Parameters:

className - The new class name to add.

replace - When true, the existing class name(s) will be overwritten with the new one. When false, the new one is added.

Returns:

Return the SVG element for chainability.

addClass

SVGElement addClass(String className,
                    boolean replace)

Add a class name to an element.

Parameters:

className - The new class name to add.

replace - When true, the existing class name(s) will be overwritten with the new one. When false, the new one is added.

Returns:

Return the SVG element for chainability.

align

SVGElement align()

Align the element relative to the chart or another box.

Parameters:

alignOptions - The alignment options. The function can be called without this parameter in order to re-align an element after the box has been updated.

alignByTranslate - Align element by translation.

box - The box to align to, needs a width and height. When the box is a string, it refers to an object in the Renderer. For example, when box is spacingBox, it refers to Renderer.spacingBox which holds width, height, x and y properties.

Returns:

Returns the SVGElement for chaining.

align

SVGElement align(AlignObject alignOptions,
                 boolean alignByTranslate,
                 String box)

Align the element relative to the chart or another box.

Parameters:

alignOptions - The alignment options. The function can be called without this parameter in order to re-align an element after the box has been updated.

alignByTranslate - Align element by translation.

box - The box to align to, needs a width and height. When the box is a string, it refers to an object in the Renderer. For example, when box is spacingBox, it refers to Renderer.spacingBox which holds width, height, x and y properties.

Returns:

Returns the SVGElement for chaining.

align

SVGElement align(AlignObject alignOptions,
                 boolean alignByTranslate)

Align the element relative to the chart or another box.

Parameters:

alignOptions - The alignment options. The function can be called without this parameter in order to re-align an element after the box has been updated.

alignByTranslate - Align element by translation.

box - The box to align to, needs a width and height. When the box is a string, it refers to an object in the Renderer. For example, when box is spacingBox, it refers to Renderer.spacingBox which holds width, height, x and y properties.

Returns:

Returns the SVGElement for chaining.

align

SVGElement align(AlignObject alignOptions,
                 boolean alignByTranslate,
                 BBoxObject box)

Align the element relative to the chart or another box.

Parameters:

alignOptions - The alignment options. The function can be called without this parameter in order to re-align an element after the box has been updated.

alignByTranslate - Align element by translation.

box - The box to align to, needs a width and height. When the box is a string, it refers to an object in the Renderer. For example, when box is spacingBox, it refers to Renderer.spacingBox which holds width, height, x and y properties.

Returns:

Returns the SVGElement for chaining.

align

SVGElement align(AlignObject alignOptions)

Align the element relative to the chart or another box.

Parameters:

alignOptions - The alignment options. The function can be called without this parameter in order to re-align an element after the box has been updated.

alignByTranslate - Align element by translation.

box - The box to align to, needs a width and height. When the box is a string, it refers to an object in the Renderer. For example, when box is spacingBox, it refers to Renderer.spacingBox which holds width, height, x and y properties.

Returns:

Returns the SVGElement for chaining.

animate

SVGElement animate(SVGAttributes params,
                   AnimationOptionsObject options,
                   SVGElement.AnimateComplete complete)

Animate to given attributes or CSS properties.

Parameters:

params - SVG attributes or CSS to animate.

options - Animation options.

complete - Function to perform at the end of animation.

Returns:

Returns the SVGElement for chaining.

animate

SVGElement animate(SVGAttributes params,
                   AnimationOptionsObject options)

Animate to given attributes or CSS properties.

Parameters:

params - SVG attributes or CSS to animate.

options - Animation options.

complete - Function to perform at the end of animation.

Returns:

Returns the SVGElement for chaining.

animate

SVGElement animate(SVGAttributes params)

Animate to given attributes or CSS properties.

Parameters:

params - SVG attributes or CSS to animate.

options - Animation options.

complete - Function to perform at the end of animation.

Returns:

Returns the SVGElement for chaining.

attr

Unknown attr()

Apply native and custom attributes to the SVG elements. In order to set the rotation center for rotation, set x and y to 0 and use translateX and translateY attributes to position the element instead. Attributes frequently used in Highcharts are fill, stroke, stroke-width.

Parameters:

hash - The native and custom SVG attributes.

val - If the type of the first argument is string, the second can be a value, which will serve as a single attribute setter. If the first argument is a string and the second is undefined, the function serves as a getter and the current value of the property is returned.

complete - A callback function to execute after setting the attributes. This makes the function compliant and interchangeable with the SVGElement#animate function.

continueAnimation - Used internally when .attr is called as part of an animation step. Otherwise, calling .attr for an attribute will stop animation for that attribute.

Returns:

If used as a setter, it returns the current Highcharts.SVGElement so the calls can be chained. If used as a getter, the current value of the attribute is returned.

attr

Unknown attr(String hash,
             String val,
             SVGElement.AttrComplete complete,
             boolean continueAnimation)

Apply native and custom attributes to the SVG elements. In order to set the rotation center for rotation, set x and y to 0 and use translateX and translateY attributes to position the element instead. Attributes frequently used in Highcharts are fill, stroke, stroke-width.

Parameters:

hash - The native and custom SVG attributes.

val - If the type of the first argument is string, the second can be a value, which will serve as a single attribute setter. If the first argument is a string and the second is undefined, the function serves as a getter and the current value of the property is returned.

complete - A callback function to execute after setting the attributes. This makes the function compliant and interchangeable with the SVGElement#animate function.

continueAnimation - Used internally when .attr is called as part of an animation step. Otherwise, calling .attr for an attribute will stop animation for that attribute.

Returns:

If used as a setter, it returns the current Highcharts.SVGElement so the calls can be chained. If used as a getter, the current value of the attribute is returned.

attr

Unknown attr(String hash,
             String val,
             SVGElement.AttrComplete complete)

Apply native and custom attributes to the SVG elements. In order to set the rotation center for rotation, set x and y to 0 and use translateX and translateY attributes to position the element instead. Attributes frequently used in Highcharts are fill, stroke, stroke-width.

Parameters:

hash - The native and custom SVG attributes.

val - If the type of the first argument is string, the second can be a value, which will serve as a single attribute setter. If the first argument is a string and the second is undefined, the function serves as a getter and the current value of the property is returned.

complete - A callback function to execute after setting the attributes. This makes the function compliant and interchangeable with the SVGElement#animate function.

continueAnimation - Used internally when .attr is called as part of an animation step. Otherwise, calling .attr for an attribute will stop animation for that attribute.

Returns:

If used as a setter, it returns the current Highcharts.SVGElement so the calls can be chained. If used as a getter, the current value of the attribute is returned.

attr

Unknown attr(String hash,
             String val)

Apply native and custom attributes to the SVG elements. In order to set the rotation center for rotation, set x and y to 0 and use translateX and translateY attributes to position the element instead. Attributes frequently used in Highcharts are fill, stroke, stroke-width.

Parameters:

hash - The native and custom SVG attributes.

val - If the type of the first argument is string, the second can be a value, which will serve as a single attribute setter. If the first argument is a string and the second is undefined, the function serves as a getter and the current value of the property is returned.

complete - A callback function to execute after setting the attributes. This makes the function compliant and interchangeable with the SVGElement#animate function.

continueAnimation - Used internally when .attr is called as part of an animation step. Otherwise, calling .attr for an attribute will stop animation for that attribute.

Returns:

If used as a setter, it returns the current Highcharts.SVGElement so the calls can be chained. If used as a getter, the current value of the attribute is returned.

attr

Unknown attr(SVGAttributes hash,
             String val,
             SVGElement.AttrComplete complete,
             boolean continueAnimation)

Apply native and custom attributes to the SVG elements. In order to set the rotation center for rotation, set x and y to 0 and use translateX and translateY attributes to position the element instead. Attributes frequently used in Highcharts are fill, stroke, stroke-width.

Parameters:

hash - The native and custom SVG attributes.

val - If the type of the first argument is string, the second can be a value, which will serve as a single attribute setter. If the first argument is a string and the second is undefined, the function serves as a getter and the current value of the property is returned.

complete - A callback function to execute after setting the attributes. This makes the function compliant and interchangeable with the SVGElement#animate function.

continueAnimation - Used internally when .attr is called as part of an animation step. Otherwise, calling .attr for an attribute will stop animation for that attribute.

Returns:

If used as a setter, it returns the current Highcharts.SVGElement so the calls can be chained. If used as a getter, the current value of the attribute is returned.

attr

Unknown attr(String hash)

Apply native and custom attributes to the SVG elements. In order to set the rotation center for rotation, set x and y to 0 and use translateX and translateY attributes to position the element instead. Attributes frequently used in Highcharts are fill, stroke, stroke-width.

Parameters:

hash - The native and custom SVG attributes.

val - If the type of the first argument is string, the second can be a value, which will serve as a single attribute setter. If the first argument is a string and the second is undefined, the function serves as a getter and the current value of the property is returned.

complete - A callback function to execute after setting the attributes. This makes the function compliant and interchangeable with the SVGElement#animate function.

continueAnimation - Used internally when .attr is called as part of an animation step. Otherwise, calling .attr for an attribute will stop animation for that attribute.

Returns:

If used as a setter, it returns the current Highcharts.SVGElement so the calls can be chained. If used as a getter, the current value of the attribute is returned.

clip

SVGElement clip()

Apply a clipping rectangle to this element.

Parameters:

clipRect - The clipping rectangle. If skipped, the current clip is removed.

Returns:

Returns the SVG element to allow chaining.

clip

SVGElement clip(SVGElement clipRect)

Apply a clipping rectangle to this element.

Parameters:

clipRect - The clipping rectangle. If skipped, the current clip is removed.

Returns:

Returns the SVG element to allow chaining.

crisp

RectangleObject crisp(RectangleObject rect,
                      double strokeWidth)

Calculate the coordinates needed for drawing a rectangle crisply and return the calculated attributes.

Parameters:

rect - Rectangle to crisp.

strokeWidth - The stroke width to consider when computing crisp positioning. It can also be set directly on the rect parameter.

Returns:

The modified rectangle arguments.

crisp

RectangleObject crisp(RectangleObject rect)

Calculate the coordinates needed for drawing a rectangle crisply and return the calculated attributes.

Parameters:

rect - Rectangle to crisp.

strokeWidth - The stroke width to consider when computing crisp positioning. It can also be set directly on the rect parameter.

Returns:

The modified rectangle arguments.

css

SVGElement css(CSSObject styles)

Set styles for the element. In addition to CSS styles supported by native SVG and HTML elements, there are also some custom made for Highcharts, like width, ellipsis and textOverflow for SVG text elements.

Parameters:

styles - The new CSS styles.

Returns:

Return the SVG element for chaining.

destroy

void destroy()

Destroy the element and element wrapper and clear up the DOM and event hooks.

fadeOut

void fadeOut()

Fade out an element by animating its opacity down to 0, and hide it on complete. Used internally for the tooltip.

Parameters:

duration - The fade duration in milliseconds.

fadeOut

void fadeOut(double duration)

Fade out an element by animating its opacity down to 0, and hide it on complete. Used internally for the tooltip.

Parameters:

duration - The fade duration in milliseconds.

getBBox

BBoxObject getBBox(boolean reload,
                   double rot)

Get the bounding box (width, height, x and y) for the element. Generally used to get rendered text size. Since this is called a lot in charts, the results are cached based on text properties, in order to save DOM traffic. The returned bounding box includes the rotation, so for example a single text line of rotation 90 will report a greater height, and a width corresponding to the line-height.

Parameters:

reload - Skip the cache and get the updated DOM bouding box.

rot - Override the element's rotation. This is internally used on axis labels with a value of 0 to find out what the bounding box would be have been if it were not rotated.

Returns:

The bounding box with x, y, width and height properties.

getBBox

BBoxObject getBBox()

Get the bounding box (width, height, x and y) for the element. Generally used to get rendered text size. Since this is called a lot in charts, the results are cached based on text properties, in order to save DOM traffic. The returned bounding box includes the rotation, so for example a single text line of rotation 90 will report a greater height, and a width corresponding to the line-height.

Parameters:

reload - Skip the cache and get the updated DOM bouding box.

rot - Override the element's rotation. This is internally used on axis labels with a value of 0 to find out what the bounding box would be have been if it were not rotated.

Returns:

The bounding box with x, y, width and height properties.

getBBox

BBoxObject getBBox(boolean reload)

Get the bounding box (width, height, x and y) for the element. Generally used to get rendered text size. Since this is called a lot in charts, the results are cached based on text properties, in order to save DOM traffic. The returned bounding box includes the rotation, so for example a single text line of rotation 90 will report a greater height, and a width corresponding to the line-height.

Parameters:

reload - Skip the cache and get the updated DOM bouding box.

rot - Override the element's rotation. This is internally used on axis labels with a value of 0 to find out what the bounding box would be have been if it were not rotated.

Returns:

The bounding box with x, y, width and height properties.

hasClass

boolean hasClass(String className)

Check if an element has the given class name.

Parameters:

className - The class name to check for.

Returns:

Whether the class name is found.

hide

SVGElement hide()

Hide the element, equivalent to setting the visibility attribute to hidden.

Returns:

Returns the SVGElement for chaining.

init

void init(SVGRenderer renderer,
          String nodeName)

Initialize the SVG element. This function only exists to make the initiation process overridable. It should not be called directly.

Parameters:

renderer - The SVGRenderer instance to initialize to.

nodeName - The SVG node name.

invert

SVGElement invert(boolean inverted)

Invert a group, rotate and flip. This is used internally on inverted charts, where the points and graphs are drawn as if not inverted, then the series group elements are inverted.

Parameters:

inverted - Whether to invert or not. An inverted shape can be un-inverted by setting it to false.

Returns:

Return the SVGElement for chaining.

on

SVGElement on(String eventType,
              SVGElement.OnHandler handler)

Add an event listener. This is a simple setter that replaces all other events of the same type, opposed to the Highcharts#addEvent function.

Parameters:

eventType - The event type. If the type is click, Highcharts will internally translate it to a touchstart event on touch devices, to prevent the browser from waiting for a click event from firing.

handler - The handler callback.

Returns:

The SVGElement for chaining.

removeClass

SVGElement removeClass(RegExp className)

Remove a class name from the element.

Parameters:

className - The class name to remove.

Returns:

Returns the SVG element for chainability.

removeClass

SVGElement removeClass(String className)

Remove a class name from the element.

Parameters:

className - The class name to remove.

Returns:

Returns the SVG element for chainability.

setRadialReference

SVGElement setRadialReference(double[] coordinates)

Set the coordinates needed to draw a consistent radial gradient across a shape regardless of positioning inside the chart. Used on pie slices to make all the slices have the same radial reference point.

Parameters:

coordinates - The center reference. The format is [centerX, centerY, diameter] in pixels.

Returns:

Returns the SVGElement for chaining.

shadow

SVGElement shadow(ShadowOptionsObject shadowOptions,
                  SVGElement group)

Add a shadow to the element. Must be called after the element is added to the DOM. In styled mode, this method is not used, instead use defs and filters.

Parameters:

shadowOptions - The shadow options. If true, the default options are applied. If false, the current shadow will be removed.

group - The SVG group element where the shadows will be applied. The default is to add it to the same parent as the current element. Internally, this is ised for pie slices, where all the shadows are added to an element behind all the slices.

cutOff - Used internally for column shadows.

Returns:

Returns the SVGElement for chaining.

shadow

SVGElement shadow(ShadowOptionsObject shadowOptions,
                  SVGElement group,
                  boolean cutOff)

Add a shadow to the element. Must be called after the element is added to the DOM. In styled mode, this method is not used, instead use defs and filters.

Parameters:

shadowOptions - The shadow options. If true, the default options are applied. If false, the current shadow will be removed.

group - The SVG group element where the shadows will be applied. The default is to add it to the same parent as the current element. Internally, this is ised for pie slices, where all the shadows are added to an element behind all the slices.

cutOff - Used internally for column shadows.

Returns:

Returns the SVGElement for chaining.

shadow

SVGElement shadow(boolean shadowOptions,
                  SVGElement group,
                  boolean cutOff)

Add a shadow to the element. Must be called after the element is added to the DOM. In styled mode, this method is not used, instead use defs and filters.

Parameters:

shadowOptions - The shadow options. If true, the default options are applied. If false, the current shadow will be removed.

group - The SVG group element where the shadows will be applied. The default is to add it to the same parent as the current element. Internally, this is ised for pie slices, where all the shadows are added to an element behind all the slices.

cutOff - Used internally for column shadows.

Returns:

Returns the SVGElement for chaining.

shadow

SVGElement shadow(ShadowOptionsObject shadowOptions)

Add a shadow to the element. Must be called after the element is added to the DOM. In styled mode, this method is not used, instead use defs and filters.

Parameters:

shadowOptions - The shadow options. If true, the default options are applied. If false, the current shadow will be removed.

group - The SVG group element where the shadows will be applied. The default is to add it to the same parent as the current element. Internally, this is ised for pie slices, where all the shadows are added to an element behind all the slices.

cutOff - Used internally for column shadows.

Returns:

Returns the SVGElement for chaining.

show

SVGElement show()

Show the element after it has been hidden.

Parameters:

inherit - Set the visibility attribute to inherit rather than visible. The difference is that an element with visibility="visible" will be visible even if the parent is hidden.

Returns:

Returns the SVGElement for chaining.

show

SVGElement show(boolean inherit)

Show the element after it has been hidden.

Parameters:

inherit - Set the visibility attribute to inherit rather than visible. The difference is that an element with visibility="visible" will be visible even if the parent is hidden.

Returns:

Returns the SVGElement for chaining.

toFront

SVGElement toFront()

Bring the element to the front. Alternatively, a new zIndex can be set.

Returns:

Returns the SVGElement for chaining.

translate

void translate(double x,
               double y)

Move an object and its children by x and y values.

Parameters:

x - The x value.

y - The y value.