Class: AbstractChart

• [new AbstractChart(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.charts.abstractchart.abstractchart.md#new abstractchart(options))

• Protected new AbstractChart(options?)

Abstract chart shape used as a base for predefined geotoolkit/charts/widgets/ChartWidget charts.

AbstractNode.constructor

▸ addCssClass(cssclass): AbstractChart

Adds new css class to node

AbstractChart

this

AbstractNode.addCssClass

▸ addInvalidateHandler(handler): AbstractChart

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

AbstractChart

this

AbstractNode.addInvalidateHandler

▸ Protected applyOpacity(context): AbstractChart

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

AbstractChart

this

AbstractNode.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

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

AbstractNode.checkCollision

▸ clone(): Node

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

Node

clone

AbstractNode.clone

▸ connectStyle(style, type, callback): AbstractChart

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

AbstractChart

this

AbstractNode.connectStyle

▸ Protected copyConstructor(src, deepCopy?): AbstractChart

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

AbstractChart

this

AbstractNode.copyConstructor

▸ Protected createLegendItem(series, item?): ToggleableSymbolItem

Creates legend item based on series or updating options based on item passed

ToggleableSymbolItem

▸ Protected createTooltipSymbol(series, index?): TooltipSymbolOptions

Gets tooltip series symbol

TooltipSymbolOptions

html to represent tooltip symbol

▸ disconnectStyle(style, type, callback): AbstractChart

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

AbstractChart

this

AbstractNode.disconnectStyle

▸ dispose(): void

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

void

AbstractNode.dispose

▸ enableEventPropagation(enable): AbstractChart

Enable event propagation from the node hierarchy from bottom to top <p> 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. </p>

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

AbstractChart

this

AbstractNode.enableEventPropagation

▸ execute(delegate): AbstractChart

Executes delegate and return the result. It allows us to keep all initialization calls in one place, <br> 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");
});

AbstractChart

The result if any or this

AbstractNode.execute

▸ execute<T&gt;(delegate): T

T

AbstractNode.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

AbstractNode.filter

▸ formatTooltipItem(item, tooltip?): string

Format tooltip item

string

tooltip content for specified tooltip item

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AbstractNode.getAnimationStyle

▸ getAnnotationOffset(): number | SpaceStyle<string | number&gt;

Returns device space to be added to annotations surrounding chart. Might be used for axes-overlapping visuals.

number | SpaceStyle<string | number&gt;

▸ getAxis(dimension): string

Returns axis identifier for provided dimension if exists, null otherwise

string

▸ getAxisDataType(dimension): DataType

Returns axis data type for the provided dimension

DataType

▸ getCachedOverlay(): CompositeNode<Node&gt;

Returns overlay node to be layered over the chart

CompositeNode<Node&gt;

▸ getClassName(): string

string

AbstractNode.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

AbstractNode.getClipStyle

▸ getColorValue(seriesId, sample): number

Returns color value for provided sample to be shared via color axis

number

▸ getCss(): CssStyle

Return CSS style

CssStyle

AbstractNode.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AbstractNode.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AbstractNode.getCssClasses

▸ Protected getCssSeries(): Node[]

Returns css series to handle the chart

Node[]

▸ getCssTransform(): string

Returns CSS transformation

string

AbstractNode.getCssTransform

▸ getDataLimits(): Rect

Returns chart shape limits

Rect

chart shape limits

▸ getDataSeries(name): INumericalDataSeries & AbstractDataSeries<any&gt;

Returns data series from data source after all the checks and manipulations

INumericalDataSeries & AbstractDataSeries<any&gt;

▸ getDataSeries(name, dimension): NumericalDataSeries

Returns data series from data source after all the checks and manipulations

NumericalDataSeries

▸ Protected getDataSource(): DataSource

Returns chart data source

DataSource

▸ getDesiredModelRange(dimension): Range

Returns desired (default) model range for the chart along provided dimension

Range

▸ getDesiredOffset(): number | SpaceStyle<string | number&gt;

Returns device space to be added to chart model limits. Might be used to layout device-spaced shapes.

number | SpaceStyle<string | number&gt;

▸ getDesiredTickGenerator(dimension): TickGenerator

Returns desired for current chart tick generator

TickGenerator

instance of tick generator

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

AbstractNode.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher&gt;

Gets invalidate method

AttributeCallback<EventDispatcher&gt;

method to invalidate this object

AbstractNode.getInvalidateMethod

▸ getLegendItems(type?): ToggleableSymbolItem[]

Returns array of chart legend items to be added to the chart legend

ToggleableSymbolItem[]

▸ Protected getLegendTitle(props, type?): string

Returns formatted legend title

string

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

AbstractNode.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number&gt;

Return margins style

SpaceStyle<string | number&gt;

AbstractNode.getMarginsStyle

▸ getModelLimits(): Rect

Returns model limits, the limits of this chart inside space

Rect

▸ getName(): string

Returns the node name

string

The node name

AbstractNode.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

AbstractNode.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

AbstractNode.getOpacityBlendMode

▸ getOrientation(): ChartOrientation

Returns chart orientation

ChartOrientation

▸ getOverlay(): CompositeNode<Node&gt;

Returns overlay node to be layered over the chart

CompositeNode<Node&gt;

▸ getParent(): Node

Return parent node

Node

parent node

AbstractNode.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

AbstractNode.getProperties

▸ getProperty(name): any

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

any

AbstractNode.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractNode.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

AbstractNode.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

AbstractNode.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

AbstractNode.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

AbstractNode.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AbstractNode.getSceneTransform

▸ getSelectionId(): string

Returns identifier for shared selection series

string

▸ Protected getSeriesForLegend(): Series[]

Returns series for generate legend items

Series[]

▸ getSeriesInfo(id): Series | Series[]

Series | Series[]

▸ getSeriesInfo(id): Series

Series

▸ getSeriesValue(name, sample): string | number | number[]

Returns value for specific series and sample

string | number | number[]

▸ getSymbolShape(sample): SymbolShape

Returns symbol shape for current sample to be shared via crosshair tool

SymbolShape

sample symbol

▸ getTableId(): string

Returns table identifier for series

string

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AbstractNode.getTag

▸ Protected getTooltipFormat(): string | TooltipFormat

Returns tooltip format callback if exists

string | TooltipFormat

▸ getTooltipItems(selection): TooltipItem[]

Enumerate tooltip items to be used if custom tooltip formatter is not specified

TooltipItem[]

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

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

AbstractNode.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AbstractNode.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AbstractNode.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractNode.hasEventListener

▸ hitTest(area, radius?): Hits

Returns selection info with selected samples and series identifier. If chart is not selected, returns provided merge object or null if nothing provided

Hits

▸ Protected initialize(options): AbstractChart

Initializes listeners and styles after creating

AbstractChart

this

▸ invalidate(bounds?, force?): AbstractChart

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

AbstractChart

this

AbstractNode.invalidate

▸ Protected invalidateParent(bounds?, force?): AbstractChart

Invalidate parent and notify all listeners. NOTE: Don't keep arguments of the event, because instance can be changed

Fires

Events.Invalidate

AbstractChart

this

AbstractNode.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractNode.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

AbstractNode.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

AbstractNode.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

AbstractNode.isSelectable

▸ isSilent(): boolean

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

boolean

AbstractNode.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

▸ notify<E&gt;(type, source, args?): AbstractChart

Notify listeners of the Node

AbstractChart

this

AbstractNode.notify

▸ off<E&gt;(type?, callback?): AbstractChart

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.

AbstractChart

this

AbstractNode.off

▸ on<E&gt;(type, callback): AbstractChart

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>

AbstractChart

this

AbstractNode.on

▸ onDataSeriesChanged(event, src, series): void

Listener for the new data series added/removed

void

▸ onDataUpdated(): void

Listener for the data source updated event. Could be called independently.

void

▸ onDataValuesChanged(event, src, args): void

Listener for the new data values added/removed or before adding/removing

void

▸ Protected onParentChanged(node): AbstractChart

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

AbstractChart

this

AbstractNode.onParentChanged

▸ onSelectionStateChanged(event, src, args): void

void

▸ Protected onVisibilityChanged(): void

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

void

AbstractNode.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

AbstractNode.postRendering

▸ Protected preRendering(context): void

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

void

AbstractNode.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

AbstractNode.registerAnimationStyle

▸ removeCssClass(cssclass): AbstractChart

Removes css class from node

AbstractChart

this

AbstractNode.removeCssClass

▸ removeInvalidateHandler(handler): AbstractChart

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

AbstractChart

this

AbstractNode.removeInvalidateHandler

▸ render(context): void

Renders node

void

AbstractNode.render

▸ renderAsync(context, callback): void

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

void

AbstractNode.renderAsync

▸ rotate(theta, x, y): AbstractChart

Rotate bounds around a given coordinate

AbstractChart

this

AbstractNode.rotate

▸ scale(xx, yy): AbstractChart

Scale node

AbstractChart

this

AbstractNode.scale

▸ setAnimationStyle(animationStyle): AbstractChart

Sets animation style

AbstractChart

AbstractNode.setAnimationStyle

▸ setAxisDataType(dimension, type): AbstractChart

Sets chart axis data type for one of the dimensions

AbstractChart

▸ setClipStyle(style): AbstractChart

Sets a new clipping style

AbstractChart

this

AbstractNode.setClipStyle

▸ setCss(style, merge?): AbstractChart

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

AbstractChart

this

AbstractNode.setCss

▸ setCssClass(name): AbstractChart

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

AbstractChart

this

AbstractNode.setCssClass

▸ setCssTransform(transform): AbstractChart

Set CSS transformation

AbstractChart

this

AbstractNode.setCssTransform

▸ Protected setDataSource(data): AbstractChart

Sets chart data source

AbstractChart

this

▸ setHorizontalFlip(flip): AbstractChart

Set horizontal flip of the representation

AbstractChart

▸ setId(id): AbstractChart

Allows the user to associate any identifier

AbstractChart

this

AbstractNode.setId

▸ setLocalTransform(localTransform, force?): AbstractChart

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

AbstractChart

this

AbstractNode.setLocalTransform

▸ setMarginsStyle(margins, merge?): AbstractChart

Sets margins style

AbstractChart

this

AbstractNode.setMarginsStyle

▸ setModelLimits(limits): AbstractChart

Sets inner model limits

AbstractChart

▸ setName(name): AbstractChart

Sets name of the node

AbstractChart

this

AbstractNode.setName

▸ setNotification(notify, force?): AbstractChart

set notification state

AbstractChart

this

AbstractNode.setNotification

▸ setOpacity(opacity, blendMode?): AbstractChart

Sets node opacity

AbstractChart

this

AbstractNode.setOpacity

▸ setOrientation(orientation): AbstractChart

Sets chart rotated due to x- and y- axes exchange (x-axis is vertical and y-axis is horizontal). NOTE: Do not call this method directly, this is called by geotoolkit/charts/widgets/ChartWidget automatically when it handles axis orientation.

AbstractChart

this

▸ setParent(parent): AbstractChart

Sets parent node. Don't call this method directly. It is internal method.

AbstractChart

this

AbstractNode.setParent

▸ setProperties(options?): AbstractChart

Sets all the properties pertaining to this object

AbstractChart

this

AbstractNode.setProperties

▸ setProperty(name, value): AbstractChart

Sets dynamic property by name

AbstractChart

this

AbstractNode.setProperty

▸ setRenderingFilter(filter): AbstractChart

Sets filter to be applied before rendering and picking

AbstractChart

this

AbstractNode.setRenderingFilter

▸ setResponsiveStyle(style): AbstractChart

Sets responsive style.

AbstractChart

this

AbstractNode.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): AbstractChart

Sets scale scroll strategy

AbstractChart

this

AbstractNode.setScaleScrollStrategy

▸ setSelectable(selectable): AbstractChart

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

AbstractChart

this

AbstractNode.setSelectable

▸ setSelectionId(id): AbstractChart

Sets new selection series identifier for shared states

AbstractChart

▸ setSilent(bool): AbstractChart

Set silent mode

AbstractChart

this

AbstractNode.setSilent

▸ setTableId(id): AbstractChart

Sets new table identifier from source data tables

AbstractChart

▸ setTag(tag): AbstractChart

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

AbstractChart

this

AbstractNode.setTag

▸ setVerticalFlip(flip): AbstractChart

Set vertical flip of the representation

AbstractChart

▸ setVisible(value): AbstractChart

Sets visibility of the node. Send event Events.VisibilityChanged

AbstractChart

this

AbstractNode.setVisible

▸ setZIndex(value): AbstractChart

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

AbstractChart

this

AbstractNode.setZIndex

▸ shear(shx, shy): AbstractChart

Shear this node's bounds

AbstractChart

this

AbstractNode.shear

▸ syncModelLimits(): AbstractChart

AbstractChart

▸ toString(): string

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

string

A string representation

AbstractNode.toString

▸ tooltipFormat(selection): string

Formats selection info for tooltip purposes, all info is shared between charts

string

▸ translate(tx, ty): AbstractChart

Translate bounds

AbstractChart

this

AbstractNode.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

AbstractNode.unregisterAnimationStyle

▸ updateSceneTransformation(): AbstractChart

Update scene transformation

AbstractChart

this

AbstractNode.updateSceneTransformation

▸ updateState(regions?, changes?): AbstractChart

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

AbstractChart

this

AbstractNode.updateState

▸ Protected updateTimeStamp(): AbstractChart

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