Class: CrossPlot

• new CrossPlot(options)

• new CrossPlot(options?)

AnnotatedWidget.constructor

▸ addAxis(axis, location, connectedObject?): Object

add new axis and connect with object

Object

AnnotatedWidget.addAxis

▸ addBaseLayer(baseLayer): CrossPlot

Add baseLayer to container

CrossPlot

this

AnnotatedWidget.addBaseLayer

▸ addChild(node): CrossPlot

Add a child node

CrossPlot

this

AnnotatedWidget.addChild

▸ addCssClass(cssclass): CrossPlot

Adds new css class to node

CrossPlot

this

AnnotatedWidget.addCssClass

▸ addInvalidateHandler(handler): CrossPlot

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

CrossPlot

this

AnnotatedWidget.addInvalidateHandler

▸ addLegend(options): LegendPanel

Creates legend, scrollable panel and interactive tools for the options provided. If legend already exists, does nothing.

Example

widget.addLegend({
// use known types to create legend items automatically (from charts)
// use custom string item for user setup
'alignment': AnchorType.LeftTop,
'offset': new Point(60, 40)
});

LegendPanel

AnnotatedWidget.addLegend

▸ Protected addLegendInteral(options): LegendPanel

LegendPanel

AnnotatedWidget.addLegendInteral

▸ addOverlay(overlay): CrossPlot

Add overlay to container

CrossPlot

this

AnnotatedWidget.addOverlay

▸ addTitle(location, options): void

Add title to annotation

void

AnnotatedWidget.addTitle

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

Adjust position of node to specified area

CrossPlot

this

AnnotatedWidget.adjustPosition

▸ Protected applyOpacity(context): CrossPlot

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

CrossPlot

this

AnnotatedWidget.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

AnnotatedWidget.applyResponsiveStyle

▸ beginExport(): CrossPlot

Prepares object before exporting and saving state

CrossPlot

AnnotatedWidget.beginExport

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

Changes the z-order of the baseLayer.

CrossPlot

this

AnnotatedWidget.changeBaseLayerOrder

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

changes the z-order of the nodes being rendered.

CrossPlot

this

AnnotatedWidget.changeChildOrder

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

Changes the z-order of the overlay.

CrossPlot

this

AnnotatedWidget.changeOverlayOrder

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

true if node is collided

AnnotatedWidget.checkCollision

▸ clearBaseLayers(disposeBaseLayers?): CrossPlot

Remove all child baseLayers from group

CrossPlot

this

AnnotatedWidget.clearBaseLayers

▸ clearCache(): CrossPlot

Clear cache

CrossPlot

this

AnnotatedWidget.clearCache

▸ clearChildren(disposeChildren?): CrossPlot

Remove all child nodes from this composite group

CrossPlot

this

AnnotatedWidget.clearChildren

▸ clearOverlays(disposeOverlays?): CrossPlot

Remove all child overlays from group

CrossPlot

this

AnnotatedWidget.clearOverlays

▸ clone(): Group<Node>

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

Group<Node>

clone

AnnotatedWidget.clone

▸ connect(object, model, orientation?, autoSize?): CrossPlot

Synchronizes object with a model

CrossPlot

this

AnnotatedWidget.connect

▸ connectStyle(style, type, callback): CrossPlot

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

CrossPlot

this

AnnotatedWidget.connectStyle

▸ connectTool(tool): CrossPlot

Connect a new tool with a toolname to the widget

CrossPlot

this

AnnotatedWidget.connectTool

▸ Protected copyConstructor(src, deepCopy?): CrossPlot

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

CrossPlot

this

AnnotatedWidget.copyConstructor

▸ disconnect(object): CrossPlot

Disconnect an object from its source model

CrossPlot

this

AnnotatedWidget.disconnect

▸ disconnectStyle(style, type, callback): CrossPlot

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

CrossPlot

this

AnnotatedWidget.disconnectStyle

▸ disconnectTool(tool): CrossPlot

Disconnect the tool from the widget

CrossPlot

this

AnnotatedWidget.disconnectTool

▸ dispose(): void

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

void

AnnotatedWidget.dispose

▸ Protected drawBorder(localContext, bounds?): CrossPlot

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

CrossPlot

this

AnnotatedWidget.drawBorder

▸ enableClipping(doClip): CrossPlot

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

CrossPlot

this

AnnotatedWidget.enableClipping

▸ enableEventPropagation(enable): CrossPlot

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

CrossPlot

this

AnnotatedWidget.enableEventPropagation

▸ enablePickingChildren(enable): CrossPlot

Enables or disables picking children

CrossPlot

this

AnnotatedWidget.enablePickingChildren

▸ endExport(): void

Restores object's state after exporting

void

AnnotatedWidget.endExport

▸ enumerateNodes(callback, target?): void

Executes a provided function once for each child node

void

AnnotatedWidget.enumerateNodes

▸ execute(delegate): CrossPlot

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

CrossPlot

The result if any or this

AnnotatedWidget.execute

▸ execute<T>(delegate): T

T

AnnotatedWidget.execute

▸ exportToPdf(options?): Promise<IWritable>

Export a part of the container to PDF

This method sets automatically export scale and limits based on input parameters and current model scale and limits

Promise<IWritable>

promise with output stream

AnnotatedWidget.exportToPdf

▸ Protected filter(context): boolean

Filter node

boolean

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

AnnotatedWidget.filter

▸ fitToBounds(): CrossPlot

fit bounds to model limits

Fires

Events.ModelVisibleLimitsChanged

CrossPlot

this

AnnotatedWidget.fitToBounds

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AnnotatedWidget.getAnimationStyle

▸ getAnnotation(location): Group<Node>

return the node at the specific annotation

Group<Node>

AnnotatedWidget.getAnnotation

▸ getAnnotationSize(): Required<AnnotationSize>

Return sizes of all annotations or the exact one

Required<AnnotationSize>

contains size of all annotations

AnnotatedWidget.getAnnotationSize

▸ getAnnotationSize(loc): string | number

string | number

AnnotatedWidget.getAnnotationSize

▸ getAutoModelLimitsMode(): boolean

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

boolean

mode

AnnotatedWidget.getAutoModelLimitsMode

▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy

Get Model Limits Logics Strategy

ModelLimitsStrategy

strategy

AnnotatedWidget.getAutoModelLimitsStrategy

▸ getAxisDataOptions(axis, getDataOptions): AxisDataOptionsOut

Get axis options

AxisDataOptionsOut

JSON which defines data.

▸ getBaseLayer(index): Node

Return baseLayer at specified index

Node

track

AnnotatedWidget.getBaseLayer

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

Return iterator by baseLayers nodes

Iterator<Node>

AnnotatedWidget.getBaseLayers

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

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

Example

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

Iterator<Node>

An iterator for child overlays.

AnnotatedWidget.getBaseLayers

▸ getBaseLayersCount(): number

Returns amount of baseLayers

number

AnnotatedWidget.getBaseLayersCount

▸ getBounds(): Rect

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

Rect

current bounds

AnnotatedWidget.getBounds

▸ getCache(): Cache

Return cache strategy to be used to cache children nodes

Cache

cache

AnnotatedWidget.getCache

▸ getCenterModelLimits(): Rect

Return model limits

Rect

annotated model limits

AnnotatedWidget.getCenterModelLimits

▸ getChild(i): Node

Return node by index

Node

AnnotatedWidget.getChild

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

Return iterator by child nodes

Iterator<S>

AnnotatedWidget.getChildren

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

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

Example

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

Iterator<Node>

An iterator for child nodes.

AnnotatedWidget.getChildren

▸ getChildrenCount(): number

Return number of child nodes

number

AnnotatedWidget.getChildrenCount

▸ getClassName(): string

string

AnnotatedWidget.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

AnnotatedWidget.getClipStyle

▸ getColorProvider(): ColorProvider

Returns color provider

ColorProvider

color provider

▸ getContentOrientation(): Orientation

Return content orientation

Orientation

content orientation

AnnotatedWidget.getContentOrientation

▸ getContentsArea(transformation?): Rect

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

Rect

AnnotatedWidget.getContentsArea

▸ getContentsTransform(): Transformation

getContentsTransform() retrieves the world transformation of the node.

Transformation

transformation from model coordinates to bounds of the group

AnnotatedWidget.getContentsTransform

▸ getCrossPlotShape(): CrossPlot

Return inner crossplot shape

CrossPlot

▸ getCss(): CssStyle

Return CSS style

CssStyle

AnnotatedWidget.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AnnotatedWidget.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AnnotatedWidget.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

AnnotatedWidget.getCssTransform

▸ getData(getDataOptions?): DataOptionsOut

get options

DataOptionsOut

AnnotatedWidget.getData

▸ getDesiredHeight(): string | number

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

string | number

desired height ("undefined" by default)

AnnotatedWidget.getDesiredHeight

▸ getDesiredWidth(): string | number

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

string | number

desired width ("undefined" by default)

AnnotatedWidget.getDesiredWidth

▸ getDeviceLimits(): Rect

Return device limits

Rect

AnnotatedWidget.getDeviceLimits

▸ getExportElement(options?): CompositeDocumentElement

Returns exportable element

CompositeDocumentElement

return exportable element

AnnotatedWidget.getExportElement

▸ getExportLimits(): Rect

Return export limits

Rect

AnnotatedWidget.getExportLimits

▸ getExportScale(): Object

Gets export scale. By default scale is not set and equal to screen scale

Object

scale

AnnotatedWidget.getExportScale

▸ Protected getExportState(): Record<string, any>

Returns export state

Record<string, any>