This is the interface implemented by the basic building blocks of a scene graph in a CanvasComponent.
Remarks
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.view.ICanvasObject
See Also
Properties
Gets or sets the descriptor instance that interprets the userObject during rendering, hit testing, and bounds calculation.
Gets or sets a flag that indicates whether ICanvasObject needs to be updated during the next call to invalidate.
Remarks
false if the visual is created or updated.See Also
Gets or sets the parent group of this instance.
Gets the next item in the list of rendered items that is owned by this element's group.
Remarks
null.Gets the previous item in the list of rendered items that is owned by this element's group.
Remarks
null.Gets or sets the user object associated with this instance.
Remarks
See Also
Gets or sets the visibility state of this instance.
Remarks
See Also
Methods
Moves this instance exactly behind the reference item in the referenced item's group rendering list, so that it will be rendered directly above the given reference.
Remarks
This method returns the current instance so that calls can be chained, e.g. object.Above(other).Raise().
Observe that this instance will move into the referenced item's group if needed.
Returns
- ↪ICanvasObject
thisso that calls can be chained.
See Also
Moves this instance exactly before the reference item in the referenced item's group rendering list, so that it will be rendered directly behind the given reference.
Remarks
This method returns the current instance so that calls can be chained, e.g. object.Below(other).Lower().
Observe that this instance will move into the referenced item's group if needed.
Returns
- ↪ICanvasObject
thisso that calls can be chained.
See Also
Moves this instance one step closer to the beginning of the group rendering list, so that it will be rendered behind its current predecessor.
Remarks
object.Lower().Lower()Returns
- ↪ICanvasObject
thisso that calls can be chained.
Moves this instance one step closer to the end of the group rendering list, so that it will be rendered on top of its current successor.
Remarks
object.Raise().Raise().Raise()Returns
- ↪ICanvasObject
thisso that calls can be chained.
Removes this item from the scene graph it currently belongs to.
See Also
Moves this instance to the beginning of the group rendering list, so that it will be rendered behind all other items in the same group.
Remarks
object.ToBack().Raise().Raise()Returns
- ↪ICanvasObject
thisso that calls can be chained.
Moves this instance to the end of the group rendering list, so that it will be rendered in front of all other items in the same group.
Remarks
object.ToFront().Lower()Returns
- ↪ICanvasObject
thisso that calls can be chained.