documentationfor yFiles for HTML 2.6

Usages of ICanvasObject

Properties

nextSiblingin ICanvasObjectGets the next item in the list of rendered items that is owned by this element's group.
previousSiblingin ICanvasObjectGets the previous item in the list of rendered items that is owned by this element's group.
firstChildin ICanvasObjectGroupGets the first item in the rendering list of this group or null.
lastChildin ICanvasObjectGroupGets the last item in the rendering list of this group or null.

Method Return Values

createSourceGhost (IInputModeContext)in ReparentStripePositionHandlerCreate a ghost object for the source region of the reparent gesture.
createTargetGhost (IInputModeContext, IStripe)in ReparentStripePositionHandlerCreate a ghost visualization for the target region of the reparent gesture.
updateSourceGhost (IInputModeContext, ICanvasObject, IStripe, StripeReparentPolicy)in ReparentStripePositionHandlerUpdates the source ghost visualization after a drag.
updateTargetGhost (IInputModeContext, ICanvasObject, IStripe, StripeReparentPolicy, Rect)in ReparentStripePositionHandlerModifies the target ghost visualization after a drag.
getCanvasObject (Point)in CanvasComponentReturns the top most canvas object instance that is hit at the given coordinate set.
getCanvasObjects (ICanvasObjectGroup?)in CanvasComponentEnumerates over all possible ICanvasObject instances in the tree below the given group.
getCanvasObjects (Point)in CanvasComponentReturns a list of all canvas objects in hit order at the given world coordinate location.
hitElementsAt (Point, ICanvasObjectGroup?, function(ICanvasObject):boolean?)in CanvasComponentEnumerates all hit elements in the canvas below the given group that are accepted by a given filter.
hitElementsAt (IInputModeContext, Point, ICanvasObjectGroup?, function(ICanvasObject):boolean?)in CanvasComponentEnumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific ICanvasContext as the argument to the isHit method.
addCanvasObject (ICanvasContext, ICanvasObjectGroup, Object)in EdgeDecorationInstallerInstalls a rendering for the item if it is an IEdge that will use the getBendDrawing and getStroke to render the path and bends.
addCanvasObject (ICanvasContext, ICanvasObjectGroup, Object)in EdgeStyleDecorationInstallerInstalls a rendering for the item if it is an IEdge.
addItem (T)in FocusIndicatorManagerOverridden to do nothing.
getCanvasObject (IModelItem)in GraphModelManagerRetrieves the ICanvasObject visualizing a given model item managed by this instance.
getMainCanvasObject (IModelItem)in GraphModelManagerRetrieves the ICanvasObject for a given model item that can be used for z-order or visibility operations.
above (ICanvasObject)in ICanvasObjectMoves 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.
below (ICanvasObject)in ICanvasObjectMoves 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.
lower ()in ICanvasObjectMoves this instance one step closer to the beginning of the group rendering list, so that it will be rendered behind its current predecessor.
raise ()in ICanvasObjectMoves 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.
toBack ()in ICanvasObjectMoves this instance to the beginning of the group rendering list, so that it will be rendered behind all other items in the same group.
toFront ()in ICanvasObjectMoves 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.
addChild (Object, ICanvasObjectDescriptor?)in ICanvasObjectGroupAdds a child element to the scene graph as a child of this group.
addCanvasObject (ICanvasContext, ICanvasObjectGroup, Object)in ICanvasObjectInstallerThis the main method of the interface that performs the installation of an item's visual representation in the canvas by adding ICanvasObjects.
getCanvasObject (T)in ItemModelManagerRetrieves the canvas object that has been registered for the given item or null.
install (T)in ItemModelManagerInstalls a member of the collection into the canvas using the descriptor.
addCanvasObject (ICanvasContext, ICanvasObjectGroup, Object)in LabelStyleDecorationInstallerInstalls a rendering for the item if it is an ILabel.
addItem (T)in ModelManagerInstalls an item and adds it to this managers set of managed items.
installItem (T)in ModelManagerInstalls a member of the collection into the canvas using the ICanvasObjectDescriptor which is returned by getInstaller.
addCanvasObject (ICanvasContext, ICanvasObjectGroup, Object)in NodeStyleDecorationInstallerInstalls a rendering for the item if it is an INode.
addCanvasObject (ICanvasContext, ICanvasObjectGroup, Object)in OrientedRectangleIndicatorInstaller
addCanvasObject (ICanvasContext, ICanvasObjectGroup, Object)in PointSelectionIndicatorInstaller
addCanvasObject (ICanvasContext, ICanvasObjectGroup, Object)in PortStyleDecorationInstallerInstalls a rendering for the item if it is an IPort.
addCanvasObject (ICanvasContext, ICanvasObjectGroup, Object)in RectangleIndicatorInstaller
addSelection (T)in SelectionIndicatorManagerAdds an item to the current selection.
addItem (IModelItem)in WebGL2HighlightIndicatorManager
addSelection (IModelItem)in WebGL2SelectionIndicatorManager

Method Parameters

updateSourceGhost (IInputModeContext, ICanvasObject, IStripe, StripeReparentPolicy)in ReparentStripePositionHandlerUpdates the source ghost visualization after a drag.
updateTargetGhost (IInputModeContext, ICanvasObject, IStripe, StripeReparentPolicy, Rect)in ReparentStripePositionHandlerModifies the target ghost visualization after a drag.
compareRenderOrder (ICanvasObject, ICanvasObject)in CanvasComponentCompares two ICanvasObject instances that are live in this canvas.
getBounds (ICanvasObject)in CanvasComponentCalculates the bounds for a given canvas object in the scene graph.
getVisual (ICanvasObject)in CanvasComponentGets the Visual that is currently visualizing the given ICanvasObject.
getVisualCreator (ICanvasObject)in CanvasComponentRetrieves the IVisualCreator for a given ICanvasObject.
hitElementsAt (Point, ICanvasObjectGroup?, function(ICanvasObject):boolean?)in CanvasComponentEnumerates all hit elements in the canvas below the given group that are accepted by a given filter.
hitElementsAt (IInputModeContext, Point, ICanvasObjectGroup?, function(ICanvasObject):boolean?)in CanvasComponentEnumerates all hit elements in the canvas below the given group that are accepted by a given filter using a specific ICanvasContext as the argument to the isHit method.
isHit (ICanvasObject, Point)in CanvasComponentCalculates the hit tests a given canvas object in the scene graph.
getItem (ICanvasObject)in CollectionModelManager
isDirty (ICanvasContext, ICanvasObject)in DefaultPortCandidateDescriptor
getModelItem (ICanvasObject)in GraphModelManagerRetrieves the corresponding IModelItem for the given canvas object.
above (ICanvasObject)in ICanvasObjectMoves 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.
below (ICanvasObject)in ICanvasObjectMoves 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.
isDirty (ICanvasContext, ICanvasObject)in ICanvasObjectDescriptorDetermines whether the given canvas object is deemed dirty and needs updating.
getItem (ICanvasObject)in ItemModelManagerTries to find the item managed by this instance that is associated with the given canvas object.
uninstallItem (ICanvasObject)in ModelManagerRemoves the given ICanvasObject.

Implementing Types

ICanvasObjectGroupThis is the interface implemented by the composite building blocks of a scene graph in a CanvasComponent.