Class: Axis

• new Axis(options)

• new Axis(options?)

AbstractNode.constructor

▸ addAlarm(alarm): Axis

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

Axis

this

▸ addCssClass(cssclass): Axis

Adds new css class to node

Axis

this

AbstractNode.addCssClass

▸ addInvalidateHandler(handler): Axis

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Axis

this

AbstractNode.addInvalidateHandler

▸ addRegion(regions): Axis

Adds a region or an array of regions to the axis. Regions are defined by color and range in bounds of the range displayed by the gauge.

Axis

▸ Protected applyOpacity(context): Axis

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

Axis

this

AbstractNode.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

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

AbstractNode.checkCollision

▸ cleanAlarms(): Axis

Removes all registered alarms

Axis

▸ cleanRegions(): Axis

Removes all registered regions from the axis

Axis

▸ clone(): Node

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

Node

clone

AbstractNode.clone

▸ connectStyle(style, type, callback): Axis

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

Axis

this

AbstractNode.connectStyle

▸ Protected copyConstructor(src, deepCopy?): Axis

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

Axis

this

AbstractNode.copyConstructor

▸ disconnectStyle(style, type, callback): Axis

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

Axis

this

AbstractNode.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. Disposes value and name shapes as well

void

AbstractNode.dispose

▸ enableEventPropagation(enable): Axis

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

Axis

this

AbstractNode.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Enumerate children nodes

void

INodeEnumerable.enumerateNodes

▸ execute(delegate): Axis

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

Axis

The result if any or this

AbstractNode.execute

▸ execute<T>(delegate): T

T

AbstractNode.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

AbstractNode.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 axis

string

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AbstractNode.getAnimationStyle

▸ getAnimationTime(): number

Returns time in which an animation should be finished in seconds

number

▸ getBounds(): Rect

Gets bound of the axis

Rect

▸ getClassName(): string

string

AbstractNode.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

AbstractNode.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

AbstractNode.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AbstractNode.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AbstractNode.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

AbstractNode.getCssTransform

▸ getFunctionRegistry(): FunctionRegistry

Returns function registry which provides handlers for gauges animation and alarms

FunctionRegistry

registry New registry to set

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

AbstractNode.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

AbstractNode.getInvalidateMethod

▸ getLabelProperties(grade): LabelOptionsOut

Returns properties pertaining to labels of requested grade

LabelOptionsOut

properties

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

AbstractNode.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

AbstractNode.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

AbstractNode.getName

▸ getNameProperties(): NameOptionsOut

Returns properties pertaining to name text

NameOptionsOut

properties

▸ getOpacity(): number

Returns current node opacity

number

opacity

AbstractNode.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

AbstractNode.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

AbstractNode.getParent

▸ getProperties(): OptionsOut

Returns properties pertaining to axis.

OptionsOut

properties

AbstractNode.getProperties

▸ getProperty(name): any

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

any

AbstractNode.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractNode.getPropertyKeys

▸ getRange(): Range

Returns the range of this axis

Range

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

AbstractNode.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

AbstractNode.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

AbstractNode.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

AbstractNode.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AbstractNode.getSceneTransform

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AbstractNode.getTag

▸ getTickGenerator(): TickGenerator

Returns the tick generator currently set on the axis

TickGenerator

▸ getTickProperties(grade): TickOptionsOut

Returns properties of the tick with provided grade

TickOptionsOut

▸ getValue(ignoreNaN?): number

Returns the value of the axis

number

▸ getValueProperties(): ValueOptionsOut

Returns an object with properties pertaining to the value shape

ValueOptionsOut

properties

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

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

AbstractNode.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AbstractNode.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AbstractNode.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

AbstractNode.hasEventListener

▸ invalidate(bounds?, force?): Axis

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

Axis

this

AbstractNode.invalidate

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

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

Fires

Events.Invalidate

Axis

this

AbstractNode.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractNode.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

AbstractNode.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

AbstractNode.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

AbstractNode.isSelectable

▸ isSilent(): boolean

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

boolean

AbstractNode.isSilent

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

Notify listeners of the Node

Axis

this

AbstractNode.notify

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

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.

Axis

this

AbstractNode.off

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

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.

Axis

this

AbstractNode.on

▸ Protected onParentChanged(node): Axis

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

Axis

this

AbstractNode.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

AbstractNode.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

AbstractNode.postRendering

▸ Protected preRendering(context): void

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

void

AbstractNode.preRendering

▸ redraw(): Axis

Recalculates the parameters of the axis and rerenders

Axis

this

▸ registerAnimationStyle(root): void

Register animation style.

void

AbstractNode.registerAnimationStyle

▸ removeAlarm(name): Axis

Removes an alarm by its name, index, or instance of alarm

Axis

this

▸ removeCssClass(cssclass): Axis

Removes css class from node

Axis

this

AbstractNode.removeCssClass

▸ removeInvalidateHandler(handler): Axis

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Axis

this

AbstractNode.removeInvalidateHandler

▸ render(context): void

Renders node

void

AbstractNode.render

▸ renderAsync(context, callback): void

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

void

AbstractNode.renderAsync

▸ rotate(theta, x, y): Axis

Rotate bounds around a given coordinate

Axis

this

AbstractNode.rotate

▸ scale(xx, yy): Axis

Scale node

Axis

this

AbstractNode.scale

▸ setAnimation(name): Axis

Sets the name of animation function corresponding to this axis

Axis

▸ setAnimationStyle(animationStyle): Axis

Sets animation style

Axis

AbstractNode.setAnimationStyle

▸ setAnimationTime(time): Axis

Sets time in which an animation should be finished in seconds

Axis

this

▸ Protected setBounds(bounds): Axis

Sets bounds of the axis

Axis

▸ setClipStyle(style): Axis

Sets a new clipping style

Axis

this

AbstractNode.setClipStyle

▸ setCss(style, merge?): Axis

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

Axis

this

AbstractNode.setCss

▸ setCssClass(name): Axis

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

Axis

this

AbstractNode.setCssClass

▸ setCssTransform(transform): Axis

Set CSS transformation

Axis

this

AbstractNode.setCssTransform

▸ setFunctionRegistry(registry): Axis

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

Axis

▸ setId(id): Axis

Allows the user to associate any identifier

Axis

this

AbstractNode.setId

▸ setLabelProperties(grade, props): Axis

Sets properties pertaining to labels for ticks of provided grade

Axis

▸ setLocalTransform(localTransform, force?): Axis

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

Axis

this

AbstractNode.setLocalTransform

▸ setMarginsStyle(margins, merge?): Axis

Sets margins style

Axis

this

AbstractNode.setMarginsStyle

▸ setName(name): Axis

Changes the name of the axis

Axis

this

AbstractNode.setName

▸ setNameProperties(props): Axis

Sets properties pertaining to name shape of the gauge

Axis

▸ setNotification(notify, force?): Axis

set notification state

Axis

this

AbstractNode.setNotification

▸ setOpacity(opacity, blendMode?): Axis

Sets node opacity

Axis

this

AbstractNode.setOpacity

▸ setProperties(props?): Axis

Sets properties pertaining to axis.

Axis

AbstractNode.setProperties

▸ setProperty(name, value): Axis

Sets dynamic property by name

Axis

this

AbstractNode.setProperty

▸ setRange(range): Axis

Sets a new data range displayed by this axis

Axis

▸ setRenderingFilter(filter): Axis

Sets filter to be applied before rendering and picking

Axis

this

AbstractNode.setRenderingFilter

▸ setResponsiveStyle(style): Axis

Sets responsive style.

Axis

this

AbstractNode.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): Axis

Sets scale scroll strategy

Axis

this

AbstractNode.setScaleScrollStrategy

▸ setSelectable(selectable): Axis

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

Axis

this

AbstractNode.setSelectable

▸ setSilent(bool): Axis

Set silent mode

Axis

this

AbstractNode.setSilent

▸ setTag(tag): Axis

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

Axis

this

AbstractNode.setTag

▸ setTickGenerator(tg): Axis

Sets tick generator on the axis

Axis

▸ setTickProperties(grade, props): Axis

Sets the properties pertaining to the ticks of provided grade

Axis

▸ setValue(val, skipAnimation?): Axis

Sets the current value in the range of this axis. If value does not fall into range represented by this axis, it will be set to min or max depending if it's smaller or bigger than the range

Axis

▸ setValueProperties(props): Axis

Sets properties pertaining to value shape of the gauge

Axis

▸ setVisible(value): Axis

Sets visibility of the node. Send event Events.VisibilityChanged

Axis

this

AbstractNode.setVisible

▸ setZIndex(value): Axis

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

Axis

this

AbstractNode.setZIndex

▸ shear(shx, shy): Axis

Shear this node's bounds

Axis

this

AbstractNode.shear

▸ toString(): string

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

string

A string representation

AbstractNode.toString

▸ translate(tx, ty): Axis

Translate bounds

Axis

this

AbstractNode.translate

▸ unregisterAnimationStyle(root): void

Unregister animation style.

void

AbstractNode.unregisterAnimationStyle

▸ updateSceneTransformation(): Axis

Update scene transformation

Axis

this

AbstractNode.updateSceneTransformation

▸ updateState(regions?, changes?): Axis

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

Axis

this

AbstractNode.updateState

▸ Protected updateTimeStamp(): Axis

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

Axis

this

AbstractNode.updateTimeStamp

▸ Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

void

AbstractNode.enableSceneGraphNotification

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

Find root of the node with specified type

InstanceType<T>

AbstractNode.findParent

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

Find root of the node with specified type

Node

AbstractNode.findParent

▸ Static getClassName(): string

string

AbstractNode.getClassName

▸ Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

boolean

AbstractNode.isSceneGraphNotificationEnabled