Skip to content
  1. API
  2. Types
  3. GridBackgroundOptions

GridBackgroundOptions

Type: object

Configuration options for {@link GridBackground}. All properties are optional; omitted values fall back to built-in defaults.

Properties

  • levels(optional) GridLevel[][=[{size:1},{size:10},{size:100},{size:1000}]] Level-of-detail definitions. Each entry specifies a cell size in graph units plus optional per-level styling.
  • maxCellScreenSize(optional) number[=200] Maximum on-screen cell width in pixels before the plugin tries to show a finer level simultaneously.
  • minCellScreenSize(optional) number[=40] Minimum on-screen cell width in pixels before switching to a coarser level.
  • opacity(optional) number[=1] Opacity of the entire grid SVG layer (0–1).
  • snap(optional) SnapOptions Node-snap configuration. Enable dot and/or line to activate snapping.