documentationfor yFiles for HTML 3.0.0.3

Usages of CanvasComponent

Properties

canvasComponentin InputModeContext
canvasComponentin KeyboardInputModeGets the canvas instance this mode is currently installed in or null.
canvasComponentin OverviewInputModeGets or sets the canvas this canvas should use to navigate.
canvasComponentin AnimatorGets the control the animations are run on.
canvasComponentin BridgeManagerGets or sets the canvasComponent that should be managed by this instance.
canvasComponentin GraphModelManagerGets the currently installed in CanvasComponent.
canvasComponentin ICanvasContextGets the Canvas that is associated with this context.
canvasComponentin ModelManagerGets the canvas instance this instance is managing.

Method Return Values

getComponent (Element)in CanvasComponentGets the CanvasComponent instance that is associated with the given element, or null.

Method Parameters

OverviewInputMode ()in OverviewInputModeCreates a new instance.
unhideOriginalEdge (IEdge, CanvasComponent)in PortRelocationHandleUnhides the original edge that was hidden during the drag operation.
createSnapResultsModelManager (CanvasComponent)in SnapContextHelper method that creates a CollectionModelManager<T> that can be used to present the current SnapResults in the provided CanvasComponent.
Animator (CanvasComponent, )in AnimatorInitializes a new instance of the Animator class for the given CanvasComponent.
invalidateComponent (CanvasComponent)in AnimatorInvalidates the control if autoInvalidation is set to true.
BridgeManager ()in BridgeManagerInitializes a new instance of the BridgeManager class.
install (CanvasComponent)in BridgeManagerInstalls this manager for the specified canvasComponent.
uninstall (CanvasComponent)in BridgeManagerReverts the install method.
install (CanvasComponent)in FocusIndicatorManager
uninstall (CanvasComponent)in FocusIndicatorManager
install (CanvasComponent, IGraph, IRenderTreeGroup?)in GraphModelManagerInstalls this instance for the specified CanvasComponent.
uninstall (CanvasComponent)in GraphModelManagerReverts the install method.
install (CanvasComponent)in HighlightIndicatorManager
uninstall (CanvasComponent)in HighlightIndicatorManager
install (CanvasComponent)in ModelManagerInstalls this instance in the given CanvasComponent instance.
uninstall (CanvasComponent)in ModelManagerUninstalls this instance from the given CanvasComponent instance.
install (CanvasComponent)in SelectionIndicatorManager
uninstall (CanvasComponent)in SelectionIndicatorManager
cleanUpDefs (CanvasComponent)in SvgDefsManagerTriggers the clean up for svg defs on the provided control.
createRenderContext (CanvasComponent)in SvgExportReturns an initialized IRenderContext and changes the given transform and the clip bounds such that a part of the given CanvasComponent instance can be exported to an image.
exportSvg (CanvasComponent)in SvgExportExports the contents of the CanvasComponent to a single, standalone SVG element.
exportSvgAsync (CanvasComponent, function():Promise<any>?)in SvgExportExports the contents of the CanvasComponent to a single, standalone SVG element.
ViewportAnimation (CanvasComponent, Rect, TimeSpan, )in ViewportAnimationCreates a new instance of ViewportAnimation.
getCurrentBoundingPolygon (CanvasComponent, ViewportDescriptor, ViewportLimitingMode)in ViewportLimiterGets the bounding polygon that should be honored for the upcoming limiting call.
limitViewport (CanvasComponent, ViewportDescriptor, ViewportLimitingMode)in ViewportLimiterInspects the requested new viewport for the given CanvasComponent and returns a valid viewport to use.
install (CanvasComponent)in WebGLFocusIndicatorManager
uninstall (CanvasComponent)in WebGLFocusIndicatorManager
install (CanvasComponent, IGraph, IRenderTreeGroup?)in WebGLGraphModelManager
uninstall (CanvasComponent)in WebGLGraphModelManager
install (CanvasComponent)in WebGLHighlightIndicatorManager
uninstall (CanvasComponent)in WebGLHighlightIndicatorManager
install (CanvasComponent)in WebGLSelectionIndicatorManager
uninstall (CanvasComponent)in WebGLSelectionIndicatorManager

Extending Types

GraphComponentA component for displaying and editing an IGraph.
GraphOverviewComponentA specialized CanvasComponent that shows an overview of an IGraph contained in another graphComponent.