- Docs
- update(options?)
update(options?)
Detailed Ticker API contract: update(options?)
Merges options into the controller’s current normalized configuration, updates wrapper metadata, and schedules a rebuild.
Signature
update(options?: TickerOptions): TickerInstance
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
options | TickerOptions | no | Fields to shallow-merge into the current normalized options. |
Returns
The same TickerInstance, so calls can be chained.
Behavior
instance.update({ duration: 32, direction: 'right' }).refresh()
- Omitted fields keep their current values.
- Supplied fields are normalized again.
- Previous controller-owned
classtokens are removed and the new tokens are added. - Unrelated classes added by application code remain.
- Behavior attributes and effective options are synchronized after applying viewport rules. Existing explicit pause intent is preserved unless
autoplayis explicitly supplied. Same-axis changes preserve pixel position; axis changes reset it. See responsive precedence. - Rebuilding is scheduled through
requestAnimationFrame; it is not a synchronous geometry read.
Calling update() with no argument still normalizes the current snapshot and schedules a refresh. After destruction it is a chainable no-op.