Interaction Reference

The complete set of Producer Component Properties and Consumer Component Functions you can wire in an Interaction. An Interaction passes a property from a producer component to a consumer component, which responds by running a function. For the concept and worked examples, see Actions & Interactions.

Producer Component Properties

The property the producer passes when the trigger fires:

Property	What it passes
selected	The currently selected item — e.g. the selected row in a table or node in a tree
options	The producer's option list (for example, a dropdown's configured options)
channels	Only the data channels attached to the producer
value	Only the current value of the producer
label	Only the label text of the producer
name	The component name
views	The list of available views
viewContext	The shared view context passed between displays — carries the selection (written with SetOptions) and the view's time/GTC parameters. The target view reads it on onCreate with SetChannels. See Passing Asset Context.
queryParameters	The producer's query parameters (for SQL-based tags)
running	The producer's run/replay state (e.g. TimeFrame components) (experimental)
dataContent	The producer's current data content (experimental)
dataContext	The producer's data context (experimental)
searchParameterUpdate	A search-parameter change from the producer, e.g. a Dropdown driving a search (experimental)

This is the full set of producer properties offered in the Interaction dropdown. Entries marked (experimental) are available, but their behavior may present some discrepancies.

Consumer Component Functions

How the consumer responds. The Available on column shows which components support each function:

Function	What the consumer does	Available on
Select	Selects an item from the consumer's options	Dropdown, Menubar, Multiselect, Table, Timeframe, Tree
Search	Filters the consumer's data by element, timeframe, or tag search	All
Expand	Expands to the next level of the asset structure (its children)	Asset Group, Dropdown, Table, Tree
Highlight	Selects rows or highlights a time range (needs a start/end)	Line Chart, Profile View, SQC Chart, Table
SetChannels	Replaces the consumer's channels with the producer's	All
AddChannels	Adds the producer's channels to the consumer's existing ones	All
SetTime	Sets the consumer's time range (start and end)	Bar Chart, Line Chart, XY Chart
SetStartTime	Sets only the start of the time range	Asset Group, Line Chart, XY Chart
SetEndTime	Sets only the end of the time range	Asset Group, Line Chart, XY Chart
SetOptions	Sets the consumer's option list — used with viewContext to carry a selection between displays	Uses viewContext
GetOptions	Reads the consumer's current option list	Uses viewContext
SetQueryParameters	Replaces all of the consumer's URL query parameters (for SQL-based tags)	All
AddQueryParameters	Adds or updates specific query parameters	All
Snapshot	Captures the consumer's current data	All
panTo	Pans the consumer (such as a map) to a location (needs lat/lng) — note the lowercase name	Map
show	Makes a hidden component visible	All
hide	Hides a visible component	All
SetOverlay	Listed in the dropdown, but the current app has no matching SetOverlay handler (only a lowercase setOverlay on the Map component) — it appears non-functional; avoid until confirmed	—
GoToView	Navigates to a different display — to move between displays, prefer a Navigation action	—
OpenPreset	Opens a saved preset on the consumer	—
deleteElement	Removes the consumer component from the display	—
getDataSources	Returns the consumer's data sources (experimental)	—
OpenBranch	Deep-links a Tree to a specific node — scrolls to it and expands the path to it while keeping the full hierarchy in view (unlike Expand, which replaces the view with one level of children). Takes the selected node as its parameter	Tree
SetSearchParameter	Sets a search parameter on the consumer, e.g. a Dropdown (experimental)	Dropdown
ElementTimeFrameSearch	Runs an element→timeframe search on the consumer	Timeframe, Timeframe Annotation Table
TimeFrameElementSearch	Runs a timeframe→element search on the consumer	Timeframe, Timeframe Annotation Table
UpdateMapping	Updates the consumer's attribute mapping (experimental)	All
ShowMappingChannels	Shows the consumer's mapped (attribute) channels (experimental)	All
HideMappingChannels	Hides the consumer's mapped (attribute) channels (experimental)	All
onChange	Fires the consumer's onChange handler (experimental)	All

This is the full set of functions offered in the Interaction dropdown. Entries marked (experimental) are available, but their behavior may present some discrepancies. The Available on column lists the components each function works on; a dash (—) means that list isn't confirmed yet. See the component scripting reference for each function's parameters and support.

GoToView vs. a Navigation action

GoToView is the one consumer function that changes the view, so it's the exception to the "Interactions stay on the current display" rule. For moving between displays, prefer a dedicated Navigation action — it's clearer and exposes the target-view picker directly. See Navigation Between Displays.

What's Next

Interactions wire components together on a single display; the next step is moving the viewer between displays, carrying context along. Continue to Navigation Between Displays →.

Related

• Actions & Interactions — the concept, configuration, and worked examples
• Navigation Between Displays — moving between displays and passing asset context
• Component Scripts — each function's parameters and the components that support it
• Interaction Functions — the scripting API for producer → consumer interactions