Renders a grid, using various different styles and render technologies.
Remarks
Examples
Enabling grid snapping
const snapContext = new GraphSnapContext()
const gridInfo = new GridInfo(50)
snapContext.nodeGridConstraintProvider = new GridConstraintProvider(gridInfo)
snapContext.bendGridConstraintProvider = new GridConstraintProvider(gridInfo)
snapContext.portGridConstraintProvider = new GridConstraintProvider(gridInfo)
snapContext.gridSnapType = GridSnapTypes.GRID_POINTS
graphEditorInputMode.snapContext = snapContextNote that the grid visualization has to be enabled separately
graphComponent.backgroundGroup.addChild(new GridVisualCreator(gridInfo))Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.view.GridVisualCreator
See Also
Constructors
Initializes a new instance of the GridVisualCreator class.
Remarks
Initializes a new instance of the GridVisualCreator class.
Remarks
Parameters
A map of options to pass to the method.
- horizontalSpacing - number
- The x spacing.
- verticalSpacing - number
- The y spacing.
Initializes a new instance of the GridVisualCreator class.
Properties
Gets or sets the grid info that describes the geometry of the grid.
Gets or sets the grid style that this implementation uses.
Gets or sets the mode used to render the grid.
Gets or sets a value indicating whether this GridVisualCreator is visible.
Methods
This method is called by the framework to create a Visual that will be included into the IRenderContext.
Remarks
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context that describes where the visual will be used.
Returns
- ↪Visual
- The visual to include in the canvas object visual tree. This may be
null.
See Also
Implements
This method updates or replaces a previously created Visual for inclusion in the IRenderContext.
Remarks
The CanvasComponent uses this method to give implementations a chance to update an existing Visual that has previously been created by the same instance during a call to createVisual. Implementation may update the oldVisual and return that same reference, or create a new visual and return the new instance or null.
I most cases oldVisual is a visual instance that has been returned by the createVisual method of this instance. This is, however, not guaranteed. Implementations have to be aware of this.
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The context that describes where the visual will be used in.
- oldVisual - Visual
- The visual instance to be updated.
Returns
- ↪Visual
oldVisual, if this instance modified the visual, or a new visual that should replace the existing one in the canvas object visual tree.