API / geotoolkit / welllog / header / LogVisualHeader / LogVisualHeader
header.LogVisualHeader.LogVisualHeader
Define an abstract implementation of visual header. NOTE: Custom LogVisualHeader implementation MUST override "clone" operation for LogVisualHeaderProvider to be able to create new header instance(s) internally. This is a base class for all visual headers.
Example
// This example shows how to create a custom header for a curve, it displays just a curve name.
import {setClassName} from '@int/geotoolkit/base';
import {LogVisualHeader} from '@int/geotoolkit/welllog/header/LogVisualHeader';
import {Transformation} from '@int/geotoolkit/util/Transformation';
import {obfuscate} from '@int/geotoolkit/lib';
import {TextStyle} from '@int/geotoolkit/attributes/TextStyle';
import {Rect} from '@int/geotoolkit/util/Rect';
import {LogCurve} from '@int/geotoolkit/welllog/LogCurve';
class CustomCurveVisualHeader extends LogVisualHeader {
constructor (options) {
super(options);
}
render (inputContext) {
const context = this.getWorldTransform() != null ? inputContext.pushTransformation(this.getWorldTransform()) : inputContext;
const rc = this.getModelLimits();
if (rc != null) {
const curve = this.getVisual();
const curveName = curve.getName();
context.setTextStyle(this.getTextStyle().clone().setAlignment('center').setBaseLine('top'));
const oldTr = context.getTransformation();
// transform anchor coordinates to device
const pos = oldTr.transformXY(rc.getCenterX(), rc.getTop());
// Sets identity transformation
context.setTransformation(new Transformation());
context.drawText(pos.getX(), pos.getY(), curveName);
// restore transformation
context.setTransformation(oldTr);
}
}
clone () {
return new CustomCurveVisualHeader(this.getVisual())
.copyConstructor(this, true);
}
}
setClassName(CustomCurveVisualHeader, 'CustomCurveVisualHeader');
// Allows using obfuscated toolkit
obfuscate(CustomCurveVisualHeader, LogVisualHeader);
// In the next step you can register it for all curves or for an instance of the curve in the header provider. For example for all LogCurves you can use the following code:
const headerProvider = widget.getHeaderContainer().getHeaderProvider();
headerProvider.registerHeaderProvider(LogCurve.getClassName(), new CustomCurveVisualHeader(null));↳
LogVisualHeader
Constructors
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 |
depth | number | Depth |
displaymode | string | Display mode |
displaystring | string | Display string |
fillstyle | string | The fill style |
fillstyle | FillStyle | The fill style |
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 |
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 |
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 |
textstyle-alignment | AlignmentStyle | Alignment |
textstyle-autosize | boolean | Auto font size on high definition display |
textstyle-background | string | Background style |
textstyle-background | FillStyle | Background style |
textstyle-baseline | BaseLineStyle | Base line |
textstyle-color | string | Color in CSS form |
textstyle-fill | FillStyle | Text fill style |
textstyle-font | string | Font see |
textstyle-fonturl | string | The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword |
textstyle-lineheight | string | number | Line height |
textstyle-multiline | boolean | Allow multi-line text |
textstyle-outline | string | Outline style |
textstyle-outline | LineStyle | Outline style |
textstyle-overflowwrap | OverflowWrapStyle | Overflow wrap |
textstyle-strikethrough | string | Strikethrough style |
textstyle-strikethrough | LineStyle | Strikethrough style |
textstyle-textoverflow | TextOverflowStyle | Text overflow |
textstyle-underline | string | Underline style |
textstyle-underline | LineStyle | Underline style |
textstyle-underlineoffset | string | number | Underline offset distance |
textstyle-whitespace | WhiteSpaceStyle | White space |
textstyle-wordbreak | WordBreakStyle | Word break |
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
• Protected new LogVisualHeader<T>(options?)
| Name | Type |
|---|---|
Optional options | T | Options<T> |
AbstractNode.constructor
Methods
▸ addCssClass(cssclass): LogVisualHeader<T>
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
▸ addInvalidateHandler(handler): LogVisualHeader<T>
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AbstractNode.addInvalidateHandler
▸ Protected applyOpacity(context): LogVisualHeader<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
▸ Protected applyResponsiveStyle(): void
Apply a responsive style rules it is exists
void
AbstractNode.applyResponsiveStyle
▸ Protected calculateDesiredHeight(width?): number
Return header desired height
| Name | Type | Description |
|---|---|---|
Optional width | number | width to fit elements in case wrapping |
number
▸ checkCollision(context): boolean
Check culling Returns true if object is inside of renderable area
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
▸ 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
▸ clone(): Node
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): LogVisualHeader<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
▸ Protected copyConstructor(src, deepCopy?): LogVisualHeader<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 | LogVisualHeader<T> | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
▸ disconnectStyle(style, type, callback): LogVisualHeader<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
▸ dispose(): void
Dispose node. Clear all listeners and disconnect style to avoid memory leaks
void
▸ drawBorder(context, borderLineStyle?, modelLimits?): LogVisualHeader<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 |
▸ Protected drawRoundedBox(context, bounds, options?): LogVisualHeader<T>
| Name | Type |
|---|---|
context | RenderingContext |
bounds | Rect |
Optional options | Object |
Optional options.fillstyle | FillStyle |
Optional options.linestyle | LineStyle |
Optional options.radius | number |
▸ 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
▸ enableEventPropagation(enable): LogVisualHeader<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
AbstractNode.enableEventPropagation
▸ execute(delegate): LogVisualHeader<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: LogVisualHeader<T>) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: LogVisualHeader<T>) => T |
T
▸ fillBorder(context, fillStyle?, modelLimits?): LogVisualHeader<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 |
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
AbstractNode.getAnimationStyle
▸ getBorderLineStyle(): LineStyle
Gets border line style
▸ getBounds(): Rect
Return bound in the parent coordinates
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ 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 |
▸ getContentsTransform(): Transformation
Return transformation from model to bounds
▸ getCss(): CssStyle
Return CSS style
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
▸ getCssClasses(): string[]
Gets list of css class names which applied to this node
string[]
▸ getCssTransform(): string
Returns CSS transformation
string
▸ getDesiredHeight(width?): number
Return header desired height
| Name | Type | Description |
|---|---|---|
Optional width | number | width to fit elements in case wrapping |
number
▸ getDisplayDepth(): number
Returns the displayed depth value
number
▸ getDisplayMode(): string | string[]
Returns the displayed mode value
string | string[]
▸ getDisplayString(): string
Returns the displayed value
string
displayString
▸ getDisplayValue(): number
Returns 0
number
▸ getFillStyle(): FillStyle
Return fill style
▸ getHighlightOptions(): HighlightOptions
Returns highlight options
highlight options
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
AbstractNode.getInvalidateMethod
▸ getIsPointingUp(): boolean
Returns true if the text is always pointing up
boolean
true if the text is always pointing up
▸ getLayoutStyle(): LayoutStyle<string | number>
Return desired layout style
LayoutStyle<string | number>
▸ getLineStyle(): LineStyle
Return line style
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
AbstractNode.getLocalTransform
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
▸ getModelLimits(): Rect
Return model limits
▸ getName(): string
Returns the node name
string
The node name
▸ getOpacity(): number
Returns current node opacity
number
opacity
▸ getOpacityBlendMode(): BlendMode
Returns current node opacity
opacity blend mode
AbstractNode.getOpacityBlendMode
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding
▸ getParent(): Node
Return parent node
parent node
▸ getProperties(): OptionsOut<Node>
Gets all the properties pertaining to this object
An object containing the props to set
▸ 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
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
AbstractNode.getRenderingFilter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
AbstractNode.getResponsiveStyle
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
▸ getScaleScrollStrategy(): Delegate
Gets scale scroll strategy
scale scroll strategy
AbstractNode.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
AbstractNode.getSceneTransform
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ 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 |
▸ 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
▸ getTextStyle(): TextStyle
Return a current text style
▸ getVisible(): boolean
Return visibility of the header
boolean
true if header itself and associated LogVisual is visible
▸ getVisual(): T
Gets visual to be used to render header
T
visual
▸ getWorldTransform(): Transformation
getWorldTransform retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
AbstractNode.getWorldTransform
▸ getZIndex(): number
Returns node z-index (null if not set)
number
▸ hasCssClass(cssClass): boolean
Check if node has specified css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class name |
boolean
▸ 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
▸ invalidate(bounds?, force?): LogVisualHeader<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
▸ invalidateLayout(propagate?): LogVisualHeader<T>
Notify that layout is invalidated. Send event Events.LayoutInvalidated
| Name | Type | Description |
|---|---|---|
Optional propagate | boolean | propagate invalidate layout to parent |
this
▸ Protected invalidateParent(bounds?, force?): LogVisualHeader<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
▸ 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
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
AbstractNode.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
horizontal flip
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
AbstractNode.isNotificationEnabled
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): LogVisualHeader<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
▸ off<E>(type?, callback?): LogVisualHeader<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: LogVisualHeader<T>, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): LogVisualHeader<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: LogVisualHeader<T>, args: EventMap[E]) => void | to be called |
this
▸ Protected onParentChanged(node): LogVisualHeader<T>
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
this
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
AbstractNode.onVisibilityChanged
▸ Protected onVisualChanged(): void
This method is called if visual is changed. Send event Events.VisualChanged
void
▸ Protected onVisualChanging(): void
This method is called if visual is changing.
void
▸ Protected onVisualStateChanged(type, source): void
void
▸ 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
▸ 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
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
AbstractNode.registerAnimationStyle
▸ removeCssClass(cssclass): LogVisualHeader<T>
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
▸ removeInvalidateHandler(handler): LogVisualHeader<T>
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AbstractNode.removeInvalidateHandler
▸ Abstract render(context): void
Renders node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
void
▸ 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
▸ rotate(theta, x, y): LogVisualHeader<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
▸ scale(xx, yy): LogVisualHeader<T>
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setAnimationStyle(animationStyle): LogVisualHeader<T>
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
AbstractNode.setAnimationStyle
▸ setAutoBounds(enable): LogVisualHeader<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 |
▸ setBorderLineStyle(lineStyle, merge?): LogVisualHeader<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
▸ setBounds(bounds): LogVisualHeader<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
▸ setClipStyle(style): LogVisualHeader<T>
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setCss(style, merge?): LogVisualHeader<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
▸ setCssClass(name): LogVisualHeader<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
▸ setCssTransform(transform): LogVisualHeader<T>
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ setDesiredHeight(value, silent?): LogVisualHeader<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
▸ setDisplayMode(displayMode): LogVisualHeader<T>
Sets the displayed mode value
| Name | Type | Description |
|---|---|---|
displayMode | string | string[] | header display mode |
▸ setDisplayString(displayString): LogVisualHeader<T>
Sets the displayed value
| Name | Type | Description |
|---|---|---|
displayString | string | the displayed value |
▸ setFillStyle(fillStyle, merge?): LogVisualHeader<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 |
▸ setHighlightOptions(options): LogVisualHeader<T>
Set highlight options
| Name | Type | Description |
|---|---|---|
options | HighlightOptions | highlight options |
▸ setHorizontalFlip(enable): LogVisualHeader<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
▸ setId(id): LogVisualHeader<T>
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setIsPointingUp(isPointingUp): LogVisualHeader<T>
Sets whether the text is always pointing up.
| Name | Type | Description |
|---|---|---|
isPointingUp | boolean | flag setting whether the text is always pointing up |
this
▸ setLayoutStyle(layoutStyle, merge?): LogVisualHeader<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 |
▸ setLineStyle(lineStyle, merge?): LogVisualHeader<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
▸ setLocalTransform(localTransform, force?): LogVisualHeader<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
AbstractNode.setLocalTransform
▸ setMarginsStyle(margins, merge?): LogVisualHeader<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
▸ setModelLimits(modelLimits): LogVisualHeader<T>
Sets model limits
| Name | Type | Description |
|---|---|---|
modelLimits | Rect | desired model Limits |
▸ setName(name): LogVisualHeader<T>
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): LogVisualHeader<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
▸ setOpacity(opacity, blendMode?): LogVisualHeader<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
▸ setPaddingStyle(paddingStyle, merge?): LogVisualHeader<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 |
▸ setProperties(properties?): LogVisualHeader<T>
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options<T> | An object containing the properties to set |
this
▸ setProperty(name, value): LogVisualHeader<T>
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): LogVisualHeader<T>
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
AbstractNode.setRenderingFilter
▸ setResponsiveStyle(style): LogVisualHeader<T>
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
AbstractNode.setResponsiveStyle
▸ setScaleScrollStrategy(strategy?): LogVisualHeader<T>
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
AbstractNode.setScaleScrollStrategy
▸ setSelectable(selectable): LogVisualHeader<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
▸ setSilent(bool): LogVisualHeader<T>
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTag(tag): LogVisualHeader<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
▸ setTextStyle(textStyle, merge?): LogVisualHeader<T>
Sets a current text style
| 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
▸ setVisible(value): LogVisualHeader<T>
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setVisual(visual): LogVisualHeader<T>
| Name | Type |
|---|---|
visual | T |
▸ setZIndex(value): LogVisualHeader<T>
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): LogVisualHeader<T>
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): LogVisualHeader<T>
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
AbstractNode.unregisterAnimationStyle
▸ Protected updateGeometry(): LogVisualHeader<T>
▸ updateSceneTransformation(): LogVisualHeader<T>
Update scene transformation
this
AbstractNode.updateSceneTransformation
▸ updateState(regions?, changes?): LogVisualHeader<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
▸ Protected updateTimeStamp(): LogVisualHeader<T>
Update time stamp to indicate that Node or Children has been changed.
this
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
AbstractNode.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>
▸ 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 |
▸ Static getClassName(): string
string
▸ 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
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean