Skip to main content

Grid

class Grid extends Shape

A node for drawing a two-dimensional grid.

Press play to preview the animation
import ...

export default makeScene2D(function* (view) {
  const grid = createRef<Grid>();

  view.add(
    <Grid
      ref={grid}
      width={'100%'}
      height={'100%'}
      stroke={'#666'}
      start={0}
      end={1}
    />,
  );

  yield* all(
    grid().end(0.5, 1).to(1, 1).wait(1),
    grid().start(0.5, 1).to(0, 1).wait(1),
  );
});

Constructors​

constructor​

public override new Gridprops: GridProps: Grid

Parameters

Overwrites Shape.constructor

Properties​

absolutePosition​

readonly public absolutePosition: SimpleVector2SignalGrid

A helper signal for operating on the position in world space.

Retrieving the position using this signal returns the position in world space. Similarly, setting the position using this signal transforms the new value to local space.

If the new value is a function, the position of this node will be continuously updated to always match the position returned by the function. This can be useful to "pin" the node in a specific place or to make it follow another node's position.

Unlike position, this signal is not compound - it doesn't contain separate signals for the x and y components.

Inherited from Shape.absolutePosition

absoluteRotation​

readonly public absoluteRotation: SimpleSignalnumberGrid

A helper signal for operating on the rotation in world space.

Retrieving the rotation using this signal returns the rotation in world space. Similarly, setting the rotation using this signal transforms the new value to local space.

If the new value is a function, the rotation of this node will be continuously updated to always match the rotation returned by the function.

Inherited from Shape.absoluteRotation

absoluteScale​

readonly public absoluteScale: SimpleVector2SignalGrid

A helper signal for operating on the scale in world space.

Retrieving the scale using this signal returns the scale in world space. Similarly, setting the scale using this signal transforms the new value to local space.

If the new value is a function, the scale of this node will be continuously updated to always match the position returned by the function.

Unlike scale, this signal is not compound - it doesn't contain separate signals for the x and y components.

Inherited from Shape.absoluteScale

alignContent​

readonly public alignContent: SimpleSignalFlexContentGrid
Inherited from Shape.alignContent

alignItems​

readonly public alignItems: SimpleSignalFlexItemsGrid
Inherited from Shape.alignItems

alignSelf​

readonly public alignSelf: SimpleSignalFlexItemsGrid
Inherited from Shape.alignSelf

antialiased​

readonly public antialiased: SimpleSignalbooleanGrid
Inherited from Shape.antialiased

basis​

readonly public basis: SimpleSignalFlexBasisGrid
Inherited from Shape.basis

bottom​

readonly public bottom: SimpleVector2SignalGrid

The position of the bottom edge of this node.

When set, this shortcut property will modify the node's position so that the bottom edge ends up in the given place.

When retrieved, it will return the position of the bottom edge in the parent space.

Inherited from Shape.bottom

bottomLeft​

readonly public bottomLeft: SimpleVector2SignalGrid

The position of the bottom left corner of this node.

When set, this shortcut property will modify the node's position so that the bottom left corner ends up in the given place.

When retrieved, it will return the position of the bottom left corner in the parent space.

Inherited from Shape.bottomLeft

bottomRight​

readonly public bottomRight: SimpleVector2SignalGrid

The position of the bottom right corner of this node.

When set, this shortcut property will modify the node's position so that the bottom right corner ends up in the given place.

When retrieved, it will return the position of the bottom right corner in the parent space.

Inherited from Shape.bottomRight

cache​

readonly public cache: SimpleSignalbooleanGrid
Inherited from Shape.cache

cachePadding​

readonly public cachePadding: SpacingSignalGrid

Controls the padding of the cached canvas used by this node.

By default, the size of the cache is determined based on the bounding box of the node and its children. That includes effects such as stroke or shadow. This property can be used to expand the cache area further. Usually used to account for custom effects created by shaders.

Inherited from Shape.cachePadding

children​

readonly public children: SignalComponentChildrenNode[]GridSignalContextComponentChildrenNode[]Grid
Inherited from Shape.children

clip​

readonly public clip: SimpleSignalbooleanGrid
Inherited from Shape.clip

composite​

readonly public composite: SimpleSignalbooleanGrid
Inherited from Shape.composite

compositeOperation​

readonly public compositeOperation: SimpleSignalGlobalCompositeOperationGrid
Inherited from Shape.compositeOperation

creationStack​

readonly public creationStack?: string
Inherited from Shape.creationStack

direction​

readonly public direction: SimpleSignalFlexDirectionGrid
Inherited from Shape.direction

element​

public element: HTMLElement
Inherited from Shape.element

end​

readonly public end: SimpleSignalnumberGrid

The percentage that should be clipped from the end of each grid line.

The portion of each grid line that comes after the given percentage will be made invisible.

This property is useful for animating the grid appearing on-screen.

fill​

readonly public fill: CanvasStyleSignalGrid
Inherited from Shape.fill

filters​

readonly public filters: FiltersSignalGrid
Inherited from Shape.filters

fontFamily​

readonly public fontFamily: SimpleSignalstringGrid
Inherited from Shape.fontFamily

fontSize​

readonly public fontSize: SimpleSignalnumberGrid
Inherited from Shape.fontSize

fontStyle​

readonly public fontStyle: SimpleSignalstringGrid
Inherited from Shape.fontStyle

fontWeight​

readonly public fontWeight: SimpleSignalnumberGrid
Inherited from Shape.fontWeight

gap​

readonly public gap: Vector2LengthSignalGrid
Inherited from Shape.gap

grow​

readonly public grow: SimpleSignalnumberGrid
Inherited from Shape.grow

isClass​

public isClass: boolean
Inherited from Shape.isClass

justifyContent​

readonly public justifyContent: SimpleSignalFlexContentGrid
Inherited from Shape.justifyContent

key​

readonly public key: string
Inherited from Shape.key

layout​

readonly public layout: SimpleSignalLayoutModeGrid
Inherited from Shape.layout

left​

readonly public left: SimpleVector2SignalGrid

The position of the left edge of this node.

When set, this shortcut property will modify the node's position so that the left edge ends up in the given place.

When retrieved, it will return the position of the left edge in the parent space.

Inherited from Shape.left

letterSpacing​

readonly public letterSpacing: SimpleSignalnumberGrid
Inherited from Shape.letterSpacing

lineCap​

readonly public lineCap: SimpleSignalCanvasLineCapGrid
Inherited from Shape.lineCap

lineDash​

readonly public lineDash: SimpleSignalnumber[]Grid
Inherited from Shape.lineDash

lineDashOffset​

readonly public lineDashOffset: SimpleSignalnumberGrid
Inherited from Shape.lineDashOffset

lineHeight​

readonly public lineHeight: SimpleSignalLengthGrid
Inherited from Shape.lineHeight

lineJoin​

readonly public lineJoin: SimpleSignalCanvasLineJoinGrid
Inherited from Shape.lineJoin

lineWidth​

readonly public lineWidth: SimpleSignalnumberGrid
Inherited from Shape.lineWidth

margin​

readonly public margin: SpacingSignalGrid
Inherited from Shape.margin

maxHeight​

readonly public maxHeight: SimpleSignalLengthLimitGrid
Inherited from Shape.maxHeight

maxWidth​

readonly public maxWidth: SimpleSignalLengthLimitGrid
Inherited from Shape.maxWidth

middle​

readonly public middle: SimpleVector2SignalGrid

The position of the center of this node.

When set, this shortcut property will modify the node's position so that the center ends up in the given place.

If the offset has not been changed, this will be the same as the position.

When retrieved, it will return the position of the center in the parent space.

Inherited from Shape.middle

minHeight​

readonly public minHeight: SimpleSignalLengthLimitGrid
Inherited from Shape.minHeight

minWidth​

readonly public minWidth: SimpleSignalLengthLimitGrid
Inherited from Shape.minWidth

offset​

readonly public offset: Vector2SignalGrid

Represents the offset of this node's origin.

By default, the origin of a node is located at its center. The origin serves as the pivot point when rotating and scaling a node, but it doesn't affect the placement of its children.

The value is relative to the size of this node. A value of 1 means as far to the right/bottom as possible. Here are a few examples of offsets:

  • [-1, -1] - top left corner
  • [1, -1] - top right corner
  • [0, 1] - bottom edge
  • [-1, 1] - bottom left corner
Inherited from Shape.offset

opacity​

readonly public opacity: SimpleSignalnumberGrid

Represents the opacity of this node in the range 0-1.

The value is clamped to the range 0-1.

Inherited from Shape.opacity

padding​

readonly public padding: SpacingSignalGrid
Inherited from Shape.padding

parent​

readonly public parent: SimpleSignalnullNodevoid = ...
Inherited from Shape.parent

position​

readonly public position: Vector2SignalGrid

Represents the position of this node in local space of its parent.

Examples

Inherited from Shape.position

properties​

readonly public properties: RecordstringPropertyMetadataany = ...
Inherited from Shape.properties

ratio​

readonly public ratio: SimpleSignalnullnumberGrid
Inherited from Shape.ratio
readonly public right: SimpleVector2SignalGrid

The position of the right edge of this node.

When set, this shortcut property will modify the node's position so that the right edge ends up in the given place.

When retrieved, it will return the position of the right edge in the parent space.

Inherited from Shape.right

rotation​

readonly public rotation: SimpleSignalnumberGrid

Represents the rotation (in degrees) of this node relative to its parent.

Inherited from Shape.rotation

scale​

readonly public scale: Vector2SignalGrid

Represents the scale of this node in local space of its parent.

Examples

Inherited from Shape.scale

shaders​

readonly public shaders: SignalPossibleShaderConfigShaderConfig[]GridSignalContextPossibleShaderConfigShaderConfig[]Grid
Experimental
This is an experimental feature. The behavior and API may change drastically between minor releases.
Inherited from Shape.shaders

shadowBlur​

readonly public shadowBlur: SimpleSignalnumberGrid
Inherited from Shape.shadowBlur

shadowColor​

readonly public shadowColor: ColorSignalGrid
Inherited from Shape.shadowColor

shadowOffset​

readonly public shadowOffset: Vector2SignalGrid
Inherited from Shape.shadowOffset

shrink​

readonly public shrink: SimpleSignalnumberGrid
Inherited from Shape.shrink

size​

readonly public size: Vector2LengthSignalGrid

Represents the size of this node.

A size is a two-dimensional vector, where x represents the width, and y represents the height.

The value of both x and y is of type Length which is either:

  • number - the desired length in pixels
  • ${number}% - a string with the desired length in percents, for example '50%'
  • null - an automatic length

When retrieving the size, all units are converted to pixels, using the current state of the layout. For example, retrieving the width set to '50%', while the parent has a width of 200px will result in the number 100 being returned.

When the node is not part of the layout, setting its size using percents refers to the size of the entire scene.

Examples

Inherited from Shape.size

skew​

readonly public skew: Vector2SignalGrid

Represents the skew of this node in local space of its parent.

Examples

Inherited from Shape.skew

spacing​

readonly public spacing: Vector2SignalGrid

The spacing between the grid lines.

start​

readonly public start: SimpleSignalnumberGrid

The percentage that should be clipped from the beginning of each grid line.

The portion of each grid line that comes before the given percentage will be made invisible.

This property is useful for animating the grid appearing on-screen.

stroke​

readonly public stroke: CanvasStyleSignalGrid
Inherited from Shape.stroke

strokeFirst​

readonly public strokeFirst: SimpleSignalbooleanGrid
Inherited from Shape.strokeFirst

styles​

public styles: CSSStyleDeclaration
Inherited from Shape.styles

textAlign​

readonly public textAlign: SimpleSignalCanvasTextAlignGrid
Inherited from Shape.textAlign

textDirection​

readonly public textDirection: SimpleSignalCanvasDirectionGrid
Inherited from Shape.textDirection

textWrap​

readonly public textWrap: SimpleSignalTextWrapGrid
Inherited from Shape.textWrap

top​

readonly public top: SimpleVector2SignalGrid

The position of the top edge of this node.

When set, this shortcut property will modify the node's position so that the top edge ends up in the given place.

When retrieved, it will return the position of the top edge in the parent space.

Inherited from Shape.top

topLeft​

readonly public topLeft: SimpleVector2SignalGrid

The position of the top left corner of this node.

When set, this shortcut property will modify the node's position so that the top left corner ends up in the given place.

When retrieved, it will return the position of the top left corner in the parent space.

Inherited from Shape.topLeft

topRight​

readonly public topRight: SimpleVector2SignalGrid

The position of the top right corner of this node.

When set, this shortcut property will modify the node's position so that the top right corner ends up in the given place.

When retrieved, it will return the position of the top right corner in the parent space.

Inherited from Shape.topRight

wrap​

readonly public wrap: SimpleSignalFlexWrapGrid
Inherited from Shape.wrap

zIndex​

readonly public zIndex: SimpleSignalnumberGrid
Inherited from Shape.zIndex

Accessors​

columnGap​

public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Shape.columnGap

height​

public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Shape.height

rowGap​

public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Shape.rowGap

width​

public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Inherited from Shape.width

x​

public get x(): SimpleSignalnumberthis
Inherited from Shape.x

y​

public get y(): SimpleSignalnumberthis
Inherited from Shape.y

Methods​

[iterator]​

public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Inherited from Shape.[iterator]

absoluteOpacity​

public absoluteOpacity(): number
Inherited from Shape.absoluteOpacity

add​

public addnode: ComponentChildren: Grid

Add the given node(s) as the children of this node.

The nodes will be appended at the end of the children list.

Examples

Parameters

Inherited from Shape.add

anchorPosition​

public anchorPosition(): Vector2
Inherited from Shape.anchorPosition

applyState​

public applyStatestate: NodeState: void
public applyStatestate: NodeStateduration: numbertiming?: TimingFunction: ThreadGenerator

Apply the given state to the node, setting all matching signal values to the provided values.

Parameters

Inherited from Shape.applyState

cacheBBox​

public cacheBBox(): BBox

Get a bounding box for the contents rendered by this node as well as its children.

Inherited from Shape.cacheBBox

childAs​

public childAsT extends NodeT = Nodeindex: number: nullT

Get the nth children cast to the specified type.

Type Parameters

Parameters

  • index: number

    The index of the child to retrieve.

Inherited from Shape.childAs

childrenAs​

public childrenAsT extends NodeT = Node(): T[]

Get the children array cast to the specified type.

Type Parameters

Inherited from Shape.childrenAs

clone​

public clonecustomProps: NodeState = {}: Grid

Create a copy of this node.

Parameters

Inherited from Shape.clone

compositeToLocal​

public compositeToLocal(): DOMMatrix
Inherited from Shape.compositeToLocal

compositeToWorld​

public compositeToWorld(): DOMMatrix

A matrix mapping composite space to world space.

Certain effects such as blur and shadows ignore the current transformation. This matrix can be used to transform their parameters so that the effect appears relative to the closest composite root.

Inherited from Shape.compositeToWorld

computedPosition​

public computedPosition(): Vector2
Inherited from Shape.computedPosition

dispose​

public dispose(): void

Prepare this node to be disposed of.

This method is called automatically when a scene is refreshed. It will be called even if the node is not currently attached to the tree.

The goal of this method is to clean any external references to allow the node to be garbage collected.

Inherited from Shape.dispose

drawOverlay​

public drawOverlaycontext: CanvasRenderingContext2Dmatrix: DOMMatrix: void

Draw an overlay for this node.

The overlay for the currently inspected node is displayed on top of the canvas.

The provided context is in screen space. The local-to-screen matrix can be used to transform all shapes that need to be displayed. This approach allows to keep the line widths and gizmo sizes consistent, no matter how zoomed-in the view is.

Parameters

Inherited from Shape.drawOverlay

findAll​

public findAllT extends NodeTpredicate: node: any => node is T: T[]
public findAllT extends NodeT = Nodepredicate: node: any => boolean: T[]

Find all descendants of this node that match the given predicate.

Type Parameters

Parameters

  • predicate: node: any => node is T

    A function that returns true if the node matches.

Inherited from Shape.findAll

findAncestor​

public findAncestorT extends NodeTpredicate: node: Node => node is T: nullT
public findAncestorT extends NodeT = Nodepredicate: node: Node => boolean: nullT

Find the closest ancestor of this node that matches the given predicate.

Type Parameters

Parameters

Inherited from Shape.findAncestor

findFirst​

public findFirstT extends NodeTpredicate: node: Node => node is T: nullT
public findFirstT extends NodeT = Nodepredicate: node: Node => boolean: nullT

Find the first descendant of this node that matches the given predicate.

Type Parameters

Parameters

Inherited from Shape.findFirst

findLast​

public findLastT extends NodeTpredicate: node: Node => node is T: nullT
public findLastT extends NodeT = Nodepredicate: node: Node => boolean: nullT

Find the last descendant of this node that matches the given predicate.

Type Parameters

Parameters

Inherited from Shape.findLast

getOriginDelta​

public getOriginDeltaorigin: Origin: Vector2

Parameters

Inherited from Shape.getOriginDelta

getState​

public getState(): NodeState

Return a snapshot of the node's current signal values.

This method will calculate the values of any reactive properties of the node at the time the method is called.

Inherited from Shape.getState

hit​

public hitposition: Vector2: nullNode

Try to find a node intersecting the given position.

Parameters

Inherited from Shape.hit

insert​

public insertnode: ComponentChildrenindex: number = 0: Grid

Insert the given node(s) at the specified index in the children list.

Examples

Parameters

Inherited from Shape.insert

instantiate​

public instantiateprops: NodeProps = {}: Grid

Create an instance of this node's class.

Parameters

Inherited from Shape.instantiate

isLayoutRoot​

public isLayoutRoot(): boolean
Inherited from Shape.isLayoutRoot

layoutEnabled​

public layoutEnabled(): boolean

Get the resolved layout mode of this node.

When the mode is null, its value will be inherited from the parent.

Use layout to get the raw mode set for this node (without inheritance).

Inherited from Shape.layoutEnabled

localToParent​

public localToParent(): DOMMatrix

Get the local-to-parent matrix for this node.

This matrix transforms vectors from local space of this node to local space of this node's parent.

Inherited from Shape.localToParent

localToWorld​

public localToWorld(): DOMMatrix

Get the local-to-world matrix for this node.

This matrix transforms vectors from local space of this node to world space.

Examples

Inherited from Shape.localToWorld

lockSize​

public lockSize(): void
Inherited from Shape.lockSize

move​

public moveby: number = 1: Grid

Rearrange this node in relation to its siblings.

Children are rendered starting from the beginning of the children list. We can change the rendering order by rearranging said list.

A positive by arguments move the node up (it will be rendered on top of the elements it has passed). Negative values move it down.

Parameters

  • by: number = 1

    Number of places by which the node should be moved.

Inherited from Shape.move

moveAbove​

public moveAbovenode: NodedirectlyAbove: boolean = false: Grid

Move the node above the provided node in the parent's layout.

The node will be moved above the provided node and from then on will be rendered on top of it. By default, if the node is already positioned higher than the sibling node, it will not get moved.

Parameters

  • node: Node

    The sibling node below which to move.

  • directlyAbove: boolean = false

    Whether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.

Inherited from Shape.moveAbove

moveBelow​

public moveBelownode: NodedirectlyBelow: boolean = false: Grid

Move the node below the provided node in the parent's layout.

The node will be moved below the provided node and from then on will be rendered below it. By default, if the node is already positioned lower than the sibling node, it will not get moved.

Parameters

  • node: Node

    The sibling node below which to move.

  • directlyBelow: boolean = false

    Whether the node should be positioned directly below the sibling. When true, will move the node even if it is already positioned below the sibling.

Inherited from Shape.moveBelow

moveDown​

public moveDown(): Grid

Move the node down in relation to its siblings.

The node will exchange places with the sibling right below it (if any) and from then on will be rendered under it.

Inherited from Shape.moveDown

moveOffset​

public moveOffsetoffset: Vector2: void

Update the offset of this node and adjust the position to keep it in the same place.

Parameters

Inherited from Shape.moveOffset

moveTo​

public moveToindex: number: Grid

Move the node to the provided position relative to its siblings.

If the node is getting moved to a lower position, it will be placed below the sibling that's currently at the provided index (if any). If the node is getting moved to a higher position, it will be placed above the sibling that's currently at the provided index (if any).

Parameters

  • index: number

    The index to move the node to.

Inherited from Shape.moveTo

moveToBottom​

public moveToBottom(): Grid

Move the node to the bottom in relation to its siblings.

The node will be placed at the beginning of the children list and from then on will be rendered below all of its siblings.

Inherited from Shape.moveToBottom

moveToTop​

public moveToTop(): Grid

Move the node to the top in relation to its siblings.

The node will be placed at the end of the children list and from then on will be rendered on top of all of its siblings.

Inherited from Shape.moveToTop

moveUp​

public moveUp(): Grid

Move the node up in relation to its siblings.

The node will exchange places with the sibling right above it (if any) and from then on will be rendered on top of it.

Inherited from Shape.moveUp

parentAs​

public parentAsT extends NodeT = Node(): nullT

Get the parent cast to the specified type.

Type Parameters

Inherited from Shape.parentAs

peekChildren​

public peekChildren(): readonly Node[]

Get the current children of this node.

Unlike children, this method does not have any side effects. It does not register the children signal as a dependency, and it does not spawn any children. It can be used to safely retrieve the current state of the scene graph for debugging purposes.

Inherited from Shape.peekChildren

reactiveClone​

public reactiveClonecustomProps: NodeState = {}: Grid

Create a reactive copy of this node.

A reactive copy has all its properties dynamically updated to match the source node.

Parameters

Inherited from Shape.reactiveClone

releaseSize​

public releaseSize(): void
Inherited from Shape.releaseSize

remove​

public remove(): Grid

Remove this node from the tree.

Inherited from Shape.remove

removeChildren​

public removeChildren(): void

Remove all children of this node.

Inherited from Shape.removeChildren

render​

public rendercontext: CanvasRenderingContext2D: Promisevoid

Render this node onto the given canvas.

Parameters

Inherited from Shape.render

reparent​

public reparentnewParent: Node: void

Change the parent of this node while keeping the absolute transform.

After performing this operation, the node will stay in the same place visually, but its parent will be changed.

Parameters

Inherited from Shape.reparent

restore​

public restore(): void
public restoreduration: numbertiming?: TimingFunction: ThreadGenerator

Restore the node to its last saved state.

This method can be used together with the save method to restore a node to a previously saved state. Restoring a node to a previous state removes that state from the state stack.

Examples

Inherited from Shape.restore

ripple​

public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany

Parameters

Inherited from Shape.ripple

save​

public save(): void

Push a snapshot of the node's current state onto the node's state stack.

This method can be used together with the restore method to save a node's current state and later restore it. It is possible to store more than one state by calling save method multiple times.

Inherited from Shape.save

snapshotClone​

public snapshotClonecustomProps: NodeState = {}: Grid

Create a copy of this node.

Unlike clone, a snapshot clone calculates any reactive properties at the moment of cloning and passes the raw values to the copy.

Parameters

Inherited from Shape.snapshotClone

toPromise​

public toPromise(): PromiseGrid

Wait for any asynchronous resources that this node or its children have.

Certain resources like images are always loaded asynchronously. Awaiting this method makes sure that all such resources are done loading before continuing the animation.

Inherited from Shape.toPromise

view​

public view(): View2D
Inherited from Shape.view

worldToLocal​

public worldToLocal(): DOMMatrix

Get the world-to-local matrix for this node.

This matrix transforms vectors from world space to local space of this node.

Examples

Inherited from Shape.worldToLocal

worldToParent​

public worldToParent(): DOMMatrix

Get the world-to-parent matrix for this node.

This matrix transforms vectors from world space to local space of this node's parent.

Inherited from Shape.worldToParent