DataFrameFactory.
for_created_visualization
for_created_visualization(created_visualizations_response: dict, on_execution_submitted: Optional[Callable[[Execution], None]], is_cancellable: bool, optimized: bool, default=False, grand_totals_position: Literal["pinnedBottom", "pinnedTop", "bottom", "top"]) ->
tuple[pandas.DataFrame, DataFrameMetadata]
Creates a data frame using a created visualization.
Parameters
| name | type | description |
|---|---|---|
| created_visualizations_response | dict | Created visualization response. |
| on_execution_submitted | Optional[Callable[[Execution], None]] | Callback to call when the execution was submitted to the backend. |
| is_cancellable | bool | Whether the execution should be cancelled when the connection is interrupted. |
| optimized | bool, default=False | Use memory optimized accumulator if True; by default, the accumulator stores headers in memory as lists of dicts, which can consume a lot of memory for large results. Optimized accumulator stores only unique values and story only reference to them in the list, which can significantly reduce memory usage. |
| grand_totals_position | Literal["pinnedBottom", "pinnedTop", "bottom", "top"] | Position where grand totals should be placed. "pinnedBottom" and "bottom" append totals, "pinnedTop" and "top" prepend totals. Defaults to "bottom". |
Returns
| type | description |
|---|---|
| pandas.DataFrame | A DataFrame instance. |