Class: PolarCrossPlot

• new PolarCrossPlot(options)

• new PolarCrossPlot(options?)

CrossPlot.constructor

▸ addCssClass(cssclass): PolarCrossPlot

Adds new css class to node

PolarCrossPlot

this

CrossPlot.addCssClass

▸ addInvalidateHandler(handler): PolarCrossPlot

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

PolarCrossPlot

this

CrossPlot.addInvalidateHandler

▸ Protected applyOpacity(context): PolarCrossPlot

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

PolarCrossPlot

this

CrossPlot.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

CrossPlot.applyResponsiveStyle

▸ cartesianToPolar(x, y): Point

Convert point from polar to cartesian coordinate system

Point

▸ checkCollision(context): boolean

Check collision

boolean

true if object is inside of rendering area

CrossPlot.checkCollision

▸ clone(): CrossPlot

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

CrossPlot

clone

CrossPlot.clone

▸ connectStyle(style, type, callback): PolarCrossPlot

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

PolarCrossPlot

this

CrossPlot.connectStyle

▸ Protected copyConstructor(src, deepCopy?): PolarCrossPlot

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

PolarCrossPlot

this

CrossPlot.copyConstructor

▸ disconnectStyle(style, type, callback): PolarCrossPlot

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

PolarCrossPlot

this

CrossPlot.disconnectStyle

▸ 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

CrossPlot.dispose

▸ enableClipping(doClip): PolarCrossPlot

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

PolarCrossPlot

CrossPlot.enableClipping

▸ enableEventPropagation(enable): PolarCrossPlot

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

PolarCrossPlot

this

CrossPlot.enableEventPropagation

▸ execute(delegate): PolarCrossPlot

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

PolarCrossPlot

The result if any or this

CrossPlot.execute

▸ execute<T>(delegate): T

T

CrossPlot.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

CrossPlot.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

CrossPlot.getAnimationStyle

▸ getBounds(): Rect

Return bounds. Will also lock the bounds so they cannot be directly modified.

Rect

bounds

CrossPlot.getBounds

▸ getCenterX(): number

Returns the X coordinate of the center of the framing rectangle of this rectangular shape.

number

CrossPlot.getCenterX

▸ getCenterY(): number

Returns the Y coordinate of the center of the framing rectangle of this rectangular shape.

number

CrossPlot.getCenterY

▸ getClassName(): string

string

CrossPlot.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

CrossPlot.getClipStyle

▸ getColorProvider(): ColorProvider

Return ColorProvider

ColorProvider

colorProvider

CrossPlot.getColorProvider

▸ getCss(): CssStyle

Return CSS style

CssStyle

CrossPlot.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

CrossPlot.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

CrossPlot.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

CrossPlot.getCssTransform

▸ getData(): Data

Get Data

Data

CrossPlot.getData

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

CrossPlot.getFillStyle

▸ getHeight(): number

Returns the height of the framing rectangle.

number

CrossPlot.getHeight

▸ getHighlightedIndices(): number[]

Gets Highlighted Indices

number[]

CrossPlot.getHighlightedIndices

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

CrossPlot.getId

▸ getIndicesAt(area, includeSize?, tr?): number[]

Return indices in search area

number[]

CrossPlot.getIndicesAt

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

CrossPlot.getInvalidateMethod

▸ getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

LayoutStyle<string | number>

CrossPlot.getLayoutStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

CrossPlot.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

CrossPlot.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

CrossPlot.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

CrossPlot.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

CrossPlot.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

CrossPlot.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

CrossPlot.getParent

▸ getPointsAt(rect): { x: number ; y: number ; z: number }[]

Return points in search area

{ x: number ; y: number ; z: number }[]

CrossPlot.getPointsAt

▸ getPolarGrid(): PolarGrid

Returns associated polar grid

PolarGrid

polar grid

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

CrossPlot.getProperties

▸ getProperty(name): any

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

any

CrossPlot.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

CrossPlot.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

CrossPlot.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

CrossPlot.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

CrossPlot.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

CrossPlot.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

CrossPlot.getSceneTransform

▸ getSymbolPainter(): Painter

Get the current painter used to draw points

Painter

CrossPlot.getSymbolPainter

▸ getSymbolShape(index): SymbolShape

Gets symbol shape by index

SymbolShape

CrossPlot.getSymbolShape

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

CrossPlot.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

CrossPlot.getVisible

▸ getWidth(): number

Returns the width of the framing rectangle.

number

CrossPlot.getWidth

▸ getWorldTransform(): Transformation

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

Transformation

transform the world transform.

CrossPlot.getWorldTransform

▸ getX(): number

Returns the X coordinate of the left bottom corner of the framing rectangle.

number

CrossPlot.getX

▸ getY(): number

Returns the Y coordinate of the left bottom corner of the framing rectangle.

number

CrossPlot.getY

▸ getZIndex(): number

Returns node z-index (null if not set)

number

CrossPlot.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

CrossPlot.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

CrossPlot.hasEventListener

▸ highlightArea(rect, reset): PolarCrossPlot

Highlights the selected area

PolarCrossPlot

CrossPlot.highlightArea

▸ highlightIndices(indices, reset): PolarCrossPlot

Highlights the selected indices

PolarCrossPlot

CrossPlot.highlightIndices

▸ hitTest(area, radius?, ignoreOrientation?): Object

Hit test in the device coordinates

Object

a collection of selected data

CrossPlot.hitTest

▸ invalidate(bounds?, force?): PolarCrossPlot

Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.

PolarCrossPlot

this

CrossPlot.invalidate

▸ invalidateLayout(): PolarCrossPlot

Notify that layout is invalidated. Send event Events.LayoutInvalidated

PolarCrossPlot

this

CrossPlot.invalidateLayout

▸ invalidateParent(bounds?, force?): PolarCrossPlot

Invalidate bounds

PolarCrossPlot

this

CrossPlot.invalidateParent

▸ isClippingEnabled(): boolean

Returns if clipping is enabled or not for this node.

boolean

CrossPlot.isClippingEnabled

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

CrossPlot.isDisposed

▸ isEmpty(): boolean

Return false if bounds is equal to zero

boolean

CrossPlot.isEmpty

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

CrossPlot.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

CrossPlot.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

CrossPlot.isSelectable

▸ isSilent(): boolean

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

boolean

CrossPlot.isSilent

▸ notify<E>(event, source, args?): PolarCrossPlot

Notify listeners of the Node

PolarCrossPlot

this

CrossPlot.notify

▸ off<E>(type?, callback?): PolarCrossPlot

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.

PolarCrossPlot

this

CrossPlot.off

▸ on<E>(type, callback): PolarCrossPlot

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.

PolarCrossPlot

this

CrossPlot.on

▸ Protected onParentChanged(node): PolarCrossPlot

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

PolarCrossPlot

this

CrossPlot.onParentChanged

▸ Protected onRectChanged(newRect): PolarCrossPlot

PolarCrossPlot

CrossPlot.onRectChanged

▸ Protected onVisibilityChanged(): void

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

void

CrossPlot.onVisibilityChanged

▸ polarToCartesian(r, theta): Point

Converting a point from polar to Cartesian coordinates, where x and y are offsets from the polar grid center

Point

▸ Protected postRendering(context): void

To be called after rendering. Call this method if you override method render

void

CrossPlot.postRendering

▸ Protected preRendering(context): void

Occurs before rendering this method sets clipping by default. Call this method if you override method render

void

CrossPlot.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

CrossPlot.registerAnimationStyle

▸ removeCssClass(cssclass): PolarCrossPlot

Removes css class from node

PolarCrossPlot

this

CrossPlot.removeCssClass

▸ removeInvalidateHandler(handler): PolarCrossPlot

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

PolarCrossPlot

this

CrossPlot.removeInvalidateHandler

▸ render(context): void

Renders node

void

CrossPlot.render

▸ renderAsync(context, callback): void

Render node in asynchronous mode. Default implementation creates call method "render" inside

void

CrossPlot.renderAsync

▸ rotate(theta, x, y): PolarCrossPlot

Rotate bounds around a given coordinate

PolarCrossPlot

this

CrossPlot.rotate

▸ scale(xx, yy): PolarCrossPlot

Scale node

PolarCrossPlot

this

CrossPlot.scale

▸ setAnimationStyle(animationStyle): PolarCrossPlot

Sets animation style

PolarCrossPlot

CrossPlot.setAnimationStyle

▸ setBounds(rect): PolarCrossPlot

Sets the location and size of the framing rectangle of this rectangular shape to the specified values. This method is the same as setRect.

PolarCrossPlot

this

CrossPlot.setBounds

▸ setBounds(x1, y1?, x2?, y2?): PolarCrossPlot

Sets the location and size of the framing rectangle of this rectangular shape to the specified values. This method is the same as setRect.

PolarCrossPlot

this

CrossPlot.setBounds

▸ setClipStyle(style): PolarCrossPlot

Sets a new clipping style

PolarCrossPlot

this

CrossPlot.setClipStyle

▸ setCss(style, merge?): PolarCrossPlot

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

PolarCrossPlot

this

CrossPlot.setCss

▸ setCssClass(name): PolarCrossPlot

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

PolarCrossPlot

this

CrossPlot.setCssClass

▸ setCssTransform(transform): PolarCrossPlot

Set CSS transformation

PolarCrossPlot

this

CrossPlot.setCssTransform

▸ setData(options): PolarCrossPlot

Sets data

PolarCrossPlot

this

CrossPlot.setData

▸ setFillStyle(fillStyle, merge?): PolarCrossPlot

Sets fill style

PolarCrossPlot

this

CrossPlot.setFillStyle

▸ setHighLightColors(colors): PolarCrossPlot

PolarCrossPlot

CrossPlot.setHighLightColors

▸ setId(id): PolarCrossPlot

Allows the user to associate any identifier

PolarCrossPlot

this

CrossPlot.setId

▸ setLayoutStyle(layoutStyle, merge?): PolarCrossPlot

Specify desired layout style

PolarCrossPlot

CrossPlot.setLayoutStyle

▸ setLineStyle(lineStyle, merge?): PolarCrossPlot

Sets line style

PolarCrossPlot

this

CrossPlot.setLineStyle

▸ setLocalTransform(localTransform, force?): PolarCrossPlot

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

PolarCrossPlot

this

CrossPlot.setLocalTransform

▸ setMarginsStyle(margins, merge?): PolarCrossPlot

Sets margins style

PolarCrossPlot

this

CrossPlot.setMarginsStyle

▸ setName(name): PolarCrossPlot

Sets name of the node

PolarCrossPlot

this

CrossPlot.setName

▸ setNotification(notify, force?): PolarCrossPlot

set notification state

PolarCrossPlot

this

CrossPlot.setNotification

▸ setOpacity(opacity, blendMode?): PolarCrossPlot

Sets node opacity

PolarCrossPlot

this

CrossPlot.setOpacity

▸ setProperties(properties?): PolarCrossPlot

Sets all the properties pertaining to this object

PolarCrossPlot

this

CrossPlot.setProperties

▸ setProperty(name, value): PolarCrossPlot

Sets dynamic property by name

PolarCrossPlot

this

CrossPlot.setProperty

▸ setRect(rect): PolarCrossPlot

Sets the location and size of the framing rectangle of this rectangular shape to the specified values.

PolarCrossPlot

CrossPlot.setRect

▸ setRect(params): PolarCrossPlot

Sets the location and size of the framing rectangle of this rectangular shape to the specified values.

PolarCrossPlot

CrossPlot.setRect

▸ setRect(x1, y1, x2, y2): PolarCrossPlot

Sets the location and size of the framing rectangle of this rectangular shape to the specified values.