Class: AdaptiveBasicLogVisualHeader<T>

• new AdaptiveBasicLogVisualHeader&lt;T&amp;gt;(options)

• new AdaptiveBasicLogVisualHeader<T>(options?)

AdaptiveLogVisualHeader&lt;T&amp;gt;.constructor

▸ addCssClass(cssclass): AdaptiveBasicLogVisualHeader<T>

Adds new css class to node

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.addCssClass

▸ addInvalidateHandler(handler): AdaptiveBasicLogVisualHeader<T>

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.addInvalidateHandler

▸ Protected applyOpacity(context): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.applyOpacity

▸ Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

void

AdaptiveLogVisualHeader.applyResponsiveStyle

▸ Protected calculateDesiredHeight(width?): number

Return header desired height

number

AdaptiveLogVisualHeader.calculateDesiredHeight

▸ Protected calculateSectionsDesiredHeight(width): number

Return overall height by specified width

number

AdaptiveLogVisualHeader.calculateSectionsDesiredHeight

▸ checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

boolean

AdaptiveLogVisualHeader.checkCollision

▸ checkTextSize(context, text, maxLen): string

Returns biggest text in specified width

string

AdaptiveLogVisualHeader.checkTextSize

▸ clone(): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

clone

AdaptiveLogVisualHeader.clone

▸ connectStyle(style, type, callback): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.connectStyle

▸ Protected copyConstructor(src, deepCopy?): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.copyConstructor

▸ disconnectStyle(style, type, callback): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.disconnectStyle

▸ dispose(): void

Dispose node. Clear all listeners and disconnect style to avoid memory leaks

void

AdaptiveLogVisualHeader.dispose

▸ drawBorder(context, borderLineStyle?, modelLimits?): AdaptiveBasicLogVisualHeader<T>

Stroke border with specified

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.drawBorder

▸ Protected drawRoundedBox(context, bounds, options?): AdaptiveBasicLogVisualHeader<T>

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.drawRoundedBox

▸ Protected drawText(context, x?, y?, text?, style?, alignment?, theta?, maxSize?): void

for internal use only, make text always readable

void

AdaptiveLogVisualHeader.drawText

▸ enableEventPropagation(enable): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.enableEventPropagation

▸ execute(delegate): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

The result if any or this

AdaptiveLogVisualHeader.execute

▸ execute<T>(delegate): T

T

AdaptiveLogVisualHeader.execute

▸ fillBorder(context, fillStyle?, modelLimits?): AdaptiveBasicLogVisualHeader<T>

Draws a rectangle at the model limits and fill it with specified fillStyle

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.fillBorder

▸ Protected filter(context): boolean

Filter node

boolean

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

AdaptiveLogVisualHeader.filter

▸ getAnimationStyle(): AnimationStyle

Return animation style

AnimationStyle

animationStyle current animation style

AdaptiveLogVisualHeader.getAnimationStyle

▸ getBorderLineStyle(): LineStyle

Gets border line style

LineStyle

AdaptiveLogVisualHeader.getBorderLineStyle

▸ getBounds(): Rect

Return bound in the parent coordinates

Rect

AdaptiveLogVisualHeader.getBounds

▸ getClassName(): string

string

AdaptiveLogVisualHeader.getClassName

▸ getClipStyle(): ClipStyle

Gets the current clipping style

ClipStyle

clipping style

AdaptiveLogVisualHeader.getClipStyle

▸ getContentsArea(transformation?): Rect

Return area without paddings. Model limits are mapped to content area, where children are layout.

Rect

AdaptiveLogVisualHeader.getContentsArea

▸ getContentsTransform(): Transformation

Return transformation from model to bounds

Transformation

AdaptiveLogVisualHeader.getContentsTransform

▸ getCss(): CssStyle

Return CSS style

CssStyle

AdaptiveLogVisualHeader.getCss

▸ getCssClass(): string

Returns css class name to be used to apply CSS style

string

the css class name

AdaptiveLogVisualHeader.getCssClass

▸ getCssClasses(): string[]

Gets list of css class names which applied to this node

string[]

AdaptiveLogVisualHeader.getCssClasses

▸ getCssTransform(): string

Returns CSS transformation

string

AdaptiveLogVisualHeader.getCssTransform

▸ getDesiredHeight(width?): number

Return header desired height

number

AdaptiveLogVisualHeader.getDesiredHeight

▸ getDisplayDepth(): number

Returns the displayed depth value

number

AdaptiveLogVisualHeader.getDisplayDepth

▸ getDisplayMode(): string | string[]

Returns the displayed mode value

string | string[]

AdaptiveLogVisualHeader.getDisplayMode

▸ getDisplayString(): string

Returns the displayed value

string

displayString

AdaptiveLogVisualHeader.getDisplayString

▸ getDisplayValue(): number

Returns 0

number

AdaptiveLogVisualHeader.getDisplayValue

▸ getElementByName(name): ElementOptionsOut<LogAbstractVisual>

return element object that is matching the given name

ElementOptionsOut<LogAbstractVisual>

element properies

AdaptiveLogVisualHeader.getElementByName

▸ getElements(): ElementOptionsOut<LogAbstractVisual>[]

Gets header elements with their parameters. NOTE: deep copy of elements is created and returned.

ElementOptionsOut<LogAbstractVisual>[]

header elements

AdaptiveLogVisualHeader.getElements

▸ getFillStyle(): FillStyle

Return fill style

FillStyle

AdaptiveLogVisualHeader.getFillStyle

▸ getHighlightOptions(): HighlightOptions

Returns highlight options

HighlightOptions

highlight options

AdaptiveLogVisualHeader.getHighlightOptions

▸ getId(): string | number

Returns the associated identifier of the node

string | number

The node's id

AdaptiveLogVisualHeader.getId

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

AttributeCallback<EventDispatcher>

method to invalidate this object

AdaptiveLogVisualHeader.getInvalidateMethod

▸ getIsPointingUp(): boolean

Returns true if the text is always pointing up

boolean

true if the text is always pointing up

AdaptiveLogVisualHeader.getIsPointingUp

▸ getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

LayoutStyle<string | number>

AdaptiveLogVisualHeader.getLayoutStyle

▸ getLineStyle(): LineStyle

Return line style

LineStyle

AdaptiveLogVisualHeader.getLineStyle

▸ getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Transformation

transform the local transform.

AdaptiveLogVisualHeader.getLocalTransform

▸ getMarginsStyle(): SpaceStyle<string | number>

Return margins style

SpaceStyle<string | number>

AdaptiveLogVisualHeader.getMarginsStyle

▸ getModelLimits(): Rect

Return model limits

Rect

AdaptiveLogVisualHeader.getModelLimits

▸ getName(): string

Returns the node name

string

The node name

AdaptiveLogVisualHeader.getName

▸ getOpacity(): number

Returns current node opacity

number

opacity

AdaptiveLogVisualHeader.getOpacity

▸ getOpacityBlendMode(): BlendMode

Returns current node opacity

BlendMode

opacity blend mode

AdaptiveLogVisualHeader.getOpacityBlendMode

▸ getPaddingStyle(): SpaceStyle<string | number>

Return padding style

SpaceStyle<string | number>

padding

AdaptiveLogVisualHeader.getPaddingStyle

▸ getParent(): Node

Return parent node

Node

parent node

AdaptiveLogVisualHeader.getParent

▸ getProperties(): OptionsOut<LogAbstractVisual>

Gets all the properties pertaining to the header

OptionsOut<LogAbstractVisual>

header properties

AdaptiveLogVisualHeader.getProperties

▸ getProperty(name): any

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

any

AdaptiveLogVisualHeader.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AdaptiveLogVisualHeader.getPropertyKeys

▸ getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

IFilter

current filter

AdaptiveLogVisualHeader.getRenderingFilter

▸ getResponsiveStyle(): ResponsiveStyle

Return responsive style

ResponsiveStyle

AdaptiveLogVisualHeader.getResponsiveStyle

▸ getRoot(): Node

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

Node

the root node

AdaptiveLogVisualHeader.getRoot

▸ getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Delegate

scale scroll strategy

AdaptiveLogVisualHeader.getScaleScrollStrategy

▸ getSceneTransform(): Transformation

Returns transformation from node to root scene

Transformation

a transformation from node to root scene

AdaptiveLogVisualHeader.getSceneTransform

▸ Protected getSectionDesiredHeight(section, width): number

Return desired height for specified section

number

AdaptiveLogVisualHeader.getSectionDesiredHeight

▸ Protected getSectionDesiredRect(sectionName?, rect?, tr?): Rect

Return desired section bounds by specified name

Rect

AdaptiveLogVisualHeader.getSectionDesiredRect

▸ getSections(): SectionOptions<T>[]

Gets header sections with their parameters. NOTE: deep copy of elements is created and returned.

SectionOptions<T>[]

header elements

AdaptiveLogVisualHeader.getSections

▸ getSettings(): Settings

Gets general settings. NOTE: deep copy of settings is created and returned.

Settings

settings

AdaptiveLogVisualHeader.getSettings

▸ getTag(): any

Returns the object associated with the node by user.

any

The node's user-object

AdaptiveLogVisualHeader.getTag

▸ Protected getTextBoundingBox(context, x?, y?, text?, style?, alignment?, theta?): Rect

Returns bounding box of the text

Rect

AdaptiveLogVisualHeader.getTextBoundingBox

▸ Protected getTextShapeHelper(x?, y?, text?, textStyle?, alignment?): Text

Return text shape helper instance

Text

text shape helper

AdaptiveLogVisualHeader.getTextShapeHelper

▸ getTextStyle(): TextStyle

Return a current text style

TextStyle

AdaptiveLogVisualHeader.getTextStyle

▸ getVisible(): boolean

Return visibility of the header

boolean

true if header itself and associated LogVisual is visible

AdaptiveLogVisualHeader.getVisible

▸ getVisual(): T

Gets visual to be used to render header

T

visual

AdaptiveLogVisualHeader.getVisual

▸ getWorldTransform(): Transformation

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

Transformation

AdaptiveLogVisualHeader.getWorldTransform

▸ getZIndex(): number

Returns node z-index (null if not set)

number

AdaptiveLogVisualHeader.getZIndex

▸ hasCssClass(cssClass): boolean

Check if node has specified css class

boolean

AdaptiveLogVisualHeader.hasCssClass

▸ hasEventListener(type, callback?): boolean

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

boolean

AdaptiveLogVisualHeader.hasEventListener

▸ hitTest(area, radius?): Hits[]

Hit test in the device coordinate. This method checks if any point is intersects <html>node inside text

Hits[]

selected items

AdaptiveLogVisualHeader.hitTest

▸ invalidate(bounds?, force?): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.invalidate

▸ invalidateLayout(propagate?): AdaptiveBasicLogVisualHeader<T>

Notify that layout is invalidated. Send event Events.LayoutInvalidated

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.invalidateLayout

▸ Protected invalidateParent(bounds?, force?): AdaptiveBasicLogVisualHeader<T>

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

Fires

Events.Invalidate

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.invalidateParent

▸ isAutoBounds(): boolean

Enable automatic bounds. If auto bounds is enabled then it equals to parent model limits

Deprecated

since 4.1, use .getLayoutStyle instead

boolean

AdaptiveLogVisualHeader.isAutoBounds

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AdaptiveLogVisualHeader.isDisposed

▸ isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

boolean

AdaptiveLogVisualHeader.isEventPropagationEnabled

▸ isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

boolean

horizontal flip

AdaptiveLogVisualHeader.isHorizontalFlip

▸ isNotificationEnabled(): boolean

return state of notification

boolean

current notification state

AdaptiveLogVisualHeader.isNotificationEnabled

▸ isSelectable(): boolean

Returns true if node can be picked/selected.

boolean

The selectable flag

AdaptiveLogVisualHeader.isSelectable

▸ isSilent(): boolean

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

boolean

AdaptiveLogVisualHeader.isSilent

▸ isVertical(): boolean

Returns vertical flag

boolean

true, if header is vertical, false otherwise

AdaptiveLogVisualHeader.isVertical

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

Notify listeners of the Node

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.notify

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

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.

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.off

▸ on<E>(type, callback): AdaptiveBasicLogVisualHeader<T>

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.

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.on

▸ Protected onParentChanged(node): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.onParentChanged

▸ Protected onVisibilityChanged(): void

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

void

AdaptiveLogVisualHeader.onVisibilityChanged

▸ Protected onVisualChanged(): void

This method is called if visual is changed. Send event Events.VisualChanged

void

AdaptiveLogVisualHeader.onVisualChanged

▸ Protected onVisualChanging(): void

This method is called if visual is changing.

void

AdaptiveLogVisualHeader.onVisualChanging

▸ Protected onVisualStateChanged(type, source): void

void

AdaptiveLogVisualHeader.onVisualStateChanged

▸ Protected postRendering(context): void

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

void

AdaptiveLogVisualHeader.postRendering

▸ Protected preRendering(context): void

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

void

AdaptiveLogVisualHeader.preRendering

▸ registerAnimationStyle(root): void

Register animation style.

void

AdaptiveLogVisualHeader.registerAnimationStyle

▸ removeCssClass(cssclass): AdaptiveBasicLogVisualHeader<T>

Removes css class from node

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.removeCssClass

▸ removeInvalidateHandler(handler): AdaptiveBasicLogVisualHeader<T>

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.removeInvalidateHandler

▸ render(inputContext): void

Renders node

void

AdaptiveLogVisualHeader.render

▸ renderAsync(context, callback): void

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

void

AdaptiveLogVisualHeader.renderAsync

▸ rotate(theta, x, y): AdaptiveBasicLogVisualHeader<T>

Rotate bounds around a given coordinate

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.rotate

▸ scale(xx, yy): AdaptiveBasicLogVisualHeader<T>

Scale node

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.scale

▸ setAnimationStyle(animationStyle): AdaptiveBasicLogVisualHeader<T>

Sets animation style

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.setAnimationStyle

▸ setAutoBounds(enable): AdaptiveBasicLogVisualHeader<T>

Enable or disable auto bounds If auto bounds is enabled then it equals to parent model limits

Deprecated

since 4.1, use .setLayoutStyle instead

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.setAutoBounds

▸ setBorderLineStyle(lineStyle, merge?): AdaptiveBasicLogVisualHeader<T>

Sets border line style

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.setBorderLineStyle

▸ setBounds(bounds): AdaptiveBasicLogVisualHeader<T>

Sets bounds of the curve in the parent coordinates and set up auto bounds false

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.setBounds

▸ setClipStyle(style): AdaptiveBasicLogVisualHeader<T>

Sets a new clipping style

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.setClipStyle

▸ setCss(style, merge?): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.setCss

▸ setCssClass(name): AdaptiveBasicLogVisualHeader<T>

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

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.setCssClass

▸ setCssTransform(transform): AdaptiveBasicLogVisualHeader<T>

Set CSS transformation

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.setCssTransform

▸ setDesiredHeight(value, silent?): AdaptiveBasicLogVisualHeader<T>

Sets desired height of the header as a layoutable object

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.setDesiredHeight

▸ setDisplayMode(displayMode): AdaptiveBasicLogVisualHeader<T>

Sets the displayed mode value

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.setDisplayMode

▸ setDisplayString(displayString): AdaptiveBasicLogVisualHeader<T>

Sets the displayed value

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.setDisplayString

▸ setElement(names, options?): AdaptiveBasicLogVisualHeader<T>

Sets header element's parameters.

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.setElement

▸ setFillStyle(fillStyle, merge?): AdaptiveBasicLogVisualHeader<T>

Sets fill style

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.setFillStyle

▸ setHighlightOptions(options): AdaptiveBasicLogVisualHeader<T>

Set highlight options

AdaptiveBasicLogVisualHeader<T>

AdaptiveLogVisualHeader.setHighlightOptions

▸ setHorizontalFlip(enable): AdaptiveBasicLogVisualHeader<T>

Set horizontal flip of the representation

AdaptiveBasicLogVisualHeader<T>

this

AdaptiveLogVisualHeader.setHorizontalFlip

▸ setId(id): AdaptiveBasicLogVisualHeader<T>

Allows the user to associate any identifier