Parameter

One parameter, resolved: what it ranges over, how it reads, and what moves it. What ctx.parameters.all lists.

@internote/canvas-sdkInterface
On this page
import { Parameter } from '@internote/canvas-sdk';

#Fields

columnRequired
The column it runs over, when column: bound one. A mark's slice: matches against it.
unknown
declaredRequired
false for a free letter nobody declared, which still gets a slider.
boolean
discreteRequired
Whether it stands on one stop at a time rather than moving through the gaps. Always true for a selector, which has nothing between its stops to stand in.
boolean
initialRequired
The position it starts at: the author's default:, else the first stop.
number
kindRequired
What the values are, for the readout: null where they are plain numbers and a decimal is the honest reading, name where they are the data's own words.
numberdatemonthweekdayhourweekname
labelRequired
The author's name: as inline content, when they gave one.
unknown
maxRequired
The top of its position range. The last index, for a categorical parameter.
number
minRequired
The bottom of its position range. 0 for a categorical parameter.
number
namesRequired
Its stops as names, when they are names, parallel to stops so that position i reads as names[i]. null for every numeric parameter.
string[] | null
nodeRequired
The control node it was read from.
CompiledNode
parameterRequired
The name it occupies in the scene's parameter map: a letter, or a word.
string
stepRequired
The distance between stops: the data's own spacing unless told otherwise, and 1 when categorical.
number
stopsRequired
The positions it may stand on, ascending.
number[]
sweepRequired
The scene's sweep of it, when it is a cue control.
ParameterSweep | null

Declared in packages/canvas-sdk/src/parameters/index.ts:79.

Last updated