Event arguments for the CollectSnapLines event.
Inheritance Hierarchy
EventArgs
InputModeEventArgs
CollectGraphSnapLinesEventArgs
Remarks
Instances of this class are also passed to addSnapLines. Implementations of that interface can use the following methods to add snap lines for specific purposes:
- addFixedNodeSnapLine – Adds an orthogonal snap line for nodes.
- addFixedSegmentSnapLine – Adds an orthogonal snap line for edge segments and bends.
- addPortSnapLine – Adds an orthogonal snap line for ports.
- addAdditionalSnapLine – Adds an additional orthogonal snap line to which all element will snap.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.CollectGraphSnapLinesEventArgs
See Also
Constructors
CollectGraphSnapLinesEventArgs
(context: IInputModeContext, fixedNodeSnapLines: ICollection<OrthogonalSnapLine>, fixedSegmentSnapLines: ICollection<OrthogonalSnapLine>, fixedPortSnapLines: ICollection<OrthogonalSnapLine>, additionalSnapLines: ICollection<OrthogonalSnapLine>)Initializes a new instance of the CollectGraphSnapLinesEventArgs class.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - IInputModeContext
- The context where the event is being used in.
- fixedNodeSnapLines - ICollection<OrthogonalSnapLine>
- The fixed node snap lines collection to add to.
- fixedSegmentSnapLines - ICollection<OrthogonalSnapLine>
- The fixed segment snap lines collection to add to.
- fixedPortSnapLines - ICollection<OrthogonalSnapLine>
- The fixed port snap lines collection to add to.
- additionalSnapLines - ICollection<OrthogonalSnapLine>
- The additional snap lines collection to add to.
Properties
Gets the context for the current event.
Defined in
Methods
Adds a snap line all elements will snap to.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- snapLine - OrthogonalSnapLine
- The snap line to add to the list of lines that all elements snap to by default.
See Also
Adds a snap line for nodes.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- snapLine - OrthogonalSnapLine
- The snap line to add to the list of lines that nodes snap to by default.
See Also
Adds a snap line for edge segments and bends.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- snapLine - OrthogonalSnapLine
- The snap line to add to the list of lines that segments snap to by default.
See Also
Adds a snap line for ports.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- snapLine - OrthogonalSnapLine
- The snap line to add to the list of lines that ports snap to by default.