Skip to content

eles.animate(opts)

eles.animate — Collection > Animation. Cytoscape.js signatures, parameters and return contract.

eles.animate — Collection › Animation

Preview · Collection › Animation

Read in the complete API reference · All API members

// Animate these elements' style and/or position to explicit targets over duration ms, easing the normalized time
eles.animate(opts: AnimateOptions): this

Animate these elements' style and/or position to explicit targets over duration ms, easing the normalized time.

There is no queue: the animation starts immediately, animations on disjoint channels run concurrently, and starting one that overlaps a running animation's channels stops the older one in place — its promise resolves, its values freeze, and the new animation captures from there. Sequence with await animation( …).play() rather than by queueing.

Animatable: position; opacity (both groups); node background-color/border-color/border-width, edge line-color; and the geometry numerics node width/height, edge width, compound padding and font-size. Colours interpolate in OKLab, matching the colour mappers.

Use named easings or cubic-bezier( …), CSS linear( …) and spring( bounce). A custom easing function is rejected — a closure cannot cross to the GPU, so accepting one would mean a curve that silently depended on whether the animation got offloaded.

Parameters
NameDescription
opts: AnimateOptions

targets (position, style, or collapsed for compound parents; viewport forms apply on cy.animate), duration, easing, delay, complete

Fields of opts
NameDescription
style: Record<string, string | number>?
position: Partial<Position>?
collapsed: boolean?

Target the collapsed state of compound parents. This is an element-only animation channel and may be combined with timing options, but not with other style, position, or viewport targets.

pan: Position?

viewport targets (core.animate)

panBy: Position?

viewport target: pan by a delta rather than to an absolute position. Resolved against the pan at creation time, so a manual pan afterwards does not move the target. Throws alongside pan — the two spell the same channel. Core-only: an element animation ignores it.

zoom: number?
fit: { eles?: unknown; boundingBox?: { x1: number; y1: number; x2?: number; y2?: number; w?: number; h?: number; }; padding?: number; }?

viewport target: animate to the viewport that fits the given elements (or an explicit model-space box). Resolved to pan/zoom when the animation is created.

center: { eles?: unknown }?

viewport target: animate the pan that centers the given elements

duration: number?
easing: string?

A named easing, cubic-bezier(), linear() or spring(bounce). For a spring, duration is the perceptual duration and the animation runs on past it to settle, so its total length is longer (see durationMs).

delay: number?
complete: () => void?
Returns this

this collection, for chaining; use animation() when you want the handle

Example

eles.animate({ position: { x: 20, y: 10 }, duration: 100 });
eles.stop(true);
console.log(cy.getElementById('a').position('x')); // 20

Example graph and handle setup

See

Collection#animation for the handle form with promise/pause/resume/reverse