Class: LinearGauge

• new LinearGauge(options)

• new LinearGauge(options?)

NumericGauge.constructor

▸ addAlarm(alarm): LinearGauge

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

LinearGauge

NumericGauge.addAlarm

▸ addAxis(name, axis, props?): LinearGauge

Adds an axis to the gauge

LinearGauge

▸ addCssClass(cssclass): LinearGauge

Adds new css class to node

LinearGauge

this

NumericGauge.addCssClass

▸ addCustomComponent(component, region, layer): LinearGauge

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.

LinearGauge

NumericGauge.addCustomComponent

▸ addIndicatorRegion(name, region?): void

Adds a region, or an array of regions to the gauge. Regions of indicator are indexed by the name that you provide. if no such name has been passed into the method, it will be impossible to do any further manipulations with this region.

void

▸ addInvalidateHandler(handler): LinearGauge

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LinearGauge

this

NumericGauge.addInvalidateHandler

▸ addRegion(name, region?): LinearGauge

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

LinearGauge

NumericGauge.addRegion

▸ Protected applyOpacity(context): LinearGauge

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

LinearGauge

this

NumericGauge.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

NumericGauge.applyResponsiveStyle

▸ checkCollision(context): boolean

Check if gauge falls within visible area on the screen

boolean

true if object is inside of rendarable area

NumericGauge.checkCollision

▸ cleanAlarms(): LinearGauge

Removes all attached alarms

LinearGauge

this

NumericGauge.cleanAlarms

▸ clearAxes(): void

Clears linear gauge axes

void

▸ clearRegions(): LinearGauge

Removes all the regions from the scene

LinearGauge

▸ clone(): Node

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

Node

clone

NumericGauge.clone

▸ connectStyle(style, type, callback): LinearGauge

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

LinearGauge

this

NumericGauge.connectStyle

▸ Protected copyConstructor(gauge): LinearGauge

Copy constructor function Used to clone gauge

LinearGauge

NumericGauge.copyConstructor

▸ disconnectStyle(style, type, callback): LinearGauge

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

LinearGauge

this

NumericGauge.disconnectStyle

▸ displayRegions(name?): LinearGauge

Debug method to display regions of the gauge in different colors

LinearGauge

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

NumericGauge.dispose

▸ enableClipping(clipping): LinearGauge

Sets innergroup clipping

LinearGauge

NumericGauge.enableClipping

▸ enableEventPropagation(enable): LinearGauge

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

LinearGauge

this

NumericGauge.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Enumerate children nodes

void

NumericGauge.enumerateNodes

▸ execute(delegate): LinearGauge

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

LinearGauge

The result if any or this

NumericGauge.execute

▸ execute<T>(delegate): T

T

NumericGauge.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

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

NumericGauge.getAlarm

▸ getAlarms(filter?): Iterator<Alarm>

Gets an iterator over existing alarms in the gauge

Iterator<Alarm>

NumericGauge.getAlarms

▸ getAnimation(): string

Returns the name of animation function associated with this gauge

string

NumericGauge.getAnimation

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

NumericGauge.getAnimationStyle

▸ getAnimationTime(): number

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

number

NumericGauge.getAnimationTime

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

Returns an iterator over existing axes groups in this gauge

Iterator<Group<Node>>

▸ getAxis(name): Axis

Gets an axis by its name or index from axes iterator

Axis

▸ getAxisProperties(name?): AxisOptions | Record<string, AxisOptions>

Gets properties pertaining to axis of the gauge

AxisOptions | Record<string, AxisOptions>

properties, empty if no axis of name 'name' exists

▸ getBackgroundStyle(): BackgroundStyleOptionsOut

Returns background styles

BackgroundStyleOptionsOut

NumericGauge.getBackgroundStyle

▸ getBounds(): Rect

Returns current bounds of the gauge

Rect

NumericGauge.getBounds

▸ getClassName(): string

string

NumericGauge.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

NumericGauge.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

NumericGauge.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

NumericGauge.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

NumericGauge.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

NumericGauge.getCssTransform

▸ getCustomComponent(index): Group<Node>

Returns a registered custom component by its index

Group<Node>

Null if no such index exists

NumericGauge.getCustomComponent

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

Return iterator on registered custom components

Iterator<Group<Node>>

NumericGauge.getCustomComponents

▸ getFunctionRegistry(): FunctionRegistry

Returns function registry which provides handlers for gauges animation and alarms

FunctionRegistry

registry New registry to set

NumericGauge.getFunctionRegistry

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

NumericGauge.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

NumericGauge.getInvalidateMethod

▸ getLayoutStyle(): LayoutStyle<string | number>

Returns the current layout of the gauge

LayoutStyle<string | number>

NumericGauge.getLayoutStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

NumericGauge.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

NumericGauge.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

NumericGauge.getName

▸ getNameProperties(): NameOptionsOut

Gets properties of value text

NameOptionsOut

NumericGauge.getNameProperties

▸ getNeedleProperties(): Required<NeedleOptions>

Returns properties pertaining to needle shape of the gauge

Required<NeedleOptions>

properties

▸ getOpacity(): number

Returns current node opacity

number

opacity

NumericGauge.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

NumericGauge.getOpacityBlendMode

▸ getOrientation(): Orientation

Returns orientation of the gauge.

Orientation

▸ getParent(): Node

Return parent node

Node

parent node

NumericGauge.getParent

▸ getProperties(): OptionsOut

Gets properties pertaining to Linear Gauge

OptionsOut

properties

NumericGauge.getProperties

▸ getProperty(name): any

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

any

NumericGauge.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

NumericGauge.getPropertyKeys

▸ getRange(): Range

Returns range displayed by this range

Range

▸ getRegion(name): Region

Returns the region registered with provided name.

Region

NumericGauge.getRegion

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

NumericGauge.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

NumericGauge.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

NumericGauge.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

NumericGauge.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

NumericGauge.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

NumericGauge.getTag

▸ getValue(): number

Returns the current value of the axis

number

NumericGauge.getValue

▸ getValueProperties(): ValueOptionsOut

Gets properties of value text

ValueOptionsOut

Format of value to set on number formatter

NumericGauge.getValueProperties

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

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

NumericGauge.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

NumericGauge.getZIndex

▸ hasAxis(axis): boolean

Checks if the gauge contains specified axis

boolean

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

NumericGauge.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

NumericGauge.hasEventListener

▸ hideRegions(): LinearGauge

Hides the regions displayed for debug reasons

LinearGauge

NumericGauge.hideRegions

▸ invalidate(bounds?, force?): LinearGauge

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

LinearGauge

this

NumericGauge.invalidate

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

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

Fires

Events.Invalidate

LinearGauge

this

NumericGauge.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

NumericGauge.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

NumericGauge.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

NumericGauge.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

NumericGauge.isSelectable

▸ isSilent(): boolean

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

boolean

NumericGauge.isSilent

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

Notify listeners of the Node

LinearGauge

this

NumericGauge.notify

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

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.

LinearGauge

this

NumericGauge.off

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

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.

LinearGauge

this

NumericGauge.on

▸ Protected onParentChanged(node): LinearGauge

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

LinearGauge

this

NumericGauge.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

NumericGauge.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

NumericGauge.postRendering

▸ Protected preRendering(context): void

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

void

NumericGauge.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

NumericGauge.registerAnimationStyle

▸ removeAlarm(name): LinearGauge

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

LinearGauge

this

NumericGauge.removeAlarm

▸ removeAxis(name): LinearGauge

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

LinearGauge

▸ removeCssClass(cssclass): LinearGauge

Removes css class from node

LinearGauge

this

NumericGauge.removeCssClass

▸ removeCustomComponent(component): LinearGauge

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

LinearGauge

NumericGauge.removeCustomComponent

▸ removeIndicatorRegion(name): void

Removes an earlier added region from the indicator

void

▸ removeInvalidateHandler(handler): LinearGauge

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LinearGauge

this

NumericGauge.removeInvalidateHandler

▸ removeRegion(name): LinearGauge

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

LinearGauge

NumericGauge.removeRegion

▸ render(context): LinearGauge

Renders node

LinearGauge

NumericGauge.render

▸ renderAsync(context, callback): void

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

void

NumericGauge.renderAsync

▸ rotate(theta, x, y): LinearGauge

Rotate bounds around a given coordinate

LinearGauge

this

NumericGauge.rotate

▸ scale(xx, yy): LinearGauge

Scale node

LinearGauge

this

NumericGauge.scale

▸ setAnimation(name): LinearGauge

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

LinearGauge

NumericGauge.setAnimation

▸ setAnimationStyle(animationStyle): LinearGauge

Sets animation style

LinearGauge

NumericGauge.setAnimationStyle

▸ setAnimationTime(time): LinearGauge

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

LinearGauge

this

NumericGauge.setAnimationTime

▸ setAxisProperties(name, props): LinearGauge

Sets properties pertaining to axis of the gauge

LinearGauge

this

▸ setBackgroundStyle(props): LinearGauge

Sets background styles

LinearGauge

NumericGauge.setBackgroundStyle

▸ setBounds(bounds): LinearGauge

Sets bounds to the gauge

LinearGauge

NumericGauge.setBounds

▸ setClipStyle(style): LinearGauge

Sets a new clipping style

LinearGauge

this

NumericGauge.setClipStyle

▸ setCss(style, merge?): LinearGauge

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

LinearGauge

this

NumericGauge.setCss

▸ setCssClass(name): LinearGauge

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

LinearGauge

this

NumericGauge.setCssClass

▸ setCssTransform(transform): LinearGauge

Set CSS transformation

LinearGauge

this

NumericGauge.setCssTransform

▸ setFunctionRegistry(registry): LinearGauge

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

LinearGauge

NumericGauge.setFunctionRegistry

▸ setId(id): LinearGauge

Allows the user to associate any identifier