Skip to main content

Home > @jsplumbtoolkit/browser-ui > GeneratedGridBackgroundOptions

GeneratedGridBackgroundOptions interface

Options for the generated grid background. This background is still in beta as of 5.10.6.

Signature:

export interface GeneratedGridBackgroundOptions extends BackgroundOptions 

Extends: BackgroundOptions

Properties

PropertyModifiersTypeDescription
autoShrink?boolean(Optional) Defaults to true, and instructs the grid that if the grid has grown beyond any minimum value set in either axis, if the content bounds subsequently shrink in that axis below the minimum, the grid should shrink back to the minimum. If you set this to false the grid will never shrink back to its minimum values once they have been exceeded.
dotRadius?number(Optional) The radius for dots representing grid positions (when gridType id GridTypes.dotted). Defaults to 2.
grid?Grid(Optional) The grid to use. This is optional; if you do not supply one the background will attempt to read the grid definition from the Surface. If that is also not set then a default grid of 50x50 pixels will be used.
gridType?GridType(Optional) Type of grid - lines or dots. Defaults to lines.
maxHeight?number(Optional) The maximum height for the grid. The value you provided is divided by 2 and then the grid is guaranteed to never exceed the range of (-maxHeight / 2) - (maxHeight / 2). maxHeight takes precedence over minHeight.
maxWidth?number(Optional) The maximum width for the grid. The value you provided is divided by 2 and then the grid is guaranteed to never exceed the range of (-maxWidth / 2) - (maxWidth / 2). maxWidth takes precedence over minWidth.
minHeight?number(Optional) The minimum height for the grid. The value you provided is divided by 2 and then the grid is guaranteed to always at least span the range of (-minHeight / 2) - (minHeight / 2).
minWidth?number(Optional) The minimum width for the grid. The value you provided is divided by 2 and then the grid is guaranteed to always at least span the range of (-minWidth / 2) - (minWidth / 2).
showBorder?boolean(Optional) Whether or not to show a thick border around the entire background. Defaults to false.
showTickMarks?boolean(Optional) If true (which is the default), the grid will also draw tick marks between the grid lines.
tickDotRadius?number(Optional) The radius for dots representing grid tick marks (when gridType id GridTypes.dotted). Defaults to 1.
tickMarksPerCell?number(Optional) Number of tick marks to draw per cell. Defaults to 2.
visible?boolean(Optional) Whether or not the background is initially visible. Defaults to true.