Class: AxisGauge

• new AxisGauge(options)

• Protected new AxisGauge(options?)

AbstractGauge.constructor

▸ Abstract addAxis(params): Axis

Adds a new axis to the axis gauge.

Axis

▸ addCssClass(cssclass): AxisGauge

Adds new css class to node

AxisGauge

this

AbstractGauge.addCssClass

▸ addCustomComponent(component, region, layer): AxisGauge

Adds a custom component to provided specified region. A custom component is a group with any geometry inside. The group bounds will be changed to fit the region it is added to. To maintain the size of your custom group it is better to add a custom region to the gauge.

AxisGauge

AbstractGauge.addCustomComponent

▸ addInvalidateHandler(handler): AxisGauge

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

AxisGauge

this

AbstractGauge.addInvalidateHandler

▸ addRegion(name, region?): AxisGauge

Adds a new region to the gauge. Region is a rectangular area on the gauge defined by x, y, width and height all set in CSS format.

Throws

When name is not provided to the custom region

AxisGauge

AbstractGauge.addRegion

▸ Protected applyOpacity(context): AxisGauge

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

AxisGauge

this

AbstractGauge.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

AbstractGauge.applyResponsiveStyle

▸ checkCollision(context): boolean

Check if gauge falls within visible area on the screen

boolean

true if object is inside of rendarable area

AbstractGauge.checkCollision

▸ clearAxes(): void

Clears gauge axes

void

▸ clone(): Node

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

Node

clone

AbstractGauge.clone

▸ connectStyle(style, type, callback): AxisGauge

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

AxisGauge

this

AbstractGauge.connectStyle

▸ Protected copyConstructor(gauge): AxisGauge

Copy constructor function Used to clone gauge

AxisGauge

AbstractGauge.copyConstructor

▸ disconnectStyle(style, type, callback): AxisGauge

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

AxisGauge

this

AbstractGauge.disconnectStyle

▸ displayRegions(name?): AxisGauge

Debug method to display regions of the gauge in different colors

AxisGauge

AbstractGauge.displayRegions

▸ 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

AbstractGauge.dispose

▸ enableClipping(clipping): AxisGauge

Sets innergroup clipping

AxisGauge

AbstractGauge.enableClipping

▸ enableEventPropagation(enable): AxisGauge

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

AxisGauge

this

AbstractGauge.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Enumerate children nodes

void

AbstractGauge.enumerateNodes

▸ execute(delegate): AxisGauge

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

AxisGauge

The result if any or this

AbstractGauge.execute

▸ execute<T>(delegate): T

T

AbstractGauge.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

AbstractGauge.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AbstractGauge.getAnimationStyle

▸ getAxes(filter?): Iterator<Axis>

Returns an iterator over existing axes in this gauge

Iterator<Axis>

▸ getAxis(name): Axis

Gets an axis by its name or index from axes iterator

Axis

▸ getBounds(): Rect

Returns current bounds of the gauge

Rect

AbstractGauge.getBounds

▸ getClassName(): string

string

AbstractGauge.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

AbstractGauge.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

AbstractGauge.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AbstractGauge.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AbstractGauge.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

AbstractGauge.getCssTransform

▸ getCustomComponent(index): Group<Node>

Returns a registered custom component by its index

Group<Node>

Null if no such index exists

AbstractGauge.getCustomComponent

▸ getCustomComponents(filter?): Iterator<Group<Node>>

Return iterator on registered custom components

Iterator<Group<Node>>

AbstractGauge.getCustomComponents

▸ getFunctionRegistry(): FunctionRegistry

Returns function registry which provides handlers for gauges animation and alarms

FunctionRegistry

registry New registry to set

AbstractGauge.getFunctionRegistry

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

AbstractGauge.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

AbstractGauge.getInvalidateMethod

▸ getLayoutStyle(): LayoutStyle<string | number>

Returns the current layout of the gauge

LayoutStyle<string | number>

AbstractGauge.getLayoutStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

AbstractGauge.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

AbstractGauge.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

AbstractGauge.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

AbstractGauge.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

AbstractGauge.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

AbstractGauge.getParent

▸ getProperties(): OptionsOut

Gets properties pertaining to this gauge.

OptionsOut

Properties

AbstractGauge.getProperties

▸ getProperty(name): any

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

any

AbstractGauge.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractGauge.getPropertyKeys

▸ getRegion(name): Region

Returns the region registered with provided name.

Region

AbstractGauge.getRegion

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

AbstractGauge.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

AbstractGauge.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

AbstractGauge.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

AbstractGauge.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AbstractGauge.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AbstractGauge.getTag

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

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

AbstractGauge.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AbstractGauge.getZIndex

▸ hasAxis(axis): boolean

Checks if the gauge contains specified axis

boolean

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AbstractGauge.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractGauge.hasEventListener

▸ hideRegions(): AxisGauge

Hides the regions displayed for debug reasons

AxisGauge

AbstractGauge.hideRegions

▸ invalidate(bounds?, force?): AxisGauge

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

AxisGauge

this

AbstractGauge.invalidate

▸ Protected invalidateParent(bounds?, force?): AxisGauge

Invalidate parent and notify all listeners. NOTE: Don't keep arguments of the event, because instance can be changed

Fires

Events.Invalidate

AxisGauge

this

AbstractGauge.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractGauge.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

AbstractGauge.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

AbstractGauge.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

AbstractGauge.isSelectable

▸ isSilent(): boolean

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

boolean

AbstractGauge.isSilent

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

Notify listeners of the Node

AxisGauge

this

AbstractGauge.notify

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

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.

AxisGauge

this

AbstractGauge.off

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

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.

AxisGauge

this

AbstractGauge.on

▸ Protected onParentChanged(node): AxisGauge

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

AxisGauge

this

AbstractGauge.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

AbstractGauge.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

AbstractGauge.postRendering

▸ Protected preRendering(context): void

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

void

AbstractGauge.preRendering

▸ reassignAxisName(oldName, newName): AxisGauge

Changes the name of axis in the map without needing to remove and readd the axis

AxisGauge

▸ registerAnimationStyle(root): void

Register animation style.

void

AbstractGauge.registerAnimationStyle

▸ removeAxis(name): AxisGauge

Removes an axis from the gauge. If no such axis exists, nothing will be done.

AxisGauge

▸ removeCssClass(cssclass): AxisGauge

Removes css class from node

AxisGauge

this

AbstractGauge.removeCssClass

▸ removeCustomComponent(component): AxisGauge

Removes a registered custom component from the gauge. If such component was not registered, does nothing.

AxisGauge

AbstractGauge.removeCustomComponent

▸ removeInvalidateHandler(handler): AxisGauge

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

AxisGauge

this

AbstractGauge.removeInvalidateHandler

▸ removeRegion(name): AxisGauge

Deletes a region from the layout. Only custom added regions can be removed. Will do nothing if no such region was registered

AxisGauge

AbstractGauge.removeRegion

▸ render(context): AxisGauge

Renders node

AxisGauge

AbstractGauge.render

▸ renderAsync(context, callback): void

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

void

AbstractGauge.renderAsync

▸ rotate(theta, x, y): AxisGauge

Rotate bounds around a given coordinate

AxisGauge

this

AbstractGauge.rotate

▸ scale(xx, yy): AxisGauge

Scale node

AxisGauge

this

AbstractGauge.scale

▸ setAnimationStyle(animationStyle): AxisGauge

Sets animation style

AxisGauge

AbstractGauge.setAnimationStyle

▸ setBounds(bounds): AxisGauge

Sets bounds to the gauge

AxisGauge

AbstractGauge.setBounds

▸ setClipStyle(style): AxisGauge

Sets a new clipping style

AxisGauge

this

AbstractGauge.setClipStyle

▸ setCss(style, merge?): AxisGauge

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

AxisGauge

this

AbstractGauge.setCss

▸ setCssClass(name): AxisGauge

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

AxisGauge

this

AbstractGauge.setCssClass

▸ setCssTransform(transform): AxisGauge

Set CSS transformation

AxisGauge

this

AbstractGauge.setCssTransform

▸ setFunctionRegistry(registry): AxisGauge

Sets function registry which will provide handlers for gauges animation and alarms

AxisGauge

AbstractGauge.setFunctionRegistry

▸ setId(id): AxisGauge

Allows the user to associate any identifier

AxisGauge

this

AbstractGauge.setId

▸ setLayoutStyle(layoutStyle, merge?): AxisGauge

Specify desired layout style

AxisGauge

AbstractGauge.setLayoutStyle

▸ setLocalTransform(localTransform): AxisGauge

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

AxisGauge

AbstractGauge.setLocalTransform

▸ setMarginsStyle(margins, merge?): AxisGauge

Sets margins style

AxisGauge

this

AbstractGauge.setMarginsStyle

▸ setName(name): AxisGauge

Sets name of the node

AxisGauge

this

AbstractGauge.setName

▸ setNotification(notify, force?): AxisGauge

set notification state

AxisGauge

this

AbstractGauge.setNotification

▸ setOpacity(opacity, blendMode?): AxisGauge

Sets node opacity

AxisGauge

this

AbstractGauge.setOpacity

▸ setProperties(props?): AxisGauge

Sets properties pertaining to this gauge.

AxisGauge

AbstractGauge.setProperties

▸ setProperty(name, value): AxisGauge

Sets dynamic property by name

AxisGauge

this

AbstractGauge.setProperty

▸ setRange(range): AxisGauge

If this method is called on the gauge instead of an axis, the value and skipAnimation will be propagated to each axis registered for the gauge. Equivalent to looping through each axis and setting this value. Sets a new data range displayed by this axis

AxisGauge

▸ setRegionSize(regionType, size): AxisGauge

For North, South sides sets height, for East and West sets width, for custom regions sets x, y, width and height

AxisGauge

AbstractGauge.setRegionSize

▸ setRenderingFilter(filter): AxisGauge

Sets filter to be applied before rendering and picking

AxisGauge

this

AbstractGauge.setRenderingFilter

▸ setResponsiveStyle(style): AxisGauge

Sets responsive style.

AxisGauge

this

AbstractGauge.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): AxisGauge

Sets scale scroll strategy

AxisGauge

this

AbstractGauge.setScaleScrollStrategy

▸ setSelectable(selectable): AxisGauge

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

AxisGauge

this

AbstractGauge.setSelectable

▸ setSilent(bool): AxisGauge

Set silent mode

AxisGauge

this

AbstractGauge.setSilent

▸ setTag(tag): AxisGauge

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

AxisGauge

this

AbstractGauge.setTag

▸ setValue(val, skipAnimation?): AxisGauge

If this method is called on the gauge instead of an axis, the value and skipAnimation will be propagated to each axis registered for the gauge. Equivalent to looping through each axis and setting this value.

AxisGauge

▸ setVisible(value): AxisGauge

Sets visibility of the node. Send event Events.VisibilityChanged

AxisGauge

this

AbstractGauge.setVisible

▸ setZIndex(value): AxisGauge

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

AxisGauge

this

AbstractGauge.setZIndex

▸ shear(shx, shy): AxisGauge

Shear this node's bounds

AxisGauge

this

AbstractGauge.shear

▸ toString(): string

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

string

A string representation

AbstractGauge.toString

▸ translate(tx, ty): AxisGauge

Translate bounds

AxisGauge

this

AbstractGauge.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

AbstractGauge.unregisterAnimationStyle

▸ updateSceneTransformation(): AxisGauge

Update scene transformation

AxisGauge

this

AbstractGauge.updateSceneTransformation

▸ updateState(regions?, changes?): AxisGauge

Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph

AxisGauge

this

AbstractGauge.updateState

▸ Protected updateTimeStamp(): AxisGauge

Update time stamp to indicate that Node or Children has been changed.

AxisGauge

this

AbstractGauge.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

AbstractGauge.enableSceneGraphNotification

▸ Static findParent<T>(node, classType, filter?): InstanceType<T>

Find root of the node with specified type

InstanceType<T>

AbstractGauge.findParent

▸ Static findParent(node, classType, filter?): Node