State & Data Blocks
State & Data Blocks operators handle data persistence, state synchronizations, and structural dataset mappings throughout the scene runtime.
Data Block Operator for Structured JSON State#
1. Functional Overview
The Data Block operator coordinates structured, tabular, or nested JSON collections inside Aircada. It handles structured payloads via its Data Input @Input, saving them or loading them from disk/offline store, and dispatches the compiled record out of its Data Output @Output, firing success or failure event hooks accordingly.
3. SDK Runtime Initialization
When initializing a Data Block operator programmatically via the SDK at runtime, pass a default object containing both the storage configurations (such as dataStoreType, tableName, etc.) and the schema for the custom data properties. This instantiates the operator with the correct storage settings and pre-populates the list of custom runtime properties that it will hold, modify, and persist when triggered.
4. Studio Configuration
Inside the Aircada Studio, designers can place a Data Block operator into the scene and define its custom key-value property schema directly using the interactive Operator UI panel, without writing setup code.
Data Block
DATA_BLOCKDATA_BLOCK@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
dataInput: (payload: DataBlock[]) => void | Data Input | DATA_BLOCK | DATA_BLOCK |
save: () => void | Save | OPERATOR | OPERATOR |
load: () => void | Load | OPERATOR | OPERATOR |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
dataOutput: AirEvent<DataBlock[]> | Data Output | DATA_BLOCK | DATA_BLOCK |
savedData: AirEvent<DataBlock[]> | Saved Data | DATA_BLOCK | DATA_BLOCK |
loadedData: AirEvent<DataBlock[]> | Loaded Data | DATA_BLOCK | DATA_BLOCK |
onSuccess: AirEvent<void> | On Success | OPERATOR | OPERATOR |
onFailure: AirEvent<void> | On Failure | OPERATOR | OPERATOR |
Metadata Stamp Operator for Session Records#
1. Functional Overview
The Data Stamp operator records historical timelines. It intercepts data block payloads, embeds the active system UTC timestamp, session ID, and user info parameters, and dispatches the stamped record downstream to ensure reliable transaction audit logging.
Data Stamp
DATA_STAMPDATA_BLOCKData Stamp Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
dataBlocks: any | dataBlocks | NONENONE | undefined |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
loadData: (payload: any) => void | Load Data | UNIT_COMMON | UNIT |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
dataOutput: AirEvent<DataBlock[]> | Data Output | DATA_BLOCK | DATA_BLOCK |
Data Store Properties Reference in Aircada#
Data stores in Aircada are configured dynamically using the following set of storage reference properties:
- dataStoreType: Determines the underlying storage driver and persistence environment. Options include TEMPORARY (in-memory runtime storage), LOCAL_STORAGE (IndexedDB browser caching), SNAPSHOT (read-only automated transaction records), DATASET (read-only lookup from Datasets), and REMOTE_BLOCK (Azure Blob containers for long-term searchable customizations).
- dataStoreId: Specifies the unique identifier of the preconfigured storage container generated through the Aircada admin panel (required for REMOTE_BLOCK storage).
- tableName: A database-like namespace used to partition and separate distinct data lists within a data store (does not apply to DATASET or SNAPSHOT types).
- saveType: Configures the key assignment strategy during writes. Set to
NEW_IDto generate a random unique key for every entry, orKEYto write to a specific record key defined in thedefinedKeyproperty. - loadType: Configures the query retrieval strategy during reads. Set to load the latest record in the table automatically, or use the key specified in the
definedKeyproperty to load a specific record.
Data Store Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
dataStoreType: "TEMPORARY" | "LOCAL_STORAGE" | "SNAPSHOT" | "DATASET" | "REMOTE_BLOCK" | Storage Type | ENUMDROPDOWN | "TEMPORARY" |
dataStoreId: string | Data Store | STRINGDROPDOWN | "" |
datasetId: IMediaItem | Dataset | MEDIA_ITEMELEMENT SELECTOR | "" |
tableName: string | Table Name | STRINGTEXT INPUT | "" |
saveType: "NEW_ID" | "KEY" | Store By | ENUMOPTION SELECTOR | "NEW_ID" |
loadType: "LATEST" | "KEY" | Load By | ENUMOPTION SELECTOR | "LATEST" |
definedKey: string | Defined Key | STRINGTEXT INPUT | "" |
Global Variables Operator for Shared Scene State#
1. Functional Overview
The Global Variables operator acts as the central registry for cross-operator state sharing. It holds and broadcasts reactive values that any component or React UI panel can query, modify, or bind to, keeping variables in sync across isolated runtime subsystems.
Global Variables
GLOBAL_VARIABLESGLOBAL_VARIABLESLoader Operator for Dynamic 3D Asset Spawning#
1. Functional Overview
The Loader operator is used to load data blocks from the specified storage location, and output the resulting data list as a Record<string, any>[] array, or send an instantiation signal to a LayerSceneObject to instantiate a preset or existing SceneObject.
Once the data is successfully loaded from the specified storage system, it is sent via the Data List trigger for other systems to listen for.
2. Properties & Filtering
The loader operator has a list of properties for filtering and sorting the data list, as well as pagination control.
3. Data Storage Integration
Its data storage mechanism properties mirror the Data Block Operator's properties. For a detailed reference on all available storage options, refer directly to the Data Store Properties reference guide.
Loader
DATA_LOADERINSTANTIATIONLoader Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
instantiateExistingUnit: boolean | Create From Scene Object | BOOLTOGGLE | false |
unitIdsToCopy: any | Copy Object | STRING_ARRAYUNIT SELECTOR | [] |
presetId: any | Preset | NONEELEMENT SELECTOR | "" |
loadFromDataStore: boolean | Load From Data Store | BOOLTOGGLE | false |
dataStoreType: "TEMPORARY" | "LOCAL_STORAGE" | "SNAPSHOT" | "DATASET" | "REMOTE_BLOCK" | Storage Type | ENUMDROPDOWN | "LOCAL_STORAGE" |
dataStoreId: string | Data Store | STRINGDROPDOWN | "" |
datasetId: IMediaItem | Dataset | MEDIA_ITEMELEMENT SELECTOR | "" |
tableName: string | Table Name | STRINGTEXT INPUT | "" |
getAll: boolean | Return All Records | BOOLTOGGLE | false |
getMultiple: boolean | Return Multiple (paged) | BOOLTOGGLE | true |
useSearch: boolean | Enable Search | BOOLTOGGLE | false |
searchKey: string | Search Key | STRINGTEXT INPUT | "" |
searchText: string | Search Text | STRINGTEXT INPUT | "" |
useTagFilter: boolean | Enable Tag Filter | BOOLTOGGLE | false |
tagsInclude: string | Tags (Include) | ENUMDROPDOWN | [] |
tagsExclude: string | Tags (Exclude) | ENUMDROPDOWN | [] |
replaceOnReload: boolean | Replace On Reload | BOOLTOGGLE | true |
sortBy: "TIME" | "ALPHABETICAL" | "CUSTOM" | Sort By | ENUMOPTION SELECTOR | "TIME" |
sortByKey: string | Sort By Key | STRINGTEXT INPUT | "" |
sortDirection: "ASCENDING" | "DESCENDING" | Sort Direction | ENUMOPTION SELECTOR | "ASCENDING" |
pageSize: int | Page Size | INTTEXT INPUT | 20 |
page: int | Page # | INTTEXT INPUT | 1 |
instantiatePageButtons: boolean | Instantiate Page Buttons | BOOLTOGGLE | false |
pageButtonUnitId: any | Page Button Object | STRING_ARRAYUNIT SELECTOR | [] |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
load: () => void | Load | OPERATOR | OPERATOR |
nextPage: () => void | Next Page | OPERATOR | OPERATOR |
previousPage: () => void | Previous Page | OPERATOR | OPERATOR |
setPage: () => void | Set Page | OPERATOR | OPERATOR |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
dataList: AirEvent<DataBlock[]> | Data List | DATA_BLOCK | DATA_BLOCK |
instantiate: AirEvent<any> | Instantiate | INSTANTIATION_SIGNAL | INSTANTIATION |
pageButtons: AirEvent<any> | Page Buttons | INSTANTIATION_SIGNAL | INSTANTIATION |
totalRows: AirEvent<int> | Total Rows | DATA_INT | AIR_PROPERTY |
totalPages: AirEvent<int> | Total Pages | DATA_INT | AIR_PROPERTY |
pageNumber: AirEvent<int> | Page Number | DATA_INT | AIR_PROPERTY |
pageSize: AirEvent<int> | Page Size | DATA_INT | AIR_PROPERTY |
pageStart: AirEvent<int> | Page Start | DATA_INT | AIR_PROPERTY |
pageEnd: AirEvent<int> | Page End | DATA_INT | AIR_PROPERTY |
onStart: AirEvent<void> | On Start | OPERATOR | OPERATOR |
onSuccess: AirEvent<void> | On Success | OPERATOR | OPERATOR |
onFailure: AirEvent<void> | On Failure | OPERATOR | OPERATOR |
Option Group Operator for Configurator Choices#
1. Functional Overview
The Option Group operator manages lists of selectable values. It allows developers to bundle text or numeric configuration states into named option rows. Triggering selections switches the activeOptionIndex and outputs the corresponding state payload to customize scene elements.
Option Group
DATA_BLOCK_OPTION_GROUPDATA_BLOCKOption Group Properties Details
| Property & Type | Display Name | System Type | Default |
|---|---|---|---|
dataValue: string | Data Value | STRINGTEXT INPUT | "" |
dataId: string | Data ID | STRINGTEXT INPUT | "" |
label: string | Label | STRINGTEXT INPUT | "" |
metadata: string | Metadata | STRINGTEXT INPUT | "{}" |
fireOnStartup: boolean | Fire On Startup | BOOLTOGGLE | false |
dataSourceType: "MANUAL" | "DATASET" | Data Source | ENUMDROPDOWN | "MANUAL" |
datasetId: IMediaItem | Dataset | MEDIA_ITEMELEMENT SELECTOR | "" |
currentDefinitionId: string | Definitions | ENUMDROPDOWN | "" |
atLeastOne: boolean | At Least One | BOOLTOGGLE | true |
allowMultiple: boolean | Allow Select Multiple | BOOLTOGGLE | false |
definedDataBlocks: any | definedDataBlocks | NONENONE | undefined |
unitIdsToCopy: any | Copy Object | STRING_ARRAYUNIT SELECTOR | [] |
@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
dataInput: (payload: DataBlock[]) => void | Data Input | DATA_BLOCK | DATA_BLOCK |
activeStyle: (payload: IStyle) => void | Active Style | DATA_STYLE | AIR_PROPERTY |
selectAll: () => void | Select All | OPERATOR | OPERATOR |
deselectAll: () => void | Deselect All | OPERATOR | OPERATOR |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
dataOutput: AirEvent<DataBlock[]> | Data Output | DATA_BLOCK | DATA_BLOCK |
onChange: AirEvent<void> | On Change | OPERATOR | OPERATOR |
URL Parameters Operator for Query String Sync#
1. Functional Overview
The URL Parameters operator simplifies deep linking integrations. It scans the page's current address bar (e.g. ?product_id=982&color=blue), parses the keys, and outputs matching query variables to initialize personalized configurators dynamically.
URL Parameters
URL_PARAMETERSDATA_BLOCK@Input
| @Input & Type | Display Name | @Input Type | Group |
|---|---|---|---|
dataInput: (payload: DataBlock[]) => void | Data Input | DATA_BLOCK | DATA_BLOCK |
@Output
| @Output & Type | Display Name | @Output Type | Group |
|---|---|---|---|
dataOutput: AirEvent<DataBlock[]> | Data Output | DATA_BLOCK | DATA_BLOCK |