DOM & Scroll Controls

Published Updated
Monitor scroll viewport positions, track window coordinates, and trigger direct DOM element updates.

DOM & Scroll Control operators interface the 3D scene engine directly with the surrounding web application document wrapper.

DOM Action Operator for HTML & CSS Updates#

Operator<DocsSdkOperatorsDomManipulator>: Communicates directly with HTML DOM components to dynamically update stylesheets, class lists, or input field values.

1. Functional Overview

The DOM Action operator provides direct procedural links between the 3D context and the hosting webpage's HTML structure. It allows the scene's event hooks to toggle element classes, inject stylesheet parameters, or retrieve browser input parameters programmatically.

DOM Action

GENERAL_ALL.DOM_ACTOR
Operator
Operator Type
DOM_ACTOR
Operator Group
GENERAL_ALL

DOM Action Properties Details

Property & TypeDisplay NameSystem TypeDefault
selector: string
CSS Selector
STRING
TEXT INPUT
""
action: "CLICK" | "DOUBLE_CLICK" | "HOVER" | "TYPE_TEXT" | "SET_VALUE" | "SET_ATTRIBUTE" | "GET_ATTRIBUTE" | "GET_PROPERTY" | "ADD_CLASS" | "REMOVE_CLASS" | "TOGGLE_CLASS" | "SET_STYLE" | "SCROLL_TO" | "FOCUS"
Action To Perform
ENUM
DROPDOWN
"CLICK"
payload: string
Text / Value Payload
STRING
TEXT INPUT
""
attributeKey: string
Attribute / Property Name
STRING
TEXT INPUT
""
shouldWait: boolean
Wait for Element
BOOL
TOGGLE
false
waitTimeout: int
Timeout (ms)
INT
RANGE SLIDER
3000
autoScroll: boolean
Scroll Into View First
BOOL
TOGGLE
false

@Input

@Input & TypeDisplay Name@Input TypeGroup
performAction: () => void
Perform Action
OPERATOROPERATOR

@Output

@Output & TypeDisplay Name@Output TypeGroup
outputData: AirEvent<string>
Output Data
DATA_STRINGAIR_PROPERTY
onSuccess: AirEvent<void>
On Success
OPERATOROPERATOR
onFailure: AirEvent<string>
On Failure
DATA_STRINGAIR_PROPERTY

Mouse Data Operator for Screen Pointer Coordinates#

Operator<DocsSdkOperatorsDomMouseData>: Resolves active pointer coordinate paths and click patterns, outputting normalized screen position floats.

1. Functional Overview

The Mouse Data operator provides ongoing viewport cursor coordinates. It tracks cursor movements across the experience screen, outputting normalized X and Y values (from -1 to +1) through Output X and Output Y, letting visual logic align elements directly with pointer positions.

Mouse Data

DATA_NUMBER.MOUSE_DATA_PROVIDER
Operator
Operator Type
MOUSE_DATA_PROVIDER
Operator Group
DATA_NUMBER

Mouse Data Properties Details

Property & TypeDisplay NameSystem TypeDefault
outputRange: [number, number]
Min / Max
RANGE
RANGE SLIDER
[-0.5, 0.5]
axis: "X" | "Y"
Active Axis
ENUM
OPTION SELECTOR
"X"
invert: boolean
Invert
BOOL
TOGGLE
false

@Input

@Input & TypeDisplay Name@Input TypeGroup
toggleOnoff: () => void
Toggle On/Off
OPERATOROPERATOR

@Output

@Output & TypeDisplay Name@Output TypeGroup
outputValue: AirEvent<float>
Output Value
DATA_FLOATAIR_PROPERTY

Scroll Manager Operator for Scrollytelling#

Operator<DocsSdkOperatorsDomScrollManager>: Monitors page scrolling metrics to dispatch layout coordinates and progress percentages.

1. Functional Overview

The Scroll Manager operator tracks the user's current reading/viewing position on the container web page. It converts browser window scroll height coordinates into raw floats or percentage ranges, broadcasting progress values to drive scroll-based 3D animations or parallax effect systems.

Scroll Manager

GENERAL_ALL.SCROLL
Operator
Operator Type
SCROLL
Operator Group
GENERAL_ALL

Scroll Manager Properties Details

Property & TypeDisplay NameSystem TypeDefault
containerUnitIds: any
Scroll Container
STRING_ARRAY
UNIT SELECTOR
[]
destinationMode: "ELEMENT" | "COORDINATES" | "TOP" | "BOTTOM"
Mode
ENUM
DROPDOWN
"ELEMENT"
targetUnitIds: any
Target Unit
STRING_ARRAY
UNIT SELECTOR
[]
targetX: float
X Position (px)
FLOAT
TEXT INPUT
0
targetY: float
Y Position (px)
FLOAT
TEXT INPUT
0
offsetY: float
Offset Y (px)
FLOAT
TEXT INPUT
0
offsetX: float
Offset X (px)
FLOAT
TEXT INPUT
0
enableObservation: boolean
Enable Triggers
BOOL
TOGGLE
false
observerThreshold: float
Threshold
FLOAT
RANGE SLIDER
0.1
observerRootMargin: string
Root Margin
STRING
TEXT INPUT
"0px"
smooth: boolean
Smooth Scroll
BOOL
TOGGLE
true

@Input

@Input & TypeDisplay Name@Input TypeGroup
scroll: () => void
Scroll
OPERATOROPERATOR

@Output

@Output & TypeDisplay Name@Output TypeGroup
onEnterViewport: AirEvent<void>
On Enter Viewport
OPERATOROPERATOR
onLeaveViewport: AirEvent<void>
On Leave Viewport
OPERATOROPERATOR