API / geotoolkit / welllog / header / AdaptiveLog2DVisualHeader / AdaptiveLog2DVisualHeader
header.AdaptiveLog2DVisualHeader.AdaptiveLog2DVisualHeader
Adaptive header for Log2d visual
| Name | Type |
|---|---|
T | extends LogAbstractVisual & IColorProviderVisual = Log2DVisual |
AdaptiveBasicLogVisualHeader<T>↳
AdaptiveLog2DVisualHeader
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
autobounds | boolean | Automatic calculation of header size on or off |
borderlinestyle | string | Border line style |
borderlinestyle | LineStyle | Border line style |
borderlinestyle-color | string | Color in CSS form |
borderlinestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
borderlinestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
borderlinestyle-fill-color | string | Color in CSS form |
borderlinestyle-fill-evenoddmode | boolean | Even-odd fill mode |
borderlinestyle-fill-fillpattern | Pattern | Pattern |
borderlinestyle-fill-fillpattern-containername | string | An 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-patternname | string | Name of this pattern for indexing |
borderlinestyle-fill-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
borderlinestyle-fill-foreground | string | Foreground color |
borderlinestyle-fill-pattern | Pattern | Pattern |
borderlinestyle-linecap | CapStyle | The line cap style |
borderlinestyle-linedashoffset | number | Line dash offset of dashed line |
borderlinestyle-linejoin | JoinStyle | The line join style |
borderlinestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
borderlinestyle-scalable | boolean | True if width should depend on transformation |
borderlinestyle-unit | string | Optional unit for the width |
borderlinestyle-width | number | string | The line thickness |
bounds | Rect | Bounds of the curve in the parent coordinates |
bounds-height | number | Height |
bounds-readonly | boolean | Readonly |
bounds-width | number | Width |
bounds-x | number | Left |
bounds-y | number | Top |
clipstyle | ClipStyle | Clipping style |
clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
clipstyle-geometry | GraphicsPath | Clipping geometry |
clipstyle-geometry-bounds | Rect | Bounds |
clipstyle | GraphicsPath | Clipping style |
cssclass | string | The css class name of this node |
csscursor | string | CSS cursor associated with node |
cssstyle | string | CSS style to be applied to inserted elements |
cursor | CursorProperties | Cursor properties |
cursor-enabled | boolean | Cursor enabled/disabled flag |
cursor-fillstyle | string | Cursor symbol fill style |
cursor-fillstyle | FillStyle | Cursor symbol fill style |
cursor-linestyle | string | Cursor symbol line style |
cursor-linestyle | LineStyle | Cursor symbol line style |
cursor-painter | string | Cursor symbol painter |
cursor-valueformat | NumberFormat | Cursor value number format |
cursor-valueformat-fulllocale | boolean | Specify format how to provide locale |
cursor-valueformat-grouplength | number | Specify group length of numbers |
cursor-valueformat-locale | string | Format locale |
cursor-valueformat-locale | Locale | Format locale |
cursor-valueformat-locale-locale | string | The name of the locale |
cursor-valueformat-locale-numberformat | NumberFormatInfo | Defines number format |
cursor-valueformat-locale-numberformat-dec | string | Defines decimal symbol |
cursor-valueformat-locale-numberformat-group | string | Defines group symbol |
cursor-valueformat-locale-numberformat-infinity | string | Defines infinity text |
cursor-valueformat-locale-numberformat-neg | string | Defines negative symbol |
cursor-valueformat-maximumfractiondigits | number | Specify maximum fraction digits |
cursor-valueformat-minimumfractiondigits | number | Specify minimum fraction digits, have to be less or equal to maximumfractiondigits |
cursor-valueformat-round | boolean | Round number |
cursor-valuetextstyle | string | Cursor value text style |
cursor-valuetextstyle | TextStyle | Cursor value text style |
cursor-valuetextstyle-alignment | AlignmentStyle | Alignment |
cursor-valuetextstyle-autosize | boolean | Auto font size on high definition display |
cursor-valuetextstyle-background | string | Background style |
cursor-valuetextstyle-background | FillStyle | Background style |
cursor-valuetextstyle-baseline | BaseLineStyle | Base line |
cursor-valuetextstyle-color | string | Color in CSS form |
cursor-valuetextstyle-fill | FillStyle | Text fill style |
cursor-valuetextstyle-font | string | Font see |
cursor-valuetextstyle-fonturl | string | The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword |
cursor-valuetextstyle-lineheight | string | number | Line height |
cursor-valuetextstyle-multiline | boolean | Allow multi-line text |
cursor-valuetextstyle-outline | string | Outline style |
cursor-valuetextstyle-outline | LineStyle | Outline style |
cursor-valuetextstyle-overflowwrap | OverflowWrapStyle | Overflow wrap |
cursor-valuetextstyle-strikethrough | string | Strikethrough style |
cursor-valuetextstyle-strikethrough | LineStyle | Strikethrough style |
cursor-valuetextstyle-textoverflow | TextOverflowStyle | Text overflow |
cursor-valuetextstyle-underline | string | Underline style |
cursor-valuetextstyle-underline | LineStyle | Underline style |
cursor-valuetextstyle-underlineoffset | string | number | Underline offset distance |
cursor-valuetextstyle-whitespace | WhiteSpaceStyle | White space |
cursor-valuetextstyle-wordbreak | WordBreakStyle | Word break |
cursor-valuevisible | boolean | Cursor value visibility state |
depth | number | Depth |
displaymode | string | Display mode |
displaystring | string | Display string |
fillstyle | string | The fill style |
fillstyle | FillStyle | The fill style |
gap | number | Gap |
horizontalflip | boolean | Flip horizontal from right to left |
id | string | number | Id of the node, its a unique identifier |
ispointingup | boolean | Defines whether the text is always pointing up |
layoutstyle | LayoutStyle | Layoutstyle |
layoutstyle-constraint | SizeConstraint | Layout constrains |
layoutstyle-flexgrow | number | Number specifying how much the item will grow relative to the rest of the items inside the same container |
layoutstyle-flexshrink | number | Number specifying how much the item will shrink relative to the rest of the items inside the same container |
layoutstyle-float | string | Float position |
layoutstyle-position | string | Layout position |
layoutstyle-size | number | string | Layout size |
linestyle | string | The line style |
linestyle | LineStyle | The line style |
localtransform | Transformation | Local transformation |
localtransform-dx | number | X axis translation |
localtransform-dy | number | Y axis translation |
localtransform-xx | number | X scale |
localtransform-xy | number | Xy skew |
localtransform-yx | number | Yx skew |
localtransform-yy | number | Y scale |
margins | number | string | It has properties for specifying the margins for each side |
maxvalueformat | NumberFormat | Max value number format |
minvalueformat | NumberFormat | Min value number format |
modellimits | Rect | Desired model Limits |
name | string | Name of the node. It is often used for debugging purposes or to simplify queries |
opacity | number | Node opacity (from 0 to 1). If it is undefined or null it inherits property from the parent. It changes globalAlpha on the rendering context |
opacityblendmode | BlendMode | Node opacity mode to blend it |
orientation | Orientation | Header orientation |
padding | number | string | It has properties for specifying the padding for each side |
scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
scalescrollstrategy-enabled | boolean | Enable flag |
selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
tag | any | Custom 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 |
textstyle | string | The text style |
textstyle | TextStyle | The text style |
transform | string | Additional CSS transformation applied to node or 'none' |
transform | Transformation | Additional CSS transformation applied to node or 'none' |
visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
z-index | number | Define node z-index |
Constructors
• new AdaptiveLog2DVisualHeader<T>(options?)
| Name | Type |
|---|---|
T | extends LogAbstractVisual<T> & IColorProviderVisual<T> = Log2DVisual |
| Name | Type | Description |
|---|---|---|
Optional options | T | Options<T> | visual or properties object |
AdaptiveBasicLogVisualHeader<T&gt;.constructor
Methods
▸ addCssClass(cssclass): AdaptiveLog2DVisualHeader<T>
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
AdaptiveBasicLogVisualHeader.addCssClass
▸ addInvalidateHandler(handler): AdaptiveLog2DVisualHeader<T>
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AdaptiveBasicLogVisualHeader.addInvalidateHandler
▸ Protected applyOpacity(context): AdaptiveLog2DVisualHeader<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
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
this
AdaptiveBasicLogVisualHeader.applyOpacity
▸ Protected applyResponsiveStyle(): void
Apply a responsive style rules it is exists
void
AdaptiveBasicLogVisualHeader.applyResponsiveStyle
▸ Protected calculateDesiredHeight(width?): number
Return header desired height
| Name | Type | Description |
|---|---|---|
Optional width | number | width to fit elements in case wrapping |
number
AdaptiveBasicLogVisualHeader.calculateDesiredHeight
▸ Protected calculateSectionsDesiredHeight(width): number
Return overall height by specified width
| Name | Type | Description |
|---|---|---|
width | number | available device width to calculate desired width |
number
AdaptiveBasicLogVisualHeader.calculateSectionsDesiredHeight
▸ checkCollision(context): boolean
Check culling Returns true if object is inside of renderable area
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
AdaptiveBasicLogVisualHeader.checkCollision
▸ checkTextSize(context, text, maxLen): string
Returns biggest text in specified width
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
text | string | Text to calculate the size for |
maxLen | number | max length available for the text |
string
AdaptiveBasicLogVisualHeader.checkTextSize
▸ clone(): AdaptiveLog2DVisualHeader<T>
All subclasses should override copyConstructor or provide custom implementation for this method
clone
AdaptiveBasicLogVisualHeader.clone
▸ connectStyle(style, type, callback): AdaptiveLog2DVisualHeader<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
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
AdaptiveBasicLogVisualHeader.connectStyle
▸ Protected copyConstructor(src, deepCopy?): AdaptiveLog2DVisualHeader<T>
Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
| Name | Type | Description |
|---|---|---|
src | AdaptiveLog2DVisualHeader<T> | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
AdaptiveBasicLogVisualHeader.copyConstructor
▸ disconnectStyle(style, type, callback): AdaptiveLog2DVisualHeader<T>
Disconnect style
This convenience method un-subscribes a listener to given style for the specified type.
| Name | Type | Description |
|---|---|---|
style | EventDispatcher | connect style |
type | string | type of event or property |
callback | AttributeCallback<EventDispatcher> | function to be called |
this
AdaptiveBasicLogVisualHeader.disconnectStyle
▸ dispose(): void
Dispose node. Clear all listeners and disconnect style to avoid memory leaks
void
AdaptiveBasicLogVisualHeader.dispose
▸ drawBorder(context, borderLineStyle?, modelLimits?): AdaptiveLog2DVisualHeader<T>
Stroke border with specified
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
Optional borderLineStyle | LineStyle | the LineStyle for the border |
Optional modelLimits | Rect | the border bounds |
AdaptiveBasicLogVisualHeader.drawBorder
▸ Protected drawRoundedBox(context, bounds, options?): AdaptiveLog2DVisualHeader<T>
| Name | Type |
|---|---|
context | RenderingContext |
bounds | Rect |
Optional options | Object |
Optional options.fillstyle | FillStyle |
Optional options.linestyle | LineStyle |
Optional options.radius | number |
AdaptiveBasicLogVisualHeader.drawRoundedBox
▸ Protected drawText(context, x?, y?, text?, style?, alignment?, theta?, maxSize?): void
for internal use only, make text always readable
| Name | Type | Description |
|---|---|---|
context | RenderingContext | rendering context |
Optional x | number | x position to place text |
Optional y | number | y position to place text |
Optional text | string | text to be displayed |
Optional style | TextStyle | text style |
Optional alignment | AnchorType | alignment for placement of text |
Optional theta | number | of rotation |
Optional maxSize | number | Dimension | max size or width |
void
AdaptiveBasicLogVisualHeader.drawText
▸ enableEventPropagation(enable): AdaptiveLog2DVisualHeader<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();| Name | Type | Description |
|---|---|---|
enable | boolean | enable |
this
AdaptiveBasicLogVisualHeader.enableEventPropagation
▸ execute(delegate): AdaptiveLog2DVisualHeader<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");
});| Name | Type | Description |
|---|---|---|
delegate | (this: AdaptiveLog2DVisualHeader<T>) => void | Function to execute |
The result if any or this
AdaptiveBasicLogVisualHeader.execute
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: AdaptiveLog2DVisualHeader<T>) => T |
T
AdaptiveBasicLogVisualHeader.execute
▸ fillBorder(context, fillStyle?, modelLimits?): AdaptiveLog2DVisualHeader<T>
Draws a rectangle at the model limits and fill it with specified fillStyle
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
Optional fillStyle | FillStyle | Fill Style for the rectangle |
Optional modelLimits | Rect | rectangle bounds |
AdaptiveBasicLogVisualHeader.fillBorder
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
AdaptiveBasicLogVisualHeader.filter
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
AdaptiveBasicLogVisualHeader.getAnimationStyle
▸ getBorderLineStyle(): LineStyle
Gets border line style
AdaptiveBasicLogVisualHeader.getBorderLineStyle
▸ getBounds(): Rect
Return bound in the parent coordinates
AdaptiveBasicLogVisualHeader.getBounds
▸ getClassName(): string
string
AdaptiveBasicLogVisualHeader.getClassName
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
AdaptiveBasicLogVisualHeader.getClipStyle
▸ getContentsArea(transformation?): Rect
Return area without paddings. Model limits are mapped to content area, where children are layout.
| Name | Type | Description |
|---|---|---|
Optional transformation | Transformation | scene transformation |
AdaptiveBasicLogVisualHeader.getContentsArea
▸ getContentsTransform(): Transformation
Return transformation from model to bounds
AdaptiveBasicLogVisualHeader.getContentsTransform
▸ getCss(): CssStyle
Return CSS style
AdaptiveBasicLogVisualHeader.getCss
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
AdaptiveBasicLogVisualHeader.getCssClass
▸ getCssClasses(): string[]
Gets list of css class names which applied to this node
string[]
AdaptiveBasicLogVisualHeader.getCssClasses
▸ getCssTransform(): string
Returns CSS transformation
string
AdaptiveBasicLogVisualHeader.getCssTransform
▸ getCursorFillStyle(): FillStyle
Returns the cursor symbol fill style
the cursor symbol fill style
▸ getCursorLineStyle(): LineStyle
Returns the cursor line style
the cursor line style
▸ getCursorPainter(): Painter
Returns the cursor symbol fill style
the cursor symbol fill style
▸ Protected getCursorSymbol(): SymbolShape
Get cursor symbol
cursor symbol
▸ getCursorValueFormat(): NumberFormat
Returns the number formatter for the cursor value
the number formatter for the cursor value
▸ getCursorValueTextStyle(): TextStyle
Returns the text style for the cursor value
the text style for the cursor value
▸ getDesiredHeight(width?): number
Return header desired height
| Name | Type | Description |
|---|---|---|
Optional width | number | width to fit elements in case wrapping |
number
AdaptiveBasicLogVisualHeader.getDesiredHeight
▸ getDisplayDepth(): number
Returns the displayed depth value
number
AdaptiveBasicLogVisualHeader.getDisplayDepth
▸ getDisplayMode(): string | string[]
Returns the displayed mode value
string | string[]
AdaptiveBasicLogVisualHeader.getDisplayMode
▸ getDisplayString(): string
Returns the displayed value
string
displayString
AdaptiveBasicLogVisualHeader.getDisplayString
▸ getDisplayValue(): number
Returns 0
number
AdaptiveBasicLogVisualHeader.getDisplayValue
▸ getElementByName(name): ElementOptionsOut<LogAbstractVisual>
return element object that is matching the given name
| Name | Type | Description |
|---|---|---|
name | string | element name |
ElementOptionsOut<LogAbstractVisual>
element properies
AdaptiveBasicLogVisualHeader.getElementByName
▸ getElements(): ElementOptionsOut<LogAbstractVisual>[]
Gets header elements with their parameters. NOTE: deep copy of elements is created and returned.
ElementOptionsOut<LogAbstractVisual>[]
header elements
AdaptiveBasicLogVisualHeader.getElements
▸ getFillStyle(): FillStyle
Return fill style
AdaptiveBasicLogVisualHeader.getFillStyle
▸ getHighlightOptions(): HighlightOptions
Returns highlight options
highlight options
AdaptiveBasicLogVisualHeader.getHighlightOptions
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
AdaptiveBasicLogVisualHeader.getId
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
AdaptiveBasicLogVisualHeader.getInvalidateMethod
▸ getIsPointingUp(): boolean
Returns true if the text is always pointing up
boolean
true if the text is always pointing up
AdaptiveBasicLogVisualHeader.getIsPointingUp
▸ getLayoutStyle(): LayoutStyle<string | number>
Return desired layout style
LayoutStyle<string | number>
AdaptiveBasicLogVisualHeader.getLayoutStyle
▸ getLineStyle(): LineStyle
Return line style
AdaptiveBasicLogVisualHeader.getLineStyle
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
AdaptiveBasicLogVisualHeader.getLocalTransform
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
AdaptiveBasicLogVisualHeader.getMarginsStyle
▸ getMaxValueFormat(): NumberFormat
Returns the number formatter for the max value
▸ getMinValueFormat(): NumberFormat
Returns the number formatter for the min value
▸ getModelLimits(): Rect
Return model limits
AdaptiveBasicLogVisualHeader.getModelLimits
▸ getName(): string
Returns the node name
string
The node name
AdaptiveBasicLogVisualHeader.getName
▸ getOpacity(): number
Returns current node opacity
number
opacity
AdaptiveBasicLogVisualHeader.getOpacity
▸ getOpacityBlendMode(): BlendMode
Returns current node opacity
opacity blend mode
AdaptiveBasicLogVisualHeader.getOpacityBlendMode
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding
AdaptiveBasicLogVisualHeader.getPaddingStyle
▸ getParent(): Node
Return parent node
parent node
AdaptiveBasicLogVisualHeader.getParent
▸ getProperties(): OptionsOut<Log2DVisual>
Gets all the properties pertaining to this object
properties
AdaptiveBasicLogVisualHeader.getProperties
▸ getProperty(name): any
Gets dynamic property by name. These properties can be used as a property bags
| Name | Type | Description |
|---|---|---|
name | string | property name |
any
AdaptiveBasicLogVisualHeader.getProperty
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
AdaptiveBasicLogVisualHeader.getPropertyKeys
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
AdaptiveBasicLogVisualHeader.getRenderingFilter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
AdaptiveBasicLogVisualHeader.getResponsiveStyle
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
AdaptiveBasicLogVisualHeader.getRoot
▸ getScaleScrollStrategy(): Delegate
Gets scale scroll strategy
scale scroll strategy
AdaptiveBasicLogVisualHeader.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
AdaptiveBasicLogVisualHeader.getSceneTransform
▸ Protected getSectionDesiredHeight(section, width): number
Return desired height for specified section
| Name | Type | Description |
|---|---|---|
section | SectionOptions<T> | section settings |
width | number | available device width to calculate desired width |
number
AdaptiveBasicLogVisualHeader.getSectionDesiredHeight
▸ Protected getSectionDesiredRect(sectionName?, rect?, tr?): Rect
Return desired section bounds by specified name
| Name | Type | Description |
|---|---|---|
Optional sectionName | string | section name |
Optional rect | Rect | optional param for internal use |
Optional tr | Transformation |
AdaptiveBasicLogVisualHeader.getSectionDesiredRect
▸ getSections(): SectionOptions<T>[]
Gets header sections with their parameters. NOTE: deep copy of elements is created and returned.
SectionOptions<T>[]
header elements
AdaptiveBasicLogVisualHeader.getSections
▸ getSettings(): Settings
Gets general settings. NOTE: deep copy of settings is created and returned.
settings
AdaptiveBasicLogVisualHeader.getSettings
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
AdaptiveBasicLogVisualHeader.getTag
▸ Protected getTextBoundingBox(context, x?, y?, text?, style?, alignment?, theta?): Rect
Returns bounding box of the text
| Name | Type | Description |
|---|---|---|
context | RenderingContext | rendering context |
Optional x | number | x position to place text |
Optional y | number | y position to place text |
Optional text | string | text to be displayed |
Optional style | TextStyle | text style |
Optional alignment | AnchorType | alignment for placement of text |
Optional theta | number | of rotation |
AdaptiveBasicLogVisualHeader.getTextBoundingBox
▸ Protected getTextShapeHelper(x?, y?, text?, textStyle?, alignment?): Text
Return text shape helper instance
| Name | Type | Description |
|---|---|---|
Optional x | number | x coordinate |
Optional y | number | y coordinate |
Optional text | string | text to display |
Optional textStyle | Type | a new shape text style |
Optional alignment | AnchorType | anchor alignment |
text shape helper
AdaptiveBasicLogVisualHeader.getTextShapeHelper
▸ getTextStyle(): TextStyle
Return a current text style
AdaptiveBasicLogVisualHeader.getTextStyle
▸ getVisible(): boolean
Return visibility of the header
boolean
true if header itself and associated LogVisual is visible
AdaptiveBasicLogVisualHeader.getVisible
▸ getVisual(): T
Gets visual to be used to render header
T
visual
AdaptiveBasicLogVisualHeader.getVisual
▸ getWorldTransform(): Transformation
getWorldTransform retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
AdaptiveBasicLogVisualHeader.getWorldTransform
▸ getZIndex(): number
Returns node z-index (null if not set)
number
AdaptiveBasicLogVisualHeader.getZIndex
▸ hasCssClass(cssClass): boolean
Check if node has specified css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class name |
boolean
AdaptiveBasicLogVisualHeader.hasCssClass
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
AdaptiveBasicLogVisualHeader.hasEventListener
▸ hitTest(area, radius?): Hits[]
Hit test in the device coordinate. This method checks if any point is intersects <html>node inside text
| Name | Type | Description |
|---|---|---|
area | HitTestArea | model area or position |
Optional radius | number | radius of selection |
Hits[]
selected items
AdaptiveBasicLogVisualHeader.hitTest
▸ invalidate(bounds?, force?): AdaptiveLog2DVisualHeader<T>
Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | bounds of the invalid rectangle in the inner node coordinates |
Optional force | boolean | true 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 |
this
AdaptiveBasicLogVisualHeader.invalidate
▸ invalidateLayout(propagate?): AdaptiveLog2DVisualHeader<T>
Notify that layout is invalidated. Send event Events.LayoutInvalidated
| Name | Type | Description |
|---|---|---|
Optional propagate | boolean | propagate invalidate layout to parent |
this
AdaptiveBasicLogVisualHeader.invalidateLayout
▸ Protected invalidateParent(bounds?, force?): AdaptiveLog2DVisualHeader<T>
Invalidate parent and notify all listeners. NOTE: Don't keep arguments of the event, because instance can be changed
Fires
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | bounds of the invalid rectangle in the inner node coordinates |
Optional force | boolean | force rendering |
this
AdaptiveBasicLogVisualHeader.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
AdaptiveBasicLogVisualHeader.isAutoBounds
▸ isCursorEnabled(): boolean
Gets a flag indicating if cursor enabled or not
boolean
true if cursor enabled and false otherwise
▸ isCursorValueVisible(): boolean
Gets a flag indicating if cursor value is visible or not
boolean
true if cursor value is visible and false otherwise
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
AdaptiveBasicLogVisualHeader.isDisposed
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
AdaptiveBasicLogVisualHeader.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
horizontal flip
AdaptiveBasicLogVisualHeader.isHorizontalFlip
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
AdaptiveBasicLogVisualHeader.isNotificationEnabled
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
AdaptiveBasicLogVisualHeader.isSelectable
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
AdaptiveBasicLogVisualHeader.isSilent
▸ isVertical(): boolean
Returns vertical flag
boolean
true, if header is vertical, false otherwise
AdaptiveBasicLogVisualHeader.isVertical
▸ notify<E>(type, source, args?): AdaptiveLog2DVisualHeader<T>
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event |
source | LogVisualHeader<Node> | source who called the event |
Optional args | EventMap[E] | event arguments |
this
AdaptiveBasicLogVisualHeader.notify
▸ off<E>(type?, callback?): AdaptiveLog2DVisualHeader<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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: AdaptiveLog2DVisualHeader<T>, args: EventMap[E]) => void | function to be called |
this
AdaptiveBasicLogVisualHeader.off
▸ on<E>(type, callback): AdaptiveLog2DVisualHeader<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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: AdaptiveLog2DVisualHeader<T>, args: EventMap[E]) => void | to be called |
this
AdaptiveBasicLogVisualHeader.on
▸ Protected onParentChanged(node): AdaptiveLog2DVisualHeader<T>
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
this
AdaptiveBasicLogVisualHeader.onParentChanged
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
AdaptiveBasicLogVisualHeader.onVisibilityChanged
▸ Protected onVisualChanged(): void
This method is called if visual is changed. Send event Events.VisualChanged
void
AdaptiveBasicLogVisualHeader.onVisualChanged
▸ Protected onVisualChanging(): void
This method is called if visual is changing.
void
AdaptiveBasicLogVisualHeader.onVisualChanging
▸ Protected onVisualStateChanged(type, source): void
void
AdaptiveBasicLogVisualHeader.onVisualStateChanged
▸ Protected postRendering(context): void
To be called after rendering. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
AdaptiveBasicLogVisualHeader.postRendering
▸ Protected preRendering(context): void
Occurs before rendering this method sets clipping by default. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
AdaptiveBasicLogVisualHeader.preRendering
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
AdaptiveBasicLogVisualHeader.registerAnimationStyle
▸ removeCssClass(cssclass): AdaptiveLog2DVisualHeader<T>
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
AdaptiveBasicLogVisualHeader.removeCssClass
▸ removeInvalidateHandler(handler): AdaptiveLog2DVisualHeader<T>
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AdaptiveBasicLogVisualHeader.removeInvalidateHandler
▸ render(inputContext): void
Renders node
| Name | Type | Description |
|---|---|---|
inputContext | RenderingContext | The rendering context to be used to draw the node |
void
AdaptiveBasicLogVisualHeader.render
▸ renderAsync(context, callback): void
Render node in asynchronous mode. Default implementation creates call method "render" inside
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function |
void
AdaptiveBasicLogVisualHeader.renderAsync
▸ rotate(theta, x, y): AdaptiveLog2DVisualHeader<T>
Rotate bounds around a given coordinate
| Name | Type | Description |
|---|---|---|
theta | number | angle to rotate node, in radians |
x | number | x coordinate to rotate around |
y | number | y coordinate to rotate around |
this
AdaptiveBasicLogVisualHeader.rotate
▸ scale(xx, yy): AdaptiveLog2DVisualHeader<T>
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
AdaptiveBasicLogVisualHeader.scale
▸ setAnimationStyle(animationStyle): AdaptiveLog2DVisualHeader<T>
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
AdaptiveBasicLogVisualHeader.setAnimationStyle
▸ setAutoBounds(enable): AdaptiveLog2DVisualHeader<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
| Name | Type | Description |
|---|---|---|
enable | boolean | Enable or disable auto bounds |
AdaptiveBasicLogVisualHeader.setAutoBounds
▸ setBorderLineStyle(lineStyle, merge?): AdaptiveLog2DVisualHeader<T>
Sets border line style
| Name | Type | Description |
|---|---|---|
lineStyle | Type | line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
AdaptiveBasicLogVisualHeader.setBorderLineStyle
▸ setBounds(bounds): AdaptiveLog2DVisualHeader<T>
Sets bounds of the curve in the parent coordinates and set up auto bounds false
| Name | Type | Description |
|---|---|---|
bounds | Rect | bounds of the curve in the parent coordinates |
this
AdaptiveBasicLogVisualHeader.setBounds
▸ setClipStyle(style): AdaptiveLog2DVisualHeader<T>
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
AdaptiveBasicLogVisualHeader.setClipStyle
▸ setCss(style, merge?): AdaptiveLog2DVisualHeader<T>
Sets CSS style. This style will be applied for all inserted elements
| Name | Type | Description |
|---|---|---|
style | Type | CSS style to be applied to inserted elements |
Optional merge | boolean | merge flag |
this
AdaptiveBasicLogVisualHeader.setCss
▸ setCssClass(name): AdaptiveLog2DVisualHeader<T>
Sets css class name of the node to be used to apply CSS style
| Name | Type | Description |
|---|---|---|
name | string | css class name of the node |
this
AdaptiveBasicLogVisualHeader.setCssClass
▸ setCssTransform(transform): AdaptiveLog2DVisualHeader<T>
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
AdaptiveBasicLogVisualHeader.setCssTransform
▸ setCursorEnabled(enabled): AdaptiveLog2DVisualHeader<T>
Sets a flag indicating if cursor enabled or not
| Name | Type | Description |
|---|---|---|
enabled | boolean | cursor enabled/disabled flag |
this
▸ setCursorFillStyle(fillStyle, merge?): AdaptiveLog2DVisualHeader<T>
Sets the cursor symbol fill style
| Name | Type | Description |
|---|---|---|
fillStyle | Type | cursor symbol fill style |
Optional merge | boolean | true if you want to merge fillStyle with existing attribute, false by default |
this
▸ setCursorLineStyle(lineStyle, merge?): AdaptiveLog2DVisualHeader<T>
Sets the cursor symbol line style
| Name | Type | Description |
|---|---|---|
lineStyle | Type | cursor symbol line style |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
▸ setCursorPainter(painter): AdaptiveLog2DVisualHeader<T>
Sets the cursor symbol painter
| Name | Type | Description |
|---|---|---|
painter | Painter | cursor symbol painter |
this
▸ setCursorValueFormat(format): AdaptiveLog2DVisualHeader<T>
Sets the number formatter for the current value
| Name | Type | Description |
|---|---|---|
format | NumberFormat | number format |
this
▸ setCursorValueTextStyle(textStyle, merge?): AdaptiveLog2DVisualHeader<T>
Sets the text style for the current value
| Name | Type | Description |
|---|---|---|
textStyle | Type | text style |
Optional merge | boolean | true if you want to merge textStyle with existing attribute, false by default |
this
▸ setCursorValueVisible(visible): AdaptiveLog2DVisualHeader<T>
Sets a visible indicating if cursor value is visible or not
| Name | Type | Description |
|---|---|---|
visible | boolean | visibility state |
this
▸ setDesiredHeight(value, silent?): AdaptiveLog2DVisualHeader<T>
Sets desired height of the header as a layoutable object
| Name | Type | Description |
|---|---|---|
value | string | number | desired height to set, use 'auto' for automatic desired height |
Optional silent | boolean | silent setting |
this
AdaptiveBasicLogVisualHeader.setDesiredHeight
▸ setDisplayMode(displayMode): AdaptiveLog2DVisualHeader<T>
Sets the displayed mode value
| Name | Type | Description |
|---|---|---|
displayMode | string | string[] | header display mode |
AdaptiveBasicLogVisualHeader.setDisplayMode
▸ setDisplayString(displayString): AdaptiveLog2DVisualHeader<T>
Sets the displayed value
| Name | Type | Description |
|---|---|---|
displayString | string | the displayed value |
AdaptiveBasicLogVisualHeader.setDisplayString
▸ setElement(names, options?): AdaptiveLog2DVisualHeader<T>
Sets header element's parameters.
| Name | Type | Description |
|---|---|---|
names | string | 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 options | ElementOptions<LogAbstractVisual> | options to set |
this
AdaptiveBasicLogVisualHeader.setElement
▸ setFillStyle(fillStyle, merge?): AdaptiveLog2DVisualHeader<T>
Sets fill style
| Name | Type | Description |
|---|---|---|
fillStyle | Type | a new fill style |
Optional merge | boolean | true if you want to merge fillStyle with existing attribute, false by default |
AdaptiveBasicLogVisualHeader.setFillStyle
▸ setHighlightOptions(options): AdaptiveLog2DVisualHeader<T>
Set highlight options
| Name | Type | Description |
|---|---|---|
options | HighlightOptions | highlight options |
AdaptiveBasicLogVisualHeader.setHighlightOptions
▸ setHorizontalFlip(enable): AdaptiveLog2DVisualHeader<T>
Set horizontal flip of the representation
| Name | Type | Description |
|---|---|---|
enable | boolean | enable flip flag, if it is null [default] header try to use same property from associated visual |
this
AdaptiveBasicLogVisualHeader.setHorizontalFlip
▸ setId(id): AdaptiveLog2DVisualHeader<T>
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
AdaptiveBasicLogVisualHeader.setId
▸ setIsPointingUp(isPointingUp): AdaptiveLog2DVisualHeader<T>
Sets whether the text is always pointing up.
| Name | Type | Description |
|---|---|---|
isPointingUp | boolean | flag setting whether the text is always pointing up |
this
AdaptiveBasicLogVisualHeader.setIsPointingUp
▸ setLayoutStyle(layoutStyle, merge?): AdaptiveLog2DVisualHeader<T>
Specify desired layout style
| Name | Type | Description |
|---|---|---|
layoutStyle | LayoutStyle<string | number> | Options<string | number> | desired layout style |
Optional merge | boolean | true if you want to merge layoutStyle with existing attribute, false by default |
AdaptiveBasicLogVisualHeader.setLayoutStyle
▸ setLineStyle(lineStyle, merge?): AdaptiveLog2DVisualHeader<T>
Sets a line style
| Name | Type | Description |
|---|---|---|
lineStyle | Type | line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
AdaptiveBasicLogVisualHeader.setLineStyle
▸ setLocalTransform(localTransform, force?): AdaptiveLog2DVisualHeader<T>
Sets local transformation to be used to transform from local to parent coordinate
| Name | Type | Description |
|---|---|---|
localTransform | Transformation | local transformation for this node |
Optional force | boolean | boolean flag to force update event if transformations are equal, false by default |
this
AdaptiveBasicLogVisualHeader.setLocalTransform
▸ setMarginsStyle(margins, merge?): AdaptiveLog2DVisualHeader<T>
Sets margins style
| Name | Type | Description |
|---|---|---|
margins | Type<string | number> | margins style |
Optional merge | boolean | true if you want to merge marginsStyle with existing attribute, false by default |
this
AdaptiveBasicLogVisualHeader.setMarginsStyle
▸ setMaxValueFormat(format): AdaptiveLog2DVisualHeader<T>
Sets the number formatter for the max value
| Name | Type | Description |
|---|---|---|
format | NumberFormat | number format |
▸ setMinValueFormat(format): AdaptiveLog2DVisualHeader<T>
Sets the number formatter for the min value
| Name | Type | Description |
|---|---|---|
format | NumberFormat | number format |
▸ setModelLimits(modelLimits): AdaptiveLog2DVisualHeader<T>
Sets model limits
| Name | Type | Description |
|---|---|---|
modelLimits | Rect | desired model Limits |
AdaptiveBasicLogVisualHeader.setModelLimits
▸ setName(name): AdaptiveLog2DVisualHeader<T>
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
AdaptiveBasicLogVisualHeader.setName
▸ setNotification(notify, force?): AdaptiveLog2DVisualHeader<T>
set notification state
| Name | Type | Description |
|---|---|---|
notify | boolean | flag set to invalidate parent or not |
Optional force | boolean | true if parent should be invalidated immediately |
this
AdaptiveBasicLogVisualHeader.setNotification
▸ setOpacity(opacity, blendMode?): AdaptiveLog2DVisualHeader<T>
Sets node opacity
| Name | Type | Description |
|---|---|---|
opacity | number | node opacity from 0 to 1 |
Optional blendMode | BlendMode | opacity blend mode. If it is normal, opacity will be replaced. |
this
AdaptiveBasicLogVisualHeader.setOpacity
▸ setPaddingStyle(paddingStyle, merge?): AdaptiveLog2DVisualHeader<T>
Sets padding style
| Name | Type | Description |
|---|---|---|
paddingStyle | Type<string | number> | padding style |
Optional merge | boolean | true if you want to merge paddingStyle with existing attribute, false by default |
AdaptiveBasicLogVisualHeader.setPaddingStyle
▸ setProperties(properties?): AdaptiveLog2DVisualHeader<T>
Sets all properties
| Name | Type | Description |
|---|---|---|
Optional properties | Options<T> | properties |
this
AdaptiveBasicLogVisualHeader.setProperties
▸ setProperty(name, value): AdaptiveLog2DVisualHeader<T>
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
AdaptiveBasicLogVisualHeader.setProperty
▸ setRenderingFilter(filter): AdaptiveLog2DVisualHeader<T>
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
AdaptiveBasicLogVisualHeader.setRenderingFilter
▸ setResponsiveStyle(style): AdaptiveLog2DVisualHeader<T>
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
AdaptiveBasicLogVisualHeader.setResponsiveStyle
▸ setScaleScrollStrategy(strategy?): AdaptiveLog2DVisualHeader<T>
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
AdaptiveBasicLogVisualHeader.setScaleScrollStrategy
▸ setSection(names, options?): AdaptiveLog2DVisualHeader<T>
Sets header section's parameters. this method does not change sections order, it change only section/s options
| Name | Type | Description |
|---|---|---|
names | string | 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 options | SectionOptions<T> | options to set |
this
AdaptiveBasicLogVisualHeader.setSection
▸ setSections(sections): AdaptiveLog2DVisualHeader<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']
| Name | Type |
|---|---|
sections | (string | SectionOptions<T>)[] |
AdaptiveBasicLogVisualHeader.setSections
▸ setSelectable(selectable): AdaptiveLog2DVisualHeader<T>
Allows to select node. If node is not selectable then child node is not selectable.
| Name | Type | Description |
|---|---|---|
selectable | boolean | flag to allow node selection |
this
AdaptiveBasicLogVisualHeader.setSelectable
▸ setSettings(settings): AdaptiveLog2DVisualHeader<T>
Sets settings element's parameters.
| Name | Type | Description |
|---|---|---|
settings | Settings | settings |
this
AdaptiveBasicLogVisualHeader.setSettings
▸ setSilent(bool): AdaptiveLog2DVisualHeader<T>
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
AdaptiveBasicLogVisualHeader.setSilent
▸ setTag(tag): AdaptiveLog2DVisualHeader<T>
Allows the user to associate any arbitrary object with the node.
| Name | Type | Description |
|---|---|---|
tag | any | The object to be associated with the node. |
this
AdaptiveBasicLogVisualHeader.setTag
▸ setTextStyle(textStyle, merge?): AdaptiveLog2DVisualHeader<T>
Sets text style for all textual elements
| Name | Type | Description |
|---|---|---|
textStyle | Type | a new shape text style |
Optional merge | boolean | true if you want to merge textStyle with existing attribute, false by default |
this
AdaptiveBasicLogVisualHeader.setTextStyle
▸ setVertical(vertical): AdaptiveLog2DVisualHeader<T>
Sets vertical flag
| Name | Type | Description |
|---|---|---|
vertical | boolean | true, if header is vertical, false otherwise |
this
AdaptiveBasicLogVisualHeader.setVertical
▸ setVisible(value): AdaptiveLog2DVisualHeader<T>
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
AdaptiveBasicLogVisualHeader.setVisible
▸ setVisual(visual): AdaptiveLog2DVisualHeader<T>
| Name | Type |
|---|---|
visual | T |
AdaptiveBasicLogVisualHeader.setVisual
▸ setZIndex(value): AdaptiveLog2DVisualHeader<T>
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
AdaptiveBasicLogVisualHeader.setZIndex
▸ shear(shx, shy): AdaptiveLog2DVisualHeader<T>
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
AdaptiveBasicLogVisualHeader.shear
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
AdaptiveBasicLogVisualHeader.toString
▸ translate(tx, ty): AdaptiveLog2DVisualHeader<T>
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
AdaptiveBasicLogVisualHeader.translate
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
AdaptiveBasicLogVisualHeader.unregisterAnimationStyle
▸ Protected updateGeometry(): AdaptiveLog2DVisualHeader<T>
AdaptiveBasicLogVisualHeader.updateGeometry
▸ updateSceneTransformation(): AdaptiveLog2DVisualHeader<T>
Update scene transformation
this
AdaptiveBasicLogVisualHeader.updateSceneTransformation
▸ updateState(regions?, changes?): AdaptiveLog2DVisualHeader<T>
Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph
| Name | Type | Description |
|---|---|---|
Optional regions | Rect[] | optional array to return invalid rectangles in the parent coordinates |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
AdaptiveBasicLogVisualHeader.updateState
▸ Protected updateTimeStamp(): AdaptiveLog2DVisualHeader<T>
Update time stamp to indicate that Node or Children has been changed.
this
AdaptiveBasicLogVisualHeader.updateTimeStamp
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
AdaptiveBasicLogVisualHeader.enableSceneGraphNotification
▸ Static findParent<T>(node, classType, filter?): InstanceType<T>
Find root of the node with specified type
| Name | Type |
|---|---|
T | extends Constructor<any> |
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | T | type of the class to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
InstanceType<T>
AdaptiveBasicLogVisualHeader.findParent
▸ Static findParent(node, classType, filter?): Node
Find root of the node with specified type
| Name | Type | Description |
|---|---|---|
node | Node | node to start search |
classType | string | interface name to search for |
Optional filter | (node: Node) => boolean | additional filter to apply |
AdaptiveBasicLogVisualHeader.findParent
▸ Static getClassName(): string
string
AdaptiveBasicLogVisualHeader.getClassName
▸ Static getDesiredHeight(header, width?): number
Return header desired content height with padding
| Name | Type | Description |
|---|---|---|
header | LogVisualHeader<Node> | header instance |
Optional width | number | available width, for header, to calculate required height |
number
AdaptiveBasicLogVisualHeader.getDesiredHeight
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean
AdaptiveBasicLogVisualHeader.isSceneGraphNotificationEnabled