Interface GeneratedGridBackgroundOptions

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

interface GeneratedGridBackgroundOptions {
    autoShrink?: boolean;
    dotRadius?: number;
    grid?: Grid;
    gridType?: "dotted" | "lines";
    maxHeight?: number;
    maxWidth?: number;
    minHeight?: number;
    minWidth?: number;
    onBackgroundReady?: OnBackgroundReadyCallback;
    showBorder?: boolean;
    showTickMarks?: boolean;
    tickDotRadius?: number;
    tickMarksPerCell?: number;
    type: string;
    visible?: boolean;
}

Hierarchy (view full)

Properties

autoShrink? dotRadius? grid? gridType? maxHeight? maxWidth? minHeight? minWidth? onBackgroundReady? showBorder? showTickMarks? tickDotRadius? tickMarksPerCell? type visible?

Properties

Optional autoShrink

autoShrink?: boolean

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.

Optional dotRadius

dotRadius?: number

The radius for dots representing grid positions (when gridType id GridTypes.dotted). Defaults to 2.

Optional grid

grid?: Grid

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.

Optional gridType

gridType?: "dotted" | "lines"

Type of grid - lines or dots. Defaults to lines.

Optional maxHeight

maxHeight?: number

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.

Optional maxWidth

maxWidth?: number

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.

Optional minHeight

minHeight?: number

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).

Optional minWidth

minWidth?: number

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).

Optional onBackgroundReady

onBackgroundReady?: OnBackgroundReadyCallback

Optional function to call when the image has loaded (or otherwise claims to be ready)

Optional showBorder

showBorder?: boolean

Whether or not to show a thick border around the entire background. Defaults to false.

Optional showTickMarks

showTickMarks?: boolean

If true (which is the default), the grid will also draw tick marks between the grid lines.

Optional tickDotRadius

tickDotRadius?: number

The radius for dots representing grid tick marks (when gridType id GridTypes.dotted). Defaults to 1.

Optional tickMarksPerCell

tickMarksPerCell?: number

Number of tick marks to draw per cell. Defaults to 2.

type

type: string

Type of background to render.

Optional visible

visible?: boolean

Whether or not the background is initially visible. Defaults to true.

Settings

Member Visibility

Theme

On This Page

autoShrinkdotRadiusgridgridTypemaxHeightmaxWidthminHeightminWidthonBackgroundReadyshowBordershowTickMarkstickDotRadiustickMarksPerCelltypevisible