Class: TornadoChart

• new TornadoChart(options)

• new TornadoChart(options?)

Shape.constructor

▸ addCssClass(cssclass): TornadoChart

Adds new css class to node

TornadoChart

this

Shape.addCssClass

▸ addInvalidateHandler(handler): TornadoChart

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

TornadoChart

this

Shape.addInvalidateHandler

▸ Protected applyOpacity(context): TornadoChart

This method is called to apply opacity if it is specified on the rendering context. The default implementation sets global alpha on the rendering context

TornadoChart

this

Shape.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

Shape.applyResponsiveStyle

▸ checkCollision(context): boolean

Check if this node is within the area being rendered by the context

boolean

true if object is inside of renderable area

Shape.checkCollision

▸ clone(): Node

All subclasses should override copyConstructor or provide custom implementation for this method

Node

clone

Shape.clone

▸ connectStyle(style, type, callback): TornadoChart

Connects style.

This convenience method subscribes a listener to given style for the specified type.
And automatically un-subscribes listener if node is disposed to prevent memory leaks

TornadoChart

this

Shape.connectStyle

▸ Protected copyConstructor(src, deepCopy?): TornadoChart

Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.

TornadoChart

this

Shape.copyConstructor

▸ disconnectStyle(style, type, callback): TornadoChart

Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.

TornadoChart

this

Shape.disconnectStyle

▸ dispose(): void

Disposes this node, once disposes a node should not be used anymore.
Clear all listeners, and disconnect styles to avoid memory leaks.
Also aggressively 'cleanup' this node by setting some of its members to null.

void

Shape.dispose

▸ enableEventPropagation(enable): TornadoChart

Enable event propagation from the node hierarchy from bottom to top

This option is similar to DOM Event bubbling, which allows to get any event from child node. By default it is disabled for better performance.

Example

import {Group} from '@int/geotoolkit/scene/Group';
import {Events as SceneEvents} from '@int/geotoolkit/scene/Node';
const parentGroup = new Group()
.setName('ParentGroup')
.enableEventPropagation(true);
const childGroup = new Group()
.setName('ChildGroup');

parentGroup.addChild(childGroup);
parentGroup.on(SceneEvents.Invalidate, (eventName, sender, args) => {
// Got notifications from all children of parent group
});
childGroup.invalidate();

TornadoChart

this

Shape.enableEventPropagation

▸ execute(delegate): TornadoChart

Executes delegate and return the result. It allows us to keep all initialization calls in one place,
and we do not need to scroll up or down in IDE to find how and where it was initialized.

Example

// All setters (.setName() for example) returns reference to the this.
// In order to modify inner object like LineStyle or Pattern, to get this object (property) we should call getter to get object reference.
// Then modify it as shown below in Option 1 or you can use execute methods shown in Option 2.
import {Group} from '@int/geotoolkit/scene/Group';
import {Rect} from '@int/geotoolkit/util/Rect';
// Option 1
const group = new Group()
.setName('MyGroup')
.setBounds(new Rect(0, 0, 42, 16))
.enableClipping(true)
.setTag({'type': 'sometype'});

group.getLineStyle().setPattern('pattern');
return group;

// Options 2 ( using execute method )
return group
.execute(function () {
this.getLineStyle()
.setPattern("pattern");
});

TornadoChart

The result if any or this

Shape.execute

▸ execute<T>(delegate): T

T

Shape.execute

▸ Protected filter(context): boolean

Filter node

boolean

flag filter flag ("true" to render node; "false" otherwise)

Shape.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Shape.getAnimationStyle

▸ getAutoGradient(): boolean

get Auto Gradient

boolean

autogradient

▸ getBounds(): Rect

Returns current bounds

Rect

bounds

▸ getClassName(): string

string

Shape.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Shape.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

Shape.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Shape.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Shape.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

Shape.getCssTransform

▸ getDrawLabels(): boolean

gets if we are drawing the labels

boolean

draw

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Shape.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Shape.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

Shape.getInvalidateMethod

▸ getLabelPosition(): number | TextPlacement

gets the location of where the text will be rendered

number | TextPlacement

▸ getLeftFillStyle(): FillStyle

Gets left fill style

FillStyle

fillStyle

▸ getLeftLineStyle(): LineStyle

Gets left line style

LineStyle

lineStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

Shape.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Shape.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

Shape.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits

Rect

the current model limits

▸ getName(): string

Returns the node name

string

The node name

Shape.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

Shape.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Shape.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

Shape.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

Shape.getProperties

▸ getProperty(name): any

Gets dynamic property by name. These properties can be used as a property bags

any

Shape.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Shape.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Shape.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Shape.getResponsiveStyle

▸ getRightFillStyle(): FillStyle

Gets right fill style

FillStyle

fillStyle

▸ getRightLineStyle(): LineStyle

Gets right line style

LineStyle

lineStyle

▸ getRoot(): Node

Returns root node.
If node doesn't have parent then it returns itself.

Node

the root node

Shape.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Shape.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Shape.getSceneTransform

▸ getSort(): string

Gets sort mode

string

sort mode

▸ getSpacing(): number

get spacing percentage between bars

number

spacing

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Shape.getTag

▸ getTicksAndLabels(): Object

gets the ticks and labels for the axis that will be attached via discrete value tick generator

Object

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Shape.getVisible

▸ getWorldTransform(): Transformation

Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.

Transformation

transform the world transform.

Shape.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Shape.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Shape.hasCssClass

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

Shape.hasEventListener

▸ highlightIndices(leftSamples, rightSamples, append?): TornadoChart

Highlight bars for specified sample indices

TornadoChart

this

▸ hitTest(area, radius?): Hits[]

Hit test in the device coordinates

Hits[]

a collection of selected data

▸ invalidate(bounds?, force?): TornadoChart

Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.

TornadoChart

this

Shape.invalidate

▸ invalidateParent(bounds?, force?): TornadoChart

Invalidate bounds

TornadoChart

this

Shape.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Shape.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Shape.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Shape.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Shape.isSelectable

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

Shape.isSilent

▸ notify<E>(event, source, args?): TornadoChart

Notify listeners of the Node

TornadoChart

this

Shape.notify

▸ off<E>(type?, callback?): TornadoChart

Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.

TornadoChart

this

Shape.off

▸ on<E>(type, callback): TornadoChart

Attach listener on event that will be called whenever the specified event is delivered to the target

If the callback function is already in the list of event listeners for this target, the function is not added a second time.

If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.

TornadoChart

this

Shape.on

▸ Protected onParentChanged(node): TornadoChart

This method is called when parent changes. Do not call it directly.

TornadoChart

this

Shape.onParentChanged

▸ Protected onVisibilityChanged(): void

This method is called if visibility is changed. Send event Events.VisibilityChanged

void

Shape.onVisibilityChanged

▸ Protected postRendering(context): void

To be called after rendering. Call this method if you override method render

void

Shape.postRendering

▸ Protected preRendering(context): void

Occurs before rendering this method sets clipping by default. Call this method if you override method render

void

Shape.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

Shape.registerAnimationStyle

▸ removeCssClass(cssclass): TornadoChart

Removes css class from node

TornadoChart

this

Shape.removeCssClass

▸ removeInvalidateHandler(handler): TornadoChart

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

TornadoChart

this

Shape.removeInvalidateHandler

▸ render(context): void

Renders node

void

Shape.render

▸ renderAsync(context, callback): void

Render node in asynchronous mode. Default implementation creates call method "render" inside

void

Shape.renderAsync

▸ rotate(theta, x, y): TornadoChart

Rotate bounds around a given coordinate

TornadoChart

this

Shape.rotate

▸ scale(xx, yy): TornadoChart

Scale node

TornadoChart

this

Shape.scale

▸ setAnimationStyle(animationStyle): TornadoChart

Sets animation style

TornadoChart

Shape.setAnimationStyle

▸ setAutoGradient(autogradient): TornadoChart

set Auto Gradient

TornadoChart

▸ setBounds(bounds): TornadoChart

Sets bounds of the node in the parent coordinates

TornadoChart

▸ setClipStyle(style): TornadoChart

Sets a new clipping style

TornadoChart

this

Shape.setClipStyle

▸ setCss(style, merge?): TornadoChart

Sets CSS style. This style will be applied for all inserted elements

TornadoChart

this

Shape.setCss

▸ setCssClass(name): TornadoChart

Sets css class name of the node to be used to apply CSS style

TornadoChart

this

Shape.setCssClass

▸ setCssTransform(transform): TornadoChart

Set CSS transformation

TornadoChart

this

Shape.setCssTransform

▸ setData(data): TornadoChart

This function is primarily used to set or change the left and right data of the tornado shape. The sort will work only if the left and right data is provided with it. If you want to only sort the data after creating the shape, then use the setSort() function instead.

TornadoChart

▸ setDrawLabels(draw): TornadoChart

sets if we are drawing the labels

TornadoChart

▸ setFillStyle(fillStyle, merge?): TornadoChart

Sets fill style

TornadoChart

this

Shape.setFillStyle

▸ setId(id): TornadoChart

Allows the user to associate any identifier

TornadoChart

this

Shape.setId

▸ setLabelPosition(position): TornadoChart

sets the location of where the text will be rendered

TornadoChart

▸ setLeftFillStyle(fillStyle, merge?): TornadoChart

Sets left fill style

TornadoChart

▸ setLeftLineStyle(lineStyle, merge?): TornadoChart

Sets left line style

TornadoChart

this

▸ setLeftTextStyle(textStyle, merge?): TornadoChart

Sets left text style

TornadoChart

▸ setLineStyle(lineStyle, merge?): TornadoChart

Sets line style

TornadoChart

this

Shape.setLineStyle

▸ setLocalTransform(localTransform, force?): TornadoChart

Sets local transformation to be used to transform from local to parent coordinate

TornadoChart

this

Shape.setLocalTransform

▸ setMarginsStyle(margins, merge?): TornadoChart

Sets margins style

TornadoChart

this

Shape.setMarginsStyle

▸ setName(name): TornadoChart

Sets name of the node

TornadoChart

this

Shape.setName

▸ setNotification(notify, force?): TornadoChart

set notification state

TornadoChart

this

Shape.setNotification

▸ setOpacity(opacity, blendMode?): TornadoChart

Sets node opacity

TornadoChart

this

Shape.setOpacity

▸ setProperties(properties?): TornadoChart

Sets all the properties pertaining to this object

TornadoChart

this

Shape.setProperties

▸ setProperty(name, value): TornadoChart

Sets dynamic property by name

TornadoChart

this

Shape.setProperty

▸ setRenderingFilter(filter): TornadoChart

Sets filter to be applied before rendering and picking

TornadoChart

this

Shape.setRenderingFilter

▸ setResponsiveStyle(style): TornadoChart

Sets responsive style.

TornadoChart

this

Shape.setResponsiveStyle

▸ setRightFillStyle(fillStyle, merge?): TornadoChart

Sets right fill style

TornadoChart

▸ setRightLineStyle(lineStyle, merge?): TornadoChart

Sets right line style

TornadoChart

this

▸ setRightTextStyle(textStyle, merge?): TornadoChart

Sets right text style

TornadoChart

▸ setScaleScrollStrategy(strategy?): TornadoChart

Sets scale scroll strategy

TornadoChart

this

Shape.setScaleScrollStrategy

▸ setSelectable(selectable): TornadoChart

Allows to select node. If node is not selectable then child node is not selectable.

TornadoChart

this

Shape.setSelectable

▸ setSilent(bool): TornadoChart

Set silent mode

TornadoChart

this

Shape.setSilent

▸ setSort(sort): TornadoChart

Sets sort mode

TornadoChart

this

▸ setSpacing(spacing): TornadoChart

set spacing between bars

TornadoChart

▸ setTag(tag): TornadoChart

Allows the user to associate any arbitrary object with the node.

TornadoChart

this

Shape.setTag

▸ setVisible(value): TornadoChart

Sets visibility of the node. Send event Events.VisibilityChanged

TornadoChart

this

Shape.setVisible

▸ setZIndex(value): TornadoChart

Sets z-index for node (set null for default)

TornadoChart

this

Shape.setZIndex

▸ shear(shx, shy): TornadoChart

Shear this node's bounds

TornadoChart

this

Shape.shear

▸ sortData(): void

private

void

▸ toString(): string

Returns a string representation of this object (generally the classname)

string

A string representation

Shape.toString

▸ translate(tx, ty): TornadoChart

Translate bounds

TornadoChart

this

Shape.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

Shape.unregisterAnimationStyle

▸ updateSceneTransformation(): TornadoChart

Update scene transformation

TornadoChart

this

Shape.updateSceneTransformation

▸ updateState(regions?, changes?): TornadoChart

Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph

TornadoChart

this

Shape.updateState

▸ Protected updateTimeStamp(): TornadoChart

Update time stamp to indicate that Node or Children has been changed.

TornadoChart

this

Shape.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

Shape.enableSceneGraphNotification

▸ Static findParent<T>(node, classType, filter?): InstanceType<T>

Find root of the node with specified type

InstanceType<T>

Shape.findParent

▸ Static findParent(node, classType, filter?): Node

Find root of the node with specified type

Node

Shape.findParent

▸ Static getClassName(): string

string

Shape.getClassName

▸ Static intersectsBounds(bounds, localTransformation, parentInvalidArea, expand?): boolean

Check collision of the shape bounds with parent invalid area

boolean

true if bounds intersect the invalid area

Shape.intersectsBounds

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

Shape.isSceneGraphNotificationEnabled