API / geotoolkit / scene / shapes / SymbolShape / SymbolShape
shapes.SymbolShape.SymbolShape
Symbols are shapes created using Symbol Painters (geotoolkit.scene.shapes.painters). It has built-in function to draw the shape based on the selected painter.
↳
SymbolShape↳↳
TadPole
Constructors
| [new SymbolShape(ax, ay, width, height, alignment, sizeisindevicespace, painter, lineStyle, fillStyle)](/solutions/geotoolkit/apis/classes/geotoolkit.scene.shapes.symbolshape.symbolshape.md#new symbolshape(ax, ay, width, height, alignment, sizeisindevicespace, painter, linestyle, fillstyle)) | [new SymbolShape(options)](/solutions/geotoolkit/apis/classes/geotoolkit.scene.shapes.symbolshape.symbolshape.md#new symbolshape(options)) |
|---|
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
alignment | AnchorType | Alignment according to the anchor point |
alignment | AnchorType | Anchor type of symbol |
ax | number | Anchor x position |
ay | number | Anchor y position |
cache | boolean | Set it to true if you want to cache complex geometry to raster |
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-geometry-bounds-height | number | Height |
clipstyle-geometry-bounds-readonly | boolean | Readonly |
clipstyle-geometry-bounds-width | number | Width |
clipstyle-geometry-bounds-x | number | Left |
clipstyle-geometry-bounds-y | number | Top |
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 |
fillstyle | string | Style applied on fill |
fillstyle | FillStyle | Style applied on fill |
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 |
height | number | Shape height |
id | string | number | Id of the node, its a unique identifier |
ispointingup | boolean | Defines whether the shape is always pointing up |
layoutstyle | LayoutStyle | Layout style to specify how to lay out shape |
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 | Style applied on outline |
linestyle | LineStyle | Style applied on outline |
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 |
maxdimension | Dimension | Maximum size for rendering |
maxdimension-height | number | Height of dimension |
maxdimension-width | number | Width of dimension or properties |
mindimension | Dimension | Minimum size for rendering |
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 |
painter | string | A function with has parameters: symbol, box, context |
painterproperties | any | Symbol's painter's properties |
preserveaspectratio | boolean | Preserve aspect ratio of the anchored shape |
preservereadingorientation | boolean | Preserve reading orientation for local transform |
preserverightangle | boolean | Preserve right angle for local transformation |
rotationangle | number | Rotation angle at anchor |
scalescrollstrategy | ScaleScrollStrategy | Scale scroll strategy |
scalescrollstrategy-enabled | boolean | Enable flag |
selectable | boolean | Selectable node, a boolean to determine if selection should consider this node |
sizeisindevicespace | boolean | Is coordinate in device space |
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' |
useminmaxdimensions | boolean | Use the min max dimensions to limit visual size |
visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
width | number | Shape width |
z-index | number | Define node z-index |
Constructors
• new SymbolShape(ax?, ay?, width?, height?, alignment?, sizeisindevicespace?, painter?, lineStyle?, fillStyle?)
Create SymbolShape
| Name | Type | Description |
|---|---|---|
Optional ax | number | anchor x position |
Optional ay | number | anchor y position |
Optional width | number | symbol width |
Optional height | number | symbol height |
Optional alignment | AnchorType | anchor type of symbol |
Optional sizeisindevicespace | boolean | flag to indicate if size of the symbol in device |
Optional painter | Painter | a function with has parameters: symbol, box, context or object, which must have method render at least |
Optional lineStyle | Type | line style of symbol |
Optional fillStyle | Type | fill style of symbol |
AnchoredShape.constructor
• new SymbolShape(options?)
Create SymbolShape
| Name | Type | Description |
|---|---|---|
Optional options | Options | symbol shape options |
AnchoredShape.constructor
Methods
▸ addCssClass(cssclass): SymbolShape
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ addInvalidateHandler(handler): SymbolShape
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AnchoredShape.addInvalidateHandler
▸ Protected applyOpacity(context): SymbolShape
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
AnchoredShape.applyResponsiveStyle
▸ checkCollision(context): boolean
Check if this node is within the area being rendered by the context
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if object is inside of renderable area
▸ clone(): SymbolShape
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): SymbolShape
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?): SymbolShape
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 | SymbolShape | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
▸ disconnectStyle(style, type, callback): SymbolShape
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
Disposes this node, once disposes a node should not be used anymore.
Clear all listeners, and disconnect styles to avoid memory leaks.
Also aggressively 'cleanup' this node by setting some of its members to null.
void
▸ draw(context): SymbolShape
Draw
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
this
▸ enableEventPropagation(enable): SymbolShape
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
AnchoredShape.enableEventPropagation
▸ enumerateNodes(callback, target?): void
Enumerate children nodes
| Name | Type | Description |
|---|---|---|
callback | Callback<Node> | callback |
Optional target | QueryBuilder<any> | target |
void
INodeEnumerable.enumerateNodes
▸ execute(delegate): SymbolShape
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: SymbolShape) => void | Function to execute |
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: SymbolShape) => T |
T
▸ Protected filter(context): boolean
Filter node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
flag filter flag ("true" to render node; "false" otherwise)
▸ getAnchor(tr?): Point
Gets the anchor
| Name | Type | Description |
|---|---|---|
Optional tr | Transformation | transformation to transform anchor |
▸ getAnchorType(): AnchorType
Returns the current anchor type.
current anchor type
▸ getAnchorX(): number
Return anchored x position
number
▸ getAnchorY(): number
Return anchored y position
number
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
AnchoredShape.getAnimationStyle
▸ getAspectRatio(): number
Returns aspect ratio of the content of the shape Returns 1
number
▸ getBounds(): Rect
Return bound in the parent coordinates
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ 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
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
▸ getHeight(): number
Return height of the shape
number
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
AnchoredShape.getInvalidateMethod
▸ getIsPointingUp(): boolean
Returns true if the shape is always pointing up
boolean
true if the shape is always pointing up
▸ getLayoutStyle(): LayoutStyle<string | number>
Return desired layout style
LayoutStyle<string | number>
▸ getLineStyle(): LineStyle
Return line style
lineStyle current line style
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
AnchoredShape.getLocalTransform
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
▸ getMaxSize(): Dimension
returns the maximum device space rendering dimension only works when setUseMinMaxSize is enabled.
max size
▸ getMinSize(): Dimension
returns the minimum device space rendering dimension only works when setUseMinMaxSize is enabled.
min size
▸ 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
AnchoredShape.getOpacityBlendMode
▸ getPainter(): EventDispatcher & IPainter | PainterFunction
Get painter function
EventDispatcher & IPainter | PainterFunction
▸ getParent(): Node
Return parent node
parent node
▸ getPreserveAspectRatio(): boolean
Returns true if aspect ratio is preserved
boolean
true if aspect ratio is preserved
AnchoredShape.getPreserveAspectRatio
▸ getPreserveReadingOrientation(): boolean
Returns true if the shape is always in a readable orientation
boolean
true if the shape is always in a readable orientation
AnchoredShape.getPreserveReadingOrientation
▸ getPreserveRightAngle(): boolean
Returns true if right angles are preserved
boolean
true if right angles are preserved
AnchoredShape.getPreserveRightAngle
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
properties
▸ 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
AnchoredShape.getRenderingFilter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
AnchoredShape.getResponsiveStyle
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
▸ getRotationAngle(): number
Returns rotation angle (in radians)
number
rotationAngle rotation angle at anchor
AnchoredShape.getRotationAngle
▸ getScaleScrollStrategy(): Delegate
Gets scale scroll strategy
scale scroll strategy
AnchoredShape.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
AnchoredShape.getSceneTransform
▸ getSize(): Dimension
Returns the size as a dimension object.
size
▸ getSizeIsInDeviceSpace(): boolean
Returns true if the shape size is set in device space
boolean
true if size is defined in device space
AnchoredShape.getSizeIsInDeviceSpace
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getUseMinMaxSize(): boolean
true if using the min max device space sizes
boolean
true if using the min max device space sizes
AnchoredShape.getUseMinMaxSize
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
▸ getWidth(): number
Return width of the shape
number
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
transform the world transform.
AnchoredShape.getWorldTransform
▸ getZIndex(): number
Returns node z-index (null if not set)
number
▸ hasCache(): boolean
Get cache flag
boolean
▸ 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
AnchoredShape.hasEventListener
▸ invalidate(bounds?, force?): SymbolShape
Invalidate area of the shape. This method invalidates parent by default. invalidated from parent to root node.
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | bounds of the invalid rectangle in the inner node coordinates |
Optional force | boolean | true if parent should be invalidated immediately if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed |
this
▸ invalidateParent(bounds?, force?): SymbolShape
Invalidate bounds
| Name | Type | Description |
|---|---|---|
Optional bounds | Rect | if null is provided then cache (if any will be completely refreshed) otherwise only specified rect or node.bounds will be refreshed |
Optional force | boolean | flag indicating if the parent must be forcibly invalidated |
this
AnchoredShape.invalidateParent
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isEventPropagationEnabled(): boolean
Return true if event propagation is enabled from child to parent
boolean
AnchoredShape.isEventPropagationEnabled
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
AnchoredShape.isNotificationEnabled
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(event, source, args?): SymbolShape
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
event | E | type of event |
source | AbstractNode | source who called the event |
Optional args | EventMap[E] | event arguments |
this
▸ off<E>(type?, callback?): SymbolShape
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: SymbolShape, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): SymbolShape
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: SymbolShape, args: EventMap[E]) => void | to be called |
this
▸ Protected onParentChanged(node): SymbolShape
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
AnchoredShape.onVisibilityChanged
▸ Protected postRendering(context): void
To be called after rendering. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ Protected preRendering(context): void
Occurs before rendering this method sets clipping by default. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
AnchoredShape.registerAnimationStyle
▸ removeCssClass(cssclass): SymbolShape
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
this
▸ removeInvalidateHandler(handler): SymbolShape
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
this
AnchoredShape.removeInvalidateHandler
▸ render(context): void
Renders node
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
void
▸ renderAsync(context, callback): void
Render node in asynchronous mode. Default implementation creates call method "render" inside
| Name | Type | Description |
|---|---|---|
context | RenderingContext | The rendering context to be used to draw the node |
callback | () => void | callback function |
void
▸ rotate(theta, x?, y?): SymbolShape
Rotate bounds around a given coordinate or anchor point
| Name | Type | Description |
|---|---|---|
theta | number | angle to rotate node, in radians |
Optional x | number | x coordinate to rotate around, use anchor-x if not specified |
Optional y | number | y coordinate to rotate around, use anchor-y if not specified |
this
▸ scale(xx, yy): SymbolShape
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
this
▸ setAnchor(p): SymbolShape
Sets anchor point to given position
| Name | Type | Description |
|---|---|---|
p | Point | point |
this
▸ setAnchor(x, y): SymbolShape
Sets anchor point to given position
| Name | Type | Description |
|---|---|---|
x | number | x coordinate |
y | number | y coordinate |
this
▸ setAnchorType(alignment): SymbolShape
Sets the anchor type.
| Name | Type | Description |
|---|---|---|
alignment | AnchorType | anchor alignment |
this
▸ setAnchorX(ax): SymbolShape
Sets x anchor position
| Name | Type | Description |
|---|---|---|
ax | number | anchor x position |
this
▸ setAnchorY(ay): SymbolShape
Sets y anchor position
| Name | Type | Description |
|---|---|---|
ay | number | anchor x position |
this
▸ setAnimationStyle(animationStyle): SymbolShape
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
AnchoredShape.setAnimationStyle
▸ setBounds(bounds): SymbolShape
Sets bounds of the node in the parent coordinates. This method takes anchor position and width and height if size is not in device space. This method was added to support layout.
| Name | Type | Description |
|---|---|---|
bounds | Rect | bound of the node in the parent coordinates |
this
▸ setCache(useCache): SymbolShape
Set cache flag
| Name | Type | Description |
|---|---|---|
useCache | boolean | cache flag |
this
▸ setClipStyle(style): SymbolShape
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
this
▸ setCss(style, merge?): SymbolShape
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): SymbolShape
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): SymbolShape
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
this
▸ setFillStyle(fillStyle, merge?): SymbolShape
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
▸ setHeight(height): SymbolShape
Sets height of the shape
| Name | Type | Description |
|---|---|---|
height | number | height of the shape |
this
▸ setId(id): SymbolShape
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
this
▸ setIsPointingUp(isPointingUp): SymbolShape
Sets whether the shape is always pointing up. Particularly useful for text.
| Name | Type | Description |
|---|---|---|
isPointingUp | boolean | flag setting whether the shape is always pointing up |
this
▸ setLayoutStyle(layoutStyle, merge?): SymbolShape
Specify desired layout style
| Name | Type | Description |
|---|---|---|
layoutStyle | LayoutStyle<string | number> | Options<string | number> | desired layout style |
Optional merge | boolean | true if you want to merge layoutStyle with existing attribute, false by default |
▸ setLineStyle(lineStyle, merge?): SymbolShape
Sets line style
| Name | Type | Description |
|---|---|---|
lineStyle | Type | line style or options |
Optional merge | boolean | true if you want to merge lineStyle with existing attribute, false by default |
this
▸ setLocalTransform(localTransform, force?): SymbolShape
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
AnchoredShape.setLocalTransform
▸ setMarginsStyle(margins, merge?): SymbolShape
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
▸ setMaxSize(maxSize): SymbolShape
sets the maximum device space rendering dimension
| Name | Type | Description |
|---|---|---|
maxSize | Dimension | maximum device space rendering dimension |
▸ setMinSize(minSize): SymbolShape
sets the minimum device space rendering dimension only works when setUseMinMaxSize is enabled.
| Name | Type | Description |
|---|---|---|
minSize | Dimension | minimum device space rendering dimension |
this
▸ setName(name): SymbolShape
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
this
▸ setNotification(notify, force?): SymbolShape
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?): SymbolShape
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
▸ setPainter(painter): SymbolShape
Sets painter function for this symbol.
| Name | Type | Description |
|---|---|---|
painter | Painter | painter function for this symbol |
this
▸ setPreserveAspectRatio(preserveAspectRatio): SymbolShape
Sets whether aspect ratio is preserved
| Name | Type | Description |
|---|---|---|
preserveAspectRatio | boolean | flag Sets whether aspect ratio is preserved |
this
AnchoredShape.setPreserveAspectRatio
▸ setPreserveReadingOrientation(preserveReadingOrientation): SymbolShape
Sets whether the shape is always in a readable orientation. Particularly useful for text. Prevents mirror effects
| Name | Type | Description |
|---|---|---|
preserveReadingOrientation | boolean | sets flag whether the shape is always in a readable orientation |
this
AnchoredShape.setPreserveReadingOrientation
▸ setPreserveRightAngle(preserveRightAngle): SymbolShape
Sets whether right angles are preserved
| Name | Type | Description |
|---|---|---|
preserveRightAngle | boolean | flag setting if right angles are preserved |
this
AnchoredShape.setPreserveRightAngle
▸ setProperties(properties?): SymbolShape
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | object containing the properties to set |
this
▸ setProperty(name, value): SymbolShape
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
this
▸ setRenderingFilter(filter): SymbolShape
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
this
AnchoredShape.setRenderingFilter
▸ setResponsiveStyle(style): SymbolShape
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
this
AnchoredShape.setResponsiveStyle
▸ setRotationAngle(rotationAngle): SymbolShape
Set rotation angle
| Name | Type | Description |
|---|---|---|
rotationAngle | number | rotation angle (in radians) at anchor |
this
AnchoredShape.setRotationAngle
▸ setScaleScrollStrategy(strategy?): SymbolShape
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
this
AnchoredShape.setScaleScrollStrategy
▸ setSelectable(selectable): SymbolShape
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): SymbolShape
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setSize(width, height?): SymbolShape
Sets size of the shape, will accept a width and height number or a Dimension object.
| Name | Type | Description |
|---|---|---|
width | number | Dimension | Options | width of the shape |
Optional height | number | height of the shape |
this
▸ setSizeIsInDeviceSpace(sizeIsInDeviceSpace): SymbolShape
Sets whether the shape size is set in device space.
| Name | Type | Description |
|---|---|---|
sizeIsInDeviceSpace | boolean | true if the shape size is fixed in device space; otherwise, false. |
this
AnchoredShape.setSizeIsInDeviceSpace
▸ setTag(tag): SymbolShape
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
▸ setUseMinMaxSize(useMinMaxSize): SymbolShape
Sets whether to use the min max device space sizes
| Name | Type | Description |
|---|---|---|
useMinMaxSize | boolean | true if using the min max device space sizes otherwise, false. |
this
AnchoredShape.setUseMinMaxSize
▸ setVisible(value): SymbolShape
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
this
▸ setWidth(width): SymbolShape
Sets width of the shape
| Name | Type | Description |
|---|---|---|
width | number | width of the shape |
this
▸ setZIndex(value): SymbolShape
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
this
▸ shear(shx, shy): SymbolShape
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
this
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): SymbolShape
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
AnchoredShape.unregisterAnimationStyle
▸ updateSceneTransformation(): SymbolShape
Update scene transformation
this
AnchoredShape.updateSceneTransformation
▸ updateState(regions?, changes?): SymbolShape
Update state. These methods reset node state and update state for children. this method is useful to refresh a scene graph
| Name | Type | Description |
|---|---|---|
Optional regions | Rect[] | optional array to return invalid rectangles in the parent coordinates |
Optional changes | StateChanges | optional parameter to specify a reason of changes |
this
▸ Protected updateTimeStamp(): SymbolShape
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
AnchoredShape.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 getAnchorPosition(rect, anchorType): Point
Return anchor position
| Name | Type | Description |
|---|---|---|
rect | Rect | rectangle to get anchor position |
anchorType | AnchorType | anchor type |
anchor
AnchoredShape.getAnchorPosition
▸ Static getClassName(): string
string
▸ Static intersectsBounds(bounds, localTransformation, parentInvalidArea, expand?): boolean
Check collision of the shape bounds with parent invalid area
| Name | Type | Description |
|---|---|---|
bounds | Rect | shape bounds |
localTransformation | Transformation | local transformation of the bounds |
parentInvalidArea | Rect | invalid parent area |
Optional expand | Dimension | optional expand the bounds in model coordinate |
boolean
true if bounds intersect the invalid area
AnchoredShape.intersectsBounds
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean