documentationfor yFiles for HTML 2.6

Usages of ICanvasObjectDescriptor

Properties

	candidateDescriptor	in CreateEdgeInputMode	Gets or sets the ICanvasObjectDescriptor that is used for visualizing the IPortCandidates in the canvas during the edit.
	closestCandidateDescriptor	in CreateEdgeInputMode	Gets or sets the ICanvasObjectDescriptor that is used for visualizing the closest IPortCandidate in the canvas during the edit.
	edgeDescriptor	in GraphModelManager	Gets or sets the ICanvasObjectDescriptor instance used for installing an IEdge into the canvas.
	edgeLabelDescriptor	in GraphModelManager	Gets or sets the ICanvasObjectDescriptor instance used for installing an ILabel of an IEdge into the canvas.
	nodeDescriptor	in GraphModelManager	Gets or sets the ICanvasObjectDescriptor instance used for installing an INode into the canvas.
	nodeLabelDescriptor	in GraphModelManager	Gets or sets the ICanvasObjectDescriptor instance used for installing an ILabel of an INode into the canvas.
	portDescriptor	in GraphModelManager	Gets or sets the ICanvasObjectDescriptor instance used for installing an IPort into the canvas.
	portLabelDescriptor	in GraphModelManager	Gets or sets the ICanvasObjectDescriptor instance used for installing an ILabel of an IPort into the canvas.
	descriptor	in ICanvasObject	Gets or sets the descriptor instance that interprets the userObject during rendering, hit testing, and bounds calculation.
	descriptor	in ItemModelManager	Gets or sets the canvas object descriptor used by install when an item is added to an canvas object group.

Fields

	DEFAULT_EDGE_DESCRIPTOR	in GraphModelManager	The immutable instance of the default ICanvasObjectDescriptor for IEdges which simply defers to the edge's IEdgeStyle.
	DEFAULT_LABEL_DESCRIPTOR	in GraphModelManager	The immutable instance of the default ICanvasObjectDescriptor for ILabels which simply defers to the label's ILabelStyle.
	DEFAULT_NODE_DESCRIPTOR	in GraphModelManager	The immutable instance of the default ICanvasObjectDescriptor for INodes which simply defers to the node's INodeStyle.
	DEFAULT_PORT_DESCRIPTOR	in GraphModelManager	The immutable instance of the default ICanvasObjectDescriptor for IPorts which simply defers to the port's IPortStyle.
	ALWAYS_DIRTY_INSTANCE	in ICanvasObjectDescriptor	A descriptor that treats userObject as an instance of IVisualCreator and ignores the dirty flag.
	ALWAYS_DIRTY_LOOKUP	in ICanvasObjectDescriptor	A descriptor that treats userObject as an instance of ILookup to obtain suitable interface implementations and ignores the dirty flag.
	ALWAYS_DIRTY_VISUAL	in ICanvasObjectDescriptor	A descriptor that treats userObject as Visual to use directly.
	DYNAMIC_DIRTY_INSTANCE	in ICanvasObjectDescriptor	An implementation that treats userObject as an instance of IVisualCreator and considers the dirty flag.
	DYNAMIC_DIRTY_LOOKUP	in ICanvasObjectDescriptor	A descriptor that treats userObject as an instance of ILookup to obtain suitable interface implementations and considers the dirty flag.
	VISUAL	in ICanvasObjectDescriptor	A descriptor that treats userObject as Visual to use directly.
	VOID	in ICanvasObjectDescriptor	An implementation that returns an ICanvasObjectDescriptor that does nothing.

Method Return Values

	createCandidateDescriptor (IInputModeContext, boolean)	in LabelPositionHandler	Creates an ICanvasObjectDescriptor to display the given candidate position.
	createCurrentPortCandidateDescriptor ()	in PortRelocationHandle	Factory method that creates the ICanvasObjectDescriptor that will be used to paint the "current" IPortCandidate.
	createPortCandidateDescriptor ()	in PortRelocationHandle	Factory method that creates the ICanvasObjectDescriptor that will be used to paint the IPortCandidates.
	createSnapResultCanvasObjectDescriptor ()	in SnapContext	Helper method used by createSnapResultsModelManager to create the ICanvasObjectDescriptor for the SnapResult type.
	getDescriptor (T)	in ItemModelManager	Returns the ICanvasObjectDescriptor used to install the `item` in the canvas.

Method Parameters

	CreateEdgeInputMode ()	in CreateEdgeInputMode	Creates a new instance that will use the IGraph from the inputModeContext to create edges in.
	createEdgeLabelModelManager (ICanvasObjectDescriptor, function(ILabel):ICanvasObjectGroup)	in GraphModelManager	Factory method for creating the ItemModelManager<T> that handles the visual representation of edge labels.
	createEdgeModelManager (ICanvasObjectDescriptor, function(IEdge):ICanvasObjectGroup)	in GraphModelManager	Factory method for creating the ItemModelManager<T> that handles the visual representation of edges.
	createNodeLabelModelManager (ICanvasObjectDescriptor, function(ILabel):ICanvasObjectGroup)	in GraphModelManager	Factory method for creating the ItemModelManager<T> that handles the visual representation of node labels.
	createNodeModelManager (ICanvasObjectDescriptor, function(INode):ICanvasObjectGroup)	in GraphModelManager	Factory method for creating the ItemModelManager<T> that handles the visual representation of nodes.
	createPortLabelModelManager (ICanvasObjectDescriptor, function(ILabel):ICanvasObjectGroup)	in GraphModelManager	Factory method for creating the ItemModelManager<T> that handles the visual representation of port labels.
	createPortModelManager (ICanvasObjectDescriptor, function(IPort):ICanvasObjectGroup)	in GraphModelManager	Factory method for creating the ItemModelManager<T> that handles the visual representation of ports.
	addChild (Object, ICanvasObjectDescriptor?)	in ICanvasObjectGroup	Adds a child element to the scene graph as a child of this group.

Implementing Types

DefaultPortCandidateDescriptor

An ICanvasObjectDescriptor implementation that can be used to draw IPortCandidate instances in a CanvasComponent.