VisualizationEditor¶
Definition¶
Extends¶
Extended By¶
None
Description¶
an open Add/Replace Visualization dialog
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| VisualizationEditor | close() | VisualizationEditor | Dismiss this dialog and unregister it. Returns the editor. |
| VisualizationEditor | create() | String | Commit the dialog: build the panel (Add) or swap it in place (Replace), close the dialog, and return the new/replaced panel id. Returns null if nothing was created (no type chosen, a required field missing, or the preview failed). |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| VisualizationEditor | getHandle() | String | The stable session handle for this editor (also its key in the Editors & Viewers menu). |
| VisualizationEditor | getSelectedTable() | String | The currently selected source table, or null. |
| VisualizationEditor | open() | VisualizationEditor | Bring this Add/Replace Visualization dialog onto the screen. Returns the editor so calls chain. |
| VisualizationEditor | setChartType(chartTypeId) | VisualizationEditor | Select a 2D chart tile by chart-type id: 'line', 'vbar', 'hbar', 'area', 'scatter', or 'advanced'. No-op for an unknown id. Returns the editor so calls chain. |
| VisualizationEditor | setTable(table) | VisualizationEditor | Select the source table the visualization is built from. No-op for an unknown table. Returns the editor so calls chain. |
| VisualizationEditor | setVisualizationType(type) | VisualizationEditor | Select the visualization family: 'table', 'tree', 'heatmap', 'chart' (2D chart), 'chart3d', or 'form'. For a specific 2D chart prefer setChartType. Returns the editor. |
| Object | toJson() | String | Returns a string of a json representation of this object. |
Method Definitions¶
close()¶
VisualizationEditor VisualizationEditor::close()
Description¶
Dismiss this dialog and unregister it. Returns the editor.
create()¶
String VisualizationEditor::create()
Description¶
Commit the dialog: build the panel (Add) or swap it in place (Replace), close the dialog, and return the new/replaced panel id. Returns null if nothing was created (no type chosen, a required field missing, or the preview failed).
getClassName()¶
Description¶
Returns the string name of this object's class type.
getHandle()¶
String VisualizationEditor::getHandle()
Description¶
The stable session handle for this editor (also its key in the Editors & Viewers menu).
getSelectedTable()¶
String VisualizationEditor::getSelectedTable()
Description¶
The currently selected source table, or null.
open()¶
VisualizationEditor VisualizationEditor::open()
Description¶
Bring this Add/Replace Visualization dialog onto the screen. Returns the editor so calls chain.
setChartType(chartTypeId)¶
VisualizationEditor VisualizationEditor::setChartType(String chartTypeId)
Description¶
Select a 2D chart tile by chart-type id: 'line', 'vbar', 'hbar', 'area', 'scatter', or 'advanced'. No-op for an unknown id. Returns the editor so calls chain.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| chartTypeId | String |
setTable(table)¶
VisualizationEditor VisualizationEditor::setTable(String table)
Description¶
Select the source table the visualization is built from. No-op for an unknown table. Returns the editor so calls chain.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| table | String |
setVisualizationType(type)¶
VisualizationEditor VisualizationEditor::setVisualizationType(String type)
Description¶
Select the visualization family: 'table', 'tree', 'heatmap', 'chart' (2D chart), 'chart3d', or 'form'. For a specific 2D chart prefer setChartType. Returns the editor.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| type | String |
toJson()¶
Description¶
Returns a string of a json representation of this object.