Last updated

API / geotoolkit / welllog / header / AdaptiveDiscreteFillVisualHeader / AdaptiveDiscreteFillVisualHeader

Class: AdaptiveDiscreteFillVisualHeader<T>

header.AdaptiveDiscreteFillVisualHeader.AdaptiveDiscreteFillVisualHeader

Adaptive header for LogDiscreteCurve visual

Type parameters

Hierarchy

Table of contents

Constructors
Methods
addCssClassaddInvalidateHandlerapplyOpacity
applyResponsiveStylecalculateDesiredHeightcalculateDiscreteElementHeight
calculateSectionsDesiredHeightcheckCollisioncheckTextSize
cloneconnectStylecopyConstructor
disconnectStyledisposedrawBorder
drawRoundedBoxdrawTextenableEventPropagation
executefillBorderfilter
getAnimationStylegetBorderLineStylegetBounds
getBoxOptionsgetClassNamegetClipStyle
getContentsAreagetContentsTransformgetCss
getCssClassgetCssClassesgetCssTransform
getDefaultDisplayTypegetDesiredHeightgetDiscreteDisplayType
getDisplayDepthgetDisplayModegetDisplayString
getDisplayValuegetElementByNamegetElements
getFillStylegetFlexBoxOptionsgetHighlightOptions
getIdgetInvalidateMethodgetIsPointingUp
getLayoutStylegetLineStylegetLocalTransform
getMarginsStylegetModelLimitsgetName
getOpacitygetOpacityBlendModegetPaddingStyle
getParentgetPropertiesgetProperty
getPropertyKeysgetRenderingFiltergetResponsiveStyle
getRootgetScaleScrollStrategygetSceneTransform
getSectionDesiredHeightgetSectionDesiredRectgetSections
getSettingsgetTaggetTextBoundingBox
getTextShapeHelpergetTextStylegetVisible
getVisualgetWorldTransformgetZIndex
hasCssClasshasEventListenerhitTest
invalidateinvalidateLayoutinvalidateParent
isAutoBoundsisDisposedisEventPropagationEnabled
isHorizontalFlipisNotificationEnabledisSelectable
isSilentisVerticalnotify
offononParentChanged
onVisibilityChangedonVisualChangedonVisualChanging
onVisualStateChangedpostRenderingpreRendering
registerAnimationStyleremoveCssClassremoveInvalidateHandler
renderrenderAsyncrotate
scalesetAnimationStylesetAutoBounds
setBorderLineStylesetBoundssetBoxOptions
setClipStylesetCsssetCssClass
setCssTransformsetDesiredHeightsetDiscreteDisplayType
setDisplayModesetDisplayStringsetElement
setFillStylesetFlexBoxOptionssetHighlightOptions
setHorizontalFlipsetIdsetIsPointingUp
setLayoutStylesetLineStylesetLocalTransform
setMarginsStylesetModelLimitssetName
setNotificationsetOpacitysetPaddingStyle
setPropertiessetPropertysetRenderingFilter
setResponsiveStylesetScaleScrollStrategysetSection
setSectionssetSelectablesetSettings
setSilentsetTagsetTextStyle
setVerticalsetVisiblesetVisual
setZIndexshearsynchronizeElements
toStringtranslateunregisterAnimationStyle
updateGeometryupdateSceneTransformationupdateState
updateTimeStampenableSceneGraphNotificationfindParent
getClassNamegetDesiredHeightisSceneGraphNotificationEnabled
Css Properties
Name Type Description
autoboundsbooleanAutomatic calculation of header size on or off
borderlinestylestringBorder line style
borderlinestyleLineStyleBorder line style
borderlinestyle-colorstringColor in CSS form
borderlinestyle-fillstringOptional fill style to be used to fill lines generated with this style
borderlinestyle-fillFillStyleOptional fill style to be used to fill lines generated with this style
borderlinestyle-fill-colorstringColor in CSS form
borderlinestyle-fill-evenoddmodebooleanEven-odd fill mode
borderlinestyle-fill-fillpatternPatternPattern
borderlinestyle-fill-fillpattern-containernamestringAn optional container name, which creates an image pattern. This parameter is used for serialization if you want to save are reference to pattern instead of the pattern itself
borderlinestyle-fill-fillpattern-patternnamestringName of this pattern for indexing
borderlinestyle-fill-fillpattern-scalablebooleanFlag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported)
borderlinestyle-fill-foregroundstringForeground color
borderlinestyle-fill-patternPatternPattern
borderlinestyle-linecapCapStyleThe line cap style
borderlinestyle-linedashoffsetnumberLine dash offset of dashed line
borderlinestyle-linejoinJoinStyleThe line join style
borderlinestyle-pixelsnapmodebooleanPixel Snap Mode, default(
borderlinestyle-scalablebooleanTrue if width should depend on transformation
borderlinestyle-unitstringOptional unit for the width
borderlinestyle-widthnumber | stringThe line thickness
boundsRectBounds of the curve in the parent coordinates
bounds-heightnumberHeight
bounds-readonlybooleanReadonly
bounds-widthnumberWidth
bounds-xnumberLeft
bounds-ynumberTop
boxoptionsBoxOptionsBox layout options
boxoptions-marginnumber | stringFlexbox item margins
clipstyleClipStyleClipping style
clipstyle-evenoddbooleanTrue if evenodd mode is on (&#x27;nonzero&#x27; mode otherwise)
clipstyle-geometryGraphicsPathClipping geometry
clipstyle-geometry-boundsRectBounds
clipstyleGraphicsPathClipping style
cssclassstringThe css class name of this node
csscursorstringCSS cursor associated with node
cssstylestringCSS style to be applied to inserted elements
depthnumberDepth
displaymodestringDisplay mode
displaystringstringDisplay string
fillstylestringThe fill style
fillstyleFillStyleThe fill style
flexboxoptionsBoxOptionsFlex box layout options
gapnumberGap
headertypeDiscreteFillDisplayTypeDiscrete header type
horizontalflipbooleanFlip horizontal from right to left
idstring | numberId of the node, its a unique identifier
ispointingupbooleanDefines whether the text is always pointing up
layoutstyleLayoutStyleLayoutstyle
layoutstyle-constraintSizeConstraintLayout constrains
layoutstyle-flexgrownumberNumber specifying how much the item will grow relative to the rest of the items inside the same container
layoutstyle-flexshrinknumberNumber specifying how much the item will shrink relative to the rest of the items inside the same container
layoutstyle-floatstringFloat position
layoutstyle-positionstringLayout position
layoutstyle-sizenumber | stringLayout size
linestylestringThe line style
linestyleLineStyleThe line style
localtransformTransformationLocal transformation
localtransform-dxnumberX axis translation
localtransform-dynumberY axis translation
localtransform-xxnumberX scale
localtransform-xynumberXy skew
localtransform-yxnumberYx skew
localtransform-yynumberY scale
marginsnumber | stringIt has properties for specifying the margins for each side
modellimitsRectDesired model Limits
namestringName of the node. It is often used for debugging purposes or to simplify queries
opacitynumberNode opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context
opacityblendmodeBlendModeNode opacity mode to blend it
orientationOrientationHeader orientation
paddingnumber | stringIt has properties for specifying the padding for each side
scalescrollstrategyScaleScrollStrategyScale scroll strategy
scalescrollstrategy-enabledbooleanEnable flag
selectablebooleanSelectable node, a boolean to determine if selection should consider this node
taganyCustom information associated with node. It is a user object which can be used by client code to store information or attach an application object to the shape
textstylestringThe text style
textstyleTextStyleThe text style
textstyle-alignmentAlignmentStyleAlignment
textstyle-autosizebooleanAuto font size on high definition display
textstyle-backgroundstringBackground style
textstyle-backgroundFillStyleBackground style
textstyle-baselineBaseLineStyleBase line
textstyle-colorstringColor in CSS form
textstyle-fillFillStyleText fill style
textstyle-fontstringFont see
textstyle-fonturlstringThe place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword
textstyle-lineheightstring | numberLine height
textstyle-multilinebooleanAllow multi-line text
textstyle-outlinestringOutline style
textstyle-outlineLineStyleOutline style
textstyle-overflowwrapOverflowWrapStyleOverflow wrap
textstyle-strikethroughstringStrikethrough style
textstyle-strikethroughLineStyleStrikethrough style
textstyle-textoverflowTextOverflowStyleText overflow
textstyle-underlinestringUnderline style
textstyle-underlineLineStyleUnderline style
textstyle-underlineoffsetstring | numberUnderline offset distance
textstyle-whitespaceWhiteSpaceStyleWhite space
textstyle-wordbreakWordBreakStyleWord break
transformstringAdditional CSS transformation applied to node or &#x27;none&#x27;
transformTransformationAdditional CSS transformation applied to node or &#x27;none&#x27;
visiblebooleanVisibility of the node, a boolean to determine if the node should be rendered or not
z-indexnumberDefine node z-index

Contents

Constructors

new AdaptiveDiscreteFillVisualHeader&lt;T&amp;gt;(options)

Protected new AdaptiveDiscreteFillVisualHeader<T>(options?)

Type parameters

NameType
Textends LogAbstractVisual<T> = LogAbstractVisual

Parameters

Name Type Description
Optional optionsT | Options<T>visual or properties object

Overrides

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

Methods

addCssClass

addCssClass(cssclass): AdaptiveDiscreteFillVisualHeader<T>

Adds new css class to node

Parameters

Name Type Description
cssclassstring | string[]css class name('s)

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.addCssClass


addInvalidateHandler

addInvalidateHandler(handler): AdaptiveDiscreteFillVisualHeader<T>

Add invalidate handler

Deprecated

since 4.0, use Node.on instead

Parameters

Name Type Description
handlerFunctionhandler to be notified about invalidation

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.addInvalidateHandler


applyOpacity

Protected applyOpacity(context): AdaptiveDiscreteFillVisualHeader<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

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.applyOpacity


applyResponsiveStyle

Protected applyResponsiveStyle(): void

Apply a responsive style rules it is exists

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.applyResponsiveStyle


calculateDesiredHeight

Protected calculateDesiredHeight(width?): number

Return header desired height

Parameters

Name Type Description
Optional widthnumberwidth to fit elements in case wrapping

Returns

number

Inherited from

AdaptiveBasicLogVisualHeader.calculateDesiredHeight


calculateDiscreteElementHeight

Protected calculateDiscreteElementHeight(): number | MeasureSectionSizeCallback<LogAbstractVisual>

Returns

number | MeasureSectionSizeCallback<LogAbstractVisual>


calculateSectionsDesiredHeight

Protected calculateSectionsDesiredHeight(width): number

Return overall height by specified width

Parameters

Name Type Description
widthnumberavailable device width to calculate desired width

Returns

number

Inherited from

AdaptiveBasicLogVisualHeader.calculateSectionsDesiredHeight


checkCollision

checkCollision(context): boolean

Check culling Returns true if object is inside of renderable area

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

boolean

Inherited from

AdaptiveBasicLogVisualHeader.checkCollision


checkTextSize

checkTextSize(context, text, maxLen): string

Returns biggest text in specified width

Parameters

Name Type Description
contextRenderingContextRendering Context
textstringText to calculate the size for
maxLennumbermax length available for the text

Returns

string

Inherited from

AdaptiveBasicLogVisualHeader.checkTextSize


clone

clone(): AdaptiveBasicLogVisualHeader<T>

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

Returns

AdaptiveBasicLogVisualHeader<T>

clone

Inherited from

AdaptiveBasicLogVisualHeader.clone


connectStyle

connectStyle(style, type, callback): AdaptiveDiscreteFillVisualHeader<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

Parameters

Name Type Description
styleEventDispatcherconnect style
typestringtype of event or property
callbackAttributeCallback<EventDispatcher>function to be called

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.connectStyle


copyConstructor

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

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

Parameters

Name Type Description
srcAdaptiveDiscreteFillVisualHeader<T>Source to copy from
Optional deepCopybooleandeep copy

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Overrides

AdaptiveBasicLogVisualHeader.copyConstructor


disconnectStyle

disconnectStyle(style, type, callback): AdaptiveDiscreteFillVisualHeader<T>

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

Parameters

Name Type Description
styleEventDispatcherconnect style
typestringtype of event or property
callbackAttributeCallback<EventDispatcher>function to be called

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.disconnectStyle


dispose

dispose(): void

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

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.dispose


drawBorder

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

Stroke border with specified

Parameters

Name Type Description
contextRenderingContextRendering Context
Optional borderLineStyleLineStylethe LineStyle for the border
Optional modelLimitsRectthe border bounds

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.drawBorder


drawRoundedBox

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

Parameters

Name Type
contextRenderingContext
boundsRect
Optional optionsObject
Optional options.fillstyleFillStyle
Optional options.linestyleLineStyle
Optional options.radiusnumber

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.drawRoundedBox


drawText

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

for internal use only, make text always readable

Parameters

Name Type Description
contextRenderingContextrendering context
Optional xnumberx position to place text
Optional ynumbery position to place text
Optional textstringtext to be displayed
Optional styleTextStyletext style
Optional alignmentAnchorTypealignment for placement of text
Optional thetanumberof rotation
Optional maxSizenumber | Dimensionmax size or width

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.drawText


enableEventPropagation

enableEventPropagation(enable): AdaptiveDiscreteFillVisualHeader<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();

Parameters

Name Type Description
enablebooleanenable

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.enableEventPropagation


execute

execute(delegate): AdaptiveDiscreteFillVisualHeader<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");
});

Parameters

Name Type Description
delegate(this: AdaptiveDiscreteFillVisualHeader<T>) => voidFunction to execute

Returns

AdaptiveDiscreteFillVisualHeader<T>

The result if any or this

Inherited from

AdaptiveBasicLogVisualHeader.execute

execute<T>(delegate): T

Type parameters

Name
T

Parameters

Name Type
delegate(this: AdaptiveDiscreteFillVisualHeader<T>) => T

Returns

T

Inherited from

AdaptiveBasicLogVisualHeader.execute


fillBorder

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

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

Parameters

Name Type Description
contextRenderingContextRendering Context
Optional fillStyleFillStyleFill Style for the rectangle
Optional modelLimitsRectrectangle bounds

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.fillBorder


filter

Protected filter(context): boolean

Filter node

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

boolean

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

Inherited from

AdaptiveBasicLogVisualHeader.filter


getAnimationStyle

getAnimationStyle(): AnimationStyle

Return animation style

Returns

AnimationStyle

animationStyle current animation style

Inherited from

AdaptiveBasicLogVisualHeader.getAnimationStyle


getBorderLineStyle

getBorderLineStyle(): LineStyle

Gets border line style

Returns

LineStyle

Inherited from

AdaptiveBasicLogVisualHeader.getBorderLineStyle


getBounds

getBounds(): Rect

Return bound in the parent coordinates

Returns

Rect

Inherited from

AdaptiveBasicLogVisualHeader.getBounds


getBoxOptions

getBoxOptions(): BoxOptionsOut

Get box layout options

Returns

BoxOptionsOut

box layout options


getClassName

getClassName(): string

Returns

string

Inherited from

AdaptiveBasicLogVisualHeader.getClassName


getClipStyle

getClipStyle(): ClipStyle

Gets the current clipping style

Returns

ClipStyle

clipping style

Inherited from

AdaptiveBasicLogVisualHeader.getClipStyle


getContentsArea

getContentsArea(transformation?): Rect

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

Parameters

Name Type Description
Optional transformationTransformationscene transformation

Returns

Rect

Inherited from

AdaptiveBasicLogVisualHeader.getContentsArea


getContentsTransform

getContentsTransform(): Transformation

Return transformation from model to bounds

Returns

Transformation

Inherited from

AdaptiveBasicLogVisualHeader.getContentsTransform


getCss

getCss(): CssStyle

Return CSS style

Returns

CssStyle

Inherited from

AdaptiveBasicLogVisualHeader.getCss


getCssClass

getCssClass(): string

Returns css class name to be used to apply CSS style

Returns

string

the css class name

Inherited from

AdaptiveBasicLogVisualHeader.getCssClass


getCssClasses

getCssClasses(): string[]

Gets list of css class names which applied to this node

Returns

string[]

Inherited from

AdaptiveBasicLogVisualHeader.getCssClasses


getCssTransform

getCssTransform(): string

Returns CSS transformation

Returns

string

Inherited from

AdaptiveBasicLogVisualHeader.getCssTransform


getDefaultDisplayType

Protected getDefaultDisplayType(): DiscreteFillDisplayType

return default header type

Returns

DiscreteFillDisplayType


getDesiredHeight

getDesiredHeight(width?): number

Return header desired height

Parameters

Name Type Description
Optional widthnumberwidth to fit elements in case wrapping

Returns

number

Inherited from

AdaptiveBasicLogVisualHeader.getDesiredHeight


getDiscreteDisplayType

getDiscreteDisplayType(): DiscreteFillDisplayType

Returns discrete fill display type

Returns

DiscreteFillDisplayType


getDisplayDepth

getDisplayDepth(): number

Returns the displayed depth value

Returns

number

Inherited from

AdaptiveBasicLogVisualHeader.getDisplayDepth


getDisplayMode

getDisplayMode(): string | string[]

Returns the displayed mode value

Returns

string | string[]

Inherited from

AdaptiveBasicLogVisualHeader.getDisplayMode


getDisplayString

getDisplayString(): string

Returns the displayed value

Returns

string

displayString

Inherited from

AdaptiveBasicLogVisualHeader.getDisplayString


getDisplayValue

getDisplayValue(): number

Returns 0

Returns

number

Inherited from

AdaptiveBasicLogVisualHeader.getDisplayValue


getElementByName

getElementByName(name): ElementOptionsOut<LogAbstractVisual>

return element object that is matching the given name

Parameters

Name Type Description
namestringelement name

Returns

ElementOptionsOut<LogAbstractVisual>

element properies

Inherited from

AdaptiveBasicLogVisualHeader.getElementByName


getElements

getElements(): ElementOptionsOut<LogAbstractVisual>[]

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

Returns

ElementOptionsOut<LogAbstractVisual>[]

header elements

Inherited from

AdaptiveBasicLogVisualHeader.getElements


getFillStyle

getFillStyle(): FillStyle

Return fill style

Returns

FillStyle

Inherited from

AdaptiveBasicLogVisualHeader.getFillStyle


getFlexBoxOptions

getFlexBoxOptions(): BoxOptionsOut

Get flex box layout options

Returns

BoxOptionsOut

flex box layout options


getHighlightOptions

getHighlightOptions(): HighlightOptions

Returns highlight options

Returns

HighlightOptions

highlight options

Inherited from

AdaptiveBasicLogVisualHeader.getHighlightOptions


getId

getId(): string | number

Returns the associated identifier of the node

Returns

string | number

The node's id

Inherited from

AdaptiveBasicLogVisualHeader.getId


getInvalidateMethod

Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

Gets invalidate method

Returns

AttributeCallback<EventDispatcher>

method to invalidate this object

Inherited from

AdaptiveBasicLogVisualHeader.getInvalidateMethod


getIsPointingUp

getIsPointingUp(): boolean

Returns true if the text is always pointing up

Returns

boolean

true if the text is always pointing up

Inherited from

AdaptiveBasicLogVisualHeader.getIsPointingUp


getLayoutStyle

getLayoutStyle(): LayoutStyle<string | number>

Return desired layout style

Returns

LayoutStyle<string | number>

Inherited from

AdaptiveBasicLogVisualHeader.getLayoutStyle


getLineStyle

getLineStyle(): LineStyle

Return line style

Returns

LineStyle

Inherited from

AdaptiveBasicLogVisualHeader.getLineStyle


getLocalTransform

getLocalTransform(): Transformation

Retrieves the transformation of bounds to parent

Returns

Transformation

transform the local transform.

Inherited from

AdaptiveBasicLogVisualHeader.getLocalTransform


getMarginsStyle

getMarginsStyle(): SpaceStyle<string | number>

Return margins style

Returns

SpaceStyle<string | number>

Inherited from

AdaptiveBasicLogVisualHeader.getMarginsStyle


getModelLimits

getModelLimits(): Rect

Return model limits

Returns

Rect

Inherited from

AdaptiveBasicLogVisualHeader.getModelLimits


getName

getName(): string

Returns the node name

Returns

string

The node name

Inherited from

AdaptiveBasicLogVisualHeader.getName


getOpacity

getOpacity(): number

Returns current node opacity

Returns

number

opacity

Inherited from

AdaptiveBasicLogVisualHeader.getOpacity


getOpacityBlendMode

getOpacityBlendMode(): BlendMode

Returns current node opacity

Returns

BlendMode

opacity blend mode

Inherited from

AdaptiveBasicLogVisualHeader.getOpacityBlendMode


getPaddingStyle

getPaddingStyle(): SpaceStyle<string | number>

Return padding style

Returns

SpaceStyle<string | number>

padding

Inherited from

AdaptiveBasicLogVisualHeader.getPaddingStyle


getParent

getParent(): Node

Return parent node

Returns

Node

parent node

Inherited from

AdaptiveBasicLogVisualHeader.getParent


getProperties

getProperties(): OptionsOut<LogAbstractVisual>

Gets all the properties pertaining to this object

Returns

OptionsOut<LogAbstractVisual>

of the header

Overrides

AdaptiveBasicLogVisualHeader.getProperties


getProperty

getProperty(name): any

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

Parameters

Name Type Description
namestringproperty name

Returns

any

Inherited from

AdaptiveBasicLogVisualHeader.getProperty


getPropertyKeys

getPropertyKeys(): string[]

Returns known properties keys

Returns

string[]

Inherited from

AdaptiveBasicLogVisualHeader.getPropertyKeys


getRenderingFilter

getRenderingFilter(): IFilter

Return filter to be used for rendering and picking

Returns

IFilter

current filter

Inherited from

AdaptiveBasicLogVisualHeader.getRenderingFilter


getResponsiveStyle

getResponsiveStyle(): ResponsiveStyle

Return responsive style

Returns

ResponsiveStyle

Inherited from

AdaptiveBasicLogVisualHeader.getResponsiveStyle


getRoot

getRoot(): Node

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

Returns

Node

the root node

Inherited from

AdaptiveBasicLogVisualHeader.getRoot


getScaleScrollStrategy

getScaleScrollStrategy(): Delegate

Gets scale scroll strategy

Returns

Delegate

scale scroll strategy

Inherited from

AdaptiveBasicLogVisualHeader.getScaleScrollStrategy


getSceneTransform

getSceneTransform(): Transformation

Returns transformation from node to root scene

Returns

Transformation

a transformation from node to root scene

Inherited from

AdaptiveBasicLogVisualHeader.getSceneTransform


getSectionDesiredHeight

Protected getSectionDesiredHeight(section, width): number

Return desired height for specified section

Parameters

Name Type Description
sectionSectionOptions<T>section settings
widthnumberavailable device width to calculate desired width

Returns

number

Inherited from

AdaptiveBasicLogVisualHeader.getSectionDesiredHeight


getSectionDesiredRect

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

Return desired section bounds by specified name

Parameters

Name Type Description
Optional sectionNamestringsection name
Optional rectRectoptional param for internal use
Optional trTransformation

Returns

Rect

Inherited from

AdaptiveBasicLogVisualHeader.getSectionDesiredRect


getSections

getSections(): SectionOptions<T>[]

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

Returns

SectionOptions<T>[]

header elements

Inherited from

AdaptiveBasicLogVisualHeader.getSections


getSettings

getSettings(): Settings

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

Returns

Settings

settings

Inherited from

AdaptiveBasicLogVisualHeader.getSettings


getTag

getTag(): any

Returns the object associated with the node by user.

Returns

any

The node's user-object

Inherited from

AdaptiveBasicLogVisualHeader.getTag


getTextBoundingBox

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

Returns bounding box of the text

Parameters

Name Type Description
contextRenderingContextrendering context
Optional xnumberx position to place text
Optional ynumbery position to place text
Optional textstringtext to be displayed
Optional styleTextStyletext style
Optional alignmentAnchorTypealignment for placement of text
Optional thetanumberof rotation

Returns

Rect

Inherited from

AdaptiveBasicLogVisualHeader.getTextBoundingBox


getTextShapeHelper

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

Return text shape helper instance

Parameters

Name Type Description
Optional xnumberx coordinate
Optional ynumbery coordinate
Optional textstringtext to display
Optional textStyleTypea new shape text style
Optional alignmentAnchorTypeanchor alignment

Returns

Text

text shape helper

Inherited from

AdaptiveBasicLogVisualHeader.getTextShapeHelper


getTextStyle

getTextStyle(): TextStyle

Return a current text style

Returns

TextStyle

Inherited from

AdaptiveBasicLogVisualHeader.getTextStyle


getVisible

getVisible(): boolean

Return visibility of the header

Returns

boolean

true if header itself and associated LogVisual is visible

Inherited from

AdaptiveBasicLogVisualHeader.getVisible


getVisual

getVisual(): T

Gets visual to be used to render header

Returns

T

visual

Inherited from

AdaptiveBasicLogVisualHeader.getVisual


getWorldTransform

getWorldTransform(): Transformation

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

Returns

Transformation

Inherited from

AdaptiveBasicLogVisualHeader.getWorldTransform


getZIndex

getZIndex(): number

Returns node z-index (null if not set)

Returns

number

Inherited from

AdaptiveBasicLogVisualHeader.getZIndex


hasCssClass

hasCssClass(cssClass): boolean

Check if node has specified css class

Parameters

Name Type Description
cssClassstringcss class name

Returns

boolean

Inherited from

AdaptiveBasicLogVisualHeader.hasCssClass


hasEventListener

hasEventListener(type, callback?): boolean

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

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

AdaptiveBasicLogVisualHeader.hasEventListener


hitTest

hitTest(area, radius?): Hits[]

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

Parameters

Name Type Description
areaHitTestAreamodel area or position
Optional radiusnumberradius of selection

Returns

Hits[]

selected items

Inherited from

AdaptiveBasicLogVisualHeader.hitTest


invalidate

invalidate(bounds?, force?): AdaptiveDiscreteFillVisualHeader<T>

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

Parameters

Name Type Description
Optional boundsRectbounds of the invalid rectangle in the inner node coordinates
Optional forcebooleantrue if parent should be invalidated immediately if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.invalidate


invalidateLayout

invalidateLayout(propagate?): AdaptiveDiscreteFillVisualHeader<T>

Notify that layout is invalidated. Send event Events.LayoutInvalidated

Parameters

Name Type Description
Optional propagatebooleanpropagate invalidate layout to parent

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.invalidateLayout


invalidateParent

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

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

Fires

Events.Invalidate

Parameters

Name Type Description
Optional boundsRectbounds of the invalid rectangle in the inner node coordinates
Optional forcebooleanforce rendering

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.invalidateParent


isAutoBounds

isAutoBounds(): boolean

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

Deprecated

since 4.1, use .getLayoutStyle instead

Returns

boolean

Inherited from

AdaptiveBasicLogVisualHeader.isAutoBounds


isDisposed

isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

AdaptiveBasicLogVisualHeader.isDisposed


isEventPropagationEnabled

isEventPropagationEnabled(): boolean

Return true if event propagation is enabled from child to parent

Returns

boolean

Inherited from

AdaptiveBasicLogVisualHeader.isEventPropagationEnabled


isHorizontalFlip

isHorizontalFlip(): boolean

Return true if the representation is flipped horizontally

Returns

boolean

horizontal flip

Inherited from

AdaptiveBasicLogVisualHeader.isHorizontalFlip


isNotificationEnabled

isNotificationEnabled(): boolean

return state of notification

Returns

boolean

current notification state

Inherited from

AdaptiveBasicLogVisualHeader.isNotificationEnabled


isSelectable

isSelectable(): boolean

Returns true if node can be picked/selected.

Returns

boolean

The selectable flag

Inherited from

AdaptiveBasicLogVisualHeader.isSelectable


isSilent

isSilent(): boolean

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

Returns

boolean

Inherited from

AdaptiveBasicLogVisualHeader.isSilent


isVertical

isVertical(): boolean

Returns vertical flag

Returns

boolean

true, if header is vertical, false otherwise

Inherited from

AdaptiveBasicLogVisualHeader.isVertical


notify

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

Notify listeners of the Node

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event
sourceLogVisualHeader<Node>source who called the event
Optional argsEventMap[E]event arguments

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.notify


off

off<E>(type?, callback?): AdaptiveDiscreteFillVisualHeader<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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: AdaptiveDiscreteFillVisualHeader<T>, args: EventMap[E]) => voidfunction to be called

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.off


on

on<E>(type, callback): AdaptiveDiscreteFillVisualHeader<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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: AdaptiveDiscreteFillVisualHeader<T>, args: EventMap[E]) => voidto be called

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.on


onParentChanged

Protected onParentChanged(node): AdaptiveDiscreteFillVisualHeader<T>

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

Parameters

Name Type Description
nodeNodenode to change parent

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.onParentChanged


onVisibilityChanged

Protected onVisibilityChanged(): void

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

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.onVisibilityChanged


onVisualChanged

Protected onVisualChanged(): void

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

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.onVisualChanged


onVisualChanging

Protected onVisualChanging(): void

This method is called if visual is changing.

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.onVisualChanging


onVisualStateChanged

Protected onVisualStateChanged(type, source): void

Parameters

Name Type
typeEvents | Events
sourceT

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.onVisualStateChanged


postRendering

Protected postRendering(context): void

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

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.postRendering


preRendering

Protected preRendering(context): void

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

Parameters

Name Type Description
contextRenderingContextRendering Context

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.preRendering


registerAnimationStyle

registerAnimationStyle(root): void

Register animation style.

Parameters

Name Type Description
rootNoderoot node for node

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.registerAnimationStyle


removeCssClass

removeCssClass(cssclass): AdaptiveDiscreteFillVisualHeader<T>

Removes css class from node

Parameters

Name Type Description
cssclassstring | string[]css class name('s)

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.removeCssClass


removeInvalidateHandler

removeInvalidateHandler(handler): AdaptiveDiscreteFillVisualHeader<T>

Remove invalidate handler

Deprecated

since 4.0, use Node.off instead

Parameters

Name Type Description
handlerFunctionhandler to be notified about invalidation

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.removeInvalidateHandler


render

render(inputContext): void

Renders node

Parameters

Name Type Description
inputContextRenderingContextThe rendering context to be used to draw the node

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.render


renderAsync

renderAsync(context, callback): void

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

Parameters

Name Type Description
contextRenderingContextThe rendering context to be used to draw the node
callback() => voidcallback function

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.renderAsync


rotate

rotate(theta, x, y): AdaptiveDiscreteFillVisualHeader<T>

Rotate bounds around a given coordinate

Parameters

Name Type Description
thetanumberangle to rotate node, in radians
xnumberx coordinate to rotate around
ynumbery coordinate to rotate around

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.rotate


scale

scale(xx, yy): AdaptiveDiscreteFillVisualHeader<T>

Scale node

Parameters

Name Type Description
xxnumberx scale factor
yynumbery scale factor

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.scale


setAnimationStyle

setAnimationStyle(animationStyle): AdaptiveDiscreteFillVisualHeader<T>

Sets animation style

Parameters

Name Type Description
animationStyleTypeanimation style

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setAnimationStyle


setAutoBounds

setAutoBounds(enable): AdaptiveDiscreteFillVisualHeader<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

Parameters

Name Type Description
enablebooleanEnable or disable auto bounds

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setAutoBounds


setBorderLineStyle

setBorderLineStyle(lineStyle, merge?): AdaptiveDiscreteFillVisualHeader<T>

Sets border line style

Parameters

Name Type Description
lineStyleTypeline style or options
Optional mergebooleantrue if you want to merge lineStyle with existing attribute, false by default

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setBorderLineStyle


setBounds

setBounds(bounds): AdaptiveDiscreteFillVisualHeader<T>

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

Parameters

Name Type Description
boundsRectbounds of the curve in the parent coordinates

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setBounds


setBoxOptions

setBoxOptions(boxOptions): AdaptiveDiscreteFillVisualHeader<T>

Set box layout options

Parameters

Name Type Description
boxOptionsBoxOptionsbox layout options

Returns

AdaptiveDiscreteFillVisualHeader<T>

this


setClipStyle

setClipStyle(style): AdaptiveDiscreteFillVisualHeader<T>

Sets a new clipping style

Parameters

Name Type Description
styleGraphicsPath | ClipStyle | Optionsa new clipping style

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setClipStyle


setCss

setCss(style, merge?): AdaptiveDiscreteFillVisualHeader<T>

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

Parameters

Name Type Description
styleTypeCSS style to be applied to inserted elements
Optional mergebooleanmerge flag

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setCss


setCssClass

setCssClass(name): AdaptiveDiscreteFillVisualHeader<T>

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

Parameters

Name Type Description
namestringcss class name of the node

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setCssClass


setCssTransform

setCssTransform(transform): AdaptiveDiscreteFillVisualHeader<T>

Set CSS transformation

Parameters

Name Type Description
transformstring | Transformationtransformation css transformation instruction or Transformation instance

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setCssTransform


setDesiredHeight

setDesiredHeight(value, silent?): AdaptiveDiscreteFillVisualHeader<T>

Sets desired height of the header as a layoutable object

Parameters

Name Type Description
valuestring | numberdesired height to set, use 'auto' for automatic desired height
Optional silentbooleansilent setting

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setDesiredHeight


setDiscreteDisplayType

setDiscreteDisplayType(displayType): AdaptiveDiscreteFillVisualHeader<T>

Sets discrete fill display type

Parameters

Name Type Description
displayTypeDiscreteFillDisplayTypediscrete fill display type

Returns

AdaptiveDiscreteFillVisualHeader<T>

this


setDisplayMode

setDisplayMode(displayMode): AdaptiveDiscreteFillVisualHeader<T>

Sets the displayed mode value

Parameters

Name Type Description
displayModestring | string[]header display mode

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setDisplayMode


setDisplayString

setDisplayString(displayString): AdaptiveDiscreteFillVisualHeader<T>

Sets the displayed value

Parameters

Name Type Description
displayStringstringthe displayed value

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setDisplayString


setElement

setElement(names, options?): AdaptiveDiscreteFillVisualHeader<T>

Sets header element's parameters.

Parameters

Name Type Description
namesstring | string[] | Record<string, ElementOptions<LogAbstractVisual>>names include
(a) element name or
(b) an array of element names or
(c) JSON-object with entries in the form of: "an_element_name": { the_element_JSON_options } (see second parameter description for details)
Optional optionsElementOptions<LogAbstractVisual>options to set

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setElement


setFillStyle

setFillStyle(fillStyle, merge?): AdaptiveDiscreteFillVisualHeader<T>

Sets fill style

Parameters

Name Type Description
fillStyleTypea new fill style
Optional mergebooleantrue if you want to merge fillStyle with existing attribute, false by default

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setFillStyle


setFlexBoxOptions

setFlexBoxOptions(flexBoxOptions): AdaptiveDiscreteFillVisualHeader<T>

Set flex box layout options

Parameters

Name Type Description
flexBoxOptionsFlexBoxOptionsbox layout options

Returns

AdaptiveDiscreteFillVisualHeader<T>

this


setHighlightOptions

setHighlightOptions(options): AdaptiveDiscreteFillVisualHeader<T>

Set highlight options

Parameters

Name Type Description
optionsHighlightOptionshighlight options

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setHighlightOptions


setHorizontalFlip

setHorizontalFlip(enable): AdaptiveDiscreteFillVisualHeader<T>

Set horizontal flip of the representation

Parameters

Name Type Description
enablebooleanenable flip flag, if it is null [default] header try to use same property from associated visual

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setHorizontalFlip


setId

setId(id): AdaptiveDiscreteFillVisualHeader<T>

Allows the user to associate any identifier

Parameters

Name Type Description
idstring | numberobject id

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setId


setIsPointingUp

setIsPointingUp(isPointingUp): AdaptiveDiscreteFillVisualHeader<T>

Sets whether the text is always pointing up.

Parameters

Name Type Description
isPointingUpbooleanflag setting whether the text is always pointing up

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setIsPointingUp


setLayoutStyle

setLayoutStyle(layoutStyle, merge?): AdaptiveDiscreteFillVisualHeader<T>

Specify desired layout style

Parameters

Name Type Description
layoutStyleLayoutStyle<string | number> | Options<string | number>desired layout style
Optional mergebooleantrue if you want to merge layoutStyle with existing attribute, false by default

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setLayoutStyle


setLineStyle

setLineStyle(lineStyle, merge?): AdaptiveDiscreteFillVisualHeader<T>

Sets a line style

Parameters

Name Type Description
lineStyleTypeline style or options
Optional mergebooleantrue if you want to merge lineStyle with existing attribute, false by default

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setLineStyle


setLocalTransform

setLocalTransform(localTransform, force?): AdaptiveDiscreteFillVisualHeader<T>

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

Parameters

Name Type Description
localTransformTransformationlocal transformation for this node
Optional forcebooleanboolean flag to force update event if transformations are equal, false by default

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setLocalTransform


setMarginsStyle

setMarginsStyle(margins, merge?): AdaptiveDiscreteFillVisualHeader<T>

Sets margins style

Parameters

Name Type Description
marginsType<string | number>margins style
Optional mergebooleantrue if you want to merge marginsStyle with existing attribute, false by default

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setMarginsStyle


setModelLimits

setModelLimits(modelLimits): AdaptiveDiscreteFillVisualHeader<T>

Sets model limits

Parameters

Name Type Description
modelLimitsRectdesired model Limits

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setModelLimits


setName

setName(name): AdaptiveDiscreteFillVisualHeader<T>

Sets name of the node

Parameters

Name Type Description
namestringThe node name

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setName


setNotification

setNotification(notify, force?): AdaptiveDiscreteFillVisualHeader<T>

set notification state

Parameters

Name Type Description
notifybooleanflag set to invalidate parent or not
Optional forcebooleantrue if parent should be invalidated immediately

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setNotification


setOpacity

setOpacity(opacity, blendMode?): AdaptiveDiscreteFillVisualHeader<T>

Sets node opacity

Parameters

Name Type Description
opacitynumbernode opacity from 0 to 1
Optional blendModeBlendModeopacity blend mode. If it is normal, opacity will be replaced.

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setOpacity


setPaddingStyle

setPaddingStyle(paddingStyle, merge?): AdaptiveDiscreteFillVisualHeader<T>

Sets padding style

Parameters

Name Type Description
paddingStyleType<string | number>padding style
Optional mergebooleantrue if you want to merge paddingStyle with existing attribute, false by default

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setPaddingStyle


setProperties

setProperties(properties?): AdaptiveDiscreteFillVisualHeader<T>

Sets all properties

Parameters

Name Type Description
Optional propertiesOptions<T>properties

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Overrides

AdaptiveBasicLogVisualHeader.setProperties


setProperty

setProperty(name, value): AdaptiveDiscreteFillVisualHeader<T>

Sets dynamic property by name

Parameters

Name Type Description
namestringproperty name
valueanyproperty value

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setProperty


setRenderingFilter

setRenderingFilter(filter): AdaptiveDiscreteFillVisualHeader<T>

Sets filter to be applied before rendering and picking

Parameters

Name Type Description
filterIFilterfilter to set

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setRenderingFilter


setResponsiveStyle

setResponsiveStyle(style): AdaptiveDiscreteFillVisualHeader<T>

Sets responsive style.

Parameters

Name Type Description
styleOptions | ResponsiveStyleresponsive style

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setResponsiveStyle


setScaleScrollStrategy

setScaleScrollStrategy(strategy?): AdaptiveDiscreteFillVisualHeader<T>

Sets scale scroll strategy

Parameters

Name Type Description
Optional strategyDelegatescale scroll strategy

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setScaleScrollStrategy


setSection

setSection(names, options?): AdaptiveDiscreteFillVisualHeader<T>

Sets header section's parameters. this method does not change sections order, it change only section/s options

Parameters

Name Type Description
namesstring | string[] | Record<string, SectionOptions<T>>names include
(a) section name or
(b) an array of section names or
(c) JSON-object with entries in the form of: "an_section_name": { the_section_JSON_options } (see second parameter description for details)
Optional optionsSectionOptions<T>options to set

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setSection


setSections

setSections(sections): AdaptiveDiscreteFillVisualHeader<T>

Set the section order and options. If the sections are empty or null, reset the order to default based on the sequence of elements. Default sequence is ['top', 'middle', 'bottom']

Parameters

Name Type
sections(string | SectionOptions<T>)[]

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setSections


setSelectable

setSelectable(selectable): AdaptiveDiscreteFillVisualHeader<T>

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

Parameters

Name Type Description
selectablebooleanflag to allow node selection

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setSelectable


setSettings

setSettings(settings): AdaptiveDiscreteFillVisualHeader<T>

Sets settings element's parameters.

Parameters

Name Type Description
settingsSettingssettings

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setSettings


setSilent

setSilent(bool): AdaptiveDiscreteFillVisualHeader<T>

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setSilent


setTag

setTag(tag): AdaptiveDiscreteFillVisualHeader<T>

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

Parameters

Name Type Description
taganyThe object to be associated with the node.

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setTag


setTextStyle

setTextStyle(textStyle, merge?): AdaptiveDiscreteFillVisualHeader<T>

Sets text style for all textual elements

Parameters

Name Type Description
textStyleTypea new shape text style
Optional mergebooleantrue if you want to merge textStyle with existing attribute, false by default

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setTextStyle


setVertical

setVertical(vertical): AdaptiveDiscreteFillVisualHeader<T>

Sets vertical flag

Parameters

Name Type Description
verticalbooleantrue, if header is vertical, false otherwise

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setVertical


setVisible

setVisible(value): AdaptiveDiscreteFillVisualHeader<T>

Sets visibility of the node. Send event Events.VisibilityChanged

Parameters

Name Type Description
valuebooleanflag specifying visibility of the node

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setVisible


setVisual

setVisual(visual): AdaptiveDiscreteFillVisualHeader<T>

Parameters

Name Type
visualT

Returns

AdaptiveDiscreteFillVisualHeader<T>

Inherited from

AdaptiveBasicLogVisualHeader.setVisual


setZIndex

setZIndex(value): AdaptiveDiscreteFillVisualHeader<T>

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

Parameters

Name Type Description
valuenumberindex determining node z-position

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.setZIndex


shear

shear(shx, shy): AdaptiveDiscreteFillVisualHeader<T>

Shear this node's bounds

Parameters

Name Type Description
shxnumberx-axis shear
shynumbery-axis shear

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.shear


synchronizeElements

Protected synchronizeElements(): AdaptiveDiscreteFillVisualHeader<T>

Synchronize element settings

Returns

AdaptiveDiscreteFillVisualHeader<T>

this


toString

toString(): string

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

Returns

string

A string representation

Inherited from

AdaptiveBasicLogVisualHeader.toString


translate

translate(tx, ty): AdaptiveDiscreteFillVisualHeader<T>

Translate bounds

Parameters

Name Type Description
txnumberx translation
tynumbery translation

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.translate


unregisterAnimationStyle

unregisterAnimationStyle(root): void

Unregister animation style.

Parameters

Name Type Description
rootNoderoot node for node

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.unregisterAnimationStyle


updateGeometry

Protected updateGeometry(): AdaptiveDiscreteFillVisualHeader<T>

Update state.

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Overrides

AdaptiveBasicLogVisualHeader.updateGeometry


updateSceneTransformation

updateSceneTransformation(): AdaptiveDiscreteFillVisualHeader<T>

Update scene transformation

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.updateSceneTransformation


updateState

updateState(regions?, changes?): AdaptiveDiscreteFillVisualHeader<T>

Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph

Parameters

Name Type Description
Optional regionsRect[]optional array to return invalid rectangles in the parent coordinates
Optional changesStateChangesoptional parameter to specify a reason of changes

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.updateState


updateTimeStamp

Protected updateTimeStamp(): AdaptiveDiscreteFillVisualHeader<T>

Update time stamp to indicate that Node or Children has been changed.

Returns

AdaptiveDiscreteFillVisualHeader<T>

this

Inherited from

AdaptiveBasicLogVisualHeader.updateTimeStamp


enableSceneGraphNotification

Static enableSceneGraphNotification(enabled): void

Enable / disable all notifications

Parameters

Name Type Description
enabledbooleansets if this object sends notifications

Returns

void

Inherited from

AdaptiveBasicLogVisualHeader.enableSceneGraphNotification


findParent

Static findParent<T>(node, classType, filter?): InstanceType<T>

Find root of the node with specified type

Type parameters

NameType
Textends Constructor<any>

Parameters

Name Type Description
nodeNodenode to start search
classTypeTtype of the class to search for
Optional filter(node: Node) => booleanadditional filter to apply

Returns

InstanceType<T>

Inherited from

AdaptiveBasicLogVisualHeader.findParent

Static findParent(node, classType, filter?): Node

Find root of the node with specified type

Parameters

Name Type Description
nodeNodenode to start search
classTypestringinterface name to search for
Optional filter(node: Node) => booleanadditional filter to apply

Returns

Node

Inherited from

AdaptiveBasicLogVisualHeader.findParent


getClassName

Static getClassName(): string

Returns

string

Inherited from

AdaptiveBasicLogVisualHeader.getClassName


getDesiredHeight

Static getDesiredHeight(header, width?): number

Return header desired content height with padding

Parameters

Name Type Description
headerLogVisualHeader<Node>header instance
Optional widthnumberavailable width, for header, to calculate required height

Returns

number

Inherited from

AdaptiveBasicLogVisualHeader.getDesiredHeight


isSceneGraphNotificationEnabled

Static isSceneGraphNotificationEnabled(): boolean

Return status of the global notification for all nodes.

Returns

boolean

Inherited from

AdaptiveBasicLogVisualHeader.isSceneGraphNotificationEnabled