API / geotoolkit / schematics / widgets / reports / SchematicsWidgetElement / SchematicsWidgetElement
reports.SchematicsWidgetElement.SchematicsWidgetElement
Define representation of DOM element
↳
SchematicsWidgetElement
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
automodellimitsmode | boolean | Auto model limits mode |
bounds | Rect | Define position of the group in the parent |
bounds-height | number | Height |
bounds-readonly | boolean | Readonly |
bounds-width | number | Width |
bounds-x | number | Left |
bounds-y | number | Top |
clipping | boolean | Enable clipping, this does not consider the clipstyle, it is related to bounds-clipping |
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 |
contentorientation | Orientation | Content orientation |
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 |
fillstyle | string | Fill style |
fillstyle | FillStyle | Fill style |
fillstyle-color | string | Color in CSS form |
fillstyle-evenoddmode | boolean | Even-odd fill mode |
fillstyle-fillpattern | Pattern | Pattern |
fillstyle-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 |
fillstyle-fillpattern-patternname | string | Name of this pattern for indexing |
fillstyle-fillpattern-scalable | boolean | Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported) |
fillstyle-foreground | string | Foreground color |
fillstyle-pattern | Pattern | Pattern |
horizontalflip | boolean | Horizontal axis goes from right to left |
id | string | number | Id of the node, its a unique identifier |
infinity | boolean | Mode to render outside the model limits |
layoutstyle | LayoutStyle | Layout style to be used for parent layout |
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 | Line style |
linestyle | LineStyle | Line style |
linestyle-color | string | Color in CSS form |
linestyle-fill | string | Optional fill style to be used to fill lines generated with this style |
linestyle-fill | FillStyle | Optional fill style to be used to fill lines generated with this style |
linestyle-linecap | CapStyle | The line cap style |
linestyle-linedashoffset | number | Line dash offset of dashed line |
linestyle-linejoin | JoinStyle | The line join style |
linestyle-pixelsnapmode | boolean | Pixel Snap Mode, default( |
linestyle-scalable | boolean | True if width should depend on transformation |
linestyle-unit | string | Optional unit for the width |
linestyle-width | number | string | The line thickness |
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 | Define inner model coordinates of the group |
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 |
pickingchildren | boolean | Enable picking children |
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 |
transform | string | Additional CSS transformation applied to node or 'none' |
transform | Transformation | Additional CSS transformation applied to node or 'none' |
verticalflip | boolean | Vertical axis goes from bottom to top |
viewcache | boolean | View cache to cache child nodes |
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 SchematicsWidgetElement(options?)
| Name | Type |
|---|---|
Optional options | { alignment?: Alignment ; animationstyle?: Type ; annotationitemswrap?: boolean ; annotationssizes?: AnnotationSize ; applicationid?: string ; automodellimitsmode?: boolean ; automodellimitsstrategy?: ModelLimitsStrategy ; baselayers?: Node[] ; border?: Type ; bounds?: Type ; boundscalculation?: string ; center: Node | Node[] | { size?: string | number | (number & Omit<number, "toString" | "toLocaleString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf">); title?: { name?: string; visible?: boolean; ... 47 more ...; size?: number & Omit<...>; } & Omit<...>; axis?: { ...; } & Omit<...>; } & Omit<{ axis?: { type?: DepthAxisType; } & Omit<Options & { animationstyle?: Type; } & { localtransform?: Transformation; transform?: string | Transformation; ... 8 more ...; csscursor?: string; } & { ...; } & OptionsBase & { ...; }, "type">; } & Omit<AnnotationOption, "axis">, keyof AnnotationOption> ; children?: Node | Node[] ; clipping?: boolean ; clipstyle?: GraphicsPath | ClipStyle | Options ; contentorientation?: Orientation ; cssclass?: string ; csscursor?: string ; cssstyle?: string | CssStyle | Options ; data?: { elements?: Elements[] | WellBoreData ; trajectory?: Trajectory2d } | Data ; deviation?: DeviationOptions & { datamodellimits?: Type } ; dynamicproperties?: Record<string, any> ; east: Node | Node[] | { size?: string | number | (number & Omit<number, "toString" | "toLocaleString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf">); title?: { name?: string; visible?: boolean; ... 47 more ...; size?: number & Omit<...>; } & Omit<...>; axis?: { ...; } & Omit<...>; } & Omit<{ axis?: { type?: DepthAxisType; } & Omit<Options & { animationstyle?: Type; } & { localtransform?: Transformation; transform?: string | Transformation; ... 8 more ...; csscursor?: string; } & { ...; } & OptionsBase & { ...; }, "type">; } & Omit<AnnotationOption, "axis">, keyof AnnotationOption> ; fillstyle?: Type ; gap?: Partial<Record<"top" | "right" | "left" | "bottom", { fillstyle?: Type ; linestyle?: Type ; resizable?: boolean ; size?: string | number ; visible?: boolean }>> ; horizontalflip?: boolean ; id?: string | number ; infinity?: boolean ; isdatamodel?: boolean ; keepvisiblelimits?: boolean ; labeling?: { connectorshape?: ConnectorShape ; defaultlocation?: LocationType ; gap?: number ; labelsfilter?: LabelsFilter ; labelshape?: LabelShape | Options ; legendmode?: boolean ; locationmap?: { component: string[] ; id?: string | string[] ; location: LocationType }[] ; mode?: Mode } ; labelingstrategy?: LabelingStrategyBase ; layout?: Layout ; layoutstyle?: LayoutStyle<string | number> | Options<string | number> ; legend?: Omit<Options, keyof OptionsBase> & OptionsBase & { alignment?: AnchorType ; autosize?: boolean ; direction?: Direction ; fillstyle?: Type ; legenditem?: { gettext?: AbstractLegendItemInfoProvider | (componentNode: ComponentNode) => string ; symbol?: Options ; textstyle?: TextStyle | Options } ; linestyle?: Type ; offset?: { x: number ; y: number } ; options?: Options ; padding?: SpaceStyle<string | number> | Options<string | number> ; sizeisindevicespace?: boolean ; visible?: boolean } ; legendalignmentarea?: AnnotationLocation ; linestyle?: Type ; localtransform?: Transformation ; margins?: Type<string | number> ; model?: Group<Node> ; modellimits?: "auto" | Rect ; multidiameterselectionmode?: MultiDiameterSelectionMode ; name?: string ; none: Node | Node[] | { size?: string | number | (number & Omit<number, "toString" | "toLocaleString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf">); title?: { name?: string; visible?: boolean; ... 47 more ...; size?: number & Omit<...>; } & Omit<...>; axis?: { ...; } & Omit<...>; } & Omit<{ axis?: { type?: DepthAxisType; } & Omit<Options & { animationstyle?: Type; } & { localtransform?: Transformation; transform?: string | Transformation; ... 8 more ...; csscursor?: string; } & { ...; } & OptionsBase & { ...; }, "type">; } & Omit<AnnotationOption, "axis">, keyof AnnotationOption> ; north: Node | Node[] | { size?: string | number | (number & Omit<number, "toString" | "toLocaleString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf">); title?: { name?: string; visible?: boolean; ... 47 more ...; size?: number & Omit<...>; } & Omit<...>; axis?: { ...; } & Omit<...>; } & Omit<{ axis?: { type?: DepthAxisType; } & Omit<Options & { animationstyle?: Type; } & { localtransform?: Transformation; transform?: string | Transformation; ... 8 more ...; csscursor?: string; } & { ...; } & OptionsBase & { ...; }, "type">; } & Omit<AnnotationOption, "axis">, keyof AnnotationOption> ; northeast: Node | Node[] | { size?: string | number | (number & Omit<number, "toString" | "toLocaleString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf">); title?: { name?: string; visible?: boolean; ... 47 more ...; size?: number & Omit<...>; } & Omit<...>; axis?: { ...; } & Omit<...>; } & Omit<{ axis?: { type?: DepthAxisType; } & Omit<Options & { animationstyle?: Type; } & { localtransform?: Transformation; transform?: string | Transformation; ... 8 more ...; csscursor?: string; } & { ...; } & OptionsBase & { ...; }, "type">; } & Omit<AnnotationOption, "axis">, keyof AnnotationOption> ; northwest: Node | Node[] | { size?: string | number | (number & Omit<number, "toString" | "toLocaleString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf">); title?: { name?: string; visible?: boolean; ... 47 more ...; size?: number & Omit<...>; } & Omit<...>; axis?: { ...; } & Omit<...>; } & Omit<{ axis?: { type?: DepthAxisType; } & Omit<Options & { animationstyle?: Type; } & { localtransform?: Transformation; transform?: string | Transformation; ... 8 more ...; csscursor?: string; } & { ...; } & OptionsBase & { ...; }, "type">; } & Omit<AnnotationOption, "axis">, keyof AnnotationOption> ; opacity?: number ; opacityblendmode?: BlendMode ; overlays?: Node[] ; padding?: Type<string | number> ; pickingchildren?: boolean ; renderingfilter?: IFilter ; responsivestyle?: Options | ResponsiveStyle ; scalescrollstrategy?: Delegate ; scalesratio?: number ; scalesratiomode?: ScalesRatioMode ; sealevel?: Options & { animationstyle?: Type } & { clipstyle?: GraphicsPath | ClipStyle | Options ; csscursor?: string ; cssstyle?: string | CssStyle | Options ; localtransform?: Transformation ; margins?: Type<string | number> ; opacity?: number ; opacityblendmode?: BlendMode ; renderingfilter?: IFilter ; responsivestyle?: Options | ResponsiveStyle ; scalescrollstrategy?: Delegate ; transform?: string | Transformation } & { fillstyle?: Type ; linestyle?: Type } & { depth?: number ; symbol?: SymbolShape } ; selectable?: boolean ; south: Node | Node[] | { size?: string | number | (number & Omit<number, "toString" | "toLocaleString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf">); title?: { name?: string; visible?: boolean; ... 47 more ...; size?: number & Omit<...>; } & Omit<...>; axis?: { ...; } & Omit<...>; } & Omit<{ axis?: { type?: DepthAxisType; } & Omit<Options & { animationstyle?: Type; } & { localtransform?: Transformation; transform?: string | Transformation; ... 8 more ...; csscursor?: string; } & { ...; } & OptionsBase & { ...; }, "type">; } & Omit<AnnotationOption, "axis">, keyof AnnotationOption> ; southeast: Node | Node[] | { size?: string | number | (number & Omit<number, "toString" | "toLocaleString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf">); title?: { name?: string; visible?: boolean; ... 47 more ...; size?: number & Omit<...>; } & Omit<...>; axis?: { ...; } & Omit<...>; } & Omit<{ axis?: { type?: DepthAxisType; } & Omit<Options & { animationstyle?: Type; } & { localtransform?: Transformation; transform?: string | Transformation; ... 8 more ...; csscursor?: string; } & { ...; } & OptionsBase & { ...; }, "type">; } & Omit<AnnotationOption, "axis">, keyof AnnotationOption> ; southwest: Node | Node[] | { size?: string | number | (number & Omit<number, "toString" | "toLocaleString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf">); title?: { name?: string; visible?: boolean; ... 47 more ...; size?: number & Omit<...>; } & Omit<...>; axis?: { ...; } & Omit<...>; } & Omit<{ axis?: { type?: DepthAxisType; } & Omit<Options & { animationstyle?: Type; } & { localtransform?: Transformation; transform?: string | Transformation; ... 8 more ...; csscursor?: string; } & { ...; } & OptionsBase & { ...; }, "type">; } & Omit<AnnotationOption, "axis">, keyof AnnotationOption> ; tag?: any ; tools?: ToolsOptions & { rubberbandzoom?: Options & { mode?: RubberBandRenderMode } & { acceptemptyrect?: boolean ; autodisabled?: boolean ; fillstyle?: Type ; linestyle?: Type ; restrictionarea?: Rect } & { mode?: RubberBandRenderMode } ; tooltip?: Options } ; tooltip?: { autoflip?: boolean ; divelement?: HTMLElement ; gettext?: (componentNodes: ComponentNode[], options: { depthunit: string | AbstractUnit ; diameterunit: string | AbstractUnit ; point: Point }) => string } ; tooltipregistry?: ComponentNodeToolTipRegistry ; trackwidthstrategy?: TrackWidthStrategy ; trajectory?: { lines?: { linestyle?: Type ; visible?: boolean } ; stations?: { symbol?: Options ; visible?: boolean } } ; transform?: string | Transformation ; units?: UnitsOptions ; verticalflip?: boolean ; viewcache?: boolean | ViewCache ; visible?: boolean ; webglrendering?: boolean ; wellborenode?: Options & { animationstyle?: Type } & { clipstyle?: GraphicsPath | ClipStyle | Options ; csscursor?: string ; cssstyle?: string | CssStyle | Options ; localtransform?: Transformation ; margins?: Type<string | number> ; opacity?: number ; opacityblendmode?: BlendMode ; renderingfilter?: IFilter ; responsivestyle?: Options | ResponsiveStyle ; scalescrollstrategy?: Delegate ; transform?: string | Transformation } & { children?: Node | Node[] ; clipping?: boolean ; infinity?: boolean } & { baselayers?: Node[] ; overlays?: Node[] } & { automodellimitsmode?: boolean ; automodellimitsstrategy?: ModelLimitsStrategy ; bounds?: Type ; contentorientation?: Orientation ; fillstyle?: Type ; horizontalflip?: boolean ; layout?: Layout ; layoutstyle?: LayoutStyle<string | number> | Options<string | number> ; linestyle?: Type ; modellimits?: "auto" | Rect ; padding?: Type<string | number> ; pickingchildren?: boolean ; verticalflip?: boolean ; viewcache?: boolean | ViewCache } & { builder?: { compressed?: IViewModeBuilder ; keepaspectratio?: IViewModeBuilder ; regular?: IViewModeBuilder } ; data?: WellBoreData ; forceopenhole?: boolean ; highlight?: Highlight ; registry?: ComponentNodeFactoryRegistry ; renderinghints?: RenderingHints ; selection?: { cssclass?: string ; fillstyle?: Type ; linestyle?: Type } ; sortcomponents?: SortComponents ; units?: UnitsOptions ; valueviewmode?: ValueViewMode ; viewmode?: ViewMode | ViewModeInfo } & { componentsvisibility?: ComponentsVisibility ; factory?: (opts?: Options) => WellBoreNode } ; west: Node | Node[] | { size?: string | number | (number & Omit<number, "toString" | "toLocaleString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf">); title?: { name?: string; visible?: boolean; ... 47 more ...; size?: number & Omit<...>; } & Omit<...>; axis?: { ...; } & Omit<...>; } & Omit<{ axis?: { type?: DepthAxisType; } & Omit<Options & { animationstyle?: Type; } & { localtransform?: Transformation; transform?: string | Transformation; ... 8 more ...; csscursor?: string; } & { ...; } & OptionsBase & { ...; }, "type">; } & Omit<AnnotationOption, "axis">, keyof AnnotationOption> ; z-index?: number } & Omit<AnnotationOptions, "data" | "legend" | "opacity" | "transform" | "children" | "fillstyle" | "linestyle" | "bounds" | "model" | "alignment" | "animationstyle" | "modellimits" | "layoutstyle" | "infinity" | AnnotationLocation | "tooltip" | keyof Options | "localtransform" | "clipstyle" | "responsivestyle" | "cssstyle" | "csscursor" | "margins" | "renderingfilter" | "scalescrollstrategy" | "opacityblendmode" | "padding" | "verticalflip" | "horizontalflip" | "clipping" | "baselayers" | "overlays" | "contentorientation" | "pickingchildren" | "layout" | "automodellimitsmode" | "automodellimitsstrategy" | "viewcache" | "annotationitemswrap" | "border" | "annotationssizes" | "keepvisiblelimits" | "isdatamodel" | "applicationid" | "tools" | "wellborenode" | "labelingstrategy" | "gap" | "webglrendering" | "trajectory" | "trackwidthstrategy" | "units" | "labeling" | "deviation" | "boundscalculation" | "scalesratio" | "scalesratiomode" | "tooltipregistry" | "legendalignmentarea" | "sealevel" | "multidiameterselectionmode"> |
WidgetElement.constructor
Methods
▸ addBaseLayer(baseLayer): SchematicsWidgetElement
Add baseLayer to container
this
▸ addChild(node): SchematicsWidgetElement
Add a child node
this
▸ addCssClass(cssclass): SchematicsWidgetElement
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addInvalidateHandler(handler): SchematicsWidgetElement
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
WidgetElement.addInvalidateHandler
▸ addOverlay(overlay): SchematicsWidgetElement
Add overlay to container
this
▸ adjustPosition(area?, vAlign?, hAlign?): SchematicsWidgetElement
Adjust position of node to specified area
| Name | Type | Description |
|---|---|---|
Optional area | Rect | specified area. Default to Parent Model Limits |
Optional vAlign | string | vertical alignment. It can be "top", "bottom", "center". Defaults to "top". |
Optional hAlign | string | horizontal alignment It can be "left", "right", "center". Defaults to "left". |
this
▸ Protected applyOpacity(context): SchematicsWidgetElement
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
WidgetElement.applyResponsiveStyle
▸ Protected calculatePreferredSize(bounds, isDesignTime): Dimension
Should calculate and return preferred size
| Name | Type | Description |
|---|---|---|
bounds | Rect | |
isDesignTime | boolean | boolean flag |
WidgetElement.calculatePreferredSize
▸ changeBaseLayerOrder(overlay, order, anchor?): SchematicsWidgetElement
Changes the z-order of the baseLayer.
| Name | Type | Description |
|---|---|---|
overlay | Node | |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
this
WidgetElement.changeBaseLayerOrder
▸ changeChildOrder(node, order, anchor?): SchematicsWidgetElement
changes the z-order of the nodes being rendered.
| Name | Type | Description |
|---|---|---|
node | Node | any child added in the Composite node |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
this
WidgetElement.changeChildOrder
▸ changeOverlayOrder(overlay, order, anchor?): SchematicsWidgetElement
Changes the z-order of the overlay.
| Name | Type | Description |
|---|---|---|
overlay | Node | child overlay |
order | NodeOrder | position to be added |
Optional anchor | Node | anchor node to specify changeOrder with respect to this node |
this
WidgetElement.changeOverlayOrder
▸ checkCollision(context): boolean
Check culling Returns true if object is inside of renderable area
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if node is collided
▸ clearBaseLayers(disposeBaseLayers?): SchematicsWidgetElement
Remove all child baseLayers from group
| Name | Type | Description |
|---|---|---|
Optional disposeBaseLayers | boolean | automatically dispose baseLayers. If it is true then method dispose is called for each baseLayer, false by default |
this
▸ clearCache(): SchematicsWidgetElement
Clear cache
this
▸ clearChildren(disposeChildren?): SchematicsWidgetElement
Remove all child nodes from this composite group
| Name | Type | Description |
|---|---|---|
Optional disposeChildren | boolean | automatically dispose children. If it is true then method dispose is called for each child. |
this
▸ clearOverlays(disposeOverlays?): SchematicsWidgetElement
Remove all child overlays from group
| Name | Type | Description |
|---|---|---|
Optional disposeOverlays | boolean | automatically dispose overlays. If it is true then method dispose is called for each overlay, false by default |
this
▸ clone(): Element
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): SchematicsWidgetElement
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?): SchematicsWidgetElement
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 | Element | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
▸ disconnectStyle(style, type, callback): SchematicsWidgetElement
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
▸ Protected drawBorder(localContext, bounds?): SchematicsWidgetElement
Draws a rectangle at the bounding box (in parent coordinates)
| Name | Type | Description |
|---|---|---|
localContext | RenderingContext | The local rendering context |
Optional bounds | Rect | group bounds |
this
▸ dropCache(): SchematicsWidgetElement
Rebuild layout
▸ enableClipping(doClip): SchematicsWidgetElement
Enables or disables clipping of this node. If enabled, shapes will not be rendered outside of its bounds.
| Name | Type | Description |
|---|---|---|
doClip | boolean | enable clipping on this node |
this
▸ enableEventPropagation(enable): SchematicsWidgetElement
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
WidgetElement.enableEventPropagation
▸ enablePickingChildren(enable): SchematicsWidgetElement
Enables or disables picking children
| Name | Type | Description |
|---|---|---|
enable | boolean | enable picking children |
this
WidgetElement.enablePickingChildren
▸ enumerateNodes(callback, target?): void
Executes a provided function once for each child node
| Name | Type | Description |
|---|---|---|
callback | Callback<Node> | provided function |
Optional target | QueryBuilder<any> | target to pass to callback as a second parameter |
void
▸ execute(delegate): SchematicsWidgetElement
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: SchematicsWidgetElement) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: SchematicsWidgetElement) => T |
T
▸ exportToImage(showWireBorder?): Image
Export element to image (without rotation)
| Name | Type | Description |
|---|---|---|
Optional showWireBorder | boolean | show wire border |
image
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
▸ getActiveElement(): Element | Element
Get active element
WidgetElement.getActiveElement
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
WidgetElement.getAnimationStyle
▸ getAutoModelLimitsMode(): boolean
Get Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds
boolean
mode
WidgetElement.getAutoModelLimitsMode
▸ getAutoModelLimitsStrategy(): ModelLimitsStrategy
Get Model Limits Logics Strategy
strategy
WidgetElement.getAutoModelLimitsStrategy
▸ getBaseLayer(index): Node
Return baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the baseLayer for |
track
▸ getBaseLayers<S>(predicate, modify?): Iterator<Node>
Return iterator by baseLayers nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
▸ getBaseLayers(filter?, modify?): Iterator<Node>
Returns an iterator for child baseLayers. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.
Example
// Gets a writable iterator
const it = node.getOverlays(null, true);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all overlays if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child overlays.
▸ getBaseLayersCount(): number
Returns amount of baseLayers
number
WidgetElement.getBaseLayersCount
▸ getBounds(): Rect
Get the bounds in the parents model space. If bounds are not set, then parent model limits are used.
current bounds
▸ getCache(): Cache
Return cache strategy to be used to cache children nodes
cache
▸ getChild(i): Node
Return node by index
| Name | Type | Description |
|---|---|---|
i | number | index of the node |
▸ getChildren<S>(predicate, modify?): Iterator<S>
Return iterator by child nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
Iterator<S>
▸ getChildren(filter?, modify?): Iterator<Node>
Returns an iterator for child nodes. The iterator does not support adding or deleting items from children by default. If it is necessary to modify a collection of children, pass true as the last parameter.
Example
// Gets a writable iterator
const it = node.getChildren(null, true);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all nodes if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child nodes.
▸ getChildrenCount(): number
Return number of child nodes
number
WidgetElement.getChildrenCount
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ getContentElement(): ElementContent
Return inner content element
WidgetElement.getContentElement
▸ getContentOrientation(): Orientation
Return content orientation
content orientation
WidgetElement.getContentOrientation
▸ 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
getContentsTransform() retrieves the world transformation of the node.
transformation from model coordinates to bounds of the group
WidgetElement.getContentsTransform
▸ 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(): string | number
Returns desired height of the group as a layoutable object This method is a helper method to get access to getLayoutStyle()
string | number
desired height ("undefined" by default)
WidgetElement.getDesiredHeight
▸ getDesiredWidth(): string | number
Returns desired width of the group as a layoutable object. This method is a helper method to get access to getLayoutStyle()
string | number
desired width ("undefined" by default)
▸ getDeviceLimits(): Rect
Return device limits
▸ getDomElement(): AbstractElement
Returns DOM element
return DOM element
▸ getElementStyle(): ElementStyle
Returns element style
return element style
▸ getElementStyle(elementStyle): any
| Name | Type |
|---|---|
elementStyle | string |
any
▸ getElementTransformations(bounds?): Transformation[]
Return array of transformations
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | element bounds |
array of transformations
WidgetElement.getElementTransformations
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ getInfiniteMode(): boolean
Return infinity mode flag
boolean
flag
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
WidgetElement.getInvalidateMethod
▸ getLayout(): Layout
Returns layout associated with the group
layout
▸ getLayoutStyle(): LayoutStyle<string | number>
return desired layout style
LayoutStyle<string | number>
▸ getLineStyle(): LineStyle
Return border style
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
WidgetElement.getLocalTransform
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
▸ getModelLimits(): Rect
Gets model limits, the limits of this groups inside space
the current 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
WidgetElement.getOpacityBlendMode
▸ getOverlay(index): Node
Return overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the overlay for |
track
▸ getOverlayAt(index): Node
Return overlay at specified index
Deprecated
since 4.2 use getOverlay instead
| Name | Type | Description |
|---|---|---|
index | number | index at which to get the overlay for |
track
▸ getOverlays<S>(predicate, modify?): Iterator<Node>
Return iterator by overlays nodes
| Name | Type |
|---|---|
S | extends Node<S> |
| Name | Type | Description |
|---|---|---|
predicate | (value: Node) => value is S | a filter function |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
▸ getOverlays(filter?, modify?): Iterator<Node>
Returns an iterator for child overlays. The iterator does not support adding or deleting items from overlays by default. If it is necessary to modify a collection of overlays, pass true as the last parameter.
Example
// Gets a writable iterator
const it = node.getOverlays(null, true);| Name | Type | Description |
|---|---|---|
Optional filter | (node: Node) => boolean | A filter function. Returns all overlays if null. |
Optional modify | boolean | An option to specify if the iterator supports adding/removing items from the collection. false by default. |
An iterator for child overlays.
▸ getOverlaysCount(): number
Returns amount of overlays
number
WidgetElement.getOverlaysCount
▸ getPaddingStyle(): SpaceStyle<string | number>
Return padding style
SpaceStyle<string | number>
padding
▸ getParent(): ElementContent
Return parent node
parent node
▸ getPreferredElementBounds(limits, cssLayout): Rect
Calculate layout bounds
| Name | Type | Description |
|---|---|---|
limits | Rect | container limits |
cssLayout | LayoutStyle<string | number> | element layout |
preferred bounds
WidgetElement.getPreferredElementBounds
▸ getPreferredSize(): Rect
Return preferred size to layout children
WidgetElement.getPreferredSize
▸ getProperties(context?): OptionsOut<Node>
Gets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional context | ISerializationContext | serialization context |
properties object
▸ 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
WidgetElement.getRenderingFilter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
WidgetElement.getResponsiveStyle
▸ getRoot(): CompositeNode<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
WidgetElement.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
WidgetElement.getSceneTransform
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getTool(): CompositeTool
Returns root tool associated to this element
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
▸ getVisibleDeviceLimits(ignoreModelLimits?): Rect
Return visible device limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
WidgetElement.getVisibleDeviceLimits
▸ getVisibleModelLimits(ignoreModelLimits?): Rect
Return visible model limits
| Name | Type | Description |
|---|---|---|
Optional ignoreModelLimits | boolean | flag defines whether to ignore ModelLimits or not |
WidgetElement.getVisibleModelLimits
▸ getWidgetElement(): CompositeSchematicsWidget
WidgetElement.getWidgetElement
▸ getWireMode(): boolean
Returns Wire mode
boolean
return wire mode
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
WidgetElement.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
WidgetElement.hasEventListener
▸ hitTest(eventArgs): Element
Return Dom element
| Name | Type | Description |
|---|---|---|
eventArgs | EventArgs | event args |
return selected object if any
▸ indexOfBaseLayer(baseLayer): number
Return index of overlay ( index of the specified child or -1 if baseLayer is not found)
| Name | Type | Description |
|---|---|---|
baseLayer | Node | baseLayer to check index |
number
WidgetElement.indexOfBaseLayer
▸ indexOfChild(node): number
Return index of child ( index of the specified child or -1 if node is not found)
| Name | Type | Description |
|---|---|---|
node | Node | node to check index |
number
▸ indexOfOverlay(overlay): number
Return index of overlay ( index of the specified child or -1 if overlay is not found)
| Name | Type | Description |
|---|---|---|
overlay | Node | overlay to check index |
number
▸ initialize(json?, context?): SchematicsWidgetElement
Initialize widget element
| Name | Type | Description |
|---|---|---|
Optional json | object | object with data to initialize |
Optional context | ParserContext | parser context |
this
▸ insertBaseLayer(index, baseLayer): SchematicsWidgetElement
Insert child baseLayer at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
baseLayer | Node | a baseLayer to add |
this
▸ insertChild(index, node): SchematicsWidgetElement
Insert child node at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
node | Node | a child node to add |
this
▸ insertOverlay(index, overlay): SchematicsWidgetElement
Insert child overlay at specified index
| Name | Type | Description |
|---|---|---|
index | number | specified index |
overlay | Node | a overlay to add |
this
▸ invalidate(bounds?, force?): SchematicsWidgetElement
Invalidate node
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | optional rectangular area to be invalidated, or force flag if rectangle is empty |
Optional force | boolean | optional boolean parameter that can force invalidation |
this
▸ invalidateLayout(propagate?): SchematicsWidgetElement
Notify that layout is invalidated. Send event Events.LayoutInvalidated
| Name | Type | Description |
|---|---|---|
Optional propagate | boolean | propagate invalidate layout to parent |
this
WidgetElement.invalidateLayout
▸ invalidateParent(bounds?, force?): SchematicsWidgetElement
Invalidate parent area
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | area to invalidate |
Optional force | boolean | force |
this
WidgetElement.invalidateParent
▸ isClippingEnabled(): boolean
Returns if clipping is enabled or not for this node.
boolean
WidgetElement.isClippingEnabled
▸ Protected isDesignTime(): boolean
Return Design time state
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
WidgetElement.isEventPropagationEnabled
▸ isHorizontalFlip(): boolean
Return true if the representation is flipped horizontally
boolean
flip
WidgetElement.isHorizontalFlip
▸ isLayoutInvalidated(): boolean
Return true if layout is invalid
boolean
WidgetElement.isLayoutInvalidated
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
WidgetElement.isNotificationEnabled
▸ isPickingChildrenEnabled(): boolean
Returns if picking children is enabled or not for this node.
boolean
pickingChildren
WidgetElement.isPickingChildrenEnabled
▸ 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
▸ isVerticalFlip(): boolean
Return true if the representation is flipped vertically
boolean
flip
▸ moveTo(area, vAlign?, hAlign?): SchematicsWidgetElement
MoveTo position of node to specified area
| Name | Type | Description |
|---|---|---|
area | Rect | specified area |
Optional vAlign | string | vertical alignment. It can be "top", "bottom", "center". |
Optional hAlign | string | horizontal alignment It can be "left", "right", "center". |
this
▸ notify<E>(type, source, args?): SchematicsWidgetElement
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event |
source | WidgetElement | source who called the event |
Optional args | EventMap[E] | event arguments |
this
▸ Protected notifyRoot(event, source, args?): Node
Notify an even to root node
| Name | Type | Description |
|---|---|---|
event | string | type of event |
source | Node | source who called the event |
Optional args | any | event arguments |
this
▸ off<E>(type?, callback?): SchematicsWidgetElement
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: SchematicsWidgetElement, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): SchematicsWidgetElement
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: SchematicsWidgetElement, args: EventMap[E]) => void | to be called |
this
▸ Protected onBoundsChanged(bounds): SchematicsWidgetElement
Occurs when bounds has been changed
| Name | Type | Description |
|---|---|---|
bounds | Rect | bound of the node in the parent coordinates |
this
▸ Protected onChildAdded(child): void
This method is called it child or children are added
void
▸ Protected onChildRemoved(child): void
This method is called it child or children are removed
| Name | Type | Description |
|---|---|---|
child | Node | removed child |
void
▸ Protected onConnectToSite(site): SchematicsWidgetElement
On de-initialize design time (happens only once)
| Name | Type | Description |
|---|---|---|
site | ISiteElement | site element |
▸ Protected onDisconnectFromSite(site): SchematicsWidgetElement
On initialize design time (happens only once)
| Name | Type | Description |
|---|---|---|
site | ISiteElement | site element |
WidgetElement.onDisconnectFromSite
▸ Protected onDomElementChanged(eventType, sender, eventArgs): SchematicsWidgetElement
Update element from domElement
| Name | Type | Description |
|---|---|---|
eventType | string | event type |
sender | Element | |
eventArgs | NodeEventArgs | argument args |
WidgetElement.onDomElementChanged
▸ onKeyDown(nativeEventArgs): boolean
Process native keyboard event
| Name | Type | Description |
|---|---|---|
nativeEventArgs | Event | arguments of the DOM event |
boolean
▸ Protected onParentChanged(node): SchematicsWidgetElement
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
WidgetElement.onVisibilityChanged
▸ Protected postRendering(context, callback?): void
To be called after rendering, used for PDF output
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
Optional callback | () => void | callback to be called after rendering |
void
▸ Protected preRendering(context, callback?): void
Occurs before child rendering
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
Optional callback | () => void | callback to be called after rendering of geometry |
void
▸ rebuild(force?, changes?): SchematicsWidgetElement
Rebuild node. This method resets state, cache, and invalidate node.
| Name | Type | Description |
|---|---|---|
Optional force | boolean | optional boolean parameter that can force invalidation |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ rebuildDomLayout(): SchematicsWidgetElement
Rebuild element DOM layout
WidgetElement.rebuildDomLayout
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
WidgetElement.registerAnimationStyle
▸ removeBaseLayer(baseLayer): SchematicsWidgetElement
Remove child baseLayer
this
▸ removeChild(node, disposeChildren?): SchematicsWidgetElement
Remove child node
| Name | Type | Description |
|---|---|---|
node | Node | Node[] | node or array of nodes to be removed |
Optional disposeChildren | boolean | automatically dispose children. If it is true then method dispose is called for each child. |
this
▸ removeCssClass(cssclass): SchematicsWidgetElement
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ removeInvalidateHandler(handler): SchematicsWidgetElement
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
WidgetElement.removeInvalidateHandler
▸ removeOverlay(overlay): SchematicsWidgetElement
Remove child overlay
this
▸ render(context): void
Render group
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render group |
void
▸ renderAsync(context, callback): void
Render node in asynchronous mode. This implementation doesn't support cache for now.
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function |
void
▸ Protected renderBackground(context, bounds): SchematicsWidgetElement
Render background
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render background |
bounds | Rect | group bounds |
this
WidgetElement.renderBackground
▸ Protected renderBaseLayers(context): SchematicsWidgetElement
Render baseLayers on bottom of cache. This method does nothing, but can be implemented to render graphics on bottom of cache and between borders
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render baseLayers |
this
WidgetElement.renderBaseLayers
▸ Protected renderBaseLayersAsync(context, callback): void
Render baseLayers on bottom of cache in asynchronous mode. This method calls renderBaseLayers
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
callback | () => void | callback function |
void
WidgetElement.renderBaseLayersAsync
▸ Protected renderChildren(context): void
Render children
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ Protected renderChildrenAsync(context, callback): void
Render children async
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
callback | () => void | callback function to be called then all children are rendered |
void
WidgetElement.renderChildrenAsync
▸ Protected renderContent(context): void
render to specified context. This method calls preRendering, renderChildren, postRendering
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ Protected renderContentAsync(context, callback): void
Render children in asynchronous mode
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function to be called then all children are rendered |
void
WidgetElement.renderContentAsync
▸ Protected renderOverlays(context): SchematicsWidgetElement
Render overlays on top of cache. This method does nothing, but can be implemented to render graphics on top of cache and between borders
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
this
▸ Protected renderOverlaysAsync(context, callback): void
Render overlays on top of cache in asynchronous mode. This method calls renderOverlays
| Name | Type | Description |
|---|---|---|
context | RenderingContext | context to render overlays |
callback | () => void | callback function |
void
WidgetElement.renderOverlaysAsync
▸ resumeUpdate(rebuild?, changes?): SchematicsWidgetElement
Resume auto update
| Name | Type | Description |
|---|---|---|
Optional rebuild | boolean | force rebuild |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ rotate(theta, x, y): SchematicsWidgetElement
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): SchematicsWidgetElement
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setActiveElement(activeElement): SchematicsWidgetElement
Set active element
this
WidgetElement.setActiveElement
▸ setAnimationStyle(animationStyle): SchematicsWidgetElement
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
WidgetElement.setAnimationStyle
▸ setAutoModelLimitsMode(mode): SchematicsWidgetElement
Set Model Limits Logics to use when no Model Limits have been set set to true: will use parents width and height, starting at 0 set to false: will use parents bounds. This is convenient method. It creates AutoModelLimitsStrategy
| Name | Type | Description |
|---|---|---|
mode | boolean | Model Limits Logics to be used |
this
WidgetElement.setAutoModelLimitsMode
▸ setAutoModelLimitsStrategy(strategy): SchematicsWidgetElement
Set Model Limits Logics Strategy
| Name | Type | Description |
|---|---|---|
strategy | ModelLimitsStrategy | Model Limits logic strategy to use |
this
WidgetElement.setAutoModelLimitsStrategy
▸ setBounds(bounds): SchematicsWidgetElement
Sets bounds of the node in the parent coordinates
| Name | Type | Description |
|---|---|---|
bounds | Type | bound of the node in the parent coordinates |
this
▸ setCache(cache, rebuild?): SchematicsWidgetElement
Sets cache to be used to cache
| Name | Type | Description |
|---|---|---|
cache | Cache | cache to be used |
Optional rebuild | boolean | rebuild cache |
this
▸ setChild(index, node): SchematicsWidgetElement
Replace child node by index
| Name | Type | Description |
|---|---|---|
index | number | index of the node |
node | Node | node |
this
▸ setClipStyle(style): SchematicsWidgetElement
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setContentOrientation(orientation): SchematicsWidgetElement
Set content orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | content orientation |
this
WidgetElement.setContentOrientation
▸ setCss(style, merge?): SchematicsWidgetElement
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): SchematicsWidgetElement
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): SchematicsWidgetElement
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ setDesiredHeight(value, silent?): SchematicsWidgetElement
Sets desired height of the group 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
WidgetElement.setDesiredHeight
▸ setDesiredWidth(value, silent?): SchematicsWidgetElement
Sets desired width of the group as a layoutable object
| Name | Type | Description |
|---|---|---|
value | string | number | desired width to set |
Optional silent | boolean | silent setting |
this
▸ setDomElement(domElement): SchematicsWidgetElement
Set DOM element
| Name | Type | Description |
|---|---|---|
domElement | Element | DOM element |
this
▸ setElementStyle(elementStyle, styleValue?): SchematicsWidgetElement
Set element style
| Name | Type | Description |
|---|---|---|
elementStyle | string | Record<string, any> | ElementStyle | element style |
Optional styleValue | any | object of value for element style |
this
▸ setFillStyle(fillStyle, merge?): SchematicsWidgetElement
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 |
this
▸ setHorizontalFlip(enable): SchematicsWidgetElement
Set horizontal flip of the representation
| Name | Type | Description |
|---|---|---|
enable | boolean | enable flip |
this
WidgetElement.setHorizontalFlip
▸ setId(id): SchematicsWidgetElement
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setInfiniteMode(infinityMode): SchematicsWidgetElement
Set infinity mode flag to draw composite without collision check
| Name | Type | Description |
|---|---|---|
infinityMode | boolean | infinity mode flag |
this
▸ setLayout(layout): SchematicsWidgetElement
Associate layout with a group.
| Name | Type | Description |
|---|---|---|
layout | Record<string, any> | Layout | layout instance to be set or layout properties to apply |
this
▸ Protected setLayoutInvalidated(invalidated): void
Set invalidation status
| Name | Type | Description |
|---|---|---|
invalidated | boolean | invalidated layout |
void
WidgetElement.setLayoutInvalidated
▸ setLayoutStyle(layoutStyle, silent?, merge?): SchematicsWidgetElement
specify desired layout style
| Name | Type | Description |
|---|---|---|
layoutStyle | LayoutStyle<string | number> | Options<string | number> | desired layout style |
Optional silent | boolean | silent setting |
Optional merge | boolean | true if you want to merge layoutStyle with existing attribute, false by default |
this
▸ setLineStyle(lineStyle, merge?): SchematicsWidgetElement
Sets border color Returns this
| 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?): SchematicsWidgetElement
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
WidgetElement.setLocalTransform
▸ setMarginsStyle(margins, merge?): SchematicsWidgetElement
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(limits): SchematicsWidgetElement
Sets inner model limits
| Name | Type | Description |
|---|---|---|
limits | Type | inner limits |
this
▸ setName(name): SchematicsWidgetElement
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): SchematicsWidgetElement
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?): SchematicsWidgetElement
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?): SchematicsWidgetElement
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 |
this
▸ setProperties(properties?): SchematicsWidgetElement
Sets all the properties pertaining to this object
this
▸ setProperty(name, value): SchematicsWidgetElement
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): SchematicsWidgetElement
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
WidgetElement.setRenderingFilter
▸ setResponsiveStyle(style): SchematicsWidgetElement
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
WidgetElement.setResponsiveStyle
▸ setScaleScrollStrategy(strategy?): SchematicsWidgetElement
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
WidgetElement.setScaleScrollStrategy
▸ setSelectable(selectable): SchematicsWidgetElement
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): SchematicsWidgetElement
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setTag(tag): SchematicsWidgetElement
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
▸ setVerticalFlip(flip): SchematicsWidgetElement
Set vertical flip of the representation
| Name | Type | Description |
|---|---|---|
flip | boolean | flag to set the vertical flip of the representation |
this
▸ setVisible(value): SchematicsWidgetElement
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setVisibleModelLimits(visibleModelBounds, deviceBounds?): SchematicsWidgetElement
Set visible model limits
| Name | Type | Description |
|---|---|---|
visibleModelBounds | Rect | visible model limits or bounds |
Optional deviceBounds | Rect | device bounds |
this
WidgetElement.setVisibleModelLimits
▸ setWireMode(enabled): SchematicsWidgetElement
Set Wire mode
| Name | Type | Description |
|---|---|---|
enabled | boolean | wire mode |
this
▸ setZIndex(value): SchematicsWidgetElement
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): SchematicsWidgetElement
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ suspendUpdate(): SchematicsWidgetElement
Suspend auto update
this
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): SchematicsWidgetElement
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | AnimatedNode | root node for node |
void
WidgetElement.unregisterAnimationStyle
▸ updateLayout(targets?): SchematicsWidgetElement
Updates layout(s)
Fires
| Name | Type | Description |
|---|---|---|
Optional targets | ILayoutable[] | optional parameter about which element to layout |
this
▸ updateSceneTransformation(): SchematicsWidgetElement
Update scene transformation
this
WidgetElement.updateSceneTransformation
▸ updateState(regions?, changes?): SchematicsWidgetElement
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
▸ updateSuspended(): boolean
Return state of suspend state
boolean
state of update
▸ Protected updateTimeStamp(): SchematicsWidgetElement
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
WidgetElement.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 isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean
WidgetElement.isSceneGraphNotificationEnabled
▸ Static rebuildDomLayout(element): IElement & Node
Rebuild DOM layout