Class: Label

• [new Label(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.controls.shapes-1.label.label.md#new label(options))

• new Label(options?)

Rectangle.constructor

▸ addCssClass(cssclass): Label

Adds new css class to node

Label

this

Rectangle.addCssClass

▸ addInvalidateHandler(handler): Label

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Label

this

Rectangle.addInvalidateHandler

▸ Protected applyOpacity(context): Label

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

Label

this

Rectangle.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

Rectangle.applyResponsiveStyle

▸ checkCollision(context): boolean

Check collision

boolean

true if object is inside of rendering area

Rectangle.checkCollision

▸ clone(): Label

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

Label

clone

Rectangle.clone

▸ connectStyle(style, type, callback): Label

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

Label

this

Rectangle.connectStyle

▸ Protected copyConstructor(src, deepCopy?): Label

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

Label

this

Rectangle.copyConstructor

▸ disconnectStyle(style, type, callback): Label

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

Label

this

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

Rectangle.dispose

▸ enableEventPropagation(enable): Label

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

Label

this

Rectangle.enableEventPropagation

▸ execute(delegate): Label

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

Label

The result if any or this

Rectangle.execute

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

T

Rectangle.execute

▸ Protected filter(context): boolean

Filter node

boolean

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

Rectangle.filter

▸ getAlignment(): AnchorType

Returns the current anchor type.

AnchorType

current anchor type

▸ getAnchor(): Point

Gets the anchor

Point

▸ getAnchorType(): AnchorType

Returns the current anchor type.

AnchorType

current anchor type

▸ getAnchorX(): number

Return anchored x position if any

number

▸ getAnchorY(): number

Return anchored y position if any

number

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

Rectangle.getAnimationStyle

▸ getBounds(): Rect

Return bounds. Will also lock the bounds so they cannot be directly modified.

Rect

bounds

Rectangle.getBounds

▸ getCenterX(): number

Returns the X coordinate of the center of the framing rectangle of this rectangular shape.

number

Rectangle.getCenterX

▸ getCenterY(): number

Returns the Y coordinate of the center of the framing rectangle of this rectangular shape.

number

Rectangle.getCenterY

▸ getClassName(): string

string

Rectangle.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

Rectangle.getClipStyle

▸ getCornerRadius(): number

return corner radius

number

radius

Rectangle.getCornerRadius

▸ getCss(): CssStyle

Return CSS style

CssStyle

Rectangle.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

Rectangle.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

Rectangle.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

Rectangle.getCssTransform

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

fillStyle current fill style

Rectangle.getFillStyle

▸ getHeight(): number

Returns the height of the framing rectangle.

number

Rectangle.getHeight

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

Rectangle.getId

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

Gets invalidate method

AttributeCallback<EventDispatcher&gt;

method to invalidate this object

Rectangle.getInvalidateMethod

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

Return desired layout style

LayoutStyle<string | number&gt;

Rectangle.getLayoutStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

lineStyle current line style

Rectangle.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

Rectangle.getLocalTransform

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

Return margins style

SpaceStyle<string | number&gt;

Rectangle.getMarginsStyle

▸ getName(): string

Returns the node name

string

The node name

Rectangle.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

Rectangle.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

Rectangle.getOpacityBlendMode

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

Return padding style

SpaceStyle<string | number&gt;

padding

▸ getParent(): Node

Return parent node

Node

parent node

Rectangle.getParent

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

Rectangle.getProperties

▸ getProperty(name): any

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

any

Rectangle.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

Rectangle.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

Rectangle.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

Rectangle.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

Rectangle.getRoot

▸ getRotationAngle(): number

Returns rotation angle (in radians)

number

rotationAngle rotation angle at anchor

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

Rectangle.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

Rectangle.getSceneTransform

▸ getSize(): Dimension

Returns user defined devise size (if exists)

Dimension

▸ getSizeIsInDeviceSpace(): boolean

Returns true if the shape size is set in device space

boolean

true if size is defined in device space

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

Rectangle.getTag

▸ getText(): string

Get this text's contents as a string.

string

text

▸ getTextStyle(): TextStyle

The style associated with this label.

TextStyle

text style

▸ getVisible(): boolean

Return visibility of the node

boolean

true if node is visible

Rectangle.getVisible

▸ getWidth(): number

Returns the width of the framing rectangle.

number

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

Rectangle.getWorldTransform

▸ getX(): number

Returns the X coordinate of the left bottom corner of the framing rectangle.

number

Rectangle.getX

▸ getY(): number

Returns the Y coordinate of the left bottom corner of the framing rectangle.

number

Rectangle.getY

▸ getZIndex(): number

Returns node z-index (null if not set)

number

Rectangle.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

Rectangle.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

Rectangle.hasEventListener

▸ invalidate(bounds?, force?): Label

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

Label

this

Rectangle.invalidate

▸ invalidateLayout(): Label

Notify that layout is invalidated. Send event Events.LayoutInvalidated

Label

this

Rectangle.invalidateLayout

▸ invalidateParent(bounds?, force?): Label

Invalidate bounds

Label

this

Rectangle.invalidateParent

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

Rectangle.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

Rectangle.isEventPropagationEnabled

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

Rectangle.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

Rectangle.isSelectable

▸ isSilent(): boolean

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

boolean

Rectangle.isSilent

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

Notify listeners of the Node

Label

this

Rectangle.notify

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

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.

Label

this

Rectangle.off

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

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>

Label

this

Rectangle.on

▸ Protected onParentChanged(node): Label

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

Label

this

Rectangle.onParentChanged

▸ Protected onRectChanged(newRect): Label

Label

Rectangle.onRectChanged

▸ Protected onVisibilityChanged(): void

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

void

Rectangle.onVisibilityChanged

▸ Protected postRendering(context): void

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

void

Rectangle.postRendering

▸ Protected preRendering(context): void

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

void

Rectangle.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

Rectangle.registerAnimationStyle

▸ removeCssClass(cssclass): Label

Removes css class from node

Label

this

Rectangle.removeCssClass

▸ removeInvalidateHandler(handler): Label

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Label

this

Rectangle.removeInvalidateHandler

▸ render(context): void

Renders node

void

Rectangle.render

▸ renderAsync(context, callback): void

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

void

Rectangle.renderAsync

▸ Protected renderContent(localContext): void

void

Rectangle.renderContent

▸ rotate(theta, x, y): Label

Rotate bounds around a given coordinate

Label

this

Rectangle.rotate

▸ scale(xx, yy): Label

Scale node

Label

this

Rectangle.scale

▸ setAlignment(alignment): Label

Sets the anchor type.

Label

this

▸ setAnchor(p1, p2?): Label

Sets anchor point to given position

Label

this

▸ setAnchorType(anchorType): Label

Sets the anchor type.

Label

this

▸ setAnchorX(ax): Label

Sets x anchor position

Label

this

▸ setAnchorY(ay): Label

Sets y anchor position

Label

this

▸ setAnimationStyle(animationStyle): Label

Sets animation style

Label

Rectangle.setAnimationStyle

▸ setBounds(rect): Label

Sets the location and size of the framing rectangle of this rectangular shape to the specified values. This method is the same as setRect.

Label

this

Rectangle.setBounds

▸ setBounds(x1, y1?, x2?, y2?): Label

Sets the location and size of the framing rectangle of this rectangular shape to the specified values. This method is the same as setRect.

Label

this

Rectangle.setBounds

▸ setClipStyle(style): Label

Sets a new clipping style

Label

this

Rectangle.setClipStyle

▸ setCornerRadius(radius): Label

Set border radius in model coordinates.

Label

this

Rectangle.setCornerRadius

▸ setCss(style, merge?): Label

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

Label

this

Rectangle.setCss

▸ setCssClass(name): Label

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

Label

this

Rectangle.setCssClass

▸ setCssTransform(transform): Label

Set CSS transformation

Label

this

Rectangle.setCssTransform

▸ setFillStyle(fillStyle, merge?): Label

Sets fill style

Label

this

Rectangle.setFillStyle

▸ setId(id): Label

Allows the user to associate any identifier

Label

this

Rectangle.setId

▸ setLayoutStyle(layoutStyle, merge?): Label

Specify desired layout style

Label

Rectangle.setLayoutStyle

▸ setLineStyle(lineStyle, merge?): Label

Sets line style

Label

this

Rectangle.setLineStyle

▸ setLocalTransform(localTransform, force?): Label

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

Label

this

Rectangle.setLocalTransform

▸ setMarginsStyle(margins, merge?): Label

Sets margins style

Label

this

Rectangle.setMarginsStyle

▸ setName(name): Label

Sets name of the node

Label

this

Rectangle.setName

▸ setNotification(notify, force?): Label

set notification state

Label

this

Rectangle.setNotification

▸ setOpacity(opacity, blendMode?): Label

Sets node opacity

Label

this

Rectangle.setOpacity

▸ setPaddingStyle(paddingStyle, merge?): Label

Sets padding style

Label

this

▸ setParent(parent): Label

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

Label

this

Rectangle.setParent

▸ setProperties(properties?): Label

Sets all the properties pertaining to this object

Label

Rectangle.setProperties

▸ setProperty(name, value): Label

Sets dynamic property by name

Label

this

Rectangle.setProperty

▸ setRect(rect): Label

Sets the location and size of the framing rectangle of this rectangular shape to the specified values.

Label

Rectangle.setRect

▸ setRect(params): Label

Sets the location and size of the framing rectangle of this rectangular shape to the specified values.

Label

Rectangle.setRect

▸ setRect(x1, y1, x2, y2): Label

Sets the location and size of the framing rectangle of this rectangular shape to the specified values.

Label

Rectangle.setRect

▸ setRenderingFilter(filter): Label

Sets filter to be applied before rendering and picking

Label

this

Rectangle.setRenderingFilter

▸ setResponsiveStyle(style): Label

Sets responsive style.

Label

this

Rectangle.setResponsiveStyle

▸ setRotationAngle(rotationAngle): Label

Set rotation angle

Label

this

▸ setScaleScrollStrategy(strategy?): Label

Sets scale scroll strategy

Label

this

Rectangle.setScaleScrollStrategy

▸ setSelectable(selectable): Label

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

Label

this

Rectangle.setSelectable

▸ setSilent(bool): Label

Set silent mode

Label

this

Rectangle.setSilent

▸ setSize(width, height?): Label

Sets device size in case if shape is in device space

Label

▸ setSizeIsInDeviceSpace(sizeIsInDeviceSpace): Label

Sets whether the shape size is set in device space.

Label

this

▸ setTag(tag): Label

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

Label

this

Rectangle.setTag

▸ setText(text): Label

Update the string this text displays.

Example

text.setText('Temperature <b style="font-color:red">110°</b> (<i style="font-color:gray">Fahrenheit</i>')

Label

this

▸ setTextStyle(textStyle, merge?): Label

Set text style

Label

this

▸ setVisible(value): Label

Sets visibility of the node. Send event Events.VisibilityChanged

Label

this

Rectangle.setVisible

▸ setZIndex(value): Label

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

Label

this

Rectangle.setZIndex

▸ shear(shx, shy): Label

Shear this node's bounds

Label

this

Rectangle.shear

▸ toString(): string

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

string

A string representation

Rectangle.toString

▸ translate(tx, ty): Label

Translate bounds