This method creates a new variable
the new created variable id
parent id of the created variable
type of the created variable
This method creates a copy of a variable
This method returns the list of variables
This method returns a variable by id
the id of a specific variable
This method returns a variable by name
the name of a specific variable
This method gets the image variable connector id.
The id of the connector
The id of the image variable
Gets the private data for any variable
the private data
the id of the variable
This method aggregates the provided variables into a new group
group id
name of the new group
list of variable ids to group together
This method moves a variable's position
new order of variable
id of the variable
parent id of the created variable
This method changes positions of variables
new order of variable
Array of the variable IDs
parent id of the variables
This method removes a list of variables.
All connectors linked to the variables will be unregistered.
list of the variables to be removed
use setValue instead and pass null as the value argument.
This method removes the variable source
the id of the variable to update
This method sets a new name for a variable
id of the variable
name of the variable
This method resets a help text for a variable
id of the variable
This method resets a placeholder for a variable
id of the variable
This method sets a new help text for a variable
id of the variable
placeholder of the variable
This method sets the image variable connector. Setting a connector will automatically remove the assetId linked to the connector if present. If a connector was the source of the variable, it will be unregistered.
The new id of the connector
The id of the image variable to update
registration object containing all details about the connector
Use setIsVisible instead.
This method sets isHidden flag for a variable
This method sets isReadonly flag for a variable
This method sets isRequired flag for a variable
This method sets isVisible flag for a variable
This method sets a new label for a variable
id of the variable
label of the variable
This method sets the items of the list variable
The items need to be unique and are not case sensitive.
the id of the list variable
the items of the list
This method sets a new placeholder for a variable
id of the variable
placeholder of the variable
Experimental
Sets the prefix for a supported variable
the id of the variable to update
the prefix to set/clear
Experimental
Sets the prefix character style for a supported variable
the id of the variable to update
the id of the character style to use/clear for the prefix
Sets the private data for any variable
the id of the variable to update
the private data
Experimental
Sets the suffix for a supported variable
the id of the variable to update
the suffix to set/clear
Experimental
Sets the suffix character style for a supported variable
the id of the variable to update
the id of the character style to use/clear for the suffix
This method sets a new type for a variable
id of the variable
type of the variable
This method sets a new value for a variable
If the value is some text to be set on a ShortTextVariable, it must not contain any type of line breaks.
the id of the variable
the new value of the variable
This method dissolves the specified group
id of the variable group
Generated using TypeDoc
The VariableController is responsible for all communication regarding the variables. Methods inside this controller can be called by
window.SDK.variable.{method-name}