API / geotoolkit / scene / shapes / tiledshape / TiledShape / TiledShape
tiledshape.TiledShape.TiledShape
Defines a shape which displays tiled images
| Name | Type |
|---|---|
TFormatResult | extends object = ImageData |
↳
TiledShape↳↳
SeismicImage
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
bottom | number | Y coordinate of the bottom right corner (if 'height' not specified) |
bounds | Rect | Bounds |
bounds-height | number | Height |
bounds-readonly | boolean | Readonly |
bounds-width | number | Width |
bounds-x | number | Left |
bounds-y | number | Top |
clipstyle | ClipStyle | Clipping style |
clipstyle-evenodd | boolean | True if evenodd mode is on ('nonzero' mode otherwise) |
clipstyle-geometry | GraphicsPath | Clipping geometry |
clipstyle-geometry-bounds | Rect | Bounds |
clipstyle | GraphicsPath | Clipping style |
cssclass | string | The css class name of this node |
csscursor | string | CSS cursor associated with node |
cssstyle | string | CSS style to be applied to inserted elements |
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 | Height (if 'bottom' not specified) |
id | string | number | Id of the node, its a unique identifier |
left | number | X coordinate of the top left corner |
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 |
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 |
right | number | X coordinate of the bottom right corner (if 'width' not specified) |
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 |
top | number | Y coordinate of the top left corner |
transform | string | Additional CSS transformation applied to node or 'none' |
transform | Transformation | Additional CSS transformation applied to node or 'none' |
visible | boolean | Visibility of the node, a boolean to determine if the node should be rendered or not |
width | number | Width (if 'right' not specified) |
z-index | number | Define node z-index |
Constructors
• new TiledShape<TFormatResult>(options?)
| Name | Type |
|---|---|
TFormatResult | extends object = ImageData |
| Name | Type |
|---|---|
Optional options | Options<TFormatResult> |
RectangularShape.constructor
Methods
▸ addCssClass(cssclass): TiledShape<TFormatResult>
Adds new css class to node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
TiledShape<TFormatResult>
this
▸ addInvalidateHandler(handler): TiledShape<TFormatResult>
Add invalidate handler
Deprecated
since 4.0, use Node.on instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
TiledShape<TFormatResult>
this
RectangularShape.addInvalidateHandler
▸ Protected applyOpacity(context): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
▸ Protected applyResponsiveStyle(): void
Apply a responsive style rules it is exists
void
RectangularShape.applyResponsiveStyle
▸ checkCollision(context): boolean
Check collision
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
boolean
true if object is inside of rendering area
RectangularShape.checkCollision
▸ clone(): Node
All subclasses should override copyConstructor or provide custom implementation for this method
clone
▸ connectStyle(style, type, callback): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
▸ Protected copyConstructor(src, deepCopy?): TiledShape<TFormatResult>
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 | TiledShape<TFormatResult> | Source to copy from |
Optional deepCopy | boolean | deep copy |
TiledShape<TFormatResult>
this
RectangularShape.copyConstructor
▸ disconnectStyle(style, type, callback): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
RectangularShape.disconnectStyle
▸ 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
▸ Protected disposeBackgroundManager(): TiledShape<TFormatResult>
TiledShape<TFormatResult>
▸ enableEventPropagation(enable): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
RectangularShape.enableEventPropagation
▸ execute(delegate): TiledShape<TFormatResult>
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: TiledShape<TFormatResult>) => void | Function to execute |
TiledShape<TFormatResult>
The result if any or this
▸ execute<T>(delegate): T
| Name |
|---|
T |
| Name | Type |
|---|---|
delegate | (this: TiledShape<TFormatResult>) => 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)
▸ getAnimationStyle(): AnimationStyle
Return animation style
animationStyle current animation style
RectangularShape.getAnimationStyle
▸ getBounds(): Rect
Return bounds. Will also lock the bounds so they cannot be directly modified.
bounds
▸ getCenterX(): number
Returns the X coordinate of the center of the framing rectangle of this rectangular shape.
number
▸ getCenterY(): number
Returns the Y coordinate of the center of the framing rectangle of this rectangular shape.
number
▸ getClassName(): string
string
▸ getClipStyle(): ClipStyle
Gets the current clipping style
clipping style
▸ getCollectPerformanceInformation(): boolean
Gets collect performance information mode enabled
boolean
true if collection performance information mode enabled
▸ getContentsTransform(): Transformation
Returns transformation
▸ 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[]
RectangularShape.getCssClasses
▸ getCssTransform(): string
Returns CSS transformation
string
RectangularShape.getCssTransform
▸ getFillStyle(): FillStyle
Return fill style
fillStyle current fill style
▸ getHeight(): number
Returns the height of the framing rectangle.
number
▸ getId(): string | number
Returns the associated identifier of the node
string | number
The node's id
▸ Protected getImageToBoundsTransform(): Transformation
Transformation of inner contents to bounds
▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>
Gets invalidate method
AttributeCallback<EventDispatcher>
method to invalidate this object
RectangularShape.getInvalidateMethod
▸ getLayoutStyle(): LayoutStyle<string | number>
Return desired layout style
LayoutStyle<string | number>
RectangularShape.getLayoutStyle
▸ getLineStyle(): LineStyle
Return line style
lineStyle current line style
▸ getLocalTransform(): Transformation
Retrieves the transformation of bounds to parent
transform the local transform.
RectangularShape.getLocalTransform
▸ getMarginsStyle(): SpaceStyle<string | number>
Return margins style
SpaceStyle<string | number>
RectangularShape.getMarginsStyle
▸ getModelArea(): Rect
Gets image size of the tiled shape
▸ 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
RectangularShape.getOpacityBlendMode
▸ getOptions(): Options<TFormatResult>
Gets options
Options<TFormatResult>
object with parameters
▸ getParent(): Node
Return parent node
parent node
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
properties
RectangularShape.getProperties
▸ getProperty(name): any
Gets dynamic property by name. These properties can be used as a property bags
| Name | Type | Description |
|---|---|---|
name | string | property name |
any
▸ getPropertyKeys(): string[]
Returns known properties keys
string[]
RectangularShape.getPropertyKeys
▸ getRenderingFilter(): IFilter
Return filter to be used for rendering and picking
current filter
RectangularShape.getRenderingFilter
▸ getResponsiveStyle(): ResponsiveStyle
Return responsive style
RectangularShape.getResponsiveStyle
▸ getRoot(): Node
Returns root node.
If node doesn't have parent then it returns itself.
the root node
▸ getScaleScrollStrategy(): Delegate
Gets scale scroll strategy
scale scroll strategy
RectangularShape.getScaleScrollStrategy
▸ getSceneTransform(): Transformation
Returns transformation from node to root scene
a transformation from node to root scene
RectangularShape.getSceneTransform
▸ getTag(): any
Returns the object associated with the node by user.
any
The node's user-object
▸ getVisible(): boolean
Return visibility of the node
boolean
true if node is visible
▸ getVisibleModelLimits(): Rect
Returns model visible limits
▸ getWidth(): number
Returns the width of the framing rectangle.
number
▸ getWorldTransform(): Transformation
Retrieves the local transformation of the node which represents multiplication of parent to bounds and contents transformations.
transform the world transform.
RectangularShape.getWorldTransform
▸ getX(): number
Returns the X coordinate of the left bottom corner of the framing rectangle.
number
▸ getY(): number
Returns the Y coordinate of the left bottom corner of the framing rectangle.
number
▸ 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
RectangularShape.hasEventListener
▸ invalidate(bounds?, force?): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
▸ invalidateLayout(): TiledShape<TFormatResult>
Notify that layout is invalidated. Send event Events.LayoutInvalidated
TiledShape<TFormatResult>
this
RectangularShape.invalidateLayout
▸ invalidateParent(bounds?, force?): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
RectangularShape.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
RectangularShape.isEventPropagationEnabled
▸ isNotificationEnabled(): boolean
return state of notification
boolean
current notification state
RectangularShape.isNotificationEnabled
▸ isSelectable(): boolean
Returns true if node can be picked/selected.
boolean
The selectable flag
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): TiledShape<TFormatResult>
Notify listeners of the Node
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event |
source | TiledShape<TFormatResult> | source who called the event |
Optional args | EventMap[E] | event arguments |
TiledShape<TFormatResult>
this
▸ off<E>(type?, callback?): TiledShape<TFormatResult>
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: TiledShape<TFormatResult>, args: EventMap[E]) => void | function to be called |
TiledShape<TFormatResult>
this
▸ on<E>(type, callback): TiledShape<TFormatResult>
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: TiledShape<TFormatResult>, args: EventMap[E]) => void | to be called |
TiledShape<TFormatResult>
this
▸ Protected onAllTilesRendered(): void
All requested tiles are rendered
void
▸ Protected onParentChanged(node): TiledShape<TFormatResult>
This method is called when parent changes. Do not call it directly.
| Name | Type | Description |
|---|---|---|
node | Node | node to change parent |
TiledShape<TFormatResult>
this
RectangularShape.onParentChanged
▸ Protected onRectChanged(newRect): TiledShape<TFormatResult>
| Name | Type |
|---|---|
newRect | Rect |
TiledShape<TFormatResult>
RectangularShape.onRectChanged
▸ Protected onStartTilesLoading(): void
The first tile is started loading
void
▸ Protected onVisibilityChanged(): void
This method is called if visibility is changed. Send event Events.VisibilityChanged
void
RectangularShape.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
RectangularShape.postRendering
▸ Protected preRendering(context): void
Occurs before rendering this method sets clipping by default. Call this method if you override method render
| Name | Type | Description |
|---|---|---|
context | RenderingContext | Rendering Context |
void
▸ registerAnimationStyle(root): void
Register animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
RectangularShape.registerAnimationStyle
▸ removeCssClass(cssclass): TiledShape<TFormatResult>
Removes css class from node
| Name | Type | Description |
|---|---|---|
cssclass | string | string[] | css class name('s) |
TiledShape<TFormatResult>
this
RectangularShape.removeCssClass
▸ removeInvalidateHandler(handler): TiledShape<TFormatResult>
Remove invalidate handler
Deprecated
since 4.0, use Node.off instead
| Name | Type | Description |
|---|---|---|
handler | Function | handler to be notified about invalidation |
TiledShape<TFormatResult>
this
RectangularShape.removeInvalidateHandler
▸ render(context): void
Render method, overrides render method of the parent. Calculates tiles required for the invalidated area (all the calculations are made in device coordinates), renders existing ones, or requests non existing ones
| Name | Type | Description |
|---|---|---|
context | RenderingContext | a rendering context |
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): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
▸ scale(xx, yy): TiledShape<TFormatResult>
Scale node
| Name | Type | Description |
|---|---|---|
xx | number | x scale factor |
yy | number | y scale factor |
TiledShape<TFormatResult>
this
▸ setAnimationStyle(animationStyle): TiledShape<TFormatResult>
Sets animation style
| Name | Type | Description |
|---|---|---|
animationStyle | Type | animation style |
TiledShape<TFormatResult>
RectangularShape.setAnimationStyle
▸ setBounds(rect): TiledShape<TFormatResult>
Sets the location and size of the framing rectangle of this rectangular shape to the specified values. This method is the same as setRect.
| Name | Type | Description |
|---|---|---|
rect | Rect | bounds rect |
TiledShape<TFormatResult>
this
▸ setBounds(x1, y1?, x2?, y2?): TiledShape<TFormatResult>
Sets the location and size of the framing rectangle of this rectangular shape to the specified values. This method is the same as setRect.
| Name | Type | Description |
|---|---|---|
x1 | number | x coordinate of the top left corner |
Optional y1 | number | y coordinate of the top left corner |
Optional x2 | number | x coordinate of the bottom right corner |
Optional y2 | number | y coordinate of the bottom right corner |
TiledShape<TFormatResult>
this
▸ setClipStyle(style): TiledShape<TFormatResult>
Sets a new clipping style
| Name | Type | Description |
|---|---|---|
style | GraphicsPath | ClipStyle | Options | a new clipping style |
TiledShape<TFormatResult>
this
▸ setCollectPerformanceInformation(collectPerformanceInfoEnabled): TiledShape<TFormatResult>
Sets collect performance information mode enabled
| Name | Type | Description |
|---|---|---|
collectPerformanceInfoEnabled | boolean | true for collection performance information mode enabled |
TiledShape<TFormatResult>
this
▸ setCss(style, merge?): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
▸ setCssClass(name): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
▸ setCssTransform(transform): TiledShape<TFormatResult>
Set CSS transformation
| Name | Type | Description |
|---|---|---|
transform | string | Transformation | transformation css transformation instruction or Transformation instance |
TiledShape<TFormatResult>
this
RectangularShape.setCssTransform
▸ setFillStyle(fillStyle, merge?): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
▸ setId(id): TiledShape<TFormatResult>
Allows the user to associate any identifier
| Name | Type | Description |
|---|---|---|
id | string | number | object id |
TiledShape<TFormatResult>
this
▸ setLayoutStyle(layoutStyle, merge?): TiledShape<TFormatResult>
Specify desired layout style
| Name | Type | Description |
|---|---|---|
layoutStyle | LayoutStyle<string | number> | Options<string | number> | desired layout style or layout style params |
Optional merge | boolean | true if you want to merge layoutStyle with existing attribute, false by default |
TiledShape<TFormatResult>
RectangularShape.setLayoutStyle
▸ setLineStyle(lineStyle, merge?): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
▸ setLocalTransform(localTransform, force?): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
RectangularShape.setLocalTransform
▸ setMarginsStyle(margins, merge?): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
RectangularShape.setMarginsStyle
▸ setName(name): TiledShape<TFormatResult>
Sets name of the node
| Name | Type | Description |
|---|---|---|
name | string | The node name |
TiledShape<TFormatResult>
this
▸ setNotification(notify, force?): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
RectangularShape.setNotification
▸ setOpacity(opacity, blendMode?): TiledShape<TFormatResult>
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. |
TiledShape<TFormatResult>
this
▸ setOptions(options): TiledShape<TFormatResult>
Sets options
| Name | Type | Description |
|---|---|---|
options | Options<TFormatResult> | object with parameters |
TiledShape<TFormatResult>
this
▸ setProperties(properties?): TiledShape<TFormatResult>
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | object containing the properties to set |
TiledShape<TFormatResult>
RectangularShape.setProperties
▸ setProperty(name, value): TiledShape<TFormatResult>
Sets dynamic property by name
| Name | Type | Description |
|---|---|---|
name | string | property name |
value | any | property value |
TiledShape<TFormatResult>
this
▸ setRect(rect): TiledShape<TFormatResult>
Sets the location and size of the framing rectangle of this rectangular shape to the specified values.
| Name | Type | Description |
|---|---|---|
rect | Rect | rect |
TiledShape<TFormatResult>
▸ setRect(params): TiledShape<TFormatResult>
Sets the location and size of the framing rectangle of this rectangular shape to the specified values.
| Name | Type | Description |
|---|---|---|
params | Options | rect params |
TiledShape<TFormatResult>
▸ setRect(x1, y1, x2, y2): TiledShape<TFormatResult>
Sets the location and size of the framing rectangle of this rectangular shape to the specified values.
| Name | Type | Description |
|---|---|---|
x1 | number | x coordinate of the top left corner |
y1 | number | y coordinate of the top left corner |
x2 | number | x coordinate of the bottom right corner |
y2 | number | y coordinate of the bottom right corner |
TiledShape<TFormatResult>
▸ setRenderingFilter(filter): TiledShape<TFormatResult>
Sets filter to be applied before rendering and picking
| Name | Type | Description |
|---|---|---|
filter | IFilter | filter to set |
TiledShape<TFormatResult>
this
RectangularShape.setRenderingFilter
▸ setResponsiveStyle(style): TiledShape<TFormatResult>
Sets responsive style.
| Name | Type | Description |
|---|---|---|
style | Options | ResponsiveStyle | responsive style |
TiledShape<TFormatResult>
this
RectangularShape.setResponsiveStyle
▸ setScaleScrollStrategy(strategy?): TiledShape<TFormatResult>
Sets scale scroll strategy
| Name | Type | Description |
|---|---|---|
Optional strategy | Delegate | scale scroll strategy |
TiledShape<TFormatResult>
this
RectangularShape.setScaleScrollStrategy
▸ setSelectable(selectable): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
RectangularShape.setSelectable
▸ setSilent(bool): TiledShape<TFormatResult>
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
TiledShape<TFormatResult>
this
▸ setTag(tag): TiledShape<TFormatResult>
Allows the user to associate any arbitrary object with the node.
| Name | Type | Description |
|---|---|---|
tag | any | The object to be associated with the node. |
TiledShape<TFormatResult>
this
▸ setVisible(value): TiledShape<TFormatResult>
Sets visibility of the node. Send event Events.VisibilityChanged
| Name | Type | Description |
|---|---|---|
value | boolean | flag specifying visibility of the node |
TiledShape<TFormatResult>
this
▸ setZIndex(value): TiledShape<TFormatResult>
Sets z-index for node (set null for default)
| Name | Type | Description |
|---|---|---|
value | number | index determining node z-position |
TiledShape<TFormatResult>
this
▸ shear(shx, shy): TiledShape<TFormatResult>
Shear this node's bounds
| Name | Type | Description |
|---|---|---|
shx | number | x-axis shear |
shy | number | y-axis shear |
TiledShape<TFormatResult>
this
▸ toString(): string
Returns a string representation of this object (generally the classname)
string
A string representation
▸ translate(tx, ty): TiledShape<TFormatResult>
Translate bounds
| Name | Type | Description |
|---|---|---|
tx | number | x translation |
ty | number | y translation |
TiledShape<TFormatResult>
this
▸ unregisterAnimationStyle(root): void
Unregister animation style.
| Name | Type | Description |
|---|---|---|
root | Node | root node for node |
void
RectangularShape.unregisterAnimationStyle
▸ updateSceneTransformation(): TiledShape<TFormatResult>
Update scene transformation
TiledShape<TFormatResult>
this
RectangularShape.updateSceneTransformation
▸ updateState(regions?, changes?): TiledShape<TFormatResult>
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 |
TiledShape<TFormatResult>
this
▸ Protected updateTimeStamp(): TiledShape<TFormatResult>
Update time stamp to indicate that Node or Children has been changed.
TiledShape<TFormatResult>
this
RectangularShape.updateTimeStamp
▸ Static enableSceneGraphNotification(enabled): void
Enable / disable all notifications
| Name | Type | Description |
|---|---|---|
enabled | boolean | sets if this object sends notifications |
void
RectangularShape.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 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
RectangularShape.intersectsBounds
▸ Static isSceneGraphNotificationEnabled(): boolean
Return status of the global notification for all nodes.
boolean