Class: LogAxis

• new LogAxis(options)

• new LogAxis(options?)

Creates axis

Axis.constructor

▸ addCssClass(cssclass): LogAxis

Adds new css class to node

LogAxis

this

Axis.addCssClass

▸ addInvalidateHandler(handler): LogAxis

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

LogAxis

this

Axis.addInvalidateHandler

▸ Protected applyOpacity(context): LogAxis

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

LogAxis

this

Axis.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

Axis.applyResponsiveStyle

▸ checkCollision(context): boolean

Check culling

boolean

true if object is inside of rendarable area

Axis.checkCollision

▸ clone(): LogAxis

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

LogAxis

clone

Axis.clone

▸ connectStyle(style, type, callback): LogAxis

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

LogAxis

this

Axis.connectStyle

▸ Protected copyConstructor(src, deepCopy?): LogAxis

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

LogAxis

this

Axis.copyConstructor

▸ disconnectStyle(style, type, callback): LogAxis

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

LogAxis

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.

void

Axis.dispose

▸ enableEventPropagation(enable): LogAxis

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

LogAxis

this

Axis.enableEventPropagation

▸ execute(delegate): LogAxis

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

LogAxis

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

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Axis.getAnimationStyle

▸ getAutoLabelRotation(): boolean

Get auto label rotation

boolean

Axis.getAutoLabelRotation

▸ getAutoLabelRotationAngle(): number

Gets auto rotation angle for vertical axis

number

angle

Axis.getAutoLabelRotationAngle

▸ getAxisDimension(): AxisMappingDimension

Gets axis dimension to synchronize tick generator parameters with external source

AxisMappingDimension

Axis.getAxisDimension

▸ getBaseLineStyle(): LineStyle

Return a base line style

LineStyle

Axis.getBaseLineStyle

▸ getBaseLineVisible(): boolean

Return base line visibility

boolean

Axis.getBaseLineVisible

▸ getBounds(): Rect

Gets axis bounds

Rect

axis bounds

Axis.getBounds

▸ getClassName(): string

string

Axis.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Axis.getClipStyle

▸ getContentsTransform(): Transformation

Retrieves the world transformation of the spatial

Transformation

Axis.getContentsTransform

▸ 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

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Axis.getFillStyle

▸ getHideOverlappedText(): boolean

Gets hide overlapped text flag

boolean

hide overlapped text flag

Axis.getHideOverlappedText

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Axis.getId

▸ getInfiniteMode(): boolean

Return infinity mode flag

boolean

flag

Axis.getInfiniteMode

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

Axis.getInvalidateMethod

▸ getLabelManualSettings(): boolean

Gets label manual settings mode (AnchorType and no shifts)

boolean

label manual settings mode

Axis.getLabelManualSettings

▸ getLabelOffset(): number

Return the label offset

number

Axis.getLabelOffset

▸ getLabelPadding(): number

Gets label padding

number

padding label padding

Axis.getLabelPadding

▸ getLabelPosition(): LabelPosition

Return the label position

LabelPosition

Axis.getLabelPosition

▸ getLayoutStyle(): LayoutStyle<string | number>

return desired layout style

LayoutStyle<string | number>

Axis.getLayoutStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

Axis.getLineStyle

▸ 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

▸ getMaximumLabelSize(): number

Gets maximum label size

number

maximum label size (in device space)

Axis.getMaximumLabelSize

▸ getMicroPositionLeft(): number

Returns micro position left

number

▸ getMicroPositionRight(): number

Returns micro position right

number

▸ Protected getMicroPositionTransformation(): Transformation

Returns micro position transformation

Transformation

micro position transformation

▸ getModelLimits(): Rect

Gets model limits

Rect

model limits

Axis.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

Axis.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

Axis.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Axis.getOpacityBlendMode

▸ getOrientation(): Orientation

Return axis orientation

Orientation

"horizontal" or "vertical"

Axis.getOrientation

▸ getParent(): Node

Return parent node

Node

parent node

Axis.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

An object containing the 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

▸ 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

▸ getShowTitleEllipsis(): boolean

Return boolean flag that enables/disables ellipsis in case if text is too long

boolean

Axis.getShowTitleEllipsis

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Axis.getTag

▸ getTextStyle(): TextStyle

Return a text style

TextStyle

textStyle

Axis.getTextStyle

▸ getTickGenerator(): TickGenerator

Return a current tick generator

TickGenerator

a current tick generator

Axis.getTickGenerator

▸ getTickInfo(): TickInfo

Returns axis tick info

TickInfo

tickInfo

Axis.getTickInfo

▸ getTickPosition(): string

Return tick position

string

tickPosition

Axis.getTickPosition

▸ getTitle(): string

Get axis title

string

axis title

Axis.getTitle

▸ getTitleAlignment(): TitleAlignment

Get title alignment

TitleAlignment

alignment

▸ getTitleAnchor(): AnchorType

Get title anchor

AnchorType

alignment

Axis.getTitleAnchor

▸ getTitleMargin(): SpaceStyle<string | number>

Returns title margin

SpaceStyle<string | number>

Axis.getTitleMargin

▸ getTitleOffset(): Point

Returns title offset

Point

offset

Axis.getTitleOffset

▸ getTitleTextStyle(): TextStyle

The style associated with this axis title.

TextStyle

textStyle

Axis.getTitleTextStyle

▸ getTitleVisible(): boolean

Get title visibility state

boolean

visible state

Axis.getTitleVisible

▸ getTrack(): LogTrack

Returns a parent log track

LogTrack

▸ 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

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?): LogAxis

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

LogAxis

this

Axis.invalidate

▸ invalidateLayout(): LogAxis

Notify that layout is invalidated. Send event Events.LayoutInvalidated

LogAxis

this

Axis.invalidateLayout

▸ invalidateParent(bounds?, force?): LogAxis

Invalidate parent area

LogAxis

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>(event, source, args?): LogAxis

Notify listeners of the Node

LogAxis

this

Axis.notify

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

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.

LogAxis

this

Axis.off

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

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.

LogAxis

this

Axis.on

▸ Protected onAxisDimensionChanged(dimension): void

Called if axis dimension is changed

void

Axis.onAxisDimensionChanged

▸ Protected onMicroPositionChanged(): LogAxis

calls when microPosition has been changed

LogAxis

this

▸ Protected onParentChanged(node): LogAxis

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

LogAxis

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

▸ registerAnimationStyle(root): void

Register animation style.

void

Axis.registerAnimationStyle

▸ removeCssClass(cssclass): LogAxis

Removes css class from node

LogAxis

this

Axis.removeCssClass

▸ removeInvalidateHandler(handler): LogAxis

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

LogAxis

this

Axis.removeInvalidateHandler

▸ render(context): void

Renders node

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

Rotate bounds around a given coordinate

LogAxis

this

Axis.rotate

▸ scale(xx, yy): LogAxis

Scale node

LogAxis

this

Axis.scale

▸ setAnimationStyle(animationStyle): LogAxis

Sets animation style

LogAxis

Axis.setAnimationStyle

▸ setAutoLabelRotation(enable): LogAxis

Set auto label rotation

LogAxis

this

Axis.setAutoLabelRotation

▸ setAutoLabelRotationAngle(angle): LogAxis

Sets auto rotation angle for vertical axis

LogAxis

this

Axis.setAutoLabelRotationAngle

▸ setAxisDimension(dimension): LogAxis

Sets axis dimension to synchronize tick generator parameters with external source

LogAxis

Axis.setAxisDimension

▸ setBaseLineStyle(lineStyle, merge?): LogAxis

Sets a base line style

LogAxis

this

Axis.setBaseLineStyle

▸ setBaseLineVisible(visible): LogAxis

Set base line visibility

LogAxis

Axis.setBaseLineVisible

▸ setBounds(bounds): LogAxis

Sets an axis bounds

LogAxis

this

Axis.setBounds

▸ setClipStyle(style): LogAxis

Sets a new clipping style

LogAxis

this

Axis.setClipStyle

▸ setCss(style, merge?): LogAxis

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

LogAxis

this

Axis.setCss

▸ setCssClass(name): LogAxis

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

LogAxis

this

Axis.setCssClass

▸ setCssTransform(transform): LogAxis

Set CSS transformation

LogAxis

this

Axis.setCssTransform

▸ setFillStyle(fillStyle, merge?): LogAxis

Sets fill style

LogAxis

this

Axis.setFillStyle

▸ setHideOverlappedText(flag): LogAxis

Sets hide overlapped text flag

LogAxis

this

Axis.setHideOverlappedText

▸ setId(id): LogAxis

Allows the user to associate any identifier

LogAxis

this

Axis.setId

▸ setInfiniteMode(infinityMode): LogAxis

Set infinity mode flag to draw axis outside the model limits

LogAxis

this

Axis.setInfiniteMode

▸ setLabelManualSettings(state): LogAxis

Sets label manual settings mode (AnchorType and no shifts)

LogAxis

this

Axis.setLabelManualSettings

▸ setLabelOffset(offset): LogAxis

Sets the label offset

LogAxis

this

Axis.setLabelOffset

▸ setLabelPadding(padding): LogAxis

Sets label padding

LogAxis

this

Axis.setLabelPadding

▸ setLabelPosition(position): LogAxis

Sets the label position

LogAxis

this

Axis.setLabelPosition

▸ setLayoutStyle(layoutStyle, merge?): LogAxis

Specify desired layout style

LogAxis

Axis.setLayoutStyle

▸ setLineStyle(lineStyle, merge?): LogAxis

Sets line style

LogAxis

this

Axis.setLineStyle

▸ setLocalTransform(localTransform, force?): LogAxis

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

LogAxis

this

Axis.setLocalTransform

▸ setMarginsStyle(margins, merge?): LogAxis

Sets margins style

LogAxis

this

Axis.setMarginsStyle

▸ setMaximumLabelSize(maximumLabelSize): LogAxis

Sets maximum label size

LogAxis

this

Axis.setMaximumLabelSize

▸ setMicroPosition(left, right): LogAxis

Sets micro position (0 - 1). It allows application code to display the visual in a subarea of the track.
By default log visuals uses all space of the trace in the horizontal direction, but micro position allows to place log visual in the specified position of the track in horizontal direction. See example below

Example

// The following code places curve 20% from left and 20% from right.
curve.setMicroPosition(0.2,0.8);

LogAxis

this

▸ setModelLimits(modelLimits): LogAxis

Sets model limits

LogAxis

this

Axis.setModelLimits

▸ setName(name): LogAxis

Sets name of the node

LogAxis

this

Axis.setName

▸ setNotification(notify, force?): LogAxis

set notification state

LogAxis

this

Axis.setNotification

▸ setOpacity(opacity, blendMode?): LogAxis

Sets node opacity

LogAxis

this