Skip to main content

Module api

Module api 

Source

Modules§

analyst_layout
analyst_panel
canvas_layout
canvas_object
canvas_panel
canvas_rect
chart_panel
chart_panel_v1
document_layout
document_node_object
document_panel
empty_panel
empty_panel_v1
node_dimension
panel
panel_id
single_tab
single_tab_v1
split_panel
split_panel_orientation
split_panel_v1
tabbed_panel
tabbed_panel_v1
viz_panel
viz_panel_v1
workbook_layout
workbook_layout_v1

Structs§

AnalystLayout
A layout for analyst backing workbooks. Panels render inline in the conversation, so entries carry no positioning — only per-panel settings, keyed by the panel’s viz id in WorkbookContent.charts.
AnalystPanel
CanvasLayout
A layout of node elements freely placed on a canvas. CanvasPanel entries represent panel nodes and HMI widgets; other CanvasObject variants may have different behavior.
CanvasPanel
A panel node or HMI widget placed on a canvas. Other CanvasObject variants may represent different node types and have their own behavior.
CanvasRect
ChartPanelV1
DocumentLayout
A layout of a document with its text editor raw state JSON and node objects such as panels metadata.
DocumentPanel
EmptyPanelV1
NodeDimension
Dimension of a node in pixels.
PanelId
Should expect a uuid. Nested panels should have unique IDs.
SingleTabV1
SplitPanelV1
TabbedPanelV1
VizPanelV1
Deprecated - use ChartPanel instead
WorkbookLayoutV1

Enums§

CanvasObject
ChartPanel
DocumentNodeObject
EmptyPanel
Panel
SingleTab
SplitPanel
SplitPanelOrientation
TabbedPanel
VizPanel
WorkbookLayout