Skip to content

Documentation / Snap / setLocalSnapGrid

setLocalSnapGrid()

ts
function setLocalSnapGrid<Animating>(anim, gridSize): unsubscribe;

Defined in: ../../extensions/src/snap.ts:80

Sets a snap grid only for the top level of the animation.

Type Parameters

Animating

Animating extends Animatable<unknown>

Parameters

anim

Animation<Animating>

gridSize

Partial<SlicedAnimatable<Animating>>

A dictionary of the size of each grid square for each variable. Ex: {x: 1, y: 1}

Returns

unsubscribe

a function to remove the snap grid