Class: CircularAxis

• new CircularAxis(options)

• new CircularAxis(options?)

Axis.constructor

▸ addAlarm(alarm): CircularAxis

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

CircularAxis

this

Axis.addAlarm

▸ addCssClass(cssclass): CircularAxis

Adds new css class to node

CircularAxis

this

Axis.addCssClass

▸ addInvalidateHandler(handler): CircularAxis

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

CircularAxis

this

Axis.addInvalidateHandler

▸ addRegion(regions): CircularAxis

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.

CircularAxis

Axis.addRegion

▸ Protected applyOpacity(context): CircularAxis

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

CircularAxis

this

Axis.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

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

Axis.checkCollision

▸ cleanAlarms(): CircularAxis

Removes all registered alarms

CircularAxis

Axis.cleanAlarms

▸ cleanRegions(): CircularAxis

Removes all registered regions from the axis

CircularAxis

Axis.cleanRegions

▸ clone(): Node

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

Node

clone

Axis.clone

▸ connectStyle(style, type, callback): CircularAxis

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

CircularAxis

this

Axis.connectStyle

▸ Protected copyConstructor(src, deepCopy?): CircularAxis

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

CircularAxis

this

Axis.copyConstructor

▸ disconnectStyle(style, type, callback): CircularAxis

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

CircularAxis

this

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

Axis.dispose

▸ enableEventPropagation(enable): CircularAxis

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

CircularAxis

this

Axis.enableEventPropagation

▸ enumerateNodes(callback, target?): void

Enumerate children nodes

void

Axis.enumerateNodes

▸ execute(delegate): CircularAxis

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

CircularAxis

The result if any or this

Axis.execute

▸ execute<T>(delegate): T

T

Axis.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

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

Axis.getAlarm

▸ getAlarms(filter?): Iterator<Alarm>

Gets an iterator over existing alarms in the gauge

Iterator<Alarm>

Axis.getAlarms

▸ getAnimation(): string

Returns the name of animation function associated with this axis

string

Axis.getAnimation

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Axis.getAnimationStyle

▸ getAnimationTime(): number

Returns time in which an animation should be finished in seconds

number

Axis.getAnimationTime

▸ getBounds(): Rect

Gets bound of the axis

Rect

Axis.getBounds

▸ getClassName(): string

string

Axis.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Axis.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

Axis.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Axis.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Axis.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

Axis.getCssTransform

▸ getFunctionRegistry(): FunctionRegistry

Returns function registry which provides handlers for gauges animation and alarms

FunctionRegistry

registry New registry to set

Axis.getFunctionRegistry

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Axis.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

Axis.getInvalidateMethod

▸ getLabelProperties(grade): LabelOptionsOut

Returns properties pertaining to labels of requested grade

LabelOptionsOut

properties

Axis.getLabelProperties

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Axis.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

Axis.getMarginsStyle

▸ getModelLimits(): Rect

Rect

▸ getName(): string

Returns the node name

string

The node name

Axis.getName

▸ getNameProperties(): NameOptionsOut

Returns properties pertaining to name text

NameOptionsOut

properties

Axis.getNameProperties

▸ getNeedleGeometry(): Group<Node>

Gets the current needle geometry

Group<Node>

▸ getNeedleOptions(): NeedleOptionsOut

Gets properties pertaining to needle

NeedleOptionsOut

properties

▸ getNeedlePosition(): string

Gets position of the needle (bottom layer or top layer)

string

▸ getOpacity(): number

Returns current node opacity

number

opacity

Axis.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Axis.getOpacityBlendMode

▸ getParent(): Node

Return parent node

Node

parent node

Axis.getParent

▸ getProperties(): OptionsOut

Returns an object with properties pertaining to this axis

OptionsOut

Object with properties

Axis.getProperties

▸ getProperty(name): any

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

any

Axis.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Axis.getPropertyKeys

▸ getRange(): Range

Returns the range of this axis

Range

Axis.getRange

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Axis.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Axis.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

Axis.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Axis.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Axis.getSceneTransform

▸ getShadowColor(): string

Gets the color of shadow fill for the gauge

string

color

▸ getShadowProperties(): ShadowOptionsOut

Gets properties pertaining to shadow of the axis

ShadowOptionsOut

properties

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Axis.getTag

▸ getTickGenerator(): TickGenerator

Returns the tick generator pertaining to this axis

TickGenerator

Axis.getTickGenerator

▸ getTickProperties(grade): TickOptionsOut

Returns properties of the tick with provided grade

TickOptionsOut

Axis.getTickProperties

▸ getValue(ignoreNaN?): number

Returns the value of the axis

number

Axis.getValue

▸ getValueProperties(): ValueOptionsOut

Returns an object with properties pertaining to the value shape

ValueOptionsOut

properties

Axis.getValueProperties

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

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

Axis.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Axis.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Axis.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Axis.hasEventListener

▸ invalidate(bounds?, force?): CircularAxis

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

CircularAxis

this

Axis.invalidate

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

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

Fires

Events.Invalidate

CircularAxis

this

Axis.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Axis.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Axis.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Axis.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Axis.isSelectable

▸ isSilent(): boolean

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

boolean

Axis.isSilent

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

Notify listeners of the Node

CircularAxis

this

Axis.notify

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

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.

CircularAxis

this

Axis.off

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

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.

CircularAxis

this

Axis.on

▸ Protected onParentChanged(node): CircularAxis

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

CircularAxis

this

Axis.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

Axis.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

Axis.postRendering

▸ Protected preRendering(context): void

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

void

Axis.preRendering

▸ redraw(): CircularAxis

Recalculates the parameters of the axis and rerenders

CircularAxis

this

Axis.redraw

▸ registerAnimationStyle(root): void

Register animation style.

void

Axis.registerAnimationStyle

▸ removeAlarm(name): CircularAxis

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

CircularAxis

this

Axis.removeAlarm

▸ removeCssClass(cssclass): CircularAxis

Removes css class from node

CircularAxis

this

Axis.removeCssClass

▸ removeInvalidateHandler(handler): CircularAxis

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

CircularAxis

this

Axis.removeInvalidateHandler

▸ render(context): void

Renders the axis and ticks

void

Axis.render

▸ renderAsync(context, callback): void

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

void

Axis.renderAsync

▸ rotate(theta, x, y): CircularAxis

Rotate bounds around a given coordinate

CircularAxis

this

Axis.rotate

▸ scale(xx, yy): CircularAxis

Scale node

CircularAxis

this

Axis.scale

▸ setAnimation(name): CircularAxis

Sets the name of animation function corresponding to this axis

CircularAxis

Axis.setAnimation

▸ setAnimationStyle(animationStyle): CircularAxis

Sets animation style

CircularAxis

Axis.setAnimationStyle

▸ setAnimationTime(time): CircularAxis

Sets time in which an animation should be finished in seconds

CircularAxis

this

Axis.setAnimationTime

▸ Protected setBounds(bounds): CircularAxis

Sets bounds of the axis

CircularAxis

Axis.setBounds

▸ setClipStyle(style): CircularAxis

Sets a new clipping style

CircularAxis

this

Axis.setClipStyle

▸ setCss(style, merge?): CircularAxis

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

CircularAxis

this

Axis.setCss

▸ setCssClass(name): CircularAxis

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

CircularAxis

this

Axis.setCssClass

▸ setCssTransform(transform): CircularAxis

Set CSS transformation

CircularAxis

this

Axis.setCssTransform

▸ setFunctionRegistry(registry): CircularAxis

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

CircularAxis

Axis.setFunctionRegistry

▸ setId(id): CircularAxis

Allows the user to associate any identifier

CircularAxis

this

Axis.setId

▸ setLabelProperties(grade, props): CircularAxis

Sets properties pertaining to labels for ticks of provided grade

CircularAxis

Axis.setLabelProperties

▸ setLocalTransform(localTransform, force?): CircularAxis

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

CircularAxis

this

Axis.setLocalTransform

▸ setMarginsStyle(margins, merge?): CircularAxis

Sets margins style

CircularAxis

this

Axis.setMarginsStyle

▸ setName(name): CircularAxis

Changes the name of the axis

CircularAxis

this

Axis.setName

▸ setNameProperties(props): CircularAxis

Sets properties pertaining to name shape of the gauge

CircularAxis

Axis.setNameProperties

▸ setNeedle(params): CircularAxis

Sets the needle for the axis

CircularAxis

this

▸ setNeedleOptions(props): CircularAxis

Sets options pertaining to the needle

CircularAxis

▸ setNeedleVisible(visible): CircularAxis

Shows or hides the needle

CircularAxis

▸ setNotification(notify, force?): CircularAxis

set notification state

CircularAxis

this

Axis.setNotification

▸ setOpacity(opacity, blendMode?): CircularAxis

Sets node opacity

CircularAxis

this

Axis.setOpacity

▸ setProperties(props?): CircularAxis

Sets properties pertaining to this axis

CircularAxis

Axis.setProperties

▸ setProperty(name, value): CircularAxis

Sets dynamic property by name

CircularAxis

this

Axis.setProperty

▸ setRange(range): CircularAxis

Sets a new data range displayed by this axis

CircularAxis

Axis.setRange

▸ setRenderingFilter(filter): CircularAxis

Sets filter to be applied before rendering and picking

CircularAxis

this

Axis.setRenderingFilter

▸ setResponsiveStyle(style): CircularAxis

Sets responsive style.

CircularAxis

this

Axis.setResponsiveStyle

▸ setScaleScrollStrategy(strategy?): CircularAxis

Sets scale scroll strategy

CircularAxis

this

Axis.setScaleScrollStrategy

▸ setSelectable(selectable): CircularAxis

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

CircularAxis

this

Axis.setSelectable

▸ setShadowColor(color): CircularAxis

Sets the color of shadow fill for the gauge

CircularAxis

this

▸ setShadowProperties(props): CircularAxis

Sets properties pertaining to shadow of the axis

CircularAxis

this

▸ setSilent(bool): CircularAxis

Set silent mode

CircularAxis

this

Axis.setSilent

▸ setTag(tag): CircularAxis

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

CircularAxis

this

Axis.setTag

▸ setTickGenerator(tickGenerator): CircularAxis

Sets a new tick generator on the axis

CircularAxis