orxtra v0.13.0 /protocols.src.orxtra.protocols._types._surfaces
On this page

A2UI surface types: SurfaceSpec describes a rendered surface; CreateSurface, UpdateComponents, UpdateDataModel, and DeleteSurface are the mutating operations unioned as SurfaceOperation.

#protocols.src.orxtra.protocols._types._surfaces

#protocols.src.orxtra.protocols._types._surfaces

#SurfaceSpec

SurfaceSpec
FieldTypeDefault
surface_idstr
catalog_idstr
theme`dict[str, Any]None`

#CreateSurface

CreateSurface
FieldTypeDefault
surface_idstr
catalog_idstr
theme`dict[str, Any]None`None
send_data_modelboolFalse

#UpdateComponents

UpdateComponents
FieldTypeDefault
surface_idstr
componentslist[dict[str, Any]]

#UpdateDataModel

UpdateDataModel
FieldTypeDefault
surface_idstr
pathstr'/'
valueAnyNone

#DeleteSurface

DeleteSurface
FieldTypeDefault
surface_idstr
Search