Class: NumericGauge

• new NumericGauge(options)

• new NumericGauge(options?)

AbstractGauge.constructor

▸ addAlarm(alarm): NumericGauge

Adds an alarm to the axis. Alarm handler will be called every time value set on the axis falls within alarm's range

NumericGauge

▸ addCssClass(cssclass): NumericGauge

Adds new css class to node

NumericGauge

this

AbstractGauge.addCssClass

▸ addCustomComponent(component, region, layer): NumericGauge

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.

NumericGauge

AbstractGauge.addCustomComponent

▸ addInvalidateHandler(handler): NumericGauge

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

NumericGauge

this

AbstractGauge.addInvalidateHandler

▸ addRegion(name, region?): NumericGauge

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

NumericGauge

AbstractGauge.addRegion

▸ Protected applyOpacity(context): NumericGauge

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

NumericGauge

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

▸ cleanAlarms(): NumericGauge

Removes all attached alarms

NumericGauge

this

▸ clone(): Node

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

Node

clone

AbstractGauge.clone

▸ connectStyle(style, type, callback): NumericGauge

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

NumericGauge

this

AbstractGauge.connectStyle

▸ Protected copyConstructor(gauge): NumericGauge

Copy constructor function Used to clone gauge

NumericGauge

AbstractGauge.copyConstructor

▸ disconnectStyle(style, type, callback): NumericGauge

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

NumericGauge

this

AbstractGauge.disconnectStyle

▸ displayRegions(name?): NumericGauge

Debug method to display regions of the gauge in different colors

NumericGauge

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): NumericGauge

Sets innergroup clipping

NumericGauge

AbstractGauge.enableClipping

▸ enableEventPropagation(enable): NumericGauge

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

NumericGauge

this

AbstractGauge.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Enumerate children nodes

void

AbstractGauge.enumerateNodes

▸ execute(delegate): NumericGauge

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

NumericGauge

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

▸ getAlarm(name): Alarm

Gets the alarm referenced by provided name or index. If alarm name is not set or no such index exists, null will be returned.

Alarm

▸ getAlarms(filter?): Iterator<Alarm>

Gets an iterator over existing alarms in the gauge

Iterator<Alarm>

▸ getAnimation(): string

Returns the name of animation function associated with this gauge

string

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AbstractGauge.getAnimationStyle

▸ getAnimationTime(): number

Returns time in which a full animation cycle is finished (in seconds)

number

▸ getBackgroundStyle(): BackgroundStyleOptionsOut

Returns background styles

BackgroundStyleOptionsOut

▸ 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

▸ getNameProperties(): NameOptionsOut

Gets properties of value text

NameOptionsOut

▸ 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

Returns an object with all the 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

▸ getValue(): number

Returns the current value of the axis

number

▸ getValueProperties(): ValueOptionsOut

Gets properties of value text

ValueOptionsOut

Format of value to set on number formatter

▸ 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

▸ 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(): NumericGauge

Hides the regions displayed for debug reasons

NumericGauge

AbstractGauge.hideRegions

▸ invalidate(bounds?, force?): NumericGauge

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

NumericGauge

this

AbstractGauge.invalidate

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

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

Fires

Events.Invalidate

NumericGauge

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>(type, source, args?): NumericGauge

Notify listeners of the Node

NumericGauge

this

AbstractGauge.notify

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

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.

NumericGauge

this

AbstractGauge.off

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

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.

NumericGauge

this

AbstractGauge.on

▸ Protected onParentChanged(node): NumericGauge

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

NumericGauge

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

▸ registerAnimationStyle(root): void

Register animation style.

void

AbstractGauge.registerAnimationStyle

▸ removeAlarm(name): NumericGauge

Removes an alarm by its name, index, or instance of alarm. The alarm will never be called again and reference to it will be removed. Does nothing if no such alarm has been added before

NumericGauge

this

▸ removeCssClass(cssclass): NumericGauge

Removes css class from node

NumericGauge

this

AbstractGauge.removeCssClass

▸ removeCustomComponent(component): NumericGauge

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

NumericGauge

AbstractGauge.removeCustomComponent

▸ removeInvalidateHandler(handler): NumericGauge

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

NumericGauge

this

AbstractGauge.removeInvalidateHandler

▸ removeRegion(name): NumericGauge

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

NumericGauge

AbstractGauge.removeRegion

▸ render(context): NumericGauge

Renders node

NumericGauge

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): NumericGauge

Rotate bounds around a given coordinate

NumericGauge

this

AbstractGauge.rotate

▸ scale(xx, yy): NumericGauge

Scale node

NumericGauge

this

AbstractGauge.scale

▸ setAnimation(name): NumericGauge

Sets the name of animation function in function registry corresponding to this axis

NumericGauge

▸ setAnimationStyle(animationStyle): NumericGauge

Sets animation style

NumericGauge

AbstractGauge.setAnimationStyle

▸ setAnimationTime(time): NumericGauge

Sets time required to accomplish a full animation run in between two values (in seconds)

NumericGauge

this

▸ setBackgroundStyle(props): NumericGauge

Sets background styles

NumericGauge

▸ setBounds(bounds): NumericGauge

Sets bounds to the gauge

NumericGauge

AbstractGauge.setBounds

▸ setClipStyle(style): NumericGauge

Sets a new clipping style

NumericGauge

this

AbstractGauge.setClipStyle

▸ setCss(style, merge?): NumericGauge

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

NumericGauge

this

AbstractGauge.setCss

▸ setCssClass(name): NumericGauge

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

NumericGauge

this

AbstractGauge.setCssClass

▸ setCssTransform(transform): NumericGauge

Set CSS transformation

NumericGauge

this

AbstractGauge.setCssTransform

▸ setFunctionRegistry(registry): NumericGauge

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

NumericGauge

AbstractGauge.setFunctionRegistry

▸ setId(id): NumericGauge

Allows the user to associate any identifier

NumericGauge

this

AbstractGauge.setId

▸ setLayoutStyle(layoutStyle, merge?): NumericGauge

Specify desired layout style

NumericGauge

AbstractGauge.setLayoutStyle

▸ setLocalTransform(localTransform): NumericGauge

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

NumericGauge

AbstractGauge.setLocalTransform

▸ setMarginsStyle(margins, merge?): NumericGauge

Sets margins style

NumericGauge

this

AbstractGauge.setMarginsStyle

▸ setName(name): NumericGauge

Sets the name of the gauge

NumericGauge

AbstractGauge.setName

▸ setNameProperties(props): NumericGauge

Sets properties pertaining to text representing gauge name

NumericGauge

▸ setNotification(notify, force?): NumericGauge

set notification state

NumericGauge

this

AbstractGauge.setNotification

▸ setOpacity(opacity, blendMode?): NumericGauge

Sets node opacity

NumericGauge

this

AbstractGauge.setOpacity

▸ setProperties(props?): NumericGauge

Sets properties pertaining to this gauge.

NumericGauge

AbstractGauge.setProperties

▸ setProperty(name, value): NumericGauge

Sets dynamic property by name

NumericGauge

this

AbstractGauge.setProperty

▸ setRegionSize(regionType, size): NumericGauge

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

NumericGauge

AbstractGauge.setRegionSize

▸ setRenderingFilter(filter): NumericGauge

Sets filter to be applied before rendering and picking

NumericGauge

this

AbstractGauge.setRenderingFilter

▸ setResponsiveStyle(style): NumericGauge

Sets responsive style.

NumericGauge

this

AbstractGauge.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): NumericGauge

Sets scale scroll strategy

NumericGauge

this

AbstractGauge.setScaleScrollStrategy

▸ setSelectable(selectable): NumericGauge

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

NumericGauge

this

AbstractGauge.setSelectable

▸ setSilent(bool): NumericGauge

Set silent mode

NumericGauge

this

AbstractGauge.setSilent

▸ setTag(tag): NumericGauge

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

NumericGauge

this

AbstractGauge.setTag

▸ setValue(val, skipAnimation?): NumericGauge

Sets the value of the gauge.

NumericGauge

▸ setValueProperties(props): NumericGauge

Sets properties pertaining to text representing gauge value

NumericGauge

▸ setVisible(value): NumericGauge

Sets visibility of the node. Send event Events.VisibilityChanged