| Package | com.yworks.canvas |
| Interface | public interface ICanvasObject |
CanvasComponent.
The interface is not meant to be implemented by application programmers. Instead, instances implementing this interface can be retrieved from the factory methods in the graph canvas component.
| Property | Defined By | ||
|---|---|---|---|
| descriptor : ICanvasObjectDescriptor
Gets or sets the descriptor instance that interprets the userObject
during rendering, hit testing, and bounds calculation. | ICanvasObject | ||
| dirty : Boolean
Gets or sets whether the canvas object is dirty and should be repainted. | ICanvasObject | ||
| group : ICanvasObjectGroup
Gets or sets the parent group of this instance. | ICanvasObject | ||
| next : ICanvasObject [read-only]
Gets the next item in the list of rendered
items that is owned by this element's group. | ICanvasObject | ||
| previous : ICanvasObject [read-only]
Gets the previous item in the list of rendered
items that is owned by this element's group. | ICanvasObject | ||
| userObject : Object
Gets or sets the user object associated with this instance. | ICanvasObject | ||
| visible : Boolean
Gets or sets the visibility state of this instance. | ICanvasObject | ||
| Method | Defined By | ||
|---|---|---|---|
Moves this instance exactly behind the reference item in the referenced item's group
rendering list, so that it will
be painted directly on top of the given reference. | ICanvasObject | ||
Moves this instance exactly before the reference item in the referenced item's group
rendering list, so that it will
be painted directly behind the given reference. | ICanvasObject | ||
Moves this instance one step closer to the beginning of the group rendering list, so that it will
be painted behind its current predecessor. | ICanvasObject | ||
Moves this instance one step closer to the end of the group rendering list, so that it will
be painted on top of its current successor. | ICanvasObject | ||
remove():void
Removes this item from the canvas object tree it currently belongs to. | ICanvasObject | ||
Moves this instance to the beginning of the group rendering list, so that it will be painted
behind all other items in the same group. | ICanvasObject | ||
Moves this instance to the end of the group rendering list, so that it will be painted
in front of all other items in the same group. | ICanvasObject | ||
| descriptor | property |
descriptor:ICanvasObjectDescriptor
Gets or sets the descriptor instance that interprets the userObject
during rendering, hit testing, and bounds calculation.
public function get descriptor():ICanvasObjectDescriptor public function set descriptor(value:ICanvasObjectDescriptor):void| dirty | property |
dirty:BooleanGets or sets whether the canvas object is dirty and should be repainted.
public function get dirty():Boolean public function set dirty(value:Boolean):void| group | property |
group:ICanvasObjectGroupGets or sets the parent group of this instance.
public function get group():ICanvasObjectGroup public function set group(value:ICanvasObjectGroup):void| next | property |
next:ICanvasObject [read-only]
Gets the next item in the list of rendered
items that is owned by this element's group.
public function get next():ICanvasObject| previous | property |
previous:ICanvasObject [read-only]
Gets the previous item in the list of rendered
items that is owned by this element's group.
public function get previous():ICanvasObject| userObject | property |
userObject:ObjectGets or sets the user object associated with this instance.
The user object will be used by the descriptor during
rendering, hit testing, and bounds calculation.
public function get userObject():Object public function set userObject(value:Object):void| visible | property |
visible:BooleanGets or sets the visibility state of this instance.
If an ICanvasObject is not visible, it will not be considered for hit tests.
public function get visible():Boolean public function set visible(value:Boolean):void| after | () | method |
public function after(reference:ICanvasObject):ICanvasObjectMoves this instance exactly behind the reference item in the referenced item's group rendering list, so that it will be painted directly on top of the given reference.
Observe that this instance will change into the referenced item's group if needed.
Parameters
reference:ICanvasObject — The item this instance is to moved behind.
|
ICanvasObject — this so that calls can be chained.
|
| before | () | method |
public function before(reference:ICanvasObject):ICanvasObjectMoves this instance exactly before the reference item in the referenced item's group rendering list, so that it will be painted directly behind the given reference.
Observe that this instance will change into the referenced item's group if needed.
Parameters
reference:ICanvasObject — the item this instance is to moved before.
|
ICanvasObject — this so that calls can be chained.
|
| lower | () | method |
public function lower():ICanvasObjectMoves this instance one step closer to the beginning of the group rendering list, so that it will be painted behind its current predecessor.
ReturnsICanvasObject — this so that calls can be chained.
|
| raise | () | method |
public function raise():ICanvasObjectMoves this instance one step closer to the end of the group rendering list, so that it will be painted on top of its current successor.
ReturnsICanvasObject — this so that calls can be chained.
|
| remove | () | method |
public function remove():voidRemoves this item from the canvas object tree it currently belongs to.
| toBack | () | method |
public function toBack():ICanvasObjectMoves this instance to the beginning of the group rendering list, so that it will be painted behind all other items in the same group.
ReturnsICanvasObject — this so that calls can be chained.
|
| toFront | () | method |
public function toFront():ICanvasObjectMoves this instance to the end of the group rendering list, so that it will be painted in front of all other items in the same group.
ReturnsICanvasObject — this so that calls can be chained.
|