Skip to main content
Version: 4.54

SourceParams

Definition of source parameters to append to an insert layer.

This type has the following structure:

KeyTypeDescriptionDefault Value
"aspectRatio"StringAspect ratio of an inserted element (analogous to grid constraints).null
"aspectRatioField"StringQuery result field to use as aspect ratio.null
"columnSpan"NumberNumber of columns used by an inserted element in the Grid (similar to grid constraints).12
"columnSpanField"StringQuery result field to use as column span.null
"heightField"StringQuery result field to use as height.null
"layout"StringName of the layout that is used to display selected content. The layout is applied to a data JSON provided by the source. There is one JSON per record or selected content entry.null
"layoutField"StringQuery result field to use as layout.null
"name"StringName of the connected picker layer (only with source picker).null
"path"StringPath under which the data is retrieved from the content of the node (only with source data and url).null
"query"StringName of the query with which the data is retrieved (only with source query).null
"queryParams"ArrayThe params to append to the query.null
"table"StringName of the database table from which the data is retrieved (only with source query).null
"template"StringName of a client template that is applied to the data (only with source query and url).null
"templateField"StringQuery result field to use as template.null
"updateInterval"NumberSpecifies for the updateMode periodic after which time, in seconds, the URL should be retrieved again (only with source url).60
"updateMode"StringSpecifies how often the URL is retrieved (only with source url).null
"url"StringURL to be retrieved (only with source url).null