Skip to content

Update a control variable

PATCH/v2/themes/{themeId}/rive-graphics/{graphicId}/control-variables/{id}

PATCH
/v2/themes/{themeId}/rive-graphics/{graphicId}/control-variables/{id}
curl --request PATCH \
--url https://api.ligr.live/rest/v2/themes/1/rive-graphics/example/control-variables/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "ifUnchangedSince": "example", "type": "string", "defaultValue": "example", "description": "example", "options": [ "example" ], "exitMode": "immediate" }'

Beta. This operation can change between minor versions. See Beta status.

Updates a control variable.

themeId
required
number format: double
graphicId
required
string
id
required
string
Media typeapplication/json
object
ifUnchangedSince
string
type

An entity type (team, player, fact, …) gets its reference data shape (dataSchema) from the server.

string
Allowed values: string number boolean enum team player match fact teamStat set round court stat period
defaultValue
description
string
options
Array<string>
exitMode
string
Allowed values: immediate deferred

Ok

Media typeapplication/json
object
updatedAt
required
string
entityId
required

Id of the created or changed entity, or null for settings.

string
nullable
stateMachine
required
object
version
required
integer format: int32
currentArtboard
required
string
currentStateMachine
required
string
controlVariables
required
Array<object>
object
id
required
string
name
required
string
type
required
string
defaultValue
Any of:
boolean
value
Any of:
boolean
data
dataSchema
description
string
options
Array<string>
exitMode
string
Allowed values: immediate deferred
dataBindings
required
Array<object>
object
id
required
string
name
required
string
defaultValue
Any of:
boolean
value
string
expression
required
string
viewModelProperty
required
object
imageDimensions
object
height
required
number format: double
width
required
number format: double
viewModelId
required
string
viewModelName
required
string
listModel
string
sourceArrayPath
string
enumValues
Array<string>
type
required
string
path
required
string
exposed
object
name
required
string
expression
required
string
required
required
boolean
entityType
required
string
Allowed values: player team competition ad
width
number format: double
height
number format: double
imageTransform
object
outWidth
number format: double
outHeight
number format: double
fit
string
Allowed values: cover contain stretch
scaleX
number format: double
scaleY
number format: double
rotateDeg
number format: double
skewXDeg
number format: double
skewYDeg
number format: double
translateX
number format: double
translateY
number format: double
padding
object
top
number format: double
right
number format: double
bottom
number format: double
left
number format: double
background
object
r
number format: double
g
number format: double
b
number format: double
a
number format: double
anchor
string
Allowed values: center top-left top top-right left right bottom-left bottom bottom-right
stateMachineInputs
required
Array<object>
object
id
required
string
name
required
string
type
required
string
Allowed values: boolean number trigger
defaultValue
Any of:
boolean
value
required
Any of:
boolean
expression
string
userExpressions
Array<object>
object
id
required
string
name
required
string
expression
required
string
description
string
selectedSport
string
selectedSchemas
Array<string>
assets
required
Array<object>
object
id
required
string
name
required
string
uniqueFileName
required
string
type
required
string
Allowed values: image font audio
expression
string
unresolved
boolean
metadata
object
size
required
number format: double
width
number format: double
height
number format: double
fileId
number format: double
storageKey
string
sha256
string
exposed
required
object
name
required
string
defaultFileId
integer format: int32
>= 1
required
required
boolean
expression
string
entityType
required
string
Allowed values: player team competition ad
scale
required
number format: double
x
required
number format: double
y
required
number format: double
artboardWidth
required
number format: double
artboardHeight
required
number format: double
renderer
string
Allowed values: webgl2 canvas
rendererRelease

A Rive renderer release choice of a theme, or of one graphic. A graphic without one follows its theme.

object
policy
required
string
Allowed values: latest pinned
release

The release for pinned, for example 2.41.0-r1.

string
deferInitialShow
boolean
layer

How deep the graphic sits when several are on air. Higher covers lower. Absent: the default depth, 100 for a Rive graphic. A code graphic has 200.

number format: double
staleReferences

Set when the request renamed a user expression. The rows whose expression still reads the old $u name. The API does not change them. Update each one to the new name.

Array<object>
object
type
required

The kind of row whose expression still reads the old name.

string
Allowed values: dataBinding userExpression input asset
id
required
string
enumMismatches

Set when an enum binding of the draft reads a theme variable that has options the Rive enum does not list.

Array<object>

A warning, not an error: the write succeeded. The binding expression reads one enum theme variable, and some options of that variable are not values of the Rive enum. Rive ignores such a value, so on air the property keeps its last value. Make the options and the enum values the same, or change the expression.

object
bindingId
required

The data binding id, for example Main.Typeface.

string
themeVariable
required

The theme variable that the expression reads, for example Typeface for $t.Typeface.

string
optionsNotInEnum
required

Options of the theme variable that the Rive enum does not list.

Array<string>
enumValuesNotInOptions
required

Values of the Rive enum that no option of the theme variable sets.

Array<string>
Example
{
"stateMachine": {
"controlVariables": [
{
"exitMode": "immediate"
}
],
"dataBindings": [
{
"exposed": {
"entityType": "player"
},
"imageTransform": {
"fit": "cover",
"anchor": "center"
}
}
],
"stateMachineInputs": [
{
"type": "boolean"
}
],
"assets": [
{
"type": "image",
"exposed": {
"entityType": "player"
}
}
],
"renderer": "webgl2",
"rendererRelease": {
"policy": "latest"
}
},
"staleReferences": [
{
"type": "dataBinding"
}
]
}