API / geotoolkit / controls / shapes / BubbleChart / BubbleChart
shapes.BubbleChart.BubbleChart
A bubble chart is a variation of a scatter chart in which the data points are replaced with bubbles,
and an additional dimension of the data is represented in the size of the bubbles.
a bubble chart plots x values, y values, z (color) values and s (size) values.
geotoolkit.controls.shapes.BubbleChart is used internally by the BubbleChart.
↳
BubbleChart
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
autominmaxs | boolean | Enable automatically calculate minimum and maximum of series s |
autominmaxx | boolean | Automatically adjust x limit to contain all symbols in x axis direction without clipping anyone |
autominmaxy | boolean | Automatically adjust y limit to contain all symbols in axis direction without clipping anyone |
autominmaxz | boolean | Enable automatically calculate minimum and maximum of series z |
cacheheightlimit | number | Height cache limit |
cachewidthlimit | number | Width cache limit |
clipstyle | ClipStyle | Clipping style |
clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
clipstyle-geometry | GraphicsPath | Clipping geometry |
clipstyle-geometry-bounds | Rect | Bounds |
clipstyle-geometry-bounds-height | number | Height |
clipstyle-geometry-bounds-readonly | boolean | Readonly |
clipstyle-geometry-bounds-width | number | Width |
clipstyle-geometry-bounds-x | number | Left |
clipstyle-geometry-bounds-y | number | Top |
clipstyle | GraphicsPath | Clipping style |
colorprovider | ColorProvider | The colorProvider used to color points based on their Z value |
colorprovider-max | number | |
colorprovider-min | number | |
colorprovider-scale | KnownScales | |
cssclass | string | The css class name of this node |
csscursor | string | CSS cursor associated with node |
cssstyle | string | CSS style to be applied to inserted elements |
defaultfillstyle | string | The fillstyle to be used if there is no ColorProvider provided or if a point has no valid Z value |
defaultfillstyle | FillStyle | The fillstyle to be used if there is no ColorProvider provided or if a point has no valid Z value |
defaultfillstyle-color | string | Color in CSS form |
defaultfillstyle-evenoddmode | boolean | Even-odd fill mode |
defaultfillstyle-fillpattern | Pattern | Pattern |
defaultfillstyle-fillpattern-containername | string | An 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 |
defaultfillstyle-fillpattern-patternname | string | Name of this pattern for indexing |
defaultfillstyle-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
defaultfillstyle-foreground | string | Foreground color |
defaultfillstyle-pattern | Pattern | Pattern |
defaultlinestyle | string | The linestyle to be used to render symbol |
defaultlinestyle | LineStyle | The linestyle to be used to render symbol |
defaultlinestyle-color | string | Color in CSS form |
defaultlinestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
defaultlinestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
defaultlinestyle-linecap | CapStyle | The line cap style |
defaultlinestyle-linedashoffset | number | Line dash offset of dashed line |
defaultlinestyle-linejoin | JoinStyle | The line join style |
defaultlinestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
defaultlinestyle-scalable | boolean | True if width should depend on transformation |
defaultlinestyle-unit | string | Optional unit for the width |
defaultlinestyle-width | number | string | The line thickness |
fillstyle | string | Style applied on fill |
fillstyle | FillStyle | Style applied on fill |
id | string | number | Id of the node, its a unique identifier |
labellocation | string | The relative location of label to bubble |
labelpadding | number | The padding between labels and bubble or view boundary |
labeltextstyle | string | The text style of labels |
labeltextstyle | TextStyle | The text style of labels |
labeltextstyle-alignment | AlignmentStyle | Alignment |
labeltextstyle-autosize | boolean | Auto font size on high definition display |
labeltextstyle-background | string | Background style |
labeltextstyle-background | FillStyle | Background style |
labeltextstyle-baseline | BaseLineStyle | Base line |
labeltextstyle-color | string | Color in CSS form |
labeltextstyle-fill | FillStyle | Text fill style |
labeltextstyle-font | string | Font see |
labeltextstyle-fonturl | string | The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword |
labeltextstyle-lineheight | string | number | Line height |
labeltextstyle-multiline | boolean | Allow multi-line text |
labeltextstyle-outline | string | Outline style |
labeltextstyle-outline | LineStyle | Outline style |
labeltextstyle-overflowwrap | OverflowWrapStyle | Overflow wrap |
labeltextstyle-strikethrough | string | Strikethrough style |
labeltextstyle-strikethrough | LineStyle | Strikethrough style |
labeltextstyle-textoverflow | TextOverflowStyle | Text overflow |
labeltextstyle-underline | string | Underline style |
labeltextstyle-underline | LineStyle | Underline style |
labeltextstyle-underlineoffset | string | number | Underline offset distance |
labeltextstyle-whitespace | WhiteSpaceStyle | White space |
labeltextstyle-wordbreak | WordBreakStyle | Word break |
labelvisible | boolean | Flag determine the visibility of labels |
linestyle | string | Style applied on outline |
linestyle | LineStyle | Style applied on outline |
localtransform | Transformation | Local transformation |
localtransform-dx | number | X axis translation |
localtransform-dy | number | Y axis translation |
localtransform-xx | number | X scale |
localtransform-xy | number | Xy skew |
localtransform-yx | number | Yx skew |
localtransform-yy | number | Y scale |
margins | number | string | It has properties for specifying the margins for each side |
maxs | number | The s maximum to use |
maxsize | number | Maximum size (side length of square) of symbol |
maxx | number | The x maximum to use, can be used to clip the data |
maxy | number | The y maximum to use, can be used to clip the data |
maxz | number | The z maximum to use |
mins | number | The s minimum to use |
minsize | number | Minimum size (side length of square) of symbol |
minspanx | number | Desired minimum distance between ticks in pixels for series x |
minspany | number | Desired minimum distance between ticks in pixels for series y |
minx | number | The x minimum to use, can be used to clip the data |
miny | number | The y minimum to use, can be used to clip the data |
minz | number | The z minimum to use |
name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
neatlimitx | boolean | Enable calculation of neat limit for series x |
neatlimity | boolean | Enable calculation of neat limit for series y |
opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
opacityblendmode | BlendMode | Node opacity mode to blend it |
preciselimitx | boolean | Option for neat limits calculates only step and hide edge ticks. It is enabled only if neatlimits is set |
preciselimity | boolean | Option for neat limits calculates only step and hide edge ticks. It is enabled only if neatlimits is set |
scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
scalescrollstrategy-enabled | boolean | Enable flag |
secondarylocation | string | The relative location of label to bubble when first location is unable to show the label completely |
selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
selectable | boolean | Determine if the shape is selectable |
sizebin | number | The number of bins for showing different degree of size, default value is the number of items in data series |
tag | any | Custom 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 |
transform | string | Additional CSS transformation applied to node or 'none' |
transform | Transformation | Additional CSS transformation applied to node or 'none' |
validlength | number | The min length of four data series |
visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
z-index | number | Define node z-index |
Constructors
• new BubbleChart(options?, parentbounds?)
ScaledShape.constructor
Methods
▸ addCssClass(cssclass): BubbleChart
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addData(amount): void
Add values to chart
| Name | Type | Description |
|---|---|---|
amount | number | the amount of added values |
void
▸ addInvalidateHandler(handler): BubbleChart
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
ScaledShape.addInvalidateHandler
▸ Protected applyOpacity(context): BubbleChart
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
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
this
▸ Protected applyResponsiveStyle(): void
Apply a responsive style rules it is exists
void
ScaledShape.applyResponsiveStyle
▸ checkCollision(context): boolean
Check collision
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if object is inside of rendering area
▸ clone(): Node
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): BubbleChart
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
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
▸ Protected copyConstructor(src, deepCopy?): BubbleChart
Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
| Name | Type | Description |
|---|---|---|
src | Shape | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
▸ disconnectStyle(style, type, callback): BubbleChart
Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
▸ dispose(): void
Disposes this node, once disposes a node should not be used anymore.
Clear all listeners, and disconnect styles to avoid memory leaks.
Also aggressively 'cleanup' this node by setting some of its members to null.
void
▸ enableEventPropagation(enable): BubbleChart
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();| Name | Type | Description |
|---|---|---|
enable | boolean | enable |
this
ScaledShape.enableEventPropagation
▸ execute(delegate): BubbleChart
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");
});| Name | Type | Description |
|---|---|---|
delegate | (this: BubbleChart) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: BubbleChart) => T |
T
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
▸ getAxisDimensionX(): AxisMappingDimension
Return axis dimension for X axis
▸ getAxisDimensionY(): AxisMappingDimension
Return axis dimension for Y axis
▸ getBounds(): Rect
Get the bounds of the chart in model unit
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ getCss(): CssStyle
Return CSS style
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
▸ getCssClasses(): string[]
Gets list of css class names which applied to this node
string[]
▸ getCssTransform(): string
Returns CSS transformation
string
▸ getData(ignoreFixedLimit?, ignoreAutoLimit?): DataOut
Get data
| Name | Type | Description |
|---|---|---|
Optional ignoreFixedLimit | boolean | if it is true, return real limit for each axis, otherwise return fixed limit |
Optional ignoreAutoLimit | boolean | ignore the auto limits |
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ getIndicesAt(area, context, sort?, isDeviceRect?): BubbleRect[]
get selected symbols
| Name | Type | Description |
|---|---|---|
area | Area | selected model area |
context | Transformation | RenderingContext | rendering context or transformation |
Optional sort | boolean | sort result by distance |
Optional isDeviceRect | boolean | true for area in device, false in model area |
array of selected symbol
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
ScaledShape.getInvalidateMethod
▸ getLineStyle(): LineStyle
Return line style
lineStyle current line style
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
▸ getName(): string
Returns the node name
string
The node name
▸ getOpacity(): number
Returns current node opacity
number
opacity
▸ getOpacityBlendMode(): BlendMode
Returns current node opacity
opacity blend mode
ScaledShape.getOpacityBlendMode
▸ getParent(): Node
Return parent node
parent node
▸ getParentBounds(): Rect
Get the real bounds of chart in pixel
▸ getProperties(context?): OptionsOut
Gets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional context | ISerializationContext | serialization context |
properties object
▸ getProperty(name): any
Gets dynamic property by name. These properties can be used as a property bags
| Name | Type | Description |
|---|---|---|
name | string | property name |
any
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
ScaledShape.getRenderingFilter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
ScaledShape.getResponsiveStyle
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
▸ getScaleScrollStrategy(): Delegate
Gets scale scroll strategy
scale scroll strategy
ScaledShape.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
▸ getSymbolShape(index): SymbolShape
Gets symbol shape by index
| Name | Type |
|---|---|
index | number |
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
transform the world transform.
▸ getZIndex(): number
Returns node z-index (null if not set)
number
▸ hasCssClass(cssClass): boolean
Check if node has specified css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class name |
boolean
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
▸ hitTest(area, radius?): BubbleRect[]
Hit test in the device coordinates
| Name | Type | Description |
|---|---|---|
area | Point | Rect | model area or position |
Optional radius | number | radius of selection |
a collection of selected data
▸ invalidate(bounds?, force?): BubbleChart
Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | bounds of the invalid rectangle in the inner node coordinates |
Optional force | boolean | true if parent should be invalidated immediately if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed |
this
▸ invalidateCache(): void
Invalidate cache for rebuilding cache before rendering
void
▸ invalidateParent(bounds?, force?): BubbleChart
Invalidate bounds
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed |
Optional force | boolean | flag indicating if the parent must be forcibly invalidated |
this
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
ScaledShape.isEventPropagationEnabled
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
ScaledShape.isNotificationEnabled
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(event, source, args?): BubbleChart
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
event | E | type of event |
source | AbstractNode | source who called the event |
Optional args | EventMap[E] | event arguments |
this
▸ off<E>(type?, callback?): BubbleChart
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: BubbleChart, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): BubbleChart
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: BubbleChart, args: EventMap[E]) => void | to be called |
this
▸ Protected onParentChanged(node): BubbleChart
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
this
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
ScaledShape.onVisibilityChanged
▸ Protected postRendering(context): void
To be called after rendering. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ Protected preRendering(context): void
Occurs before rendering this method sets clipping by default. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
ScaledShape.registerAnimationStyle
▸ removeCssClass(cssclass): BubbleChart
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ removeData(from, amount): void
remove data from chart
| Name | Type | Description |
|---|---|---|
from | number | index where starting remove |
amount | number | amount of data to be removed |
void
▸ removeInvalidateHandler(handler): BubbleChart
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
ScaledShape.removeInvalidateHandler
▸ render(context): void
Renders node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
void
▸ renderAsync(context, callback): void
Render node in asynchronous mode. Default implementation creates call method "render" inside
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function |
void
▸ rotate(theta, x, y): BubbleChart
Rotate bounds around a given coordinate
| Name | Type | Description |
|---|---|---|
theta | number | angle to rotate node, in radians |
x | number | x coordinate to rotate around |
y | number | y coordinate to rotate around |
this
▸ scale(xx, yy): BubbleChart
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setAnimationStyle(animationStyle): BubbleChart
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
▸ setBounds(bounds): boolean
Set the bounds of the chart in model unit
| Name | Type | Description |
|---|---|---|
bounds | Rect | bounds of the chart in model unit |
boolean
▸ setClipStyle(style): BubbleChart
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setCss(style, merge?): BubbleChart
Sets CSS style. This style will be applied for all inserted elements
| Name | Type | Description |
|---|---|---|
style | Type | CSS style to be applied to inserted elements |
Optional merge | boolean | merge flag |
this
▸ setCssClass(name): BubbleChart
Sets css class name of the node to be used to apply CSS style
| Name | Type | Description |
|---|---|---|
name | string | css class name of the node |
this
▸ setCssTransform(transform): BubbleChart
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ setFillStyle(fillStyle, merge?): BubbleChart
Sets fill style
| Name | Type | Description |
|---|---|---|
fillStyle | Type | a new fill style |
Optional merge | boolean | true if you want to merge fillStyle with existing attribute, false by default |
this
▸ setId(id): BubbleChart
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setLineStyle(lineStyle, merge?): BubbleChart
Sets line style
| Name | Type | Description |
|---|---|---|
lineStyle | Type | line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
▸ setLocalTransform(localTransform, force?): BubbleChart
Sets local transformation to be used to transform from local to parent coordinate
| Name | Type | Description |
|---|---|---|
localTransform | Transformation | local transformation for this node |
Optional force | boolean | boolean flag to force update event if transformations are equal, false by default |
this
▸ setMarginsStyle(margins, merge?): BubbleChart
Sets margins style
| Name | Type | Description |
|---|---|---|
margins | Type<string | number> | margins style |
Optional merge | boolean | true if you want to merge marginsStyle with existing attribute, false by default |
this
▸ setName(name): BubbleChart
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): BubbleChart
set notification state
| Name | Type | Description |
|---|---|---|
notify | boolean | flag set to invalidate parent or not |
Optional force | boolean | true if parent should be invalidated immediately |
this
▸ setOpacity(opacity, blendMode?): BubbleChart
Sets node opacity
| Name | Type | Description |
|---|---|---|
opacity | number | node opacity from 0 to 1 |
Optional blendMode | BlendMode | opacity blend mode. If it is normal, opacity will be replaced. |
this
▸ setParentBounds(parentbounds): BubbleChart
Set the real bounds (real size in pixel) for chart
| Name | Type | Description |
|---|---|---|
parentbounds | Rect | bounds of the chart in pixel |
this
▸ setProperties(properties?): BubbleChart
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
▸ setProperty(name, value): BubbleChart
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): BubbleChart
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
ScaledShape.setRenderingFilter
▸ setResponsiveStyle(style): BubbleChart
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
ScaledShape.setResponsiveStyle
▸ setScaleScrollStrategy(strategy?): BubbleChart
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
ScaledShape.setScaleScrollStrategy
▸ setSelectable(selectable): BubbleChart
Allows to select node. If node is not selectable then child node is not selectable.
| Name | Type | Description |
|---|---|---|
selectable | boolean | flag to allow node selection |
this
▸ setSilent(bool): BubbleChart
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTag(tag): BubbleChart
Allows the user to associate any arbitrary object with the node.
| Name | Type | Description |
|---|---|---|
tag | any | The object to be associated with the node. |
this
▸ setVisible(value): BubbleChart
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setZIndex(value): BubbleChart
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): BubbleChart
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): BubbleChart
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
ScaledShape.unregisterAnimationStyle
▸ updateLimits(parentbounds?, start?, end?): void
Update the model bounds
| Name | Type | Description |
|---|---|---|
Optional parentbounds | Rect | bounds of parent node |
Optional start | number | the starting index for incrementally calculating new model bounds |
Optional end | number | the ending index for incrementally calculating new model bounds |
void
▸ updateSceneTransformation(): BubbleChart
Update scene transformation
this
ScaledShape.updateSceneTransformation
▸ updateState(regions?, changes?): BubbleChart
Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph
| Name | Type | Description |
|---|---|---|
Optional regions | Rect[] | optional array to return invalid rectangles in the parent coordinates |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ Protected updateTimeStamp(): BubbleChart
Update time stamp to indicate that Node or Children has been changed.
this
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
ScaledShape.enableSceneGraphNotification
▸ Static findParent<T>(node, classType, filter?): InstanceType<T>
Find root of the node with specified type
| Name | Type |
|---|---|
T | extends Constructor<any> |
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | T | type of the class to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
InstanceType<T>
▸ Static findParent(node, classType, filter?): Node
Find root of the node with specified type
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | string | interface name to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
▸ Static getClassName(): string
string
▸ Static intersectsBounds(bounds, localTransformation, parentInvalidArea, expand?): boolean
Check collision of the shape bounds with parent invalid area
| Name | Type | Description |
|---|---|---|
bounds | Rect | shape bounds |
localTransformation | Transformation | local transformation of the bounds |
parentInvalidArea | Rect | invalid parent area |
Optional expand | Dimension | optional expand the bounds in model coordinate |
boolean
true if bounds intersect the invalid area
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean