Class: BoxPlot

• new BoxPlot(options, data)

• new BoxPlot(options?, data?)

Creates box plot

ScaledShape.constructor

▸ addCssClass(cssclass): BoxPlot

Adds new css class to node

BoxPlot

this

ScaledShape.addCssClass

▸ addInvalidateHandler(handler): BoxPlot

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

BoxPlot

this

ScaledShape.addInvalidateHandler

▸ Protected applyOpacity(context): BoxPlot

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

BoxPlot

this

ScaledShape.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

ScaledShape.applyResponsiveStyle

▸ calculateAbsWidth(context): void

calculate model unit width of each component based on the absolute value of box width

void

▸ checkCollision(context): boolean

Check collision

boolean

true if object is inside of rendering area

ScaledShape.checkCollision

▸ clone(): Node

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

Node

clone

ScaledShape.clone

▸ connectStyle(style, type, callback): BoxPlot

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

BoxPlot

this

ScaledShape.connectStyle

▸ Protected copyConstructor(src, deepCopy?): BoxPlot

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

BoxPlot

this

ScaledShape.copyConstructor

▸ disconnectStyle(style, type, callback): BoxPlot

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

BoxPlot

this

ScaledShape.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

ScaledShape.dispose

▸ enableEventPropagation(enable): BoxPlot

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();

BoxPlot

this

ScaledShape.enableEventPropagation

▸ execute(delegate): BoxPlot

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");
});

BoxPlot

The result if any or this

ScaledShape.execute

▸ execute<T>(delegate): T

T

ScaledShape.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

ScaledShape.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

ScaledShape.getAnimationStyle

▸ getBounds(): Rect

get the bounds of model

Rect

current bounds

ScaledShape.getBounds

▸ getClassName(): string

string

ScaledShape.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

ScaledShape.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

ScaledShape.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

ScaledShape.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

ScaledShape.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

ScaledShape.getCssTransform

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

ScaledShape.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

ScaledShape.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

ScaledShape.getInvalidateMethod

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

ScaledShape.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

ScaledShape.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

ScaledShape.getMarginsStyle

▸ getModelLimits(): Rect

get model limits

Rect

current model limits

▸ getName(): string

Returns the node name

string

The node name

ScaledShape.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

ScaledShape.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

ScaledShape.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

ScaledShape.getParent

▸ getProcessedDatasets(): DataSet[]

return processed data sets

DataSet[]

processed data sets

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

properties object

ScaledShape.getProperties

▸ getProperty(name): any

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

any

ScaledShape.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

ScaledShape.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

ScaledShape.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

ScaledShape.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

ScaledShape.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

ScaledShape.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

ScaledShape.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

ScaledShape.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

ScaledShape.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.

ScaledShape.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

ScaledShape.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

ScaledShape.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

ScaledShape.hasEventListener

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

Hit test in the device coordinate

SeriesElementInfo[]

a collection of selected data

▸ invalidate(bounds?, force?): BoxPlot

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

BoxPlot

this

ScaledShape.invalidate

▸ invalidateParent(bounds?, force?): BoxPlot

Invalidate bounds

BoxPlot

this

ScaledShape.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

ScaledShape.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

ScaledShape.isEventPropagationEnabled

▸ isHorizontal(): boolean

get orientation of boxes

boolean

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

ScaledShape.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

ScaledShape.isSelectable

▸ isSilent(): boolean

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

boolean

ScaledShape.isSilent

▸ notify<E>(type, source, args?): BoxPlot

Notify listeners of the Node

BoxPlot

this

ScaledShape.notify

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

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.

BoxPlot

this

ScaledShape.off

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

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.

BoxPlot

this

ScaledShape.on

▸ Protected onParentChanged(node): BoxPlot

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

BoxPlot

this

ScaledShape.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

ScaledShape.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

ScaledShape.postRendering

▸ Protected preRendering(context): void

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

void

ScaledShape.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

ScaledShape.registerAnimationStyle

▸ removeCssClass(cssclass): BoxPlot

Removes css class from node

BoxPlot

this

ScaledShape.removeCssClass

▸ removeInvalidateHandler(handler): BoxPlot

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

BoxPlot

this

ScaledShape.removeInvalidateHandler

▸ render(context): void

Renders node

void

ScaledShape.render

▸ renderAsync(context, callback): void

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

void

ScaledShape.renderAsync

▸ rotate(theta, x, y): BoxPlot

Rotate bounds around a given coordinate

BoxPlot

this

ScaledShape.rotate

▸ scale(xx, yy): BoxPlot

Scale node

BoxPlot

this

ScaledShape.scale

▸ setAnimationStyle(animationStyle): BoxPlot

Sets animation style

BoxPlot

ScaledShape.setAnimationStyle

▸ setClipStyle(style): BoxPlot

Sets a new clipping style

BoxPlot

this

ScaledShape.setClipStyle

▸ setCss(style, merge?): BoxPlot

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

BoxPlot

this

ScaledShape.setCss

▸ setCssClass(name): BoxPlot

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

BoxPlot

this

ScaledShape.setCssClass

▸ setCssTransform(transform): BoxPlot

Set CSS transformation

BoxPlot

this

ScaledShape.setCssTransform

▸ setData(data?): BoxPlot

Sets data to display

BoxPlot

this

▸ setFillStyle(fillStyle, merge?): BoxPlot

Sets fill style

BoxPlot

this

ScaledShape.setFillStyle

▸ setId(id): BoxPlot

Allows the user to associate any identifier

BoxPlot

this

ScaledShape.setId

▸ setLineStyle(lineStyle, merge?): BoxPlot

Sets line style

BoxPlot

this

ScaledShape.setLineStyle

▸ setLocalTransform(localTransform, force?): BoxPlot

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

BoxPlot

this

ScaledShape.setLocalTransform

▸ setMarginsStyle(margins, merge?): BoxPlot

Sets margins style

BoxPlot

this

ScaledShape.setMarginsStyle

▸ setModelLimits(limits): BoxPlot

set model limits

BoxPlot

this

▸ setName(name): BoxPlot

Sets name of the node

BoxPlot

this

ScaledShape.setName

▸ setNotification(notify, force?): BoxPlot

set notification state

BoxPlot

this

ScaledShape.setNotification

▸ setOpacity(opacity, blendMode?): BoxPlot

Sets node opacity

BoxPlot

this

ScaledShape.setOpacity

▸ setOptions(options?): BoxPlot

Sets display options

BoxPlot

this

▸ setProperties(properties?): BoxPlot

Sets properties

BoxPlot

this

ScaledShape.setProperties

▸ setProperty(name, value): BoxPlot

Sets dynamic property by name

BoxPlot

this

ScaledShape.setProperty

▸ setRenderingFilter(filter): BoxPlot

Sets filter to be applied before rendering and picking

BoxPlot

this

ScaledShape.setRenderingFilter

▸ setResponsiveStyle(style): BoxPlot

Sets responsive style.

BoxPlot

this

ScaledShape.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): BoxPlot

Sets scale scroll strategy

BoxPlot

this

ScaledShape.setScaleScrollStrategy

▸ setSelectable(selectable): BoxPlot

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

BoxPlot

this

ScaledShape.setSelectable

▸ setSilent(bool): BoxPlot

Set silent mode

BoxPlot

this

ScaledShape.setSilent

▸ setTag(tag): BoxPlot

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

BoxPlot

this

ScaledShape.setTag

▸ setVisible(value): BoxPlot

Sets visibility of the node. Send event Events.VisibilityChanged

BoxPlot

this

ScaledShape.setVisible

▸ setZIndex(value): BoxPlot

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

BoxPlot

this

ScaledShape.setZIndex

▸ shear(shx, shy): BoxPlot

Shear this node's bounds

BoxPlot

this

ScaledShape.shear

▸ toString(): string

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

string

A string representation

ScaledShape.toString

▸ translate(tx, ty): BoxPlot

Translate bounds

BoxPlot

this

ScaledShape.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

ScaledShape.unregisterAnimationStyle

▸ updateSceneTransformation(): BoxPlot

Update scene transformation

BoxPlot

this

ScaledShape.updateSceneTransformation

▸ updateState(regions?, changes?): BoxPlot

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

BoxPlot

this

ScaledShape.updateState

▸ Protected updateTimeStamp(): BoxPlot

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

BoxPlot

this

ScaledShape.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

ScaledShape.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T>

ScaledShape.findParent

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

Find root of the node with specified type

Node

ScaledShape.findParent

▸ Static getClassName(): string

string

ScaledShape.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

ScaledShape.intersectsBounds

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

ScaledShape.isSceneGraphNotificationEnabled