Class: BarScale

• [new BarScale(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.map.util-3.barscale.barscale.md#new barscale(options))

• new BarScale(options?)

MapScale.constructor

▸ addCssClass(cssclass): BarScale

Adds new css class to node

BarScale

this

MapScale.addCssClass

▸ addInvalidateHandler(handler): BarScale

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

BarScale

this

MapScale.addInvalidateHandler

▸ Protected applyOpacity(context): BarScale

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

BarScale

this

MapScale.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

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

MapScale.checkCollision

▸ clone(): Node

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

Node

clone

MapScale.clone

▸ connectStyle(style, type, callback): BarScale

Connects style.<br> <br> This convenience method subscribes a listener to given style for the specified type.<br> And automatically un-subscribes listener if node is disposed to prevent memory leaks

BarScale

this

MapScale.connectStyle

▸ Protected copyConstructor(src, deepCopy?): BarScale

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

BarScale

this

MapScale.copyConstructor

▸ disconnectStyle(style, type, callback): BarScale

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

BarScale

this

MapScale.disconnectStyle

▸ dispose(): void

Disposes this node, once disposes a node should not be used anymore.<br> Clear all listeners, and disconnect styles to avoid memory leaks.<br> Also aggressively 'cleanup' this node by setting some of its members to null.

void

MapScale.dispose

▸ enableEventPropagation(enable): BarScale

Enable event propagation from the node hierarchy from bottom to top <p> 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. </p>

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

BarScale

this

MapScale.enableEventPropagation

▸ execute(delegate): BarScale

Executes delegate and return the result. It allows us to keep all initialization calls in one place, <br> 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");
});

BarScale

The result if any or this

MapScale.execute

▸ execute<T&gt;(delegate): T

T

MapScale.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

MapScale.filter

▸ getAnchor(tr?): Point

Gets the anchor

Point

MapScale.getAnchor

▸ getAnchorType(): AnchorType

Returns the current anchor type.

AnchorType

current anchor type

MapScale.getAnchorType

▸ getAnchorX(): number

Return anchored x position

number

MapScale.getAnchorX

▸ getAnchorY(): number

Return anchored y position

number

MapScale.getAnchorY

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

MapScale.getAnimationStyle

▸ getAspectRatio(): number

Returns aspect ratio of the content of the shape Returns 1

number

MapScale.getAspectRatio

▸ getBackgroundStyle(): FillStyle

Return background fill style

FillStyle

fillStyle current fill style

▸ getBounds(): Rect

Return bound in the parent coordinates

Rect

MapScale.getBounds

▸ getClassName(): string

string

MapScale.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

MapScale.getClipStyle

▸ getCss(): CssStyle

Return CSS style

CssStyle

MapScale.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

MapScale.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

MapScale.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

MapScale.getCssTransform

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

MapScale.getFillStyle

▸ getFillStyleList(): FillStyle[]

Returns list of fill styles used for the bar scale rectangular sections

FillStyle[]

▸ getHeight(): number

Return height of the shape

number

MapScale.getHeight

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

MapScale.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher&gt;

Gets invalidate method

AttributeCallback<EventDispatcher&gt;

method to invalidate this object

MapScale.getInvalidateMethod

▸ getIsPointingUp(): boolean

Returns true if the shape is always pointing up

boolean

true if the shape is always pointing up

MapScale.getIsPointingUp

▸ getLabelMode(): BarScaleLabelMode

Returns current bar scale axis label mode

BarScaleLabelMode

▸ getLayoutStyle(): LayoutStyle<string | number&gt;

Return desired layout style

LayoutStyle<string | number&gt;

MapScale.getLayoutStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

MapScale.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

MapScale.getLocalTransform

▸ getMajorTickHeight(): number

Returns major ticks height

number

▸ getMarginsStyle(): SpaceStyle<string | number&gt;

Return margins style

SpaceStyle<string | number&gt;

MapScale.getMarginsStyle

▸ getMaxSize(): Dimension

returns the maximum device space rendering dimension only works when setUseMinMaxSize is enabled.

Dimension

max size

MapScale.getMaxSize

▸ getMinSize(): Dimension

returns the minimum device space rendering dimension only works when setUseMinMaxSize is enabled.

Dimension

min size

MapScale.getMinSize

▸ getMinorTickHeight(): number

Returns minor ticks height

number

▸ getName(): string

Returns the node name

string

The node name

MapScale.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

MapScale.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

MapScale.getOpacityBlendMode

▸ getPaddingStyle(): SpaceStyle<string | number&gt;

Return padding style

SpaceStyle<string | number&gt;

padding

MapScale.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

MapScale.getParent

▸ getPreserveAspectRatio(): boolean

Returns true if aspect ratio is preserved

boolean

true if aspect ratio is preserved

MapScale.getPreserveAspectRatio

▸ getPreserveReadingOrientation(): boolean

Returns true if the shape is always in a readable orientation

boolean

true if the shape is always in a readable orientation

MapScale.getPreserveReadingOrientation

▸ getPreserveRightAngle(): boolean

Returns true if right angles are preserved

boolean

true if right angles are preserved

MapScale.getPreserveRightAngle

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

bar scale properties

MapScale.getProperties

▸ getProperty(name): any

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

any

MapScale.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

MapScale.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

MapScale.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

MapScale.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

MapScale.getRoot

▸ getRotationAngle(): number

Returns rotation angle (in radians)

number

rotationAngle rotation angle at anchor

MapScale.getRotationAngle

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

MapScale.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

MapScale.getSceneTransform

▸ getSecondSystem(): UnitSystem

Returns current system for the second bar line

UnitSystem

▸ getSize(): Dimension

Returns the size as a dimension object.

Dimension

size

MapScale.getSize

▸ getSizeIsInDeviceSpace(): boolean

Returns true if the shape size is set in device space

boolean

true if size is defined in device space

MapScale.getSizeIsInDeviceSpace

▸ getSystem(): UnitSystem

Returns current unit system

UnitSystem

MapScale.getSystem

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

MapScale.getTag

▸ getTextStyle(): TextStyle

Returns the style associated with this map scale text

TextStyle

MapScale.getTextStyle

▸ getTickPosition(): TickPosition

Returns scale tick position

TickPosition

▸ getTickVisible(): boolean

Returns current tick visibility

boolean

▸ getTicksAmount(): number

Returns current ticks amount

number

▸ getUseMinMaxSize(): boolean

true if using the min max device space sizes

boolean

true if using the min max device space sizes

MapScale.getUseMinMaxSize

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

MapScale.getVisible

▸ getWidth(): number

Return width of the shape

number

MapScale.getWidth

▸ getWorldTransform(): Transformation

Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.

Transformation

transform the world transform.

MapScale.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

MapScale.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

MapScale.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

MapScale.hasEventListener

▸ invalidate(bounds?, force?): BarScale

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

BarScale

this

MapScale.invalidate

▸ invalidateParent(bounds?, force?): BarScale

Invalidate bounds

BarScale

this

MapScale.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

MapScale.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

MapScale.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

MapScale.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

MapScale.isSelectable

▸ isSilent(): boolean

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

boolean

MapScale.isSilent

▸ notify<E&gt;(event, source, args?): BarScale

Notify listeners of the Node

BarScale

this

MapScale.notify

▸ off<E&gt;(type?, callback?): BarScale

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.

BarScale

this

MapScale.off

▸ on<E&gt;(type, callback): BarScale

Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>

BarScale

this

MapScale.on

▸ Protected onParentChanged(node): BarScale

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

BarScale

this

MapScale.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

MapScale.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

MapScale.postRendering

▸ Protected preRendering(context): void

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

void

MapScale.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

MapScale.registerAnimationStyle

▸ removeCssClass(cssclass): BarScale

Removes css class from node

BarScale

this

MapScale.removeCssClass

▸ removeInvalidateHandler(handler): BarScale

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

BarScale

this

MapScale.removeInvalidateHandler

▸ render(context): void

Renders itself

void

MapScale.render

▸ renderAsync(context, callback): void

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

void

MapScale.renderAsync

▸ rotate(theta, x?, y?): BarScale

Rotate bounds around a given coordinate or anchor point

BarScale

this

MapScale.rotate

▸ scale(xx, yy): BarScale

Scale node

BarScale

this

MapScale.scale

▸ setAnchor(p): BarScale

Sets anchor point to given position

BarScale

this

MapScale.setAnchor

▸ setAnchor(x, y): BarScale

Sets anchor point to given position

BarScale

this

MapScale.setAnchor

▸ setAnchorType(alignment): BarScale

Sets the anchor type.

BarScale

this

MapScale.setAnchorType

▸ setAnchorX(ax): BarScale

Sets x anchor position

BarScale

this

MapScale.setAnchorX

▸ setAnchorY(ay): BarScale

Sets y anchor position

BarScale

this

MapScale.setAnchorY

▸ setAnimationStyle(animationStyle): BarScale

Sets animation style

BarScale

MapScale.setAnimationStyle

▸ setBackgroundStyle(fillStyle, merge?): BarScale

Sets background fill style

BarScale

this

▸ setBounds(bounds): BarScale

Sets bounds of the node in the parent coordinates. This method takes anchor position and width and height if size is not in device space. This method was added to support layout.

BarScale

this

MapScale.setBounds

▸ setClipStyle(style): BarScale

Sets a new clipping style

BarScale

this

MapScale.setClipStyle

▸ setCss(style, merge?): BarScale

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

BarScale

this

MapScale.setCss

▸ setCssClass(name): BarScale

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

BarScale

this

MapScale.setCssClass

▸ setCssTransform(transform): BarScale

Set CSS transformation

BarScale

this

MapScale.setCssTransform

▸ setFillStyle(fillStyle, merge?): BarScale

Sets fill style

BarScale

this

MapScale.setFillStyle

▸ setFillStyleList(styles): BarScale

Sets fill style list for the bar scale rectangular sections

BarScale

this

▸ setHeight(height): BarScale

Sets height of the shape

BarScale

this

MapScale.setHeight

▸ setId(id): BarScale

Allows the user to associate any identifier

BarScale

this

MapScale.setId

▸ setIsPointingUp(isPointingUp): BarScale

Sets whether the shape is always pointing up. Particularly useful for text.

BarScale

this

MapScale.setIsPointingUp

▸ setLabelMode(mode): BarScale

Sets bar scale axis label mode

BarScale

this

▸ setLayoutStyle(layoutStyle, merge?): BarScale

Specify desired layout style

BarScale

MapScale.setLayoutStyle

▸ setLineStyle(lineStyle, merge?): BarScale

Sets line style

BarScale

this

MapScale.setLineStyle

▸ setLocalTransform(localTransform, force?): BarScale

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

BarScale

this

MapScale.setLocalTransform

▸ setMajorTickHeight(value): BarScale

Sets major (far left and right) ticks height value

BarScale

this

▸ setMapScale(scale): BarScale

Sets scale

BarScale

this

MapScale.setMapScale

▸ setMarginsStyle(margins, merge?): BarScale

Sets margins style

BarScale

this

MapScale.setMarginsStyle

▸ setMaxSize(maxSize): BarScale

sets the maximum device space rendering dimension

BarScale

MapScale.setMaxSize

▸ setMinSize(minSize): BarScale

sets the minimum device space rendering dimension only works when setUseMinMaxSize is enabled.

BarScale

this

MapScale.setMinSize

▸ setMinorTickHeight(value): BarScale

Sets minor (inner) ticks height value

BarScale

this

▸ setName(name): BarScale

Sets name of the node

BarScale

this

MapScale.setName

▸ setNotification(notify, force?): BarScale

set notification state

BarScale

this

MapScale.setNotification

▸ setOpacity(opacity, blendMode?): BarScale

Sets node opacity

BarScale

this

MapScale.setOpacity

▸ setPaddingStyle(paddingStyle, merge?): BarScale

Sets padding style

BarScale

this

MapScale.setPaddingStyle

▸ setParent(parent): BarScale

Sets parent node. Don't call this method directly. It is internal method.

BarScale

this

MapScale.setParent

▸ setPreserveAspectRatio(preserveAspectRatio): BarScale

Sets whether aspect ratio is preserved

BarScale

this

MapScale.setPreserveAspectRatio

▸ setPreserveReadingOrientation(preserveReadingOrientation): BarScale

Sets whether the shape is always in a readable orientation. Particularly useful for text. Prevents mirror effects

BarScale

this

MapScale.setPreserveReadingOrientation

▸ setPreserveRightAngle(preserveRightAngle): BarScale

Sets whether right angles are preserved

BarScale

this

MapScale.setPreserveRightAngle

▸ setProperties(props?): BarScale

Sets bar scale object properties

BarScale

this