API / geotoolkit / charts / AreaRangeChart / AreaRangeChart
charts.AreaRangeChart.AreaRangeChart
Chart shape to display AreaRangeChart (filled area between two series)
↳
AreaRangeChart
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
animation | boolean | Chart animation parameter (boolean to enable/disable default animation, enum for pre-installed variant, use object for custom style) |
animation | Effects | Chart animation parameter (boolean to enable/disable default animation, enum for pre-installed variant, use object for custom style) |
baseline | number | Chart baseline |
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 |
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 |
gapfillcutoffvalue | number | Value of the cutoff used for removing NaN valued samples. Gaps will only be 'filled' when the cutoff value is non zero |
gapvalue | number | Maximum value will be used to disconnect the sample if the distance between two samples in x axis is more than specified value |
id | string | number | Id of the node, its a unique identifier |
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 |
name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
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 |
percentarea | boolean | Percent area mode flag |
scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
scalescrollstrategy-enabled | boolean | Enable flag |
selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
selectionsymbol | SymbolOptions | Default selection symbol options for all series |
selectionsymbol-height | number | Height of the symbol |
selectionsymbol-sizeisindevicespace | boolean | Keeps size of the symbol fixed in device space and width and height are in device |
selectionsymbol-step | number | Step to filter symbols |
selectionsymbol-width | number | Width of the symbol |
showinterpolatedvalue | boolean | Show interpolated value between two samples |
spline | boolean | True to display spline chart instead of polyline |
stacked | boolean | Stacked mode flag |
symbol | SymbolOptions | Symbol options for all 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 |
tooltip | SeriesTooltip | Define default series tooltip |
tooltip-format | string | Format of series tooltip series.symbol - series symbol series.list - series list symbol series.name - series name series.id - series id series.unit - series unit series.index - series sample index value - series value |
tooltip-title | string | Tooltip title format template string: chartname - chart name (if specified) charttype - chart type (linechart, crossplot, etc) symbol - chart symbol (if any series have it) list - chart list symbol Series can be addressed with its name (if specified) or id (by default): seriesid.name - specific series name seriesid.value - specific series value seriesid.unit - specific series unit seriesid.symbol - specific series symbol seriesid.id - specific series identifier |
tooltipformat | string | Tooltip format callback or template string: chartname - chart name (if specified) charttype - chart type (linechart, crossplot, etc) symbol - chart symbol (if any series have it) list - chart list symbol Series can be addressed with its name (if specified) or id (by default): seriesid.name - specific series name seriesid.value - specific series value seriesid.unit - specific series unit seriesid.symbol - specific series symbol seriesid.id - specific series identifier Data table meta info can be addressed with series.meta and full path to the property. For example: series.meta.object.field - refers to 'value' string from dataTable.setMetaData({object: {field: 'value'}}) |
transform | string | Additional CSS transformation applied to node or 'none' |
transform | Transformation | Additional CSS transformation applied to node or 'none' |
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 AreaRangeChart(options?)
Chart shape to display AreaRangeChart (filled area between two series)
| Name | Type | Description |
|---|---|---|
Optional options | Options | chart options |
AreaChart.constructor
Methods
▸ addCssClass(cssclass): AreaRangeChart
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addInvalidateHandler(handler): AreaRangeChart
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AreaChart.addInvalidateHandler
▸ Protected applyOpacity(context): AreaRangeChart
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
AreaChart.applyResponsiveStyle
▸ 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): AreaRangeChart
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?): AreaRangeChart
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): AreaRangeChart
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): AreaRangeChart
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
AreaChart.enableEventPropagation
▸ enumerateNodes(callback, target?): void
Enumerate children nodes
| Name | Type | Description |
|---|---|---|
callback | Callback<Node> | callback |
Optional target | QueryBuilder<any> | target |
void
▸ execute(delegate): AreaRangeChart
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: AreaRangeChart) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: AreaRangeChart) => 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 |
AreaChart.getDesiredModelRange
▸ 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
AreaChart.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
Returns properties
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
AreaChart.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): number
Returns value for specific series and sample
| Name | Type | Description |
|---|---|---|
name | string | series name |
sample | number | sample to return |
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): AreaRangeChart
Initializes listeners and styles after creating
| Name | Type | Description |
|---|---|---|
options | Options | initialization options |
this
▸ invalidate(bounds?, force?): AreaRangeChart
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?): AreaRangeChart
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
AreaChart.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
AreaChart.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?): AreaRangeChart
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?): AreaRangeChart
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: AreaRangeChart, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): AreaRangeChart
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: AreaRangeChart, 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): AreaRangeChart
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
AreaChart.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
AreaChart.registerAnimationStyle
▸ removeCssClass(cssclass): AreaRangeChart
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ removeInvalidateHandler(handler): AreaRangeChart
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AreaChart.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): AreaRangeChart
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): AreaRangeChart
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setAnimationStyle(animationStyle): AreaRangeChart
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
▸ setAxisDataType(dimension, type): AreaRangeChart
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): AreaRangeChart
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setCss(style, merge?): AreaRangeChart
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): AreaRangeChart
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): AreaRangeChart
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ Protected setDataSource(data): AreaRangeChart
Sets chart data source
| Name | Type | Description |
|---|---|---|
data | DataSource | data source |
this
▸ setFillStyle(fillstyle?): AreaRangeChart
Sets area fill style
| Name | Type | Description |
|---|---|---|
Optional fillstyle | Type | area fillstyle |
this
▸ setHorizontalFlip(flip): AreaRangeChart
Set horizontal flip of the representation
| Name | Type | Description |
|---|---|---|
flip | boolean | flag to set the horizontal flip of the representation |
▸ setId(id): AreaRangeChart
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setLocalTransform(localTransform, force?): AreaRangeChart
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?): AreaRangeChart
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): AreaRangeChart
Sets inner model limits
| Name | Type | Description |
|---|---|---|
limits | Rect | inner limits |
▸ setName(name): AreaRangeChart
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): AreaRangeChart
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?): AreaRangeChart
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): AreaRangeChart
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): AreaRangeChart
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 |
AreaChart.setPolarCircularFlip
▸ setPolarClockwiseDirection(clockwise): AreaRangeChart
Sets clockwise/counterclockwise direction for polar system
| Name | Type | Description |
|---|---|---|
clockwise | boolean | true for clockwise, false otherwise |
AreaChart.setPolarClockwiseDirection
▸ setPolarStartAngle(angle): AreaRangeChart
Sets model space start angle for polar system
| Name | Type | Description |
|---|---|---|
angle | number | start angle |
▸ setProperties(options?): AreaRangeChart
Sets properties
| Name | Type | Description |
|---|---|---|
Optional options | Options | object properties |
▸ setProperty(name, value): AreaRangeChart
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): AreaRangeChart
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
▸ setResponsiveStyle(style): AreaRangeChart
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
▸ setScaleScrollStrategy(strategy?): AreaRangeChart
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
AreaChart.setScaleScrollStrategy
▸ setSelectable(selectable): AreaRangeChart
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): AreaRangeChart
Sets new selection series identifier for shared states
| Name | Type | Description |
|---|---|---|
id | string | selection series identifier |
▸ setSilent(bool): AreaRangeChart
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTableId(id): AreaRangeChart
Sets new table identifier from source data tables
| Name | Type | Description |
|---|---|---|
id | string | new table identifier |
▸ setTag(tag): AreaRangeChart
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
▸ setTernaryAxesLocation(xLocation, yLocation): AreaRangeChart
Sets axes data locations
| Name | Type | Description |
|---|---|---|
xLocation | TernaryAxisLocation | location for the x-series |
yLocation | TernaryAxisLocation | location for the y-series |
AreaChart.setTernaryAxesLocation
▸ setVerticalFlip(flip): AreaRangeChart
Set vertical flip of the representation
| Name | Type | Description |
|---|---|---|
flip | boolean | flag to set the vertical flip of the representation |
▸ setVisible(value): AreaRangeChart
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setZIndex(value): AreaRangeChart
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): AreaRangeChart
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ syncModelLimits(): AreaRangeChart
▸ 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): AreaRangeChart
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
AreaChart.unregisterAnimationStyle
▸ updateSceneTransformation(): AreaRangeChart
Update scene transformation
this
AreaChart.updateSceneTransformation
▸ updateState(regions?, changes?): AreaRangeChart
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(): AreaRangeChart
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
AreaChart.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