Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion v1/specification/docs/Specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,10 @@ The `updateAction()` function is called by the Renderer to update one or more fi
Graphic. The `data` field contains a (potentially partial) update of the internal state of the Graphic and follows the
model described in the Manifest using the `schema` field.

The `skipAnimation` field indicates whether the Graphic should update with or without animation.
When not provided, the `skipAnimation` field defaults to `false`. The Graphic MUST skip the animation when
`skipAnimation` is set to `true`.

The returned Promise MUST resolve after the execution of the update.


Expand All @@ -342,6 +346,7 @@ customAction: (
params: {
id: string;
payload: unknown;
skipAnimation?: boolean;
} & VendorExtend
) => Promise<ReturnPayload | undefined>;
```
Expand All @@ -350,7 +355,12 @@ correspond to an `id` of an Action that is defined in the Manifest file, inside
`payload` field is the described in the corresponding Action inside the Manifest file. The returned Promise MUST
resolve when the action is executed.

<br>
The `skipAnimation` field indicates whether the Graphic should disappear with or without animation.
When not provided, the `skipAnimation` field defaults to `false`. The Graphic MUST skip the animation when
`skipAnimation` is set to `true`.

---

Additionally, every non-real-time Graphic MUST implement the following functions.

#### goToTime()
Expand Down
3 changes: 3 additions & 0 deletions v1/typescript-definitions/src/definitions/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ export type ActionInvokeParams = {
id: string;
/** Params to send into the method */
payload: unknown;

/** If true, skips animation (defaults to false) */
skipAnimation?: boolean;
} & VendorExtend;

export type PlayActionReturnPayload = ReturnPayload & {
Expand Down