Class: ContourShape

• new ContourShape(options)

• new ContourShape(options?)

Shape.constructor

▸ addContourListener(contourListener): void

Registers the specified contour listener to receive events from this contour shape.

Deprecated

since 4.0, use .on() instead

void

▸ addCssClass(cssclass): ContourShape

Adds new css class to node

ContourShape

this

Shape.addCssClass

▸ addInvalidateHandler(handler): ContourShape

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

ContourShape

this

Shape.addInvalidateHandler

▸ addVisual(visual, order, refVisual?): void

Add a visual to this contour shape. It may be inserted at the front or the back. If there is no reference visual then valid order parameters include CG_O_FRONT and CG_O_BACK. If there is a reference visual then value order parameters include CG_O_ABOVE and CG_O_BELOW. Throws an exception for invalid order parameters and for null visual/refVisual.

Throws

Error if param is null

void

▸ Protected applyOpacity(context): ContourShape

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

ContourShape

this

Shape.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

Shape.applyResponsiveStyle

▸ checkCollision(context): boolean

Check if this node is within the area being rendered by the context

boolean

true if object is inside of renderable area

Shape.checkCollision

▸ clone(): Node

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

Node

clone

Shape.clone

▸ connectStyle(style, type, callback): ContourShape

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

ContourShape

this

Shape.connectStyle

▸ Protected copyConstructor(src, deepCopy?): ContourShape

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

ContourShape

this

Shape.copyConstructor

▸ disconnectStyle(style, type, callback): ContourShape

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

ContourShape

this

Shape.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

Shape.dispose

▸ enableEventPropagation(enable): ContourShape

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

ContourShape

this

Shape.enableEventPropagation

▸ execute(delegate): ContourShape

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

ContourShape

The result if any or this

Shape.execute

▸ execute<T>(delegate): T

T

Shape.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

Shape.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Shape.getAnimationStyle

▸ getBorder(): ContourBorderVisual

Gets first ContourBorderVisual of visuals

ContourBorderVisual

[visual] First ContourBorderVisual of visuals

▸ getBoundingBox(): Rect

Gets the bounding box of this contour shape. If projection has been set, then the projected bounding box is returned.

Rect

bbox The bounding box of the contour shape.

▸ getBounds(): Rect

Return bounds

Rect

bounds

▸ getClassName(): string

string

Shape.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Shape.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

Shape.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Shape.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Shape.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

Shape.getCssTransform

▸ getDataSource(): AbstractContourDataSource

Gets the data source which provides grids to the contour.

AbstractContourDataSource

dataSource The contour data source.

▸ getFault(): ContourFaultVisual

Gets first ContourFaultVisual of visuals

ContourFaultVisual

[visual] First ContourFaultVisual of visuals

▸ getFaultPointPrecision(): number

Gets the fault point comparison precision (measured in grid cells)

number

precision The fault point precision.

▸ getFaultsList(): ContourFaultList

Gets the faults.

ContourFaultList

faults Object that stores the faults for this Contour Shape.

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Shape.getFillStyle

▸ getGrid(): ContourAbstractGrid

Gets the contour grid. (Object that stores grid data for this contour shape)

ContourAbstractGrid

grid The contour grid.

▸ getGridToModel(): Transformation

Gets the grid to model transform

Transformation

gridToModel The grid to model transformation.

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Shape.getId

▸ getIgnoreErroneousData(): boolean

Gets the flag for grid data checking. DEFAULT: IgnoreErroneousData=false

boolean

ignore Flag indicating whether grid data changing should be enabled.

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

Shape.getInvalidateMethod

▸ getIsofill(): ContourFillVisual

Gets first ContourFillVisual of visuals

ContourFillVisual

[visual] First ContourFillVisual of visuals

▸ getIsoline(): ContourLineVisual

Gets first ContourLineVisual of visuals

ContourLineVisual

[visual] First ContourIsolineVisual of visuals

▸ getLabelsDirection(): ContourLabelsDirection

Gets the labels direction.

ContourLabelsDirection

direction The labels direction.

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

Shape.getLineStyle

▸ getListeners(): AbstractVisual[]

Gets all the contour listeners.

AbstractVisual[]

listeners The contour listeners.

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Shape.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

Shape.getMarginsStyle

▸ getMaxLabelWidth(): number

Gets the max label width.

number

maxLabelWidth The max label width.

▸ getMaxVisibleLevel(): number

Gets the last visible scale level.

number

maxLevel The last visible scale level.

▸ getMinVisibleLevel(): number

Gets the first visible scale level.

number

minLevel The first visible scale level.

▸ getName(): string

Returns the node name

string

The node name

Shape.getName

▸ getNonProjectedBoundingBox(tr): Rect

Gets the non-projected bounding box.

Rect

bbox The non-projected bounding box of the contour shape.

▸ getNotify(): boolean

Gets the listeners notification flag

Deprecated

since 4.0, use .isSilent() instead

boolean

notify The boolean notification flag.

▸ getOpacity(): number

Returns current node opacity

number

opacity

Shape.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Shape.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

Shape.getParent

▸ getProjectionBox(modelBox, reverse?): Rect

Converts the model box to the projection box and returns it.

Rect

modelBox

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

Contour shape properties

Shape.getProperties

▸ getProperty(name): any

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

any

Shape.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Shape.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Shape.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Shape.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

Shape.getRoot

▸ getScale(): ContourScale

Gets the contour scale. This is used to determine the data values for the isolines in this Contour Shape

ContourScale

scale The contour scale.

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Shape.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Shape.getSceneTransform

▸ getShapeProjection(): AbstractProjection

Gets the shape projection that is to be used when drawing this shape.

AbstractProjection

projection The shape projection.

▸ getSmoothingIsolines(): boolean

Gets a flag indicating if isolines are smoothed.

boolean

smoothed Flag indicating whether isolines are smoothed.

▸ getSmoothingIsolinesType(): IsoLineSmoothingType

Returns smoothing type

IsoLineSmoothingType

smoothingType smoothing type

▸ getSmoothingLabels(): boolean

Gets the smoothLabels flag.

boolean

smoothLabels The smoothLabels flag.

▸ getSuppressIntersectingLabels(): boolean

Gets the intersecting labels suppression status. Default is false. This status indicates if contour will render labels without intersecting each other. Default is FALSE. The status is true if labels don't intersect each other.

boolean

suppress The flag indicating whether intersecting labels are suppressed.

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Shape.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Shape.getVisible

▸ getVisuals(visualClassName): ContourFillVisual[]

Get all fill visuals

ContourFillVisual[]

▸ getVisuals(visualClassName): ContourBorderVisual[]

Get all border visuals

ContourBorderVisual[]

▸ getVisuals(visualClassName): ContourFaultVisual[]

Get all fault visuals

ContourFaultVisual[]

▸ getVisuals(visualClassName): ContourLineVisual[]

Get all isoline visuals

ContourLineVisual[]

▸ getVisuals(): AbstractVisual[]

Get all visuals

AbstractVisual[]

▸ getVisuals(visualClassName?): AbstractVisual[]

Gets the visuals by theirs classname

AbstractVisual[]

visuals The visuals.

▸ getWorldTransform(): Transformation

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

Transformation

transform the world transform.

Shape.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Shape.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Shape.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Shape.hasEventListener

▸ invalidate(bounds?, force?): ContourShape

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

ContourShape

this

Shape.invalidate

▸ invalidateParent(bounds?, force?): ContourShape

Invalidate bounds

ContourShape

this

Shape.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Shape.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Shape.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Shape.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Shape.isSelectable

▸ isSilent(): boolean

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

boolean

Shape.isSilent

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

Notify listeners of the Node

ContourShape

this

Shape.notify

▸ notifyListeners(args): void

Notifies the registered listeners of an event.

Deprecated

since 4.0, use .notify() instead

void

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

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.

ContourShape

this

Shape.off

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

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.

ContourShape

this

Shape.on

▸ Protected onParentChanged(node): ContourShape

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

ContourShape

this

Shape.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Shape.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

Shape.postRendering

▸ Protected preRendering(context): void

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

void

Shape.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

Shape.registerAnimationStyle

▸ removeContourListener(contourListener): void

Removes the specified contour listener from receiving events from this contour shape.

Deprecated

since 4.0, use .off() instead

void

▸ removeCssClass(cssclass): ContourShape

Removes css class from node

ContourShape

this

Shape.removeCssClass

▸ removeInvalidateHandler(handler): ContourShape

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

ContourShape

this

Shape.removeInvalidateHandler

▸ removeVisual(visual): void

Remove the specified visual from this contour shape.

Throws

Error if param is null

void

▸ render(renderingContext): void

Renders node

void

Shape.render

▸ renderAsync(context, callback): void

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

void

Shape.renderAsync

▸ rotate(theta, x, y): ContourShape

Rotate bounds around a given coordinate

ContourShape

this

Shape.rotate

▸ scale(xx, yy): ContourShape

Scale node

ContourShape

this

Shape.scale

▸ setAnimationStyle(animationStyle): ContourShape

Sets animation style

ContourShape

Shape.setAnimationStyle

▸ setBoundingBox(bbox): ContourShape

Sets the bounding box for the contour shape, in non-projected model space.

ContourShape

this

▸ setClipStyle(style): ContourShape

Sets a new clipping style

ContourShape

this

Shape.setClipStyle

▸ setCss(style, merge?): ContourShape

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

ContourShape

this

Shape.setCss

▸ setCssClass(name): ContourShape

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

ContourShape

this

Shape.setCssClass

▸ setCssTransform(transform): ContourShape

Set CSS transformation

ContourShape

this

Shape.setCssTransform

▸ setDataSource(dataSource): ContourShape

Sets the data source which provides grids to the contour.

ContourShape

this

▸ setFaultPointPrecision(precision): ContourShape

Sets the fault point comparison precision (measured in grid cells)

ContourShape

this

▸ setFaultsList(faults): ContourShape

Sets the faults by assigning the Faults property to a new ContourFaultList object storing the faults. If you attempt to assign the Faults property a null value, this will be translated into an empty ContourFaultList.

ContourShape

this

▸ setFillStyle(fillStyle, merge?): ContourShape

Sets fill style

ContourShape

this

Shape.setFillStyle

▸ setGrid(grid): ContourShape

Sets the contour grid.(Object that stores grid data for this contour shape). This will throw an exception if grid is set to null.

Throws

Error if grid is null

ContourShape

this

▸ setGridToModel(gridToModel): ContourShape

Sets the grid to model transform Throws exception when it is set to null.

Throws

Error if param is null

ContourShape

this

▸ setId(id): ContourShape

Allows the user to associate any identifier

ContourShape

this

Shape.setId

▸ setIgnoreErroneousData(ignore?): ContourShape

Sets the flag for grid data checking. It is recommended to set value to FALSE always. DEFAULT: IgnoreErroneousData=false

ContourShape

this

▸ setLabelsDirection(direction): ContourShape

Sets the labels direction.

ContourShape

this

▸ setLineStyle(lineStyle, merge?): ContourShape

Sets line style

ContourShape

this

Shape.setLineStyle

▸ setListeners(listeners): ContourShape

Sets all the contour listeners.

ContourShape

this

▸ setLocalTransform(localTransform, force?): ContourShape

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

ContourShape

this

Shape.setLocalTransform

▸ setMarginsStyle(margins, merge?): ContourShape

Sets margins style

ContourShape

this

Shape.setMarginsStyle

▸ setMaxLabelWidth(maxLabelWidth): ContourShape

Sets the max label width.

ContourShape

this

▸ setMaxVisibleLevel(maxLevel): ContourShape

Sets the last visible scale level.

ContourShape

this