documentationfor yFiles for HTML 3.0.0.3

Usages of SnapResult

Properties

snapResultsin SnapContextGets the collection of SnapResults.
objectRendererin SnapResultGets or sets the IObjectRenderer<SnapResult> instance that is used to create an IVisualCreator and with it a Visual for this result.

Method Return Values

collectPointSnapResult (CollectSnapResultsEventArgs, IModelItem, Point)in OrthogonalSnapLineCollects a valid SnapResult that snaps the movedPoint to this orthogonal line.
collectReshapeSnapResult (CollectSnapResultsEventArgs, ReshapeRectangleContext, IModelItem, Rect, SnapLineSnapTypes)in OrthogonalSnapLineCalculates a valid SnapResult that snaps the side of a reshaped rectangle described by the snapType to this orthogonal line.
collectSegmentSnapResult (CollectSnapResultsEventArgs, IModelItem, number, number, number, SnapLineSnapTypes)in OrthogonalSnapLineCalculates a valid SnapResult that snaps the orthogonal segment defined by the given parameters to this orthogonal line.
collectPointSnapResult (CollectSnapResultsEventArgs, IModelItem, Point, number)in SnapCircleCollects a valid SnapResult that snaps the movedPoint to this circle.
createSnapResultRenderer ()in SnapContextHelper method used by createSnapResultsModelManager to create the IObjectRenderer<SnapResult> for the SnapResult type.
createSnapResultsModelManager (CanvasComponent)in SnapContextHelper method that creates a CollectionModelManager<T> that can be used to present the current SnapResults in the provided CanvasComponent.
collectPointSnapResult (CollectSnapResultsEventArgs, IModelItem, Point, GridSnapTypes)in SnapGridCollects a valid SnapResult that snaps the movedPoint to grid points or lines of the gridInfo depending on the gridSnapTypes.
collectReshapedCornerSnapResult (CollectSnapResultsEventArgs, ReshapeRectangleContext, IModelItem, Rect)in SnapGridCollects a valid SnapResult that snaps the corner of the reshaped rectangle that corresponds to the reshapePosition to a grid point.
collectReshapedSideSnapResult (CollectSnapResultsEventArgs, ReshapeRectangleContext, IModelItem, Rect, SnapLineSnapTypes)in SnapGridCalculates a valid SnapResult that snaps the side of a reshaped rectangle described by the snapType to a grid line.
collectPointSnapResult (CollectSnapResultsEventArgs, IModelItem, Point)in SnapLineCollects a valid SnapResult that snaps the movedPoint to this line.
createCircleSnapResult (SnapConstraint, number, any, IModelItem, Point, SnapCircle, IObjectRenderer<SnapResult>?)in SnapResultFactory method that creates a SnapResult that snaps to a given circle.
createLineSnapResult (SnapConstraint, number, any, IModelItem, Point, SnapLine, IObjectRenderer<SnapResult>?)in SnapResultFactory method that creates a SnapResult which represents a SnapLine to which the current moved item will potentially snap.
createResizeSnapResult (SnapConstraint, number, any, IModelItem?, SnapSize?, IObjectRenderer<SnapResult>?)in SnapResultFactory method that creates a SnapResult which snaps to a given size through a resize operation.
createSnapResult (SnapConstraint, number, any?, IModelItem?, Point?, SnapReference?, IObjectRenderer<SnapResult>?)in SnapResultFactory method that creates a SnapResult using the given constraint.
collectReshapeSnapResult (CollectSnapResultsEventArgs, ReshapeRectangleContext, IModelItem, Rect)in SnapSizeCalculates a valid SnapResult that snaps the width or height of a reshaped rectangle to the size.

Method Parameters

CollectSnapResultsEventArgs (IInputModeContext, Point, Point, number, number, ICollection<SnapResult>)in CollectSnapResultsEventArgsCreates a new instance of the event arguments using the provided values for initialization.
addSnapResult (SnapResult)in CollectSnapResultsEventArgsAdds a SnapResult to the collection of snap results.
processSnapResults (List<SnapResult>, Point, Point)in SnapContextChooses the current SnapResults from a temporary list.
SnapResult (SnapConstraint, number, any?, IModelItem?, Point?, SnapReference?, IObjectRenderer<SnapResult>?)in SnapResultInitializes the tag, weight and constraint with the given values.
createCircleSnapResult (SnapConstraint, number, any, IModelItem, Point, SnapCircle, IObjectRenderer<SnapResult>?)in SnapResultFactory method that creates a SnapResult that snaps to a given circle.
createLineSnapResult (SnapConstraint, number, any, IModelItem, Point, SnapLine, IObjectRenderer<SnapResult>?)in SnapResultFactory method that creates a SnapResult which represents a SnapLine to which the current moved item will potentially snap.
createResizeSnapResult (SnapConstraint, number, any, IModelItem?, SnapSize?, IObjectRenderer<SnapResult>?)in SnapResultFactory method that creates a SnapResult which snaps to a given size through a resize operation.
createSnapResult (SnapConstraint, number, any?, IModelItem?, Point?, SnapReference?, IObjectRenderer<SnapResult>?)in SnapResultFactory method that creates a SnapResult using the given constraint.