Skip to main content

GridBackgroundComponent

const GridBackgroundComponent: object

This is a headless component that adds a grid background to the surface/paper it resides in.

Type Declaration​

mounted()​

mounted: () => void

Returns​

void

name​

name: string = COMPONENT_GRID_BACKGROUND

props​

props: object

props.autoShrink​

autoShrink: object

props.autoShrink.type​

type: BooleanConstructor = Boolean

props.dotRadius​

dotRadius: object

props.dotRadius.type​

type: NumberConstructor = Number

props.grid​

grid: object

props.grid.type​

type: PropType<Grid>

props.gridType​

gridType: object

props.gridType.type​

type: PropType<GridType>

props.maxHeight​

maxHeight: object

props.maxHeight.type​

type: NumberConstructor = Number

props.maxWidth​

maxWidth: object

props.maxWidth.type​

type: NumberConstructor = Number

props.minHeight​

minHeight: object

props.minHeight.type​

type: NumberConstructor = Number

props.minWidth​

minWidth: object

props.minWidth.type​

type: NumberConstructor = Number

props.showBorder​

showBorder: object

props.showBorder.type​

type: BooleanConstructor = Boolean

props.showTickMarks​

showTickMarks: object

props.showTickMarks.type​

type: BooleanConstructor = Boolean

props.tickDotRadius​

tickDotRadius: object

props.tickDotRadius.type​

type: NumberConstructor = Number

props.tickMarksPerCell​

tickMarksPerCell: object

props.tickMarksPerCell.type​

type: NumberConstructor = Number

props.visible​

visible: object

props.visible.type​

type: BooleanConstructor = Boolean

render()​

render: (_ctx) => any

Parameters​

_ctx​

any

Returns​

any

setup()​

setup(): object

Returns​

object

service​

service: unknown