Home > @unseenco/backstage-core > ISheet > declareSequenceVariants

ISheet.declareSequenceVariants() method

Declares the sequence variants available on this sheet. Each variant has its own independent sequence data, allowing the same properties to be animated differently per variant (e.g. mobile vs desktop).

The "default" variant is always required and is included automatically if omitted.

Signature:

declareSequenceVariants(variants: SequenceVariantId[]): void;

Parameters

Parameter	Type	Description
variants	SequenceVariantId[]	An array of variant names (each at least 3 characters long)

Returns:

void

Example

const sheet = project.sheet('Scene')
sheet.declareSequenceVariants(['default', 'mobile', 'desktop'])
sheet.setActiveSequenceVariant('mobile')