API / geotoolkit / charts / FloatingBarChart / FloatingBarChart
charts.FloatingBarChart.FloatingBarChart
Chart shape to display data as FloatingBarChart
↳
FloatingBarChart
Constructors
Methods
Constructors
• new FloatingBarChart(options?)
Chart shape to display data as FloatingBarChart
| Name | Type | Description |
|---|---|---|
Optional options | Options | options |
BarChart.constructor
Methods
▸ addCssClass(cssclass): FloatingBarChart
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addInvalidateHandler(handler): FloatingBarChart
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
▸ Protected applyOpacity(context): FloatingBarChart
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
▸ checkCollision(context): boolean
Check if this node is within the area being rendered by the context
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if object is inside of renderable area
▸ clone(): Node
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): FloatingBarChart
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?): FloatingBarChart
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 | AbstractNode | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
▸ Protected createLegendItem(series, item?): ToggleableSymbolItem
Creates legend item based on series or updating options based on item passed
| Name | Type | Description |
|---|---|---|
series | Series | series object |
Optional item | ToggleableSymbolItem | legend item |
▸ Protected createTooltipSymbol(series, index?): TooltipSymbolOptions
Gets tooltip series symbol
| Name | Type | Description |
|---|---|---|
series | Series | series information |
Optional index | number | symbol index (if there's more than one) |
html to represent tooltip symbol
▸ disconnectStyle(style, type, callback): FloatingBarChart
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): FloatingBarChart
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
BarChart.enableEventPropagation
▸ enumerateNodes(callback, target?): void
Enumerate children nodes
| Name | Type | Description |
|---|---|---|
callback | Callback<Node> | callback |
Optional target | QueryBuilder<any> | target |
void
▸ execute(delegate): FloatingBarChart
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: FloatingBarChart) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: FloatingBarChart) => 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)
▸ formatTooltipItem(item, tooltip?): string
Format tooltip item
| Name | Type | Description |
|---|---|---|
item | TooltipItem | item |
Optional tooltip | SeriesTooltip | tooltip options |
string
tooltip content for specified tooltip item
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
▸ getAnnotationOffset(): number | SpaceStyle<string | number>
Returns device space to be added to annotations surrounding chart. Might be used for axes-overlapping visuals.
number | SpaceStyle<string | number>
▸ getAxis(dimension): string
Returns axis identifier for provided dimension if exists, null otherwise
| Name | Type | Description |
|---|---|---|
dimension | AxisDimensionType | requested axis dimension |
string
▸ getAxisDataType(dimension): DataType
Returns axis data type for the provided dimension
| Name | Type | Description |
|---|---|---|
dimension | AxisDimensionType | dimension to check |
▸ getCachedOverlay(): CompositeNode<Node>
Returns overlay node to be layered over the chart
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ getColorValue(seriesId, sample): number
Returns color value for provided sample to be shared via color axis
| Name | Type | Description |
|---|---|---|
seriesId | string | series name identifier |
sample | number | sample value |
number
▸ 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[]
▸ Protected getCssSeries(): Node[]
Returns css series to handle the chart
Node[]
▸ getCssTransform(): string
Returns CSS transformation
string
▸ getDataLimits(): Rect
Returns chart shape limits
chart shape limits
▸ getDataSeries(name): INumericalDataSeries & AbstractDataSeries<any>
Returns data series from data source after all the checks and manipulations
| Name | Type | Description |
|---|---|---|
name | string | series name identifier |
INumericalDataSeries & AbstractDataSeries<any>
▸ getDataSeries(name, dimension): NumericalDataSeries
Returns data series from data source after all the checks and manipulations
| Name | Type | Description |
|---|---|---|
name | string | series name identifier |
dimension | AxisDimensionType | DataType | data dimension or type needed |
▸ Protected getDataSource(): DataSource
Returns chart data source
▸ getDesiredModelRange(dimension): Range
Returns desired (default) model range for the chart along provided dimension
| Name | Type | Description |
|---|---|---|
dimension | AxisDimensionType | dimension to check |
▸ getDesiredOffset(): number | SpaceStyle<string | number>
Returns device space to be added to chart model limits. Might be used to layout device-spaced shapes.
number | SpaceStyle<string | number>
▸ getDesiredTickGenerator(dimension): TickGenerator
Returns desired for current chart tick generator
| Name | Type | Description |
|---|---|---|
dimension | AxisDimensionType | dimension type |
instance of tick generator
BarChart.getDesiredTickGenerator
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
▸ getLegendItems(type?): ToggleableSymbolItem[]
Returns array of chart legend items to be added to the chart legend
| Name | Type |
|---|---|
Optional type | LegendType |
▸ Protected getLegendTitle(props, type?): string
Returns formatted legend title
| Name | Type | Description |
|---|---|---|
props | Record<string, string> | format properties object |
Optional type | LegendType | legend type |
string
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
▸ getModelLimits(): Rect
Returns model limits, the limits of this chart inside space
▸ 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
▸ getOrientation(): ChartOrientation
Returns chart orientation
▸ getOverlay(): CompositeNode<Node>
Returns overlay node to be layered over the chart
▸ getParent(): Node
Return parent node
parent node
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
properties
▸ 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
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
▸ 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
BarChart.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
▸ getSelectionId(): string
Returns identifier for shared selection series
string
▸ Protected getSeriesForLegend(): Series[]
Returns series for generate legend items
Series[]
▸ getSeriesInfo(id): Series[]
| Name | Type |
|---|---|
id | Y |
Series[]
▸ getSeriesInfo(id): Series
| Name | Type |
|---|---|
id | string |
▸ getSeriesValue(name, sample): string | number | number[]
Returns value for specific series and sample
| Name | Type | Description |
|---|---|---|
name | string | series name |
sample | number | sample to return |
string | number | number[]
▸ getSymbolShape(sample): SymbolShape
Returns symbol shape for current sample to be shared via crosshair tool
| Name | Type | Description |
|---|---|---|
sample | number | sample index value |
sample symbol
▸ getTableId(): string
Returns table identifier for series
string
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ Protected getTooltipFormat(): string | TooltipFormat
Returns tooltip format callback if exists
string | TooltipFormat
▸ getTooltipItems(selection): TooltipItem[]
Enumerate tooltip items to be used if custom tooltip formatter is not specified
| Name | Type | Description |
|---|---|---|
selection | Record<string, number[]> | selection current selection |
▸ 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?): Hits
Returns selection info with selected samples and series identifier. If chart is not selected, returns provided merge object or null if nothing provided
▸ Protected initialize(options): FloatingBarChart
Initializes listeners and styles after creating
| Name | Type | Description |
|---|---|---|
options | Options | initialization options |
this
▸ invalidate(bounds?, force?): FloatingBarChart
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
▸ Protected invalidateParent(bounds?, force?): FloatingBarChart
Invalidate parent and notify all listeners. NOTE: Don't keep arguments of the event, because instance can be changed
Fires
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | bounds of the invalid rectangle in the inner node coordinates |
Optional force | boolean | force rendering |
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
BarChart.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
BarChart.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
▸ isVerticalFlip(): boolean
Return true if the representation is flipped vertically
boolean
▸ notify<E>(type, source, args?): FloatingBarChart
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event |
source | AbstractChart | source who called the event |
Optional args | EventMap[E] | event arguments |
this
▸ off<E>(type?, callback?): FloatingBarChart
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: FloatingBarChart, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): FloatingBarChart
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: FloatingBarChart, args: EventMap[E]) => void | to be called |
this
▸ onDataSeriesChanged(event, src, series): void
Listener for the new data series added/removed
| Name | Type | Description |
|---|---|---|
event | SeriesAdded | SeriesRemoved | event name |
src | DataSource | data source |
series | string[] | series identifiers |
void
▸ onDataUpdated(): void
Listener for the data source updated event. Could be called independently.
void
▸ onDataValuesChanged(event, src, args): void
Listener for the new data values added/removed or before adding/removing
| Name | Type | Description |
|---|---|---|
event | ValuesAdding | ValuesAdded | ValuesRemoving | ValuesRemoved | event name |
src | DataSource | data source |
args | Object | values interval added/removed |
args.count | number | |
args.from | number |
void
▸ Protected onParentChanged(node): FloatingBarChart
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
this
▸ onSelectionStateChanged(event, src, args): void
| Name | Type |
|---|---|
event | StateUpdated |
src | SelectionSeries |
args | StateUpdatedArgs |
void
BarChart.onSelectionStateChanged
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
▸ 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
BarChart.registerAnimationStyle
▸ removeCssClass(cssclass): FloatingBarChart
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ removeInvalidateHandler(handler): FloatingBarChart
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
BarChart.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): FloatingBarChart
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): FloatingBarChart
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setAnimationStyle(animationStyle): FloatingBarChart
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
▸ setAxisDataType(dimension, type): FloatingBarChart
Sets chart axis data type for one of the dimensions
| Name | Type | Description |
|---|---|---|
dimension | AxisDimensionType | dimension to change |
type | DataType | new data type |
▸ setClipStyle(style): FloatingBarChart
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setCss(style, merge?): FloatingBarChart
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): FloatingBarChart
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): FloatingBarChart
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ setDataMode(mode): FloatingBarChart
Sets data mode
| Name | Type | Description |
|---|---|---|
mode | DataMode | bar mode |
this
▸ Protected setDataSource(data): FloatingBarChart
Sets chart data source
| Name | Type | Description |
|---|---|---|
data | DataSource | data source |
this
▸ setHorizontalFlip(flip): FloatingBarChart
Set horizontal flip of the representation
| Name | Type | Description |
|---|---|---|
flip | boolean | flag to set the horizontal flip of the representation |
▸ setId(id): FloatingBarChart
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setLocalTransform(localTransform, force?): FloatingBarChart
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?): FloatingBarChart
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
▸ setModelLimits(limits): FloatingBarChart
Sets inner model limits
| Name | Type | Description |
|---|---|---|
limits | Rect | inner limits |
▸ setName(name): FloatingBarChart
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): FloatingBarChart
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?): FloatingBarChart
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
▸ setOrientation(orientation): FloatingBarChart
Sets chart rotated due to x- and y- axes exchange (x-axis is vertical and y-axis is horizontal). NOTE: Do not call this method directly, this is called by geotoolkit/charts/widgets/ChartWidget automatically when it handles axis orientation.
| Name | Type |
|---|---|
orientation | ChartOrientation |
this
▸ setPolarCircularFlip(flip): FloatingBarChart
Sets circular space flip direction (standard or inside-out) for polar system
| Name | Type | Description |
|---|---|---|
flip | boolean | true for edge-to-the-center direction, false otherwise |
▸ setPolarClockwiseDirection(clockwise): FloatingBarChart
Sets clockwise/counterclockwise direction for polar system
| Name | Type | Description |
|---|---|---|
clockwise | boolean | true for clockwise, false otherwise |
BarChart.setPolarClockwiseDirection
▸ setPolarStartAngle(angle): FloatingBarChart
Sets model space start angle for polar system
| Name | Type | Description |
|---|---|---|
angle | number | start angle |
▸ setProperties(options?): FloatingBarChart
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional options | Options | object containing the properties to set |
this
▸ setProperty(name, value): FloatingBarChart
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): FloatingBarChart
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
▸ setResponsiveStyle(style): FloatingBarChart
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
▸ setScaleScrollStrategy(strategy?): FloatingBarChart
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
BarChart.setScaleScrollStrategy
▸ setSelectable(selectable): FloatingBarChart
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
▸ setSelectionId(id): FloatingBarChart
Sets new selection series identifier for shared states
| Name | Type | Description |
|---|---|---|
id | string | selection series identifier |
▸ setSilent(bool): FloatingBarChart
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setStackedModeEnabled(enabled): FloatingBarChart
Sets stacked chart mode enabled
| Name | Type | Description |
|---|---|---|
enabled | boolean | enabled |
this
BarChart.setStackedModeEnabled
▸ setTableId(id): FloatingBarChart
Sets new table identifier from source data tables
| Name | Type | Description |
|---|---|---|
id | string | new table identifier |
▸ setTag(tag): FloatingBarChart
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
▸ setVerticalFlip(flip): FloatingBarChart
Set vertical flip of the representation
| Name | Type | Description |
|---|---|---|
flip | boolean | flag to set the vertical flip of the representation |
▸ setVisible(value): FloatingBarChart
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setZIndex(value): FloatingBarChart
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): FloatingBarChart
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ syncModelLimits(): FloatingBarChart
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ tooltipFormat(selection): string
Formats selection info for tooltip purposes, all info is shared between charts
| Name | Type | Description |
|---|---|---|
selection | Record<string, number[]> | current selection info |
string
▸ translate(tx, ty): FloatingBarChart
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | AnimatedNode | root node for node |
void
BarChart.unregisterAnimationStyle
▸ updateSceneTransformation(): FloatingBarChart
Update scene transformation
this
BarChart.updateSceneTransformation
▸ updateState(regions?, changes?): FloatingBarChart
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(): FloatingBarChart
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
BarChart.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 isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean