documentationfor yFiles for HTML 3.0.0.3

Usages of GeneralPath

Properties

pathin LassoSelectionEventArgsGets the current lasso selection path of the LassoSelectionInputMode.
selectionPathin LassoSelectionInputModeGets the current or last selection path.
pathin MarqueeSelectionEventArgsGets the current selection as a path of the MarqueeSelectionInputMode.
selectionPathin MarqueeSelectionInputModeGets the current or last marquee selection in world coordinates as a path.
pathin GeneralPathNodeStyleGet or sets the path that defines the boundary of the shape.
normalizedOutlinein ImageNodeStyleGets or sets the normalized outline of the image that will be displayed.

Method Return Values

createSmoothedPath (number, SmoothingPolicy?, boolean?)in GeneralPathCreates a new path based on this one where corners are smoothed with a quadratic Bézier arc starting at smoothingLength away from the corner.
createTransformedPath (Matrix)in GeneralPathCreates a new GeneralPath that is a copy of this path with all geometry transformed using the supplied matrix.
flatten (number?)in GeneralPathCreates a new path from this instance flattening all Bézier curves using the given tolerance.
getPath (IEdge)in CompositeEdgeStyleGets the path from the first style as the reference.
getOutline (INode)in CompositeNodeStyleCalculates the outline based on the first style.
getPath (IEdge)in DelegatingEdgeStyleGets the path of the edge from getEdge by using the style from getStyle.
getOutline (INode)in DelegatingNodeStyleGets the outline of the visual representation of the node from getNode by using the style from getStyle.
cropEdgePath (IEdge, boolean, IArrow, GeneralPath)in EdgePathCropperCrops the provided path at one end of an edge.
cropEdgePathAtArrow (boolean, IArrow, GeneralPath)in EdgePathCropperCrops an edge's path at the source or target side with respect to the given arrow.
cropEdgePathAtPortGeometry (IEdge, boolean, IArrow, GeneralPath)in EdgePathCropperCrops an edge's path at the source or target side at the port geometry with respect to the given arrow.
handleEmptyPath (IEdge, boolean, IArrow, GeneralPath)in EdgePathCropperHandles the edge path cropping if cropEdgePath would result in a cleared path.
cropPath (IEdge, IArrow, IArrow, GeneralPath)in EdgeStyleBaseCrops the edge's path at the nodes.
getPath (IEdge)in EdgeStyleBaseGets the path of the edge.
createPolygonPath (number, number?, boolean?, boolean?)in GeneralPathNodeStyleCreates a GeneralPath in the form of a polygon.
createStarPath (number, number, number?, boolean?, boolean?)in GeneralPathNodeStyleCreates a GeneralPath in the form of a star.
cropEdgePath (IEdge, boolean, IArrow, GeneralPath)in IEdgePathCropperCrops the provided path at one end of an edge.
getPath ()in IPathGeometryReturns a representation of the visible path of the edge in the form of a GeneralPath
getOutline ()in IShapeGeometryReturns the outline of the shape or null.
getOutline (INode)in NodeStyleBaseGets the outline of the visual style.
createPolylinePath (IEdge)in PathEdgeStyleBaseCreates a polyline path from the sourcePort via the bends to the targetPort of the edge.
createSelfLoopPath (IEdge, boolean, number?)in PathEdgeStyleBaseSpecial implementation that will create a self-loop path for the given edge.
cropPath (IEdge, GeneralPath, IArrow?, IArrow?)in PathEdgeStyleBaseCrops the edge's path at its source and target nodes.
getCroppedPath (IEdge)in PathEdgeStyleBaseCrops the raw path obtained from getPath to accommodate for cropping and arrow heads.
getObstacles (IRenderContext, IEdge)in PathEdgeStyleBaseReturns getCroppedPath unless isVisible yields false for the provided context and clip.
getPath (IEdge)in PathEdgeStyleBaseGets the raw, un-cropped, and un-smoothed path that shall be used for the given edge.
addBridges (IRenderContext, GeneralPath, IBridgeCreator?)in BridgeManagerCore method that will add bridges to a GeneralPath using the IBridgeCreator callback to determine the type of the bridges.
getObstacles (IRenderContext)in GraphObstacleProviderIterates over all edges and nodes to query an IObstacleProvider from the IModelItem's lookup.
getObstacles (IRenderContext)in IObstacleProviderReturns a path representing obstacles that would need bridges.

Method Parameters

append (GeneralPath, boolean)in GeneralPathAppends the contents of the given path to this path.
append (GeneralPath, number, number, boolean)in GeneralPathAppends parts of the contents of the given path to this path.
areaIntersects (GeneralPath, number?)in GeneralPathDetermines whether the area formed by this instance intersects with the area formed by the given path instance.
hasSameValue (GeneralPath)in GeneralPathDetermines whether a given GeneralPath instance can be considered equivalent to this one, that is, both represent the same path with the same sub-path types and coordinates.
pathIntersects (GeneralPath, number?)in GeneralPathDetermines whether this path's stroked segments intersect with a given path.
prepend (GeneralPath, boolean)in GeneralPathAdds the contents of the given path to the beginning of this path.
lassoSelect (GeneralPath, SelectionPolicy?)in GraphInputModePerforms lasso-selection with the given path.
onLassoSelect (IInputModeContext, GeneralPath, SelectionPolicy)in GraphInputModePerforms lasso-selection with the given path.
create ()in IBendSelectionTester
getBendsInPath (IInputModeContext, GeneralPath)in IBendSelectionTesterReturns the bends within the given lasso path.
create (function(IInputModeContext, GeneralPath):boolean)in ILassoTestable
isInPath (IInputModeContext, GeneralPath)in ILassoTestableReturns true if the corresponding item is considered to intersect the given path.
create ()in IPortSelectionTester
getPortsInPath (IInputModeContext, GeneralPath)in IPortSelectionTesterReturns the ports within the given lasso path.
isInPath (IInputModeContext, GeneralPath, IEdge)in CompositeEdgeStyleDetermines if the edge is in the path based on any style.
isInPath (IInputModeContext, GeneralPath, ILabel)in CompositeLabelStyleDetermines if the label is in the path based on any style.
isInPath (IInputModeContext, GeneralPath, INode)in CompositeNodeStyleDetermines if the node is in the path based on any style.
isInPath (IInputModeContext, GeneralPath, IPort)in CompositePortStyleDetermines if the port is in the path based on any style.
isInPath (IInputModeContext, GeneralPath, IEdge)in DelegatingEdgeStyleDetermines with the style from getStyle whether the visualization of the edge from getEdge is included in the lasso selection.
isInPath (IInputModeContext, GeneralPath, ILabel)in DelegatingLabelStyleDetermines with the style from getStyle whether the visualization of the label from getLabel is included in the lasso selection.
isInPath (IInputModeContext, GeneralPath, INode)in DelegatingNodeStyleDetermines with the style from getStyle whether the visualization of the node from getNode is included in the lasso selection.
isInPath (IInputModeContext, GeneralPath, IPort)in DelegatingPortStyleDetermines with the style from getStyle whether the visualization of the port from getPort is included in the lasso selection.
cropEdgePath (IEdge, boolean, IArrow, GeneralPath)in EdgePathCropperCrops the provided path at one end of an edge.
cropEdgePathAtArrow (boolean, IArrow, GeneralPath)in EdgePathCropperCrops an edge's path at the source or target side with respect to the given arrow.
cropEdgePathAtPortGeometry (IEdge, boolean, IArrow, GeneralPath)in EdgePathCropperCrops an edge's path at the source or target side at the port geometry with respect to the given arrow.
handleEmptyPath (IEdge, boolean, IArrow, GeneralPath)in EdgePathCropperHandles the edge path cropping if cropEdgePath would result in a cleared path.
addArrows (IRenderContext, SVGGElement, IEdge, GeneralPath, IArrow, IArrow)in EdgeStyleBaseAdds the arrows to a given container.
cropPath (IEdge, IArrow, IArrow, GeneralPath)in EdgeStyleBaseCrops the edge's path at the nodes.
getSourceArrowAnchor (GeneralPath, IArrow)in EdgeStyleBaseCalculates the source arrow anchor and direction for a given arrow and path.
getTargetArrowAnchor (GeneralPath, IArrow)in EdgeStyleBaseCalculates the target arrow anchor and direction for a given arrow and path.
isInPath (IInputModeContext, GeneralPath, IEdge)in EdgeStyleBaseDetermines whether the visualization for the specified edge is included in the lasso selection.
updateArrows (IRenderContext, SVGGElement, IEdge, GeneralPath, IArrow, IArrow)in EdgeStyleBaseUpdates the arrows in a given container.
GeneralPathNodeStyle (GeneralPath?, )in GeneralPathNodeStyleCreates a new instance using the specified path.
createAspectRatioInstance (GeneralPath)in GeneralPathNodeStyleCreates a new GeneralPathNodeStyle instance for a copy of the given path.
create (function(IEdge, boolean, IArrow, GeneralPath):GeneralPath)in IEdgePathCropper
cropEdgePath (IEdge, boolean, IArrow, GeneralPath)in IEdgePathCropperCrops the provided path at one end of an edge.
ImageNodeStyle (string?, )in ImageNodeStyleCreates a new instance that uses the specified image.
isInPath (IInputModeContext, GeneralPath, ILabel)in LabelStyleBaseDetermines whether the visualization for the specified label is included in the lasso selection.
isInPath (IInputModeContext, GeneralPath, INode)in NodeStyleBaseDetermines whether the visualization for the specified node is included in the lasso selection.
cropPath (IEdge, GeneralPath, IArrow?, IArrow?)in PathEdgeStyleBaseCrops the edge's path at its source and target nodes.
getSourceArrowAnchor (GeneralPath, IArrow)in PathEdgeStyleBaseCalculates the source arrow anchor and direction for a given arrow and path.
getTargetArrowAnchor (GeneralPath, IArrow)in PathEdgeStyleBaseCalculates the target arrow anchor and direction for a given arrow and path.
isInPath (IInputModeContext, GeneralPath, IEdge)in PathEdgeStyleBaseDetermines whether the visualization for the specified edge is included in the lasso selection.
isInPath (IInputModeContext, GeneralPath, IPort)in PortStyleBaseDetermines whether the visualization for the specified port is included in the lasso selection.
addText (SVGGElement | SVGTextElement, string, Font, Size?, TextWrapping?, TextMeasurePolicy?, boolean?, GeneralPath?)in TextRenderSupportAdd the text content to the provided SVG text element.
addBridges (IRenderContext, GeneralPath, IBridgeCreator?)in BridgeManagerCore method that will add bridges to a GeneralPath using the IBridgeCreator callback to determine the type of the bridges.
insertDefaultCustomBridge (IRenderContext, GeneralPath, Point, Point, number)in BridgeManagerImplementation that will be called by the default value of the defaultBridgeCreator to satisfy requests to createCustomBridge.
registerObstacle (IRenderContext, GeneralPath)in BridgeManagerDynamically registers an obstacle path with the context during the rendering.
createPathAnimation (GeneralPath, IMutablePoint, TimeSpan)in IAnimationCreates a new instance of an IAnimation that animates the given IMutablePoint along a path.
create ()in IBridgeCreator
createCustomBridge (IRenderContext, GeneralPath, Point, Point, number)in IBridgeCreatorCalled by the BridgeManager if the getCrossingStyle method yields CUSTOM to actually insert a bridge into the given GeneralPath.