Class: ContourLineVisual

• new ContourLineVisual(options)

• new ContourLineVisual(options?)

AbstractVisual.constructor

▸ addCssClass(cssclass): ContourLineVisual

Adds new css class to node

ContourLineVisual

this

AbstractVisual.addCssClass

▸ addInvalidateHandler(handler): ContourLineVisual

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

ContourLineVisual

this

AbstractVisual.addInvalidateHandler

▸ addVisualListener(visualListener): void

Registers the specified visual listener to receiving events from this visual.

Deprecated

since 4.0

void

AbstractVisual.addVisualListener

▸ Protected applyOpacity(context): ContourLineVisual

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

ContourLineVisual

this

AbstractVisual.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

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

AbstractVisual.checkCollision

▸ chooseColor(index, len): string

Choose a color for the supplied contour value, using the current BehaviorType.

string

color Color with the required color for this index

AbstractVisual.chooseColor

▸ clone(): Node

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

Node

clone

AbstractVisual.clone

▸ connectStyle(style, type, callback): ContourLineVisual

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

ContourLineVisual

this

AbstractVisual.connectStyle

▸ contourInvalidated(args): void

This method is invoked when the contour shape has been invalidated. Nothing is performed for this class, but it must be overridden in subclasses for correct event processing.

Deprecated

since 4.0, use onContourShapeSet() and .on()/.off() for events

void

AbstractVisual.contourInvalidated

▸ Protected copyConstructor(src, deepCopy?): ContourLineVisual

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

ContourLineVisual

this

AbstractVisual.copyConstructor

▸ disconnectStyle(style, type, callback): ContourLineVisual

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

ContourLineVisual

this

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

AbstractVisual.dispose

▸ enableEventPropagation(enable): ContourLineVisual

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

ContourLineVisual

this

AbstractVisual.enableEventPropagation

▸ execute(delegate): ContourLineVisual

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

ContourLineVisual

The result if any or this

AbstractVisual.execute

▸ execute<T>(delegate): T

T

AbstractVisual.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

AbstractVisual.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AbstractVisual.getAnimationStyle

▸ getClassName(): string

string

AbstractVisual.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

AbstractVisual.getClipStyle

▸ getColorBehavior(): BehaviorType

Gets the color behavior for this visual.

BehaviorType

colorBehavior The color behavior type.

AbstractVisual.getColorBehavior

▸ getColorMap(): VisualColorMap

Gets the visual colorMap.

VisualColorMap

colorMap The colorMap used by this visual

AbstractVisual.getColorMap

▸ getCss(): CssStyle

Return CSS style

CssStyle

AbstractVisual.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AbstractVisual.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AbstractVisual.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

AbstractVisual.getCssTransform

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

AbstractVisual.getFillStyle

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

AbstractVisual.getId

▸ getIndexStep(): number

Gets the index step for the line visual. Only contour lines with (index = step * i) will be displayed. Where 'i' iterates through all available line indices.

number

step Integer step interval

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

AbstractVisual.getInvalidateMethod

▸ getIsolinesStylingStrategy(): IsolineStylingStrategy

Gets the isolines styling strategy

IsolineStylingStrategy

▸ getLabelFormat(): NumberFormat

Gets label format.

NumberFormat

format

▸ getLabelMargin(): number

Gets the label margin. The margin is specified in device coordinates. Default is 5.

number

margin The margin around labels in device coordinates.

▸ getLabelSpacing(): number

Gets the label spacing. This is the space between nearby labels on an isoLine. Distance is specified in device space. Default is 200.

number

spacing The label spacing.

▸ getLabelingStrategy(): AbstractContourLabelingStrategy

Gets the labeling strategy.

AbstractContourLabelingStrategy

strategy The labeling strategy.

▸ getLabelsVisible(): boolean

Gets the visibility of all isolines

boolean

isolinesVisible True of all labels should be visible.

▸ getLineReservationFor(index): number

Find the line reservation value for the isoline with the specified index. This is used to determine if a particular isoline should be drawn.

Throws

if Index out of range

number

lineReservation The computed line reservation value.

▸ getLineStyle(): LineStyle

Gets the current LineStyle that is used to draw the isolines of this line visual. The "line color" property of the attribute is ignored because it is set directly from the colorMap. I.e. set such properties as "line style", and they will be applied globally to all isolines in this visual, regardless of color.

LineStyle

lineStyle The line style.

AbstractVisual.getLineStyle

▸ getLinesVisible(): boolean

Gets the visibility of all isolines

boolean

isolinesVisible True of all isolines should be visible.

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

AbstractVisual.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

AbstractVisual.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

AbstractVisual.getName

▸ getNotify(): boolean

Gets the notification state of this visual

Deprecated

since 4.0, use .isSilent() instead

boolean

notify If this is true, updates will be broadcast to the listeners.

AbstractVisual.getNotify

▸ getOpacity(): number

Returns current node opacity

number

opacity

AbstractVisual.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

AbstractVisual.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

AbstractVisual.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

visual properties

AbstractVisual.getProperties

▸ getProperty(name): any

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

any

AbstractVisual.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractVisual.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

AbstractVisual.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

AbstractVisual.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

AbstractVisual.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

AbstractVisual.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AbstractVisual.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AbstractVisual.getTag

▸ getTextStyle(): TextStyle

Gets the current text style attribute that is used to draw the labels for this line visual. The "line color" property of the attribute is ignored because it is set directly from the colormap. I.e. set such properties as "font style", and they will be applied globally to all isolines in this visual, regardless of color.

TextStyle

textStyle The text style.

▸ getUseFontColorForLabels(): boolean

Gets the flag which indicates if font color is used for label text color.

boolean

useFontColor Flag which indicates if font color is used for label text color.

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

AbstractVisual.getVisible

▸ getWorldTransform(): Transformation

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

Transformation

transform the world transform.

AbstractVisual.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AbstractVisual.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AbstractVisual.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractVisual.hasEventListener

▸ invalidate(bounds?, force?): ContourLineVisual

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

ContourLineVisual

this

AbstractVisual.invalidate

▸ invalidateParent(bounds?, force?): ContourLineVisual

Invalidate bounds

ContourLineVisual

this

AbstractVisual.invalidateParent

▸ invalidateVisual(): void

Invalidates the visual, sending events

void

AbstractVisual.invalidateVisual

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractVisual.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

AbstractVisual.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

AbstractVisual.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

AbstractVisual.isSelectable

▸ isSilent(): boolean

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

boolean

AbstractVisual.isSilent

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

Notify listeners of the Node

ContourLineVisual

this

AbstractVisual.notify

▸ notifyListeners(args): void

Notifies the registered listeners of an event.

Deprecated

since 4.0

void

AbstractVisual.notifyListeners

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

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.

ContourLineVisual

this

AbstractVisual.off

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

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.

ContourLineVisual

this

AbstractVisual.on

▸ Protected onContourShapeSet(contour): void

this method called when visual is connected to Contour shape. override it to subscribe and unsubscribe

void

AbstractVisual.onContourShapeSet

▸ Protected onParentChanged(node): ContourLineVisual

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

ContourLineVisual

this

AbstractVisual.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

AbstractVisual.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

AbstractVisual.postRendering

▸ Protected preRendering(context): void

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

void

AbstractVisual.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

AbstractVisual.registerAnimationStyle

▸ removeCssClass(cssclass): ContourLineVisual

Removes css class from node

ContourLineVisual

this

AbstractVisual.removeCssClass

▸ removeInvalidateHandler(handler): ContourLineVisual

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

ContourLineVisual

this

AbstractVisual.removeInvalidateHandler

▸ removeVisualListener(visualListener): void

Unregisters the specified visual listener from receiving event from this visual.

Deprecated

since 4.0

void

AbstractVisual.removeVisualListener

▸ render(renderingContext): void

Render the visual. This must be defined in all subclasses.

void

AbstractVisual.render

▸ renderAsync(context, callback): void

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

void

AbstractVisual.renderAsync

▸ resetLabelGridMapping(): void

Reset label grid mapping. The grid mapping is used for mapping triangle grid to model space.

void

▸ rotate(theta, x, y): ContourLineVisual

Rotate bounds around a given coordinate

ContourLineVisual

this

AbstractVisual.rotate

▸ scale(xx, yy): ContourLineVisual

Scale node

ContourLineVisual

this

AbstractVisual.scale

▸ setAnimationStyle(animationStyle): ContourLineVisual

Sets animation style

ContourLineVisual

AbstractVisual.setAnimationStyle

▸ setClipStyle(style): ContourLineVisual

Sets a new clipping style

ContourLineVisual

this

AbstractVisual.setClipStyle

▸ setColorBehavior(colorBehavior): ContourLineVisual

Sets the color behavior for this visual.

ContourLineVisual

this

AbstractVisual.setColorBehavior

▸ setColorMap(colorMap): ContourLineVisual

Sets the visual colorMap

ContourLineVisual

this

AbstractVisual.setColorMap

▸ setCss(style, merge?): ContourLineVisual

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

ContourLineVisual

this

AbstractVisual.setCss

▸ setCssClass(name): ContourLineVisual

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

ContourLineVisual

this

AbstractVisual.setCssClass

▸ setCssTransform(transform): ContourLineVisual

Set CSS transformation

ContourLineVisual

this

AbstractVisual.setCssTransform

▸ setFillStyle(fillStyle, merge?): ContourLineVisual

Sets fill style

ContourLineVisual

this

AbstractVisual.setFillStyle

▸ setId(id): ContourLineVisual

Allows the user to associate any identifier

ContourLineVisual

this

AbstractVisual.setId

▸ setIndexStep(step): ContourLineVisual

Sets the index step for the line visual. Only contour lines with (index = step * i) will be displayed. Where 'i' iterates through all available line indices.

ContourLineVisual

this

▸ setIsolinesStylingStrategy(strategy): ContourLineVisual

Sets the isolines styling strategy. If set, style set in setLineStyle will be ignored. The "line color" property of the styles will override colorMap.

ContourLineVisual

this

▸ setLabelFormat(format): ContourLineVisual

Sets label format.

ContourLineVisual

this

▸ setLabelMargin(margin): ContourLineVisual

Sets the label margin. The margin is specified in device coordinates. Default is 5.

ContourLineVisual

this

▸ setLabelSpacing(spacing): ContourLineVisual

Sets the label spacing. This is the space between nearby labels on an isoLine. Distance is specified in device space. Default is 200.

ContourLineVisual

this

▸ setLabelingStrategy(strategy): ContourLineVisual

Sets the labeling strategy.

ContourLineVisual

this

▸ setLabelsVisible(visible): ContourLineVisual

Sets the visibility for all isolines

ContourLineVisual

this

▸ setLineReservation(lineReservation): ContourLineVisual

Use this property to set the local reference to the line reservation array. This array is actually stored in the contour shape, and is passed to each line visual. All the elements of the array 'reservation[lineIndex] = Math.Max( reservation[lineIndex], GetIndexStep() )' Later, the implementation of the line visual may decide if the isoline with some particular index should be drawn using 'GetLineReservationFor' and 'GetIndexStep' methods. Hence, major and minor isolines can be supported.

ContourLineVisual

this

▸ setLineStyle(lineStyle, merge?): ContourLineVisual

Sets the current LineStyle that is used to draw the isolines of this line visual. The "line color" property of the attribute is ignored because it is set directly from the colorMap. I.e. set such properties as "line style", and they will be applied globally to all isolines in this visual, regardless of color.

ContourLineVisual

this

AbstractVisual.setLineStyle

▸ setLinesVisible(visible): ContourLineVisual

Sets the visibility for all isolines

ContourLineVisual

this

▸ setLocalTransform(localTransform, force?): ContourLineVisual

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

ContourLineVisual

this

AbstractVisual.setLocalTransform

▸ setMarginsStyle(margins, merge?): ContourLineVisual

Sets margins style

ContourLineVisual

this

AbstractVisual.setMarginsStyle

▸ setName(name): ContourLineVisual

Sets name of the node

ContourLineVisual

this

AbstractVisual.setName

▸ setNotification(notify, force?): ContourLineVisual

set notification state

ContourLineVisual

this

AbstractVisual.setNotification

▸ setNotify(notify): void

Sets the notification state of this visual

Deprecated

since 4.0, use .setSilent() instead

void

AbstractVisual.setNotify

▸ setOpacity(opacity, blendMode?): ContourLineVisual

Sets node opacity

ContourLineVisual

this

AbstractVisual.setOpacity

▸ setProperties(properties?): ContourLineVisual

Sets all the properties pertaining to this object

ContourLineVisual

this

AbstractVisual.setProperties

▸ setProperty(name, value): ContourLineVisual

Sets dynamic property by name

ContourLineVisual

this

AbstractVisual.setProperty

▸ setRenderingFilter(filter): ContourLineVisual

Sets filter to be applied before rendering and picking

ContourLineVisual

this

AbstractVisual.setRenderingFilter

▸ setResponsiveStyle(style): ContourLineVisual

Sets responsive style.

ContourLineVisual

this

AbstractVisual.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): ContourLineVisual

Sets scale scroll strategy

ContourLineVisual

this

AbstractVisual.setScaleScrollStrategy

▸ setSelectable(selectable): ContourLineVisual

Allows to select node. If node is not selectable then child node is not selectable.

ContourLineVisual

this

AbstractVisual.setSelectable

▸ setSilent(bool): ContourLineVisual

Set silent mode

ContourLineVisual

this

AbstractVisual.setSilent

▸ setTag(tag): ContourLineVisual

Allows the user to associate any arbitrary object with the node.

ContourLineVisual

this

AbstractVisual.setTag

▸ setTextStyle(textStyle, merge?): ContourLineVisual

Sets the current text style attributes that is used to draw the labels for this line visual.

ContourLineVisual

this

▸ setUseFontColorForLabels(useFontColor): ContourLineVisual

Sets the flag which indicates if font color should be used for label text color.

ContourLineVisual

this

▸ setVisible(value): ContourLineVisual

Sets visibility of the node. Send event Events.VisibilityChanged

ContourLineVisual

this

AbstractVisual.setVisible

▸ setZIndex(value): ContourLineVisual

Sets z-index for node (set null for default)

ContourLineVisual

this

AbstractVisual.setZIndex

▸ shear(shx, shy): ContourLineVisual

Shear this node's bounds

ContourLineVisual

this

AbstractVisual.shear

▸ toString(): string

Returns a string representation of this object (generally the classname)

string

A string representation

AbstractVisual.toString

▸ translate(tx, ty): ContourLineVisual

Translate bounds