Class: Plot

• new Plot(options)

• new Plot(options?)

Creates plot

EventDispatcher.constructor

▸ dispose(disposeRoot?): void

Disposes the plot and the associated resources.
This may also call dispose on the root node (see disposeRoot).
The plot should not be used/accessed anymore after this has been called.

void

EventDispatcher.dispose

▸ getAutoUpdateInterval(): number

Returns the time interval for autoupdate mechanism.

number

The time interval in ms

▸ getBoundingClientRect(): DOMRect

Returns the client rect for the plots container element as DOMRect.

DOMRect

the client rect for the plots container element

▸ getCanvas(): HTMLCanvasElement | HTMLCanvasElement[]

Returns the canvas element or elements used by this plot

HTMLCanvasElement | HTMLCanvasElement[]

The canvas element

▸ getClassName(): string

string

EventDispatcher.getClassName

▸ getContainingElement(): HTMLElement

Returns the containing element for the plot
This is either the canvas element or the div element depending on the chosen functionality

HTMLElement

The canvas width

▸ getHeight(): number

Returns the containing element height in virtual pixels.
This returns the raw size given at initialization or through the setSize function.
It ignores any Browser zoom.

number

The canvas height

▸ getRoot(): Node

Returns the root node of the scenegraph.

Node

The root node

▸ getTool(): ToolsContainer

Returns root tool associated to plot

ToolsContainer

▸ getWidth(): number

Returns the containing element width in virtual pixels.
This returns the raw size given at initialization or through the setSize function.
It ignores any Browser zoom.

number

The canvas width

▸ hasEventListener(type, callback?): boolean

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

boolean

EventDispatcher.hasEventListener

▸ isAutoUpdate(): boolean

Return true if auto update is enabled.

boolean

The status of autoupdate

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

EventDispatcher.isDisposed

▸ isInfiniteAutoUpdate(): boolean

Return true if infinite auto update is enabled.

boolean

The status of infinite auto update

▸ isSilent(): boolean

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

boolean

EventDispatcher.isSilent

▸ notify<E>(type, source, args?): Plot

Notify listeners

Plot

this

EventDispatcher.notify

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

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.

Plot

this

EventDispatcher.off

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

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.

Plot

this

EventDispatcher.on

▸ onResize(): Plot

Forces a resize on the plot using its known width and height.

Plot

this

▸ resumeUpdate(refresh?): Plot

Resumes plot update, allowing the update function of triggering a render.

Plot

this

▸ setAutoSize(autoSize): Plot

Enable or disable autosize mechanism.
If enabled, this will let the Plot resize the associated canvas whenever the plot itself is resized.

Plot

this

▸ setAutoUpdate(enable, infinite?): Plot

Enables or disables auto update mechanism.
If auto update is enabled, whenever a node is invalidated it will trigger a Plot update/render.

Plot

this

▸ setAutoUpdateInterval(interval?): Plot

Sets the time interval for autoupdate mechanism.
This will define the delay for polling the status of the Plot and trigger an update/render if necessary.

Plot

this

▸ setRoot(root): Plot

Sets the root node ot be the given node.

Plot

this

▸ setSilent(bool): Plot

Set silent mode

Plot

this

EventDispatcher.setSilent

▸ setSize(width, height): Plot

Sets the plot size to the given dimensions.
This will also change the canvas size if autosize is enabled.
If autorootbounds is enabled, this will also update the bounds of the root node.

Plot

this

▸ setWatermark(watermark): Plot

Sets watermark to have on a plot

Example

import {Text} from '@int/geotoolkit/scene/shapes/Text';
import {AnchorType} from '@int/geotoolkit/util/AnchorType';
const watermark = new Text({
'alignment': AnchorType.LeftBottom, // watermark position on the screen
'textstyle': {
'font': '60px sans-serif'
},
'text': 'My Watermark'
});
plot.setWatermark(watermark);

Plot

this

▸ suspendUpdate(): Plot

Suspends plot update, preventing the update function from triggering a render.

Plot

this

▸ update(): Plot

Updates the plot, forcing a render.
This will be called automatically when the plot has been marked as dirty if the autoupdate is enabled.

Plot

this

▸ Static getClassName(): string

string

EventDispatcher.getClassName

▸ Static getPlotByNode(node): Plot

Get registered plot associated with node

Plot

plot

▸ Static setEnableDevTool(enabled): void

Enable/disable dev tool support

void