Class: PieChart

• [new PieChart(options, data)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.shapes-1.piechart.piechart.md#new piechart(options, data))

• new PieChart(options?, data?)

DonutChart.constructor

▸ addBaseLayer(baseLayer): PieChart

Add baseLayer to container

PieChart

this

DonutChart.addBaseLayer

▸ addChild(node): PieChart

Add a child node

PieChart

this

DonutChart.addChild

▸ addCssClass(cssclass): PieChart

Adds new css class to node

PieChart

this

DonutChart.addCssClass

▸ addInvalidateHandler(handler): PieChart

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

PieChart

this

DonutChart.addInvalidateHandler

▸ addOverlay(overlay): PieChart

Add overlay to container

PieChart

this

DonutChart.addOverlay

▸ adjustPosition(area?, vAlign?, hAlign?): PieChart

Adjust position of node to specified area

PieChart

this

DonutChart.adjustPosition

▸ Protected applyOpacity(context): PieChart

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

PieChart

this

DonutChart.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

DonutChart.applyResponsiveStyle

▸ changeBaseLayerOrder(overlay, order, anchor?): PieChart

Changes the z-order of the baseLayer.

PieChart

this

DonutChart.changeBaseLayerOrder

▸ changeChildOrder(node, order, anchor?): PieChart

changes the z-order of the nodes being rendered.

PieChart

this

DonutChart.changeChildOrder

▸ changeOverlayOrder(overlay, order, anchor?): PieChart

Changes the z-order of the overlay.

PieChart

this

DonutChart.changeOverlayOrder

▸ checkCollision(context): boolean

Check collision

boolean

true if object is inside of rendering area

DonutChart.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): PieChart

Remove all child baseLayers from group

PieChart

this

DonutChart.clearBaseLayers

▸ clearCache(): PieChart

Clear cache

PieChart

this

DonutChart.clearCache

▸ clearChildren(disposeChildren?): PieChart

Remove all child nodes from this composite group

PieChart

this

DonutChart.clearChildren

▸ clearOverlays(disposeOverlays?): PieChart

Remove all child overlays from group

PieChart

this

DonutChart.clearOverlays

▸ clone(): Group<Node&gt;

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

Group<Node&gt;

clone

DonutChart.clone

▸ connectStyle(style, type, callback): PieChart

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

PieChart

this

DonutChart.connectStyle

▸ Protected copyConstructor(src, deepCopy?): PieChart

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

PieChart

this

DonutChart.copyConstructor

▸ disconnectStyle(style, type, callback): PieChart

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

PieChart

this

DonutChart.disconnectStyle

▸ dispose(): void

Dispose DonutChart and its shapes

void

DonutChart.dispose

▸ Protected drawBorder(localContext, bounds?): PieChart

Draws a rectangle at the bounding box (in parent coordinates)

PieChart

this

DonutChart.drawBorder

▸ enableClipping(doClip): PieChart

Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.

PieChart

this

DonutChart.enableClipping

▸ enableEventPropagation(enable): PieChart

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

PieChart

this

DonutChart.enableEventPropagation

▸ enablePickingChildren(enable): PieChart

Enables or disables picking children

PieChart

this

DonutChart.enablePickingChildren

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

DonutChart.enumerateNodes

▸ execute(delegate): PieChart

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

PieChart

The result if any or this

DonutChart.execute

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

T

DonutChart.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

DonutChart.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

DonutChart.getAnimationStyle

▸ getAutoModelLimitsMode(): boolean

Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds

boolean

mode

DonutChart.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

DonutChart.getAutoModelLimitsStrategy

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

DonutChart.getBaseLayer

▸ getBaseLayers<S&gt;(predicate, modify?): Iterator<Node&gt;

Return iterator by baseLayers nodes

Iterator<Node&gt;

DonutChart.getBaseLayers

▸ getBaseLayers(filter?, modify?): Iterator<Node&gt;

Returns an iterator for child baseLayers. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node&gt;

An iterator for child overlays.

DonutChart.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

DonutChart.getBaseLayersCount

▸ getBounds(): Rect

Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.

Rect

current bounds

DonutChart.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

DonutChart.getCache

▸ getChild(i): Node

Return node by index

Node

DonutChart.getChild

▸ getChildren<S&gt;(predicate, modify?): Iterator<S&gt;

Return iterator by child nodes

Iterator<S&gt;

DonutChart.getChildren

▸ getChildren(filter?, modify?): Iterator<Node&gt;

Returns an iterator for child nodes. The iterator does not support adding or deleting items from children by default. If it is necessary to modify a collection of children, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getChildren(null, true);

Iterator<Node&gt;

An iterator for child nodes.

DonutChart.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

DonutChart.getChildrenCount

▸ getClassName(): string

string

DonutChart.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

DonutChart.getClipStyle

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

DonutChart.getContentOrientation

▸ getContentsArea(transformation?): Rect

Return area without paddings. Model limits are mapped to content area, where children are layout.

Rect

DonutChart.getContentsArea

▸ getContentsTransform(): Transformation

<code>getContentsTransform()</code> retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

DonutChart.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

DonutChart.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

DonutChart.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

DonutChart.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

DonutChart.getCssTransform

▸ getDesiredHeight(): string | number

Returns desired height of the group as a layoutable object This method is a helper method to get access to getLayoutStyle()

string | number

desired height ("undefined" by default)

DonutChart.getDesiredHeight

▸ getDesiredWidth(): string | number

Returns desired width of the group as a layoutable object. This method is a helper method to get access to getLayoutStyle()

string | number

desired width ("undefined" by default)

DonutChart.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

DonutChart.getDeviceLimits

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

DonutChart.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

DonutChart.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

DonutChart.getInfiniteMode

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

Gets invalidate method

AttributeCallback<EventDispatcher&gt;

method to invalidate this object

DonutChart.getInvalidateMethod

▸ getLayout(): Layout

Returns layout associated with the group

Layout

layout

DonutChart.getLayout

▸ getLayoutStyle(): LayoutStyle<string | number&gt;

return desired layout style

LayoutStyle<string | number&gt;

DonutChart.getLayoutStyle

▸ getLineStyle(): LineStyle

Return border style

LineStyle

DonutChart.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

DonutChart.getLocalTransform

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

Return margins style

SpaceStyle<string | number&gt;

DonutChart.getMarginsStyle

▸ getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Rect

the current model limits

DonutChart.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

DonutChart.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

DonutChart.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

DonutChart.getOpacityBlendMode

▸ getOptions(): OptionsBaseOut

Gets display options (see DonutChart.setOptions for more info)

OptionsBaseOut

display options

DonutChart.getOptions

▸ getOverlay(index): Node

Return overlay at specified index

Node

track

DonutChart.getOverlay

▸ getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Node

track

DonutChart.getOverlayAt

▸ getOverlays<S&gt;(predicate, modify?): Iterator<Node&gt;

Return iterator by overlays nodes

Iterator<Node&gt;

DonutChart.getOverlays

▸ getOverlays(filter?, modify?): Iterator<Node&gt;

Returns an iterator for child overlays. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.

Example

// Gets a writable iterator
const it = node.getOverlays(null, true);

Iterator<Node&gt;

An iterator for child overlays.

DonutChart.getOverlays

▸ getOverlaysCount(): number

Returns amount of overlays

number

DonutChart.getOverlaysCount

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

Return padding style

SpaceStyle<string | number&gt;

padding

DonutChart.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

DonutChart.getParent

▸ getPreferredSize(): Rect

Return preferred size to layout children

Rect

DonutChart.getPreferredSize

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties object

DonutChart.getProperties

▸ getProperty(name): any

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

any

DonutChart.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

DonutChart.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

DonutChart.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

DonutChart.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

DonutChart.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

DonutChart.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

DonutChart.getSceneTransform

▸ getSliceByIndex(index): SliceInfo

return slice at specific index if it exists, null otherwise

Example

{ 'label: 'slice1', 'value': 42, 'percentage' : 14.01, 'color': 'red', 'angleDegStart' : 10, 'angleDegEnd' : 45 }

SliceInfo

object that describes slice information - the corresponding slice information contains

DonutChart.getSliceByIndex

▸ getSlicesCount(): number

return the number of slices in the donut chart

number

DonutChart.getSlicesCount

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

DonutChart.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

DonutChart.getVisible

▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Rect

DonutChart.getVisibleDeviceLimits

▸ getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Rect

DonutChart.getVisibleModelLimits

▸ getWorldTransform(): Transformation

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

Transformation

DonutChart.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

DonutChart.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

DonutChart.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

DonutChart.hasEventListener

▸ highlightSlices(slices, append?): PieChart

Highlight specified slices

PieChart

this

DonutChart.highlightSlices

▸ indexOfBaseLayer(baseLayer): number

Return index of overlay ( index of the specified child or -1 if baseLayer is not found)

number

DonutChart.indexOfBaseLayer

▸ indexOfChild(node): number

Return index of child ( index of the specified child or -1 if node is not found)

number

DonutChart.indexOfChild

▸ indexOfOverlay(overlay): number

Return index of overlay ( index of the specified child or -1 if overlay is not found)

number

DonutChart.indexOfOverlay

▸ insertBaseLayer(index, baseLayer): PieChart

Insert child baseLayer at specified index

PieChart

this

DonutChart.insertBaseLayer

▸ insertChild(index, node): PieChart

Insert child node at specified index

PieChart

this

DonutChart.insertChild

▸ insertOverlay(index, overlay): PieChart

Insert child overlay at specified index

PieChart

this

DonutChart.insertOverlay

▸ invalidate(bounds?, force?): PieChart

Invalidate node

PieChart

this

DonutChart.invalidate

▸ invalidateLayout(propagate?): PieChart

Notify that layout is invalidated. Send event Events.LayoutInvalidated

PieChart

this

DonutChart.invalidateLayout

▸ invalidateParent(bounds?, force?): PieChart

Invalidate parent area

PieChart

this

DonutChart.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

DonutChart.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

DonutChart.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

DonutChart.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

flip

DonutChart.isHorizontalFlip

▸ isLayoutInvalidated(): boolean

Return true if layout is invalid

boolean

DonutChart.isLayoutInvalidated

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

DonutChart.isNotificationEnabled

▸ isPickingChildrenEnabled(): boolean

Returns if picking children is enabled or not for this node.

boolean

pickingChildren

DonutChart.isPickingChildrenEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

DonutChart.isSelectable

▸ isSilent(): boolean

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

boolean

DonutChart.isSilent

▸ isVerticalFlip(): boolean

Return true if the representation is flipped vertically

boolean

flip

DonutChart.isVerticalFlip

▸ moveTo(area, vAlign?, hAlign?): PieChart

MoveTo position of node to specified area

PieChart

this

DonutChart.moveTo

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

Notify listeners of the Node

PieChart

this

DonutChart.notify

▸ Protected notifyRoot(event, source, args?): Node

Notify an even to root node

Node

this

DonutChart.notifyRoot

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

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.

PieChart

this

DonutChart.off

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

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>

PieChart

this

DonutChart.on

▸ Protected onBoundsChanged(bounds): PieChart

Occurs when bounds has been changed

PieChart

this

DonutChart.onBoundsChanged

▸ Protected onChildAdded(child): void

This method is called it child or children are added

void

DonutChart.onChildAdded

▸ Protected onChildRemoved(child): void

This method is called it child or children are removed

void

DonutChart.onChildRemoved

▸ Protected onParentChanged(node): PieChart

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

PieChart

this

DonutChart.onParentChanged

▸ Protected onVisibilityChanged(): void

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