axis.define · Umwelt docs

Reference/Commands/axis.define

axis.definecommandsince 0.1

Declares an additional time axis, such as reading order next to story order.

Command lineTypeScript.NET

Request

umwelt call story.umw axis.define '{
  "projectId": "ball",
  "axis": { "id": "reading", "label": "Reading order" }
}'

Request

const result = await client.axisDefine({ projectId: 'ball', axis: { id: 'reading', label: 'Reading order' } });

Request

var result = engine.AxisDefine(new DefineAxisInput
{
    ProjectId = "ball",
    Axis = new AxisDef { Id = "reading", Label = "Reading order" },
});

Response

{
  "id": "reading",
  "label": "Reading order"
}

Payload

Field	Type	Description
`projectId`required	string	The project to write to.
`axis`required	AxisDef	The axis: `id` and `label`. The id `tick` and ids beginning with `umwelt:` are reserved.

Field	Type	Description
`id`always	string	The axis id, used in `on` and in `at.axis`.
`label`always	string	How it reads, such as “Reading order”.

Defining it again is a no-op. The same id with the same label returns it unchanged; another label is a CONFLICT.

A record off the axis is visible to nobody there. A read on an axis sees only records whose event has a position on it.

Axes belong to the project. They apply at once to every timeline, and are never renamed or removed.

VALIDATION_FAILEDThe payload is malformed, the id is reserved, or the label is empty.

CONFLICTThe axis exists with another label.

NOT_FOUNDThe project does not exist.

HANDSHAKE_REQUIREDOver the protocol, hello was not sent first.

Every code is listed in Errors.