documentationfor yFiles for HTML 3.0.0.3

Properties

nextSiblingin IRenderTreeElementGets the next element, i.e., the element above this element in the parent.
previousSiblingin IRenderTreeElementGets the previous element, i.e., the element below this element in the parent.
firstChildin IRenderTreeGroupGets the first element of this group or null.
lastChildin IRenderTreeGroupGets the last element of this group or null.
renderOrderComparatorin RenderTreeGets an comparison instance that compares two IRenderTreeElement with respect to their rendering order.

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, IRenderTreeElement, IStripe, StripeReparentPolicy)in ReparentStripePositionHandlerUpdates the source ghost visualization after a drag.
updateTargetGhost (IInputModeContext, IRenderTreeElement, IStripe, StripeReparentPolicy, Rect)in ReparentStripePositionHandlerModifies the target ghost visualization after a drag.
addItem (T)in FocusIndicatorManagerOverridden to do nothing.
getMainRenderTreeElement (IModelItem)in GraphModelManagerRetrieves the IRenderTreeElement for a given model item that can be used for z-order or visibility operations.
getRenderTreeElement (IModelItem)in GraphModelManagerRetrieves the IRenderTreeElement visualizing a given model item managed by this instance.
above (IRenderTreeElement)in IRenderTreeElementMoves this instance directly above the reference element.
below (IRenderTreeElement)in IRenderTreeElementMoves this instance directly below the reference element.
lower ()in IRenderTreeElementLowers this instance within its containing group, to render it one step further to the back.
raise ()in IRenderTreeElementRaises this instance within its containing group, to render it one step further to the front.
toBack ()in IRenderTreeElementMoves this instance to the back of its containing group, to render it below all other elements in this group.
toFront ()in IRenderTreeElementMoves this instance to the front of its containing group, to render it above all other elements in this group.
getRenderTreeElement (T)in ItemModelManagerRetrieves the render tree element that has been registered for the given item or null.
install (T)in ItemModelManagerInstalls a member of the collection into the canvas using the renderer.
addItem (T)in ModelManagerInstalls an item and adds it to this manager's set of managed items.
installItem (T)in ModelManagerInstalls a member of the collection into the canvas using the IObjectRenderer<T> which is returned by getRenderer.
createElement (IRenderTreeGroup, TRenderTag, IObjectRenderer<TRenderTag>)in RenderTreeAdds a child element to the scene graph as a child of the parent group.
createElement (IRenderTreeGroup, Visual)in RenderTreeAdds a Visual to the scene graph as a child of the parent group.
createElement (IRenderTreeGroup, IVisualCreator)in RenderTreeAdds an IVisualCreator to the scene graph as a child of the parent group.
createElement (IRenderTreeGroup, ILookup)in RenderTreeAdds an ILookup implementation to the scene graph that provides the IObjectRenderer<T> interfaces (IVisualCreator, IBoundsProvider, IVisibilityTestable, IHitTestable) in its lookup implementation.
getElements (IRenderTreeGroup?, boolean?)in RenderTreeEnumerates over all possible IRenderTreeElement instances in the tree below the given group.
hitElementsAt (Point, IInputModeContext?, IRenderTreeGroup?)in RenderTreeReturns an IEnumerable<T> of all hit elements in the canvas below the given group.
addItem (IModelItem)in WebGLHighlightIndicatorManager
addItem (IModelItem)in WebGLSelectionIndicatorManager

Method Parameters

updateSourceGhost (IInputModeContext, IRenderTreeElement, IStripe, StripeReparentPolicy)in ReparentStripePositionHandlerUpdates the source ghost visualization after a drag.
updateTargetGhost (IInputModeContext, IRenderTreeElement, IStripe, StripeReparentPolicy, Rect)in ReparentStripePositionHandlerModifies the target ghost visualization after a drag.
getItem (IRenderTreeElement)in CollectionModelManager
getModelItem (IRenderTreeElement)in GraphModelManagerRetrieves the corresponding IModelItem for the given render tree element.
above (IRenderTreeElement)in IRenderTreeElementMoves this instance directly above the reference element.
below (IRenderTreeElement)in IRenderTreeElementMoves this instance directly below the reference element.
getItem (IRenderTreeElement)in ItemModelManagerTries to find the item managed by this instance that is associated with the given render tree element.
uninstallItem (IRenderTreeElement)in ModelManagerRemoves the given IRenderTreeElement.
getBounds (IRenderTreeElement)in RenderTreeCalculates the bounds for a given render tree element.
getVisual (IRenderTreeElement)in RenderTreeGets the Visual that is currently visualizing the given IRenderTreeElement.
getVisualCreator (IRenderTreeElement)in RenderTreeRetrieves the IVisualCreator for a given IRenderTreeElement.
isHit (IRenderTreeElement, Point)in RenderTreeTests if a given render tree element is hit at the given location.
remove (IRenderTreeElement)in RenderTreeRemoves an element from this tree along with all its descendants if it's a group.
setParent (IRenderTreeElement, IRenderTreeGroup)in RenderTreeChanges the parent of the given element to be the newParent.

Implementing Types

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