API / geotoolkit / welllog / header / DiscreteStackedFillVisualHeader / DiscreteStackedFillVisualHeader
header.DiscreteStackedFillVisualHeader.DiscreteStackedFillVisualHeader
Adaptive header for StackedLogFill visual
AdaptiveDiscreteFillVisualHeader<StackedLogFill>↳
DiscreteStackedFillVisualHeader
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 |
boxoptions | BoxOptions | Box layout options |
boxoptions-margin | number | string | Flexbox item margins |
boxvisibility | BoxVisibility | Box visibility options |
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 |
flexboxoptions | BoxOptions | Flex box layout options |
gap | number | Gap |
headertype | DiscreteFillDisplayType | Discrete header type |
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 |
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 |
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
• new DiscreteStackedFillVisualHeader(options?)
| Name | Type | Description |
|---|---|---|
Optional options | StackedLogFill | Options | visual or properties object |
AdaptiveDiscreteFillVisualHeader<StackedLogFill&gt;.constructor
Methods
▸ addCssClass(cssclass): DiscreteStackedFillVisualHeader
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.addCssClass
▸ addInvalidateHandler(handler): DiscreteStackedFillVisualHeader
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.addInvalidateHandler
▸ Protected applyOpacity(context): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.applyOpacity
▸ Protected applyResponsiveStyle(): void
Apply a responsive style rules it is exists
void
AdaptiveDiscreteFillVisualHeader.applyResponsiveStyle
▸ Protected calculateDesiredHeight(width?): number
Return header desired height
| Name | Type | Description |
|---|---|---|
Optional width | number | width to fit elements in case wrapping |
number
AdaptiveDiscreteFillVisualHeader.calculateDesiredHeight
▸ Protected calculateDiscreteElementHeight(): number | MeasureSectionSizeCallback<LogAbstractVisual>
number | MeasureSectionSizeCallback<LogAbstractVisual>
AdaptiveDiscreteFillVisualHeader.calculateDiscreteElementHeight
▸ Protected calculateSectionsDesiredHeight(width): number
Return overall height by specified width
| Name | Type | Description |
|---|---|---|
width | number | available device width to calculate desired width |
number
AdaptiveDiscreteFillVisualHeader.calculateSectionsDesiredHeight
▸ checkCollision(context): boolean
Check culling Returns true if object is inside of renderable area
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.checkTextSize
▸ clone(): DiscreteStackedFillVisualHeader
All subclasses should override copyConstructor or provide custom implementation for this method
DiscreteStackedFillVisualHeader
clone
AdaptiveDiscreteFillVisualHeader.clone
▸ connectStyle(style, type, callback): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.connectStyle
▸ Protected copyConstructor(src, deepCopy?): DiscreteStackedFillVisualHeader
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 | DiscreteStackedFillVisualHeader | Source to copy from |
Optional deepCopy | boolean | deep copy |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.copyConstructor
▸ disconnectStyle(style, type, callback): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.disconnectStyle
▸ dispose(): void
Dispose node. Clear all listeners and disconnect style to avoid memory leaks
void
AdaptiveDiscreteFillVisualHeader.dispose
▸ drawBorder(context, borderLineStyle?, modelLimits?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.drawBorder
▸ Protected drawRoundedBox(context, bounds, options?): DiscreteStackedFillVisualHeader
| Name | Type |
|---|---|
context | RenderingContext |
bounds | Rect |
Optional options | Object |
Optional options.fillstyle | FillStyle |
Optional options.linestyle | LineStyle |
Optional options.radius | number |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.drawText
▸ enableEventPropagation(enable): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.enableEventPropagation
▸ execute(delegate): DiscreteStackedFillVisualHeader
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: DiscreteStackedFillVisualHeader) => void | Function to execute |
DiscreteStackedFillVisualHeader
The result if any or this
AdaptiveDiscreteFillVisualHeader.execute
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: DiscreteStackedFillVisualHeader) => T |
T
AdaptiveDiscreteFillVisualHeader.execute
▸ fillBorder(context, fillStyle?, modelLimits?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.fillBorder
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
AdaptiveDiscreteFillVisualHeader.filter
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
AdaptiveDiscreteFillVisualHeader.getAnimationStyle
▸ getBorderLineStyle(): LineStyle
Gets border line style
AdaptiveDiscreteFillVisualHeader.getBorderLineStyle
▸ getBounds(): Rect
Return bound in the parent coordinates
AdaptiveDiscreteFillVisualHeader.getBounds
▸ getBoxOptions(): BoxOptionsOut
Get box layout options
box layout options
AdaptiveDiscreteFillVisualHeader.getBoxOptions
▸ getBoxVisibility(): BoxVisibility
Returns box visibility options
box visibility
▸ getClassName(): string
string
AdaptiveDiscreteFillVisualHeader.getClassName
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
AdaptiveDiscreteFillVisualHeader.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 |
AdaptiveDiscreteFillVisualHeader.getContentsArea
▸ getContentsTransform(): Transformation
Return transformation from model to bounds
AdaptiveDiscreteFillVisualHeader.getContentsTransform
▸ getCss(): CssStyle
Return CSS style
AdaptiveDiscreteFillVisualHeader.getCss
▸ getCssClass(): string
Returns css class name to be used to apply CSS style
string
the css class name
AdaptiveDiscreteFillVisualHeader.getCssClass
▸ getCssClasses(): string[]
Gets list of css class names which applied to this node
string[]
AdaptiveDiscreteFillVisualHeader.getCssClasses
▸ getCssTransform(): string
Returns CSS transformation
string
AdaptiveDiscreteFillVisualHeader.getCssTransform
▸ Protected getDefaultDisplayType(): DiscreteFillDisplayType
return default header type
AdaptiveDiscreteFillVisualHeader.getDefaultDisplayType
▸ getDesiredHeight(width?): number
Return header desired height
| Name | Type | Description |
|---|---|---|
Optional width | number | width to fit elements in case wrapping |
number
AdaptiveDiscreteFillVisualHeader.getDesiredHeight
▸ getDiscreteDisplayType(): DiscreteFillDisplayType
Returns discrete fill display type
AdaptiveDiscreteFillVisualHeader.getDiscreteDisplayType
▸ getDisplayDepth(): number
Returns the displayed depth value
number
AdaptiveDiscreteFillVisualHeader.getDisplayDepth
▸ getDisplayMode(): string | string[]
Returns the displayed mode value
string | string[]
AdaptiveDiscreteFillVisualHeader.getDisplayMode
▸ getDisplayString(): string
Returns the displayed value
string
displayString
AdaptiveDiscreteFillVisualHeader.getDisplayString
▸ getDisplayValue(): number
Returns 0
number
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.getElementByName
▸ getElements(): ElementOptionsOut<LogAbstractVisual>[]
Gets header elements with their parameters. NOTE: deep copy of elements is created and returned.
ElementOptionsOut<LogAbstractVisual>[]
header elements
AdaptiveDiscreteFillVisualHeader.getElements
▸ getFillStyle(): FillStyle
Return fill style
AdaptiveDiscreteFillVisualHeader.getFillStyle
▸ getFlexBoxOptions(): BoxOptionsOut
Get flex box layout options
flex box layout options
AdaptiveDiscreteFillVisualHeader.getFlexBoxOptions
▸ getHighlightOptions(): HighlightOptions
Returns highlight options
highlight options
AdaptiveDiscreteFillVisualHeader.getHighlightOptions
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
AdaptiveDiscreteFillVisualHeader.getId
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
AdaptiveDiscreteFillVisualHeader.getInvalidateMethod
▸ getIsPointingUp(): boolean
Returns true if the text is always pointing up
boolean
true if the text is always pointing up
AdaptiveDiscreteFillVisualHeader.getIsPointingUp
▸ getLayoutStyle(): LayoutStyle<string | number>
Return desired layout style
LayoutStyle<string | number>
AdaptiveDiscreteFillVisualHeader.getLayoutStyle
▸ getLineStyle(): LineStyle
Return line style
AdaptiveDiscreteFillVisualHeader.getLineStyle
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
AdaptiveDiscreteFillVisualHeader.getLocalTransform
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
AdaptiveDiscreteFillVisualHeader.getMarginsStyle
▸ getModelLimits(): Rect
Return model limits
AdaptiveDiscreteFillVisualHeader.getModelLimits
▸ getName(): string
Returns the node name
string
The node name
AdaptiveDiscreteFillVisualHeader.getName
▸ getOpacity(): number
Returns current node opacity
number
opacity
AdaptiveDiscreteFillVisualHeader.getOpacity
▸ getOpacityBlendMode(): BlendMode
Returns current node opacity
opacity blend mode
AdaptiveDiscreteFillVisualHeader.getOpacityBlendMode
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding
AdaptiveDiscreteFillVisualHeader.getPaddingStyle
▸ getParent(): Node
Return parent node
parent node
AdaptiveDiscreteFillVisualHeader.getParent
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
of the header
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.getProperty
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
AdaptiveDiscreteFillVisualHeader.getPropertyKeys
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
AdaptiveDiscreteFillVisualHeader.getRenderingFilter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
AdaptiveDiscreteFillVisualHeader.getResponsiveStyle
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
AdaptiveDiscreteFillVisualHeader.getRoot
▸ getScaleScrollStrategy(): Delegate
Gets scale scroll strategy
scale scroll strategy
AdaptiveDiscreteFillVisualHeader.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
AdaptiveDiscreteFillVisualHeader.getSceneTransform
▸ Protected getSectionDesiredHeight(section, width): number
Return desired height for specified section
| Name | Type | Description |
|---|---|---|
section | SectionOptions<StackedLogFill> | section settings |
width | number | available device width to calculate desired width |
number
AdaptiveDiscreteFillVisualHeader.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 |
AdaptiveDiscreteFillVisualHeader.getSectionDesiredRect
▸ getSections(): SectionOptions<StackedLogFill>[]
Gets header sections with their parameters. NOTE: deep copy of elements is created and returned.
SectionOptions<StackedLogFill>[]
header elements
AdaptiveDiscreteFillVisualHeader.getSections
▸ getSettings(): Settings
Gets general settings. NOTE: deep copy of settings is created and returned.
settings
AdaptiveDiscreteFillVisualHeader.getSettings
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
AdaptiveDiscreteFillVisualHeader.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 |
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.getTextShapeHelper
▸ getTextStyle(): TextStyle
Return a current text style
AdaptiveDiscreteFillVisualHeader.getTextStyle
▸ getVisible(): boolean
Return visibility of the header
boolean
true if header itself and associated LogVisual is visible
AdaptiveDiscreteFillVisualHeader.getVisible
▸ getVisual(): StackedLogFill
Gets visual to be used to render header
visual
AdaptiveDiscreteFillVisualHeader.getVisual
▸ getWorldTransform(): Transformation
getWorldTransform retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
AdaptiveDiscreteFillVisualHeader.getWorldTransform
▸ getZIndex(): number
Returns node z-index (null if not set)
number
AdaptiveDiscreteFillVisualHeader.getZIndex
▸ hasCssClass(cssClass): boolean
Check if node has specified css class
| Name | Type | Description |
|---|---|---|
cssClass | string | css class name |
boolean
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.hitTest
▸ invalidate(bounds?, force?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.invalidate
▸ invalidateLayout(propagate?): DiscreteStackedFillVisualHeader
Notify that layout is invalidated. Send event Events.LayoutInvalidated
| Name | Type | Description |
|---|---|---|
Optional propagate | boolean | propagate invalidate layout to parent |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.invalidateLayout
▸ Protected invalidateParent(bounds?, force?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.isAutoBounds
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
AdaptiveDiscreteFillVisualHeader.isDisposed
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
AdaptiveDiscreteFillVisualHeader.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
horizontal flip
AdaptiveDiscreteFillVisualHeader.isHorizontalFlip
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
AdaptiveDiscreteFillVisualHeader.isNotificationEnabled
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
AdaptiveDiscreteFillVisualHeader.isSelectable
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
AdaptiveDiscreteFillVisualHeader.isSilent
▸ isVertical(): boolean
Returns vertical flag
boolean
true, if header is vertical, false otherwise
AdaptiveDiscreteFillVisualHeader.isVertical
▸ notify<E>(type, source, args?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.notify
▸ off<E>(type?, callback?): DiscreteStackedFillVisualHeader
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: DiscreteStackedFillVisualHeader, args: EventMap[E]) => void | function to be called |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.off
▸ on<E>(type, callback): DiscreteStackedFillVisualHeader
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: DiscreteStackedFillVisualHeader, args: EventMap[E]) => void | to be called |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.on
▸ Protected onParentChanged(node): DiscreteStackedFillVisualHeader
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.onParentChanged
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
AdaptiveDiscreteFillVisualHeader.onVisibilityChanged
▸ Protected onVisualChanged(): void
This method is called if visual is changed. Send event Events.VisualChanged
void
AdaptiveDiscreteFillVisualHeader.onVisualChanged
▸ Protected onVisualChanging(): void
This method is called if visual is changing.
void
AdaptiveDiscreteFillVisualHeader.onVisualChanging
▸ Protected onVisualStateChanged(type, source): void
| Name | Type |
|---|---|
type | Events | Events |
source | StackedLogFill |
void
AdaptiveDiscreteFillVisualHeader.onVisualStateChanged
▸ Protected onVisualTransformationChanged(): 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
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.preRendering
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
AdaptiveDiscreteFillVisualHeader.registerAnimationStyle
▸ removeCssClass(cssclass): DiscreteStackedFillVisualHeader
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.removeCssClass
▸ removeInvalidateHandler(handler): DiscreteStackedFillVisualHeader
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.removeInvalidateHandler
▸ render(inputContext): void
Renders node
| Name | Type | Description |
|---|---|---|
inputContext | RenderingContext | The rendering context to be used to draw the node |
void
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.renderAsync
▸ rotate(theta, x, y): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.rotate
▸ scale(xx, yy): DiscreteStackedFillVisualHeader
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.scale
▸ setAnimationStyle(animationStyle): DiscreteStackedFillVisualHeader
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setAnimationStyle
▸ setAutoBounds(enable): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setAutoBounds
▸ setBorderLineStyle(lineStyle, merge?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setBorderLineStyle
▸ setBounds(bounds): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setBounds
▸ setBoxOptions(boxOptions): DiscreteStackedFillVisualHeader
Set box layout options
| Name | Type | Description |
|---|---|---|
boxOptions | BoxOptions | box layout options |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setBoxOptions
▸ setBoxVisibility(visibility): DiscreteStackedFillVisualHeader
Set box visibility options
| Name | Type | Description |
|---|---|---|
visibility | BoxVisibility | box visibility options |
DiscreteStackedFillVisualHeader
this
▸ setClipStyle(style): DiscreteStackedFillVisualHeader
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setClipStyle
▸ setCss(style, merge?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setCss
▸ setCssClass(name): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setCssClass
▸ setCssTransform(transform): DiscreteStackedFillVisualHeader
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setCssTransform
▸ setDesiredHeight(value, silent?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setDesiredHeight
▸ setDiscreteDisplayType(displayType): DiscreteStackedFillVisualHeader
Sets discrete fill display type
| Name | Type | Description |
|---|---|---|
displayType | DiscreteFillDisplayType | discrete fill display type |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setDiscreteDisplayType
▸ setDisplayMode(displayMode): DiscreteStackedFillVisualHeader
Sets the displayed mode value
| Name | Type | Description |
|---|---|---|
displayMode | string | string[] | header display mode |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setDisplayMode
▸ setDisplayString(displayString): DiscreteStackedFillVisualHeader
Sets the displayed value
| Name | Type | Description |
|---|---|---|
displayString | string | the displayed value |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setDisplayString
▸ setElement(names, options?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setElement
▸ setFillStyle(fillStyle, merge?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setFillStyle
▸ setFlexBoxOptions(flexBoxOptions): DiscreteStackedFillVisualHeader
Set flex box layout options
| Name | Type | Description |
|---|---|---|
flexBoxOptions | FlexBoxOptions | box layout options |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setFlexBoxOptions
▸ setHighlightOptions(options): DiscreteStackedFillVisualHeader
Set highlight options
| Name | Type | Description |
|---|---|---|
options | HighlightOptions | highlight options |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setHighlightOptions
▸ setHorizontalFlip(enable): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setHorizontalFlip
▸ setId(id): DiscreteStackedFillVisualHeader
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setId
▸ setIsPointingUp(isPointingUp): DiscreteStackedFillVisualHeader
Sets whether the text is always pointing up.
| Name | Type | Description |
|---|---|---|
isPointingUp | boolean | flag setting whether the text is always pointing up |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setIsPointingUp
▸ setLayoutStyle(layoutStyle, merge?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setLayoutStyle
▸ setLineStyle(lineStyle, merge?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setLineStyle
▸ setLocalTransform(localTransform, force?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setLocalTransform
▸ setMarginsStyle(margins, merge?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setMarginsStyle
▸ setModelLimits(modelLimits): DiscreteStackedFillVisualHeader
Sets model limits
| Name | Type | Description |
|---|---|---|
modelLimits | Rect | desired model Limits |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setModelLimits
▸ setName(name): DiscreteStackedFillVisualHeader
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setName
▸ setNotification(notify, force?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setNotification
▸ setOpacity(opacity, blendMode?): DiscreteStackedFillVisualHeader
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. |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setOpacity
▸ setPaddingStyle(paddingStyle, merge?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setPaddingStyle
▸ setProperties(properties?): DiscreteStackedFillVisualHeader
Sets all properties
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setProperties
▸ setProperty(name, value): DiscreteStackedFillVisualHeader
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setProperty
▸ setRenderingFilter(filter): DiscreteStackedFillVisualHeader
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setRenderingFilter
▸ setResponsiveStyle(style): DiscreteStackedFillVisualHeader
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setResponsiveStyle
▸ setScaleScrollStrategy(strategy?): DiscreteStackedFillVisualHeader
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setScaleScrollStrategy
▸ setSection(names, options?): DiscreteStackedFillVisualHeader
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<StackedLogFill>> | 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<StackedLogFill> | options to set |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setSection
▸ setSections(sections): DiscreteStackedFillVisualHeader
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<StackedLogFill>)[] |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setSections
▸ setSelectable(selectable): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setSelectable
▸ setSettings(settings): DiscreteStackedFillVisualHeader
Sets settings element's parameters.
| Name | Type | Description |
|---|---|---|
settings | Settings | settings |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setSettings
▸ setSilent(bool): DiscreteStackedFillVisualHeader
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setSilent
▸ setTag(tag): DiscreteStackedFillVisualHeader
Allows the user to associate any arbitrary object with the node.
| Name | Type | Description |
|---|---|---|
tag | any | The object to be associated with the node. |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setTag
▸ setTextStyle(textStyle, merge?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setTextStyle
▸ setVertical(vertical): DiscreteStackedFillVisualHeader
Sets vertical flag
| Name | Type | Description |
|---|---|---|
vertical | boolean | true, if header is vertical, false otherwise |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setVertical
▸ setVisible(value): DiscreteStackedFillVisualHeader
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setVisible
▸ setVisual(visual): DiscreteStackedFillVisualHeader
| Name | Type |
|---|---|
visual | StackedLogFill |
DiscreteStackedFillVisualHeader
AdaptiveDiscreteFillVisualHeader.setVisual
▸ setZIndex(value): DiscreteStackedFillVisualHeader
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.setZIndex
▸ shear(shx, shy): DiscreteStackedFillVisualHeader
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.shear
▸ Protected synchronizeElements(): DiscreteStackedFillVisualHeader
Synchronize element settings
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.synchronizeElements
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
AdaptiveDiscreteFillVisualHeader.toString
▸ translate(tx, ty): DiscreteStackedFillVisualHeader
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.translate
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
AdaptiveDiscreteFillVisualHeader.unregisterAnimationStyle
▸ Protected updateGeometry(): DiscreteStackedFillVisualHeader
Update state.
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.updateGeometry
▸ updateSceneTransformation(): DiscreteStackedFillVisualHeader
Update scene transformation
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.updateSceneTransformation
▸ updateState(regions?, changes?): DiscreteStackedFillVisualHeader
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 |
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.updateState
▸ Protected updateTimeStamp(): DiscreteStackedFillVisualHeader
Update time stamp to indicate that Node or Children has been changed.
DiscreteStackedFillVisualHeader
this
AdaptiveDiscreteFillVisualHeader.updateTimeStamp
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
AdaptiveDiscreteFillVisualHeader.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>
AdaptiveDiscreteFillVisualHeader.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 |
AdaptiveDiscreteFillVisualHeader.findParent
▸ Static getClassName(): string
string
AdaptiveDiscreteFillVisualHeader.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
AdaptiveDiscreteFillVisualHeader.getDesiredHeight
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean
AdaptiveDiscreteFillVisualHeader.isSceneGraphNotificationEnabled