Last updated

API / geotoolkit / controls / shapes / LineChart / LineChart

Class: LineChart

shapes.LineChart.LineChart

The Line Chart is a chart that displays data with lines.
Line Chart can display data with several curve types:

  • Linear - A simple polyline
  • Spline - Spline (Bezier)
  • Logscale - logarithmic
    It can be further customized by using the options in the constructor.

Example

// Creating a simple line chart. (X values are shared for the chart )
import {CssStyle} from '@int/geotoolkit/css/CssStyle';
const x = [0, 2, 4, 6, 8, ...];
const y = [
[10, 53.3022600566037, 40.79461201233789, 53.4218930513598, ...],
[1000, 642.6507126996294, 696.8659508964047, 618.771930876188, ...]
];
const linechart = new LineChart({
'x': x,
'y': y,
'linestyles': [...],
'series': [{
'visible': true
}]
});
return lineChart;

// To draw a Line Chart but not display the gridlines user can do the following:
linechart.getGrid().setVisible(false);

// or use Css
linechart.setCss(new CssStyle({'css': '.geotoolkit.axis.Grid { visible: false;}' }));

Hierarchy

Implements

Table of contents

Constructors
Methods
addBaseLayeraddChildaddCssClass
addInvalidateHandleraddOverlayadjustPosition
applyOpacityapplyResponsiveStylechangeBaseLayerOrder
changeChildOrderchangeOverlayOrdercheckCollision
clearBaseLayersclearCacheclearChildren
clearOverlayscloneconnectStyle
copyConstructordisconnectStyledispose
drawBorderenableClippingenableEventPropagation
enablePickingChildrenenumerateNodesexecute
filtergetAnimationStylegetAutoDataLimits
getAutoModelLimitsModegetAutoModelLimitsStrategygetBaseLayer
getBaseLayersgetBaseLayersCountgetBounds
getCachegetChildgetChildren
getChildrenCountgetClassNamegetClipStyle
getContentOrientationgetContentsAreagetContentsTransform
getCssgetCssClassgetCssClasses
getCssTransformgetDatagetDataLimits
getDesiredHeightgetDesiredWidthgetDeviceLimits
getFillStylegetGapFillCutoffValuegetGapValue
getGridgetIdgetInfiniteMode
getInvalidateMethodgetLayoutgetLayoutStyle
getLineStylegetLocalTransformgetMarginsStyle
getModelLimitsgetNamegetOpacity
getOpacityBlendModegetOptionsgetOverlay
getOverlayAtgetOverlaysgetOverlaysCount
getPaddingStylegetParentgetPreferredSize
getPropertiesgetPropertygetPropertyKeys
getRenderingFiltergetResponsiveStylegetRoot
getScaleScrollStrategygetSceneTransformgetTag
getVisiblegetVisibleDeviceLimitsgetVisibleModelLimits
getWorldTransformgetZIndexhasCssClass
hasEventListenerhitTestindexOfBaseLayer
indexOfChildindexOfOverlayinsertBaseLayer
insertChildinsertOverlayinvalidate
invalidateLayoutinvalidateParentisClippingEnabled
isDisposedisEventPropagationEnabledisHorizontalFlip
isLayoutInvalidatedisNotificationEnabledisPickingChildrenEnabled
isSelectableisSilentisVerticalFlip
moveTonotifynotifyRoot
offononBoundsChanged
onChildAddedonChildRemovedonParentChanged
onVisibilityChangedpostRenderingpreRendering
rebuildregisterAnimationStyleremoveBaseLayer
removeChildremoveCssClassremoveInvalidateHandler
removeOverlayrenderrenderAsync
renderBackgroundrenderBaseLayersrenderBaseLayersAsync
renderChildrenrenderChildrenAsyncrenderContent
renderContentAsyncrenderOverlaysrenderOverlaysAsync
resumeUpdaterotatescale
setAnimationStylesetAutoDataLimitssetAutoModelLimitsMode
setAutoModelLimitsStrategysetBoundssetCache
setChildsetClipStylesetContentOrientation
setCsssetCssClasssetCssTransform
setDatasetDesiredHeightsetDesiredWidth
setFillStylesetGapFillCutoffValuesetGapValue
setGridStylesetHorizontalFlipsetId
setInfiniteModesetLayoutsetLayoutInvalidated
setLayoutStylesetLineStylesetLocalTransform
setMarginsStylesetModelLimitssetName
setNotificationsetOpacitysetOptimization
setOptimizationSymbolsetOptimizationTypesetOptions
setPaddingStylesetPropertiessetProperty
setRenderingFiltersetResponsiveStylesetScaleScrollStrategy
setSelectablesetSilentsetTag
setVerticalFlipsetVisiblesetVisibleModelLimits
setZIndexshearsuspendUpdate
toStringtranslateunregisterAnimationStyle
updateLayoutupdateSceneTransformationupdateState
updateSuspendedupdateTimeStampenableSceneGraphNotification
findParentgetClassNameisSceneGraphNotificationEnabled
Css Properties
Name Type Description
automodellimitsmodebooleanAuto model limits mode
boundsRectDefine position of the group in the parent
bounds-heightnumberHeight
bounds-readonlybooleanReadonly
bounds-widthnumberWidth
bounds-xnumberLeft
bounds-ynumberTop
boundsRectBounds or position on the chart
cachebooleanBoolean flag that specify cache usage
clippingbooleanEnable clipping, this does not consider the clipstyle, it is related to bounds-clipping
clipstyleClipStyleClipping style
clipstyle-evenoddbooleanTrue if evenodd mode is on ('nonzero' mode otherwise)
clipstyle-geometryGraphicsPathClipping geometry
clipstyle-geometry-boundsRectBounds
clipstyleGraphicsPathClipping style
contentorientationOrientationContent orientation
cssclassstringThe css class name of this node
csscursorstringCSS cursor associated with node
cssstylestringCSS style to be applied to inserted elements
fillstylestringFill style
fillstyleFillStyleFill style
fillstyle-colorstringColor in CSS form
fillstyle-evenoddmodebooleanEven-odd fill mode
fillstyle-fillpatternPatternPattern
fillstyle-fillpattern-containernamestringAn optional container name, which creates an image pattern. This parameter is used for serialization if you want to save are reference to pattern instead of the pattern itself
fillstyle-fillpattern-patternnamestringName of this pattern for indexing
fillstyle-fillpattern-scalablebooleanFlag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported)
fillstyle-foregroundstringForeground color
fillstyle-patternPatternPattern
horizontalflipbooleanHorizontal axis goes from right to left
idstring | numberId of the node, its a unique identifier
infinitybooleanMode to render outside the model limits
layoutstyleLayoutStyleLayout style to be used for parent layout
layoutstyle-constraintSizeConstraintLayout constrains
layoutstyle-flexgrownumberNumber specifying how much the item will grow relative to the rest of the items inside the same container
layoutstyle-flexshrinknumberNumber specifying how much the item will shrink relative to the rest of the items inside the same container
layoutstyle-floatstringFloat position
layoutstyle-positionstringLayout position
layoutstyle-sizenumber | stringLayout size
linestylestringLine style
linestyleLineStyleLine style
linestyle-colorstringColor in CSS form
linestyle-fillstringOptional fill style to be used to fill lines generated with this style
linestyle-fillFillStyleOptional fill style to be used to fill lines generated with this style
linestyle-linecapCapStyleThe line cap style
linestyle-linedashoffsetnumberLine dash offset of dashed line
linestyle-linejoinJoinStyleThe line join style
linestyle-pixelsnapmodebooleanPixel Snap Mode, default(
linestyle-scalablebooleanTrue if width should depend on transformation
linestyle-unitstringOptional unit for the width
linestyle-widthnumber | stringThe line thickness
localtransformTransformationLocal transformation
localtransform-dxnumberX axis translation
localtransform-dynumberY axis translation
localtransform-xxnumberX scale
localtransform-xynumberXy skew
localtransform-yxnumberYx skew
localtransform-yynumberY scale
marginsnumber | stringIt has properties for specifying the margins for each side
modellimitsRectDefine inner model coordinates of the group
modellimitsRectModel limits of chart. if it is not set then model limits are calculated
namestringName of the node. It is often used for debugging purposes or to simplify queries
opacitynumberNode opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
opacityblendmodeBlendModeNode opacity mode to blend it
paddingnumber | stringIt has properties for specifying the padding for each side
pickingchildrenbooleanEnable picking children
scalescrollstrategyScaleScrollStrategyScale scroll strategy
scalescrollstrategy-enabledbooleanEnable flag
selectablebooleanSelectable node, a boolean to determine if selection should consider this node
taganyCustom information associated with node. It is a user object which can be used by client code to store information or attach an application object to the shape
transformstringAdditional CSS transformation applied to node or 'none'
transformTransformationAdditional CSS transformation applied to node or 'none'
verticalflipbooleanVertical axis goes from bottom to top
viewcachebooleanView cache to cache child nodes
visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
z-indexnumberDefine node z-index

Contents

Constructors

new LineChart(options, y, lineStyles, bounds, spline, logscale, fillStyles, baseLine, stackedarea, percentarea, arearange, series)

new LineChart(options?, y?, lineStyles?, bounds?, spline?, logscale?, fillStyles?, baseLine?, stackedarea?, percentarea?, arearange?, series?)

Create LineChart

Parameters

Name Type Description
Optional optionsnumber[] | number[][] | Options | INumericalDataSeries[]array of X coordinates or parameters object
Optional ynumber[][]array of Y coordinates
Optional lineStylesLineStyle[]Line styles to apply to curves
Optional boundsRectbounds or position on the chart
Optional splinebooleansmooth the curve or not
Optional logscaleboolean | { x?: boolean ; y?: boolean }use log scale or not
Optional fillStylesFillStyle[]Fill Styles
Optional baseLinenumberY value of a horizontal line which will define the base line for fill
Optional stackedareabooleanuse to determine if stacked area or not
Optional percentareabooleanuse to determine if percent area of not
Optional arearangeAreaRangeDefines Area Range
Optional series{ visible?: boolean }[]Defines the visibility of linechart series. By default it's true

Overrides

Group.constructor

Methods

addBaseLayer

addBaseLayer(baseLayer): LineChart

Add baseLayer to container

Parameters

Name Type Description
baseLayerNode | Node[]baseLayer to be added

Returns

LineChart

this

Inherited from

Group.addBaseLayer


addChild

addChild(node): LineChart

Add a child node

Parameters

Name Type Description
nodeNode | Iterator<Node> | Node[]the child node to be added

Returns

LineChart

this

Inherited from

Group.addChild


addCssClass

addCssClass(cssclass): LineChart

Adds new css class to node

Parameters

Name Type Description
cssclassstring | string[]css class name('s)

Returns

LineChart

this

Inherited from

Group.addCssClass


addInvalidateHandler

addInvalidateHandler(handler): LineChart

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Parameters

Name Type Description
handlerFunctionhandler to be notified about invalidation

Returns

LineChart

this

Inherited from

Group.addInvalidateHandler


addOverlay

addOverlay(overlay): LineChart

Add overlay to container

Parameters

Name Type Description
overlayNode | Node[]overlay to be added

Returns

LineChart

this

Inherited from

Group.addOverlay


adjustPosition

adjustPosition(area?, vAlign?, hAlign?): LineChart

Adjust position of node to specified area

Parameters

Name Type Description
Optional areaRectspecified area. Default to Parent Model Limits
Optional vAlignstringvertical alignment. It can be "top", "bottom", "center". Defaults to "top".
Optional hAlignstringhorizontal alignment It can be "left", "right", "center". Defaults to "left".

Returns

LineChart

this

Inherited from

Group.adjustPosition


applyOpacity

Protected applyOpacity(context): LineChart

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

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

LineChart

this

Inherited from

Group.applyOpacity


applyResponsiveStyle

Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

Returns

void

Inherited from

Group.applyResponsiveStyle


changeBaseLayerOrder

changeBaseLayerOrder(overlay, order, anchor?): LineChart

Changes the z-order of the baseLayer.

Parameters

Name Type Description
overlayNode
orderNodeOrderposition to be added
Optional anchorNodeanchor node to specify changeOrder with respect to this node

Returns

LineChart

this

Inherited from

Group.changeBaseLayerOrder


changeChildOrder

changeChildOrder(node, order, anchor?): LineChart

changes the z-order of the nodes being rendered.

Parameters

Name Type Description
nodeNodeany child added in the Composite node
orderNodeOrderposition to be added
Optional anchorNodeanchor node to specify changeOrder with respect to this node

Returns

LineChart

this

Inherited from

Group.changeChildOrder


changeOverlayOrder

changeOverlayOrder(overlay, order, anchor?): LineChart

Changes the z-order of the overlay.

Parameters

Name Type Description
overlayNodechild overlay
orderNodeOrderposition to be added
Optional anchorNodeanchor node to specify changeOrder with respect to this node

Returns

LineChart

this

Inherited from

Group.changeOverlayOrder


checkCollision

checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

boolean

true if node is collided

Inherited from

Group.checkCollision


clearBaseLayers

clearBaseLayers(disposeBaseLayers?): LineChart

Remove all child baseLayers from group

Parameters

Name Type Description
Optional disposeBaseLayersbooleanautomatically dispose baseLayers. If it is true then method dispose is called for each baseLayer, false by default

Returns

LineChart

this

Inherited from

Group.clearBaseLayers


clearCache

clearCache(): LineChart

Clear cache

Returns

LineChart

this

Inherited from

Group.clearCache


clearChildren

clearChildren(disposeChildren?): LineChart

Remove all child nodes from this composite group

Parameters

Name Type Description
Optional disposeChildrenbooleanautomatically dispose children. If it is true then method dispose is called for each child.

Returns

LineChart

this

Inherited from

Group.clearChildren


clearOverlays

clearOverlays(disposeOverlays?): LineChart

Remove all child overlays from group

Parameters

Name Type Description
Optional disposeOverlaysbooleanautomatically dispose overlays. If it is true then method dispose is called for each overlay, false by default

Returns

LineChart

this

Inherited from

Group.clearOverlays


clone

clone(): Group<Node>

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

Returns

Group<Node>

clone

Inherited from

Group.clone


connectStyle

connectStyle(style, type, callback): LineChart

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

Parameters

Name Type Description
styleEventDispatcherconnect style
typestringtype of event or property
callbackAttributeCallback<EventDispatcher>function to be called

Returns

LineChart

this

Inherited from

Group.connectStyle


copyConstructor

Protected copyConstructor(src, deepCopy?): LineChart

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

Parameters

Name Type Description
srcLineChartSource to copy from
Optional deepCopybooleandeep copy

Returns

LineChart

this

Overrides

Group.copyConstructor


disconnectStyle

disconnectStyle(style, type, callback): LineChart

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

Parameters

Name Type Description
styleEventDispatcherconnect style
typestringtype of event or property
callbackAttributeCallback<EventDispatcher>function to be called

Returns

LineChart

this

Inherited from

Group.disconnectStyle


dispose

dispose(): void

Dispose node. Clear all listeners and disconnect style to avoid memory leaks

Returns

void

Inherited from

Group.dispose


drawBorder

Protected drawBorder(localContext, bounds?): LineChart

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

Parameters

Name Type Description
localContextRenderingContextThe local rendering context
Optional boundsRectgroup bounds

Returns

LineChart

this

Inherited from

Group.drawBorder


enableClipping

enableClipping(doClip): LineChart

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

Parameters

Name Type Description
doClipbooleanenable clipping on this node

Returns

LineChart

this

Inherited from

Group.enableClipping


enableEventPropagation

enableEventPropagation(enable): LineChart

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

Parameters

Name Type Description
enablebooleanenable

Returns

LineChart

this

Inherited from

Group.enableEventPropagation


enablePickingChildren

enablePickingChildren(enable): LineChart

Enables or disables picking children

Parameters

Name Type Description
enablebooleanenable picking children

Returns

LineChart

this

Inherited from

Group.enablePickingChildren


enumerateNodes

enumerateNodes(callback, target?): void

Executes a provided function once for each child node

Parameters

Name Type Description
callbackCallback<Node>provided function
Optional targetQueryBuilder<any>target to pass to callback as a second parameter

Returns

void

Inherited from

Group.enumerateNodes


execute

execute(delegate): LineChart

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

Parameters

Name Type Description
delegate(this: LineChart) => voidFunction to execute

Returns

LineChart

The result if any or this

Inherited from

Group.execute

execute<T>(delegate): T

Type parameters

Name
T

Parameters

Name Type
delegate(this: LineChart) => T

Returns

T

Inherited from

Group.execute


filter

Protected filter(context): boolean

Filter node

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

boolean

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

Inherited from

Group.filter


getAnimationStyle

getAnimationStyle(): AnimationStyle

Return animation style

Returns

AnimationStyle

animationStyle current animation style

Inherited from

Group.getAnimationStyle


getAutoDataLimits

getAutoDataLimits(): boolean

Returns flag to indicate automatic calculation of data limits

Returns

boolean

Implementation of

IChartDataVisual.getAutoDataLimits


getAutoModelLimitsMode

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

Returns

boolean

mode

Inherited from

Group.getAutoModelLimitsMode


getAutoModelLimitsStrategy

getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

Returns

ModelLimitsStrategy

strategy

Inherited from

Group.getAutoModelLimitsStrategy


getBaseLayer

getBaseLayer(index): Node

Return baseLayer at specified index

Parameters

Name Type Description
indexnumberindex at which to get the baseLayer for

Returns

Node

track

Inherited from

Group.getBaseLayer


getBaseLayers

getBaseLayers<S>(predicate, modify?): Iterator<Node>

Return iterator by baseLayers nodes

Type parameters

NameType
Sextends Node<S>

Parameters

Name Type Description
predicate(value: Node) => value is Sa filter function
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<Node>

Inherited from

Group.getBaseLayers

getBaseLayers(filter?, modify?): Iterator<Node>

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

Parameters

Name Type Description
Optional filter(node: Node) => booleanA filter function. Returns all overlays if null.
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<Node>

An iterator for child overlays.

Inherited from

Group.getBaseLayers


getBaseLayersCount

getBaseLayersCount(): number

Returns amount of baseLayers

Returns

number

Inherited from

Group.getBaseLayersCount


getBounds

getBounds(): Rect

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

Returns

Rect

current bounds

Inherited from

Group.getBounds


getCache

getCache(): Cache

Return cache strategy to be used to cache children nodes

Returns

Cache

cache

Inherited from

Group.getCache


getChild

getChild(i): Node

Return node by index

Parameters

Name Type Description
inumberindex of the node

Returns

Node

Inherited from

Group.getChild


getChildren

getChildren<S>(predicate, modify?): Iterator<S>

Return iterator by child nodes

Type parameters

NameType
Sextends Node<S>

Parameters

Name Type Description
predicate(value: Node) => value is Sa filter function
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<S>

Inherited from

Group.getChildren

getChildren(filter?, modify?): Iterator<Node>

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

Parameters

Name Type Description
Optional filter(node: Node) => booleanA filter function. Returns all nodes if null.
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<Node>

An iterator for child nodes.

Inherited from

Group.getChildren


getChildrenCount

getChildrenCount(): number

Return number of child nodes

Returns

number

Inherited from

Group.getChildrenCount


getClassName

getClassName(): string

Returns

string

Inherited from

Group.getClassName


getClipStyle

getClipStyle(): ClipStyle

Gets the current clipping style

Returns

ClipStyle

clipping style

Inherited from

Group.getClipStyle


getContentOrientation

getContentOrientation(): Orientation

Return content orientation

Returns

Orientation

content orientation

Inherited from

Group.getContentOrientation


getContentsArea

getContentsArea(transformation?): Rect

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

Parameters

Name Type Description
Optional transformationTransformationscene transformation

Returns

Rect

Inherited from

Group.getContentsArea


getContentsTransform

getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Returns

Transformation

transformation from model coordinates to bounds of the group

Inherited from

Group.getContentsTransform


getCss

getCss(): CssStyle

Return CSS style

Returns

CssStyle

Inherited from

Group.getCss


getCssClass

getCssClass(): string

Returns css class name to be used to apply CSS style

Returns

string

the css class name

Inherited from

Group.getCssClass


getCssClasses

getCssClasses(): string[]

Gets list of css class names which applied to this node

Returns

string[]

Inherited from

Group.getCssClasses


getCssTransform

getCssTransform(): string

Returns CSS transformation

Returns

string

Inherited from

Group.getCssTransform


getData

getData(): DataModel

Return the current chart setting

Returns

DataModel


getDataLimits

getDataLimits(): Rect

Return original data limits

Returns

Rect

Implementation of

IChartDataVisual.getDataLimits


getDesiredHeight

getDesiredHeight(): string | number

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

Returns

string | number

desired height ("undefined" by default)

Inherited from

Group.getDesiredHeight


getDesiredWidth

getDesiredWidth(): string | number

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

Returns

string | number

desired width ("undefined" by default)

Inherited from

Group.getDesiredWidth


getDeviceLimits

getDeviceLimits(): Rect

Return device limits

Returns

Rect

Inherited from

Group.getDeviceLimits


getFillStyle

getFillStyle(): FillStyle

Return fill style

Returns

FillStyle

fillStyle current fill style

Inherited from

Group.getFillStyle


getGapFillCutoffValue

getGapFillCutoffValue(): number

Returns the value of the cutoff used for removing NaN valued samples

Returns

number

The cutoff value


getGapValue

getGapValue(): number

Returns The maximum discontinuity allowed in x axis

Returns

number

value


getGrid

getGrid(): Grid

Return embedded gridlines

Returns

Grid


getId

getId(): string | number

Returns the associated identifier of the node

Returns

string | number

The node's id

Inherited from

Group.getId


getInfiniteMode

getInfiniteMode(): boolean

Return infinity mode flag

Returns

boolean

flag

Inherited from

Group.getInfiniteMode


getInvalidateMethod

Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

Returns

AttributeCallback<EventDispatcher>

method to invalidate this object

Inherited from

Group.getInvalidateMethod


getLayout

getLayout(): Layout

Returns layout associated with the group

Returns

Layout

layout

Inherited from

Group.getLayout


getLayoutStyle

getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

Returns

LayoutStyle<string | number>

Inherited from

Group.getLayoutStyle


getLineStyle

getLineStyle(): LineStyle

Return border style

Returns

LineStyle

Inherited from

Group.getLineStyle


getLocalTransform

getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Returns

Transformation

transform the local transform.

Inherited from

Group.getLocalTransform


getMarginsStyle

getMarginsStyle(): SpaceStyle<string | number>

Return margins style

Returns

SpaceStyle<string | number>

Inherited from

Group.getMarginsStyle


getModelLimits

getModelLimits(): Rect

Gets model limits, the limits of this groups inside space

Returns

Rect

the current model limits

Overrides

Group.getModelLimits


getName

getName(): string

Returns the node name

Returns

string

The node name

Inherited from

Group.getName


getOpacity

getOpacity(): number

Returns current node opacity

Returns

number

opacity

Inherited from

Group.getOpacity


getOpacityBlendMode

getOpacityBlendMode(): BlendMode

Returns current node opacity

Returns

BlendMode

opacity blend mode

Inherited from

Group.getOpacityBlendMode


getOptions

getOptions(): OptionsBaseOut

Gets visual options for the chart

Returns

OptionsBaseOut


getOverlay

getOverlay(index): Node

Return overlay at specified index

Parameters

Name Type Description
indexnumberindex at which to get the overlay for

Returns

Node

track

Inherited from

Group.getOverlay


getOverlayAt

getOverlayAt(index): Node

Return overlay at specified index

Deprecated

since 4.2 use getOverlay instead

Parameters

Name Type Description
indexnumberindex at which to get the overlay for

Returns

Node

track

Inherited from

Group.getOverlayAt


getOverlays

getOverlays<S>(predicate, modify?): Iterator<Node>

Return iterator by overlays nodes

Type parameters

NameType
Sextends Node<S>

Parameters

Name Type Description
predicate(value: Node) => value is Sa filter function
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<Node>

Inherited from

Group.getOverlays

getOverlays(filter?, modify?): Iterator<Node>

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

Parameters

Name Type Description
Optional filter(node: Node) => booleanA filter function. Returns all overlays if null.
Optional modifybooleanAn option to specify if the iterator supports adding/removing items from the collection. false by default.

Returns

Iterator<Node>

An iterator for child overlays.

Inherited from

Group.getOverlays


getOverlaysCount

getOverlaysCount(): number

Returns amount of overlays

Returns

number

Inherited from

Group.getOverlaysCount


getPaddingStyle

getPaddingStyle(): SpaceStyle<string | number>

Return padding style

Returns

SpaceStyle<string | number>

padding

Inherited from

Group.getPaddingStyle


getParent

getParent(): Node

Return parent node

Returns

Node

parent node

Inherited from

Group.getParent


getPreferredSize

getPreferredSize(): Rect

Return preferred size to layout children

Returns

Rect

Inherited from

Group.getPreferredSize


getProperties

getProperties(): OptionsOut

Gets all the properties pertaining to this object

Returns

OptionsOut

options

Overrides

Group.getProperties


getProperty

getProperty(name): any

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

Parameters

Name Type Description
namestringproperty name

Returns

any

Inherited from

Group.getProperty


getPropertyKeys

getPropertyKeys(): string[]

Returns known properties keys

Returns

string[]

Inherited from

Group.getPropertyKeys


getRenderingFilter

getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

Returns

IFilter

current filter

Inherited from

Group.getRenderingFilter


getResponsiveStyle

getResponsiveStyle(): ResponsiveStyle

Return responsive style

Returns

ResponsiveStyle

Inherited from

Group.getResponsiveStyle


getRoot

getRoot(): Node

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

Returns

Node

the root node

Inherited from

Group.getRoot


getScaleScrollStrategy

getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Returns

Delegate

scale scroll strategy

Inherited from

Group.getScaleScrollStrategy


getSceneTransform

getSceneTransform(): Transformation

Returns transformation from node to root scene

Returns

Transformation

a transformation from node to root scene

Inherited from

Group.getSceneTransform


getTag

getTag(): any

Returns the object associated with the node by user.

Returns

any

The node's user-object

Inherited from

Group.getTag


getVisible

getVisible(): boolean

Return visibility of the node

Returns

boolean

true if node is visible

Inherited from

Group.getVisible


getVisibleDeviceLimits

getVisibleDeviceLimits(ignoreModelLimits?): Rect

Return visible device limits

Parameters

Name Type Description
Optional ignoreModelLimitsbooleanflag defines whether to ignore ModelLimits or not

Returns

Rect

Inherited from

Group.getVisibleDeviceLimits


getVisibleModelLimits

getVisibleModelLimits(ignoreModelLimits?): Rect

Return visible model limits

Parameters

Name Type Description
Optional ignoreModelLimitsbooleanflag defines whether to ignore ModelLimits or not

Returns

Rect

Inherited from

Group.getVisibleModelLimits


getWorldTransform

getWorldTransform(): Transformation

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

Returns

Transformation

Inherited from

Group.getWorldTransform


getZIndex

getZIndex(): number

Returns node z-index (null if not set)

Returns

number

Inherited from

Group.getZIndex


hasCssClass

hasCssClass(cssClass): boolean

Check if node has specified css class

Parameters

Name Type Description
cssClassstringcss class name

Returns

boolean

Inherited from

Group.hasCssClass


hasEventListener

hasEventListener(type, callback?): boolean

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

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

Group.hasEventListener


hitTest

hitTest(area, radius?, ignoreOrientation?): Hits

Hit test in the device coordinate. This method checks if any point is inside the area and shape intersects area.

Parameters

Name Type Description
areaPoint | Rectmodel area or position
Optional radiusnumberradius of selection
Optional ignoreOrientationOrientationOrientation to ignore - this parameter is ignored for arrays of points

Returns

Hits

a collection of objects


indexOfBaseLayer

indexOfBaseLayer(baseLayer): number

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

Parameters

Name Type Description
baseLayerNodebaseLayer to check index

Returns

number

Inherited from

Group.indexOfBaseLayer


indexOfChild

indexOfChild(node): number

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

Parameters

Name Type Description
nodeNodenode to check index

Returns

number

Inherited from

Group.indexOfChild


indexOfOverlay

indexOfOverlay(overlay): number

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

Parameters

Name Type Description
overlayNodeoverlay to check index

Returns

number

Inherited from

Group.indexOfOverlay


insertBaseLayer

insertBaseLayer(index, baseLayer): LineChart

Insert child baseLayer at specified index

Parameters

Name Type Description
indexnumberspecified index
baseLayerNodea baseLayer to add

Returns

LineChart

this

Inherited from

Group.insertBaseLayer


insertChild

insertChild(index, node): LineChart

Insert child node at specified index

Parameters

Name Type Description
indexnumberspecified index
nodeNodea child node to add

Returns

LineChart

this

Inherited from

Group.insertChild


insertOverlay

insertOverlay(index, overlay): LineChart

Insert child overlay at specified index

Parameters

Name Type Description
indexnumberspecified index
overlayNodea overlay to add

Returns

LineChart

this

Inherited from

Group.insertOverlay


invalidate

invalidate(bounds?, force?): LineChart

Invalidate node

Parameters

Name Type Description
Optional boundsRectoptional rectangular area to be invalidated, or force flag if rectangle is empty
Optional forcebooleanoptional boolean parameter that can force invalidation

Returns

LineChart

this

Inherited from

Group.invalidate


invalidateLayout

invalidateLayout(propagate?): LineChart

Notify that layout is invalidated. Send event Events.LayoutInvalidated

Parameters

Name Type Description
Optional propagatebooleanpropagate invalidate layout to parent

Returns

LineChart

this

Inherited from

Group.invalidateLayout


invalidateParent

invalidateParent(bounds?, force?): LineChart

Invalidate parent area

Parameters

Name Type Description
Optional boundsRectarea to invalidate
Optional forcebooleanforce

Returns

LineChart

this

Inherited from

Group.invalidateParent


isClippingEnabled

isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

Returns

boolean

Inherited from

Group.isClippingEnabled


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

Group.isDisposed


isEventPropagationEnabled

isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

Returns

boolean

Inherited from

Group.isEventPropagationEnabled


isHorizontalFlip

isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

Returns

boolean

flip

Inherited from

Group.isHorizontalFlip


isLayoutInvalidated

isLayoutInvalidated(): boolean

Return true if layout is invalid

Returns

boolean

Inherited from

Group.isLayoutInvalidated


isNotificationEnabled

isNotificationEnabled(): boolean

return state of notification

Returns

boolean

current notification state

Inherited from

Group.isNotificationEnabled


isPickingChildrenEnabled

isPickingChildrenEnabled(): boolean

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

Returns

boolean

pickingChildren

Inherited from

Group.isPickingChildrenEnabled


isSelectable

isSelectable(): boolean

Returns true if node can be picked/selected.

Returns

boolean

The selectable flag

Inherited from

Group.isSelectable


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

Group.isSilent


isVerticalFlip

isVerticalFlip(): boolean

Return true if the representation is flipped vertically

Returns

boolean

flip

Inherited from

Group.isVerticalFlip


moveTo

moveTo(area, vAlign?, hAlign?): LineChart

MoveTo position of node to specified area

Parameters

Name Type Description
areaRectspecified area
Optional vAlignstringvertical alignment. It can be "top", "bottom", "center".
Optional hAlignstringhorizontal alignment It can be "left", "right", "center".

Returns

LineChart

this

Inherited from

Group.moveTo


notify

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

Notify listeners of the Node

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event
sourceGroup<Node>source who called the event
Optional argsEventMap<Node>[E]event arguments

Returns

LineChart

this

Inherited from

Group.notify


notifyRoot

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

Notify an even to root node

Parameters

Name Type Description
eventstringtype of event
sourceNodesource who called the event
Optional argsanyevent arguments

Returns

Node

this

Inherited from

Group.notifyRoot


off

off<E>(type?, callback?): LineChart

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: LineChart, args: EventMap<Node>[E]) => voidfunction to be called

Returns

LineChart

this

Inherited from

Group.off


on

on<E>(type, callback): LineChart

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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: LineChart, args: EventMap<Node>[E]) => voidto be called

Returns

LineChart

this

Inherited from

Group.on


onBoundsChanged

Protected onBoundsChanged(bounds): LineChart

Occurs when bounds has been changed

Parameters

Name Type Description
boundsRectbound of the node in the parent coordinates

Returns

LineChart

this

Inherited from

Group.onBoundsChanged


onChildAdded

Protected onChildAdded(child): void

This method is called it child or children are added

Parameters

Name Type Description
childNode | Iterator<Node>added child

Returns

void

Inherited from

Group.onChildAdded


onChildRemoved

Protected onChildRemoved(child): void

This method is called it child or children are removed

Parameters

Name Type Description
childNoderemoved child

Returns

void

Inherited from

Group.onChildRemoved


onParentChanged

Protected onParentChanged(node): LineChart

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

Parameters

Name Type Description
nodeNodenode to change parent

Returns

LineChart

this

Inherited from

Group.onParentChanged


onVisibilityChanged

Protected onVisibilityChanged(): void

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

Returns

void

Inherited from

Group.onVisibilityChanged


postRendering

Protected postRendering(context, callback?): void

To be called after rendering, used for PDF output

Parameters

Name Type Description
contextRenderingContextRendering Context
Optional callback() => voidcallback to be called after rendering

Returns

void

Inherited from

Group.postRendering


preRendering

Protected preRendering(context, callback?): void

Occurs before child rendering

Parameters

Name Type Description
contextRenderingContextRendering Context
Optional callback() => voidcallback to be called after rendering of geometry

Returns

void

Inherited from

Group.preRendering


rebuild

rebuild(force?, changes?): LineChart

Rebuild node. This method resets state, cache, and invalidate node.

Parameters

Name Type Description
Optional forcebooleanoptional boolean parameter that can force invalidation
Optional changesStateChangesoptional parameter to specify a reason of changes

Returns

LineChart

this

Inherited from

Group.rebuild


registerAnimationStyle

registerAnimationStyle(root): void

Register animation style.

Parameters

Name Type Description
rootNoderoot node for node

Returns

void

Inherited from

Group.registerAnimationStyle


removeBaseLayer

removeBaseLayer(baseLayer): LineChart

Remove child baseLayer

Parameters

Name Type Description
baseLayerNode | Node[]baseLayer or array of nodes to be removed

Returns

LineChart

this

Inherited from

Group.removeBaseLayer


removeChild

removeChild(node, disposeChildren?): LineChart

Remove child node

Parameters

Name Type Description
nodeNode | Node[]node or array of nodes to be removed
Optional disposeChildrenbooleanautomatically dispose children. If it is true then method dispose is called for each child.

Returns

LineChart

this

Inherited from

Group.removeChild


removeCssClass

removeCssClass(cssclass): LineChart

Removes css class from node

Parameters

Name Type Description
cssclassstring | string[]css class name('s)

Returns

LineChart

this

Inherited from

Group.removeCssClass


removeInvalidateHandler

removeInvalidateHandler(handler): LineChart

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Parameters

Name Type Description
handlerFunctionhandler to be notified about invalidation

Returns

LineChart

this

Inherited from

Group.removeInvalidateHandler


removeOverlay

removeOverlay(overlay): LineChart

Remove child overlay

Parameters

Name Type Description
overlayNode | Node[]overlay or array of nodes to be removed

Returns

LineChart

this

Inherited from

Group.removeOverlay


render

render(context): void

Render group

Parameters

Name Type Description
contextRenderingContextcontext to render group

Returns

void

Inherited from

Group.render


renderAsync

renderAsync(context, callback): void

Render node in asynchronous mode. This implementation doesn't support cache for now.

Parameters

Name Type Description
contextRenderingContextThe rendering context to be used to draw the node
callback() => voidcallback function

Returns

void

Inherited from

Group.renderAsync


renderBackground

Protected renderBackground(context, bounds): LineChart

Render background

Parameters

Name Type Description
contextRenderingContextcontext to render background
boundsRectgroup bounds

Returns

LineChart

this

Inherited from

Group.renderBackground


renderBaseLayers

Protected renderBaseLayers(context): LineChart

Render baseLayers on bottom of cache. This method does nothing, but can be implemented to render graphics on bottom of cache and between borders

Parameters

Name Type Description
contextRenderingContextcontext to render baseLayers

Returns

LineChart

this

Inherited from

Group.renderBaseLayers


renderBaseLayersAsync

Protected renderBaseLayersAsync(context, callback): void

Render baseLayers on bottom of cache in asynchronous mode. This method calls renderBaseLayers

Parameters

Name Type Description
contextRenderingContextcontext to render overlays
callback() => voidcallback function

Returns

void

Inherited from

Group.renderBaseLayersAsync


renderChildren

Protected renderChildren(context): void

Render children

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void

Inherited from

Group.renderChildren


renderChildrenAsync

Protected renderChildrenAsync(context, callback): void

Render children async

Parameters

Name Type Description
contextRenderingContextRendering Context
callback() => voidcallback function to be called then all children are rendered

Returns

void

Inherited from

Group.renderChildrenAsync


renderContent

Protected renderContent(context): void

render to specified context. This method calls preRendering, renderChildren, postRendering

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void

Inherited from

Group.renderContent


renderContentAsync

Protected renderContentAsync(context, callback): void

Render children in asynchronous mode

Parameters

Name Type Description
contextRenderingContextThe rendering context to be used to draw the node
callback() => voidcallback function to be called then all children are rendered

Returns

void

Inherited from

Group.renderContentAsync


renderOverlays

Protected renderOverlays(context): LineChart

Render overlays on top of cache. This method does nothing, but can be implemented to render graphics on top of cache and between borders

Parameters

Name Type Description
contextRenderingContextcontext to render overlays

Returns

LineChart

this

Inherited from

Group.renderOverlays


renderOverlaysAsync

Protected renderOverlaysAsync(context, callback): void

Render overlays on top of cache in asynchronous mode. This method calls renderOverlays

Parameters

Name Type Description
contextRenderingContextcontext to render overlays
callback() => voidcallback function

Returns

void

Inherited from

Group.renderOverlaysAsync


resumeUpdate

resumeUpdate(rebuild?, changes?): LineChart

Resume auto update

Parameters

Name Type Description
Optional rebuildbooleanforce rebuild
Optional changesStateChangesoptional parameter to specify a reason of changes

Returns

LineChart

this

Inherited from

Group.resumeUpdate


rotate

rotate(theta, x, y): LineChart

Rotate bounds around a given coordinate

Parameters

Name Type Description
thetanumberangle to rotate node, in radians
xnumberx coordinate to rotate around
ynumbery coordinate to rotate around

Returns

LineChart

this

Inherited from

Group.rotate


scale

scale(xx, yy): LineChart

Scale node

Parameters

Name Type Description
xxnumberx scale factor
yynumbery scale factor

Returns

LineChart

this

Inherited from

Group.scale


setAnimationStyle

setAnimationStyle(animationStyle): LineChart

Sets animation style

Parameters

Name Type Description
animationStyleTypeanimation style

Returns

LineChart

Inherited from

Group.setAnimationStyle


setAutoDataLimits

setAutoDataLimits(enable): LineChart

Sets a flag to indicate automatic calculation of data limits

Parameters

Name Type Description
enablebooleanenable or disable calculation of the data limits

Returns

LineChart

this

Implementation of

IChartDataVisual.setAutoDataLimits


setAutoModelLimitsMode

setAutoModelLimitsMode(mode): LineChart

Set 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. This is convenient method. It creates AutoModelLimitsStrategy

Parameters

Name Type Description
modebooleanModel Limits Logics to be used

Returns

LineChart

this

Inherited from

Group.setAutoModelLimitsMode


setAutoModelLimitsStrategy

setAutoModelLimitsStrategy(strategy): LineChart

Set Model Limits Logics Strategy

Parameters

Name Type Description
strategyModelLimitsStrategyModel Limits logic strategy to use

Returns

LineChart

this

Inherited from

Group.setAutoModelLimitsStrategy


setBounds

setBounds(bounds): LineChart

Sets bounds of the node in the parent coordinates

Parameters

Name Type Description
boundsTypebound of the node in the parent coordinates

Returns

LineChart

this

Inherited from

Group.setBounds


setCache

setCache(cache, rebuild?): LineChart

Sets cache to be used to cache

Parameters

Name Type Description
cacheCachecache to be used
Optional rebuildbooleanrebuild cache

Returns

LineChart

this

Inherited from

Group.setCache


setChild

setChild(index, node): LineChart

Replace child node by index

Parameters

Name Type Description
indexnumberindex of the node
nodeNodenode

Returns

LineChart

this

Inherited from

Group.setChild


setClipStyle

setClipStyle(style): LineChart

Sets a new clipping style

Parameters

Name Type Description
styleGraphicsPath | ClipStyle | Optionsa new clipping style

Returns

LineChart

this

Inherited from

Group.setClipStyle


setContentOrientation

setContentOrientation(orientation): LineChart

Set content orientation

Parameters

Name Type Description
orientationOrientationcontent orientation

Returns

LineChart

this

Inherited from

Group.setContentOrientation


setCss

setCss(style, merge?): LineChart

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

Parameters

Name Type Description
styleTypeCSS style to be applied to inserted elements
Optional mergebooleanmerge flag

Returns

LineChart

this

Inherited from

Group.setCss


setCssClass

setCssClass(name): LineChart

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

Parameters

Name Type Description
namestringcss class name of the node

Returns

LineChart

this

Inherited from

Group.setCssClass


setCssTransform

setCssTransform(transform): LineChart

Set CSS transformation

Parameters

Name Type Description
transformstring | Transformationtransformation css transformation instruction or Transformation instance

Returns

LineChart

this

Inherited from

Group.setCssTransform


setData

setData(data): LineChart

Set the data to be plotted in the line chart.

Parameters

Name Type Description
dataPartial<DataModel>data

Returns

LineChart

this


setDesiredHeight

setDesiredHeight(value, silent?): LineChart

Sets desired height of the group as a layoutable object

Parameters

Name Type Description
valuestring | numberdesired height to set, use 'auto' for automatic desired height
Optional silentbooleansilent setting

Returns

LineChart

this

Inherited from

Group.setDesiredHeight


setDesiredWidth

setDesiredWidth(value, silent?): LineChart

Sets desired width of the group as a layoutable object

Parameters

Name Type Description
valuestring | numberdesired width to set
Optional silentbooleansilent setting

Returns

LineChart

this

Inherited from

Group.setDesiredWidth


setFillStyle

setFillStyle(fillStyle, merge?): LineChart

Sets fill style

Parameters

Name Type Description
fillStyleTypea new fill style
Optional mergebooleantrue if you want to merge fillStyle with existing attribute, false by default

Returns

LineChart

this

Inherited from

Group.setFillStyle


setGapFillCutoffValue

setGapFillCutoffValue(cutoff): LineChart

Sets the value of the cutoff used for removing NaN valued samples. Gaps will only be 'filled' when the cutoff value is non zero.

Parameters

Name Type Description
cutoffnumberThe cutoff value. When non zero is set

Returns

LineChart

this


setGapValue

setGapValue(value): LineChart

Set the value of the gap. Value will be used to disconnect the sample if the distance between two samples in x axis is more than specified value

Parameters

Name Type Description
valuenumberThe maximum discontinuity allowed in x axis

Returns

LineChart

this


setGridStyle

setGridStyle(tickStyles?): LineChart

Set grid line styles

Parameters

Name Type
Optional tickStylesObject
Optional tickStyles.xObject
Optional tickStyles.x.edgeType
Optional tickStyles.x.majorType
Optional tickStyles.x.minorType
Optional tickStyles.yObject
Optional tickStyles.y.edgeType
Optional tickStyles.y.majorType
Optional tickStyles.y.minorType

Returns

LineChart


setHorizontalFlip

setHorizontalFlip(enable): LineChart

Set horizontal flip of the representation

Parameters

Name Type Description
enablebooleanenable flip

Returns

LineChart

this

Inherited from

Group.setHorizontalFlip


setId

setId(id): LineChart

Allows the user to associate any identifier

Parameters

Name Type Description
idstring | numberobject id

Returns

LineChart

this

Inherited from

Group.setId


setInfiniteMode

setInfiniteMode(infinityMode): LineChart

Set infinity mode flag to draw composite without collision check

Parameters

Name Type Description
infinityModebooleaninfinity mode flag

Returns

LineChart

this

Inherited from

Group.setInfiniteMode


setLayout

setLayout(layout): LineChart

Associate layout with a group.

Parameters

Name Type Description
layoutRecord<string, any> | Layoutlayout instance to be set or layout properties to apply

Returns

LineChart

this

Inherited from

Group.setLayout


setLayoutInvalidated

Protected setLayoutInvalidated(invalidated): void

Set invalidation status

Parameters

Name Type Description
invalidatedbooleaninvalidated layout

Returns

void

Inherited from

Group.setLayoutInvalidated


setLayoutStyle

setLayoutStyle(layoutStyle, silent?, merge?): LineChart

specify desired layout style

Parameters

Name Type Description
layoutStyleLayoutStyle<string | number> | Options<string | number>desired layout style
Optional silentbooleansilent setting
Optional mergebooleantrue if you want to merge layoutStyle with existing attribute, false by default

Returns

LineChart

this

Inherited from

Group.setLayoutStyle


setLineStyle

setLineStyle(lineStyle, merge?): LineChart

Sets border color Returns this

Parameters

Name Type Description
lineStyleTypeline style or options
Optional mergebooleantrue if you want to merge lineStyle with existing attribute, false by default

Returns

LineChart

this

Inherited from

Group.setLineStyle


setLocalTransform

setLocalTransform(localTransform, force?): LineChart

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

Parameters

Name Type Description
localTransformTransformationlocal transformation for this node
Optional forcebooleanboolean flag to force update event if transformations are equal, false by default

Returns

LineChart

this

Inherited from

Group.setLocalTransform


setMarginsStyle

setMarginsStyle(margins, merge?): LineChart

Sets margins style

Parameters

Name Type Description
marginsType<string | number>margins style
Optional mergebooleantrue if you want to merge marginsStyle with existing attribute, false by default

Returns

LineChart

this

Inherited from

Group.setMarginsStyle


setModelLimits

setModelLimits(limits): LineChart

Sets inner model limits and it sets autodatalimits to false

Parameters

Name Type Description
limitsRectinner limits

Returns

LineChart

this

Overrides

Group.setModelLimits


setName

setName(name): LineChart

Sets name of the node

Parameters

Name Type Description
namestringThe node name

Returns

LineChart

this

Inherited from

Group.setName


setNotification

setNotification(notify, force?): LineChart

set notification state

Parameters

Name Type Description
notifybooleanflag set to invalidate parent or not
Optional forcebooleantrue if parent should be invalidated immediately

Returns

LineChart

this

Inherited from

Group.setNotification


setOpacity

setOpacity(opacity, blendMode?): LineChart

Sets node opacity

Parameters

Name Type Description
opacitynumbernode opacity from 0 to 1
Optional blendModeBlendModeopacity blend mode. If it is normal, opacity will be replaced.

Returns

LineChart

this

Inherited from

Group.setOpacity


setOptimization

setOptimization(needOptimization?): LineChart

Turns on/off optimization for line

Parameters

Name Type Description
Optional needOptimizationbooleanIs optimization for line on

Returns

LineChart

this


setOptimizationSymbol

setOptimizationSymbol(needOptimize?): LineChart

Turns on/off optimization for symbols

Parameters

Name Type Description
Optional needOptimizebooleanIs optimization for symbols on

Returns

LineChart

this


setOptimizationType

setOptimizationType(optimizationType): LineChart

Sets optimization type

Parameters

Name Type Description
optimizationTypeOptimizationTypeoptimization type which used with current line

Returns

LineChart

this


setOptions

setOptions(options): LineChart

Sets options

Parameters

Name Type Description
optionsOptionsAn object containing the properties to set, see LineChart.setProperties

Returns

LineChart

this


setPaddingStyle

setPaddingStyle(paddingStyle, merge?): LineChart

Sets padding style

Parameters

Name Type Description
paddingStyleType<string | number>padding style
Optional mergebooleantrue if you want to merge paddingStyle with existing attribute, false by default

Returns

LineChart

this

Inherited from

Group.setPaddingStyle


setProperties

setProperties(properties?): LineChart

Sets visual options for the chart

Parameters

Name Type Description
Optional propertiesOptionsoptions

Returns

LineChart

this

Overrides

Group.setProperties


setProperty

setProperty(name, value): LineChart

Sets dynamic property by name

Parameters

Name Type Description
namestringproperty name
valueanyproperty value

Returns

LineChart

this

Inherited from

Group.setProperty


setRenderingFilter

setRenderingFilter(filter): LineChart

Sets filter to be applied before rendering and picking

Parameters

Name Type Description
filterIFilterfilter to set

Returns

LineChart

this

Inherited from

Group.setRenderingFilter


setResponsiveStyle

setResponsiveStyle(style): LineChart

Sets responsive style.

Parameters

Name Type Description
styleOptions | ResponsiveStyleresponsive style

Returns

LineChart

this

Inherited from

Group.setResponsiveStyle


setScaleScrollStrategy

setScaleScrollStrategy(strategy?): LineChart

Sets scale scroll strategy

Parameters

Name Type Description
Optional strategyDelegatescale scroll strategy

Returns

LineChart

this

Inherited from

Group.setScaleScrollStrategy


setSelectable

setSelectable(selectable): LineChart

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

Parameters

Name Type Description
selectablebooleanflag to allow node selection

Returns

LineChart

this

Inherited from

Group.setSelectable


setSilent

setSilent(bool): LineChart

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

LineChart

this

Inherited from

Group.setSilent


setTag

setTag(tag): LineChart

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

Parameters

Name Type Description
taganyThe object to be associated with the node.

Returns

LineChart

this

Inherited from

Group.setTag


setVerticalFlip

setVerticalFlip(flip): LineChart

Set vertical flip of the representation

Parameters

Name Type Description
flipbooleanflag to set the vertical flip of the representation

Returns

LineChart

this

Inherited from

Group.setVerticalFlip


setVisible

setVisible(value): LineChart

Sets visibility of the node. Send event Events.VisibilityChanged

Parameters

Name Type Description
valuebooleanflag specifying visibility of the node

Returns

LineChart

this

Inherited from

Group.setVisible


setVisibleModelLimits

setVisibleModelLimits(visibleModelBounds, deviceBounds?): LineChart

Set visible model limits

Parameters

Name Type Description
visibleModelBoundsRectvisible model limits or bounds
Optional deviceBoundsRectdevice bounds

Returns

LineChart

this

Inherited from

Group.setVisibleModelLimits


setZIndex

setZIndex(value): LineChart

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

Parameters

Name Type Description
valuenumberindex determining node z-position

Returns

LineChart

this

Inherited from

Group.setZIndex


shear

shear(shx, shy): LineChart

Shear this node's bounds

Parameters

Name Type Description
shxnumberx-axis shear
shynumbery-axis shear

Returns

LineChart

this

Inherited from

Group.shear


suspendUpdate

suspendUpdate(): LineChart

Suspend auto update

Returns

LineChart

this

Inherited from

Group.suspendUpdate


toString

toString(): string

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

Returns

string

A string representation

Inherited from

Group.toString


translate

translate(tx, ty): LineChart

Translate bounds

Parameters

Name Type Description
txnumberx translation
tynumbery translation

Returns

LineChart

this

Inherited from

Group.translate


unregisterAnimationStyle

unregisterAnimationStyle(root): void

Unregister animation style.

Parameters

Name Type Description
rootAnimatedNoderoot node for node

Returns

void

Inherited from

Group.unregisterAnimationStyle


updateLayout

updateLayout(targets?): LineChart

Updates layout(s)

Fires

Events.LayoutUpdated

Parameters

Name Type Description
Optional targetsILayoutable[]optional parameter about which element to layout

Returns

LineChart

this

Inherited from

Group.updateLayout


updateSceneTransformation

updateSceneTransformation(): LineChart

Update scene transformation

Returns

LineChart

this

Inherited from

Group.updateSceneTransformation


updateState

updateState(regions?, changes?): LineChart

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

Parameters

Name Type Description
Optional regionsRect[]optional array to return invalid rectangles in the parent coordinates
Optional changesStateChangesoptional parameter to specify a reason of changes

Returns

LineChart

this

Inherited from

Group.updateState


updateSuspended

updateSuspended(): boolean

Return state of suspend state

Returns

boolean

state of update

Inherited from

Group.updateSuspended


updateTimeStamp

Protected updateTimeStamp(): LineChart

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

Returns

LineChart

this

Inherited from

Group.updateTimeStamp


enableSceneGraphNotification

Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

Parameters

Name Type Description
enabledbooleansets if this object sends notifications

Returns

void

Inherited from

Group.enableSceneGraphNotification


findParent

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

Find root of the node with specified type

Type parameters

NameType
Textends Constructor<any>

Parameters

Name Type Description
nodeNodenode to start search
classTypeTtype of the class to search for
Optional filter(node: Node) => booleanadditional filter to apply

Returns

InstanceType<T>

Inherited from

Group.findParent

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

Find root of the node with specified type

Parameters

Name Type Description
nodeNodenode to start search
classTypestringinterface name to search for
Optional filter(node: Node) => booleanadditional filter to apply

Returns

Node

Inherited from

Group.findParent


getClassName

Static getClassName(): string

Returns

string

Inherited from

Group.getClassName


isSceneGraphNotificationEnabled

Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

Returns

boolean

Inherited from

Group.isSceneGraphNotificationEnabled