DataFrameFactory.
for_items
for_items(items: ColumnsDef, filter_by: Optional[Union[Filter, list[Filter]]], auto_index: bool, on_execution_submitted: Optional[Callable[[Execution], None]], is_cancellable: bool) ->
pandas.DataFrame
Creates a data frame for named items. This is a convenience method that will create DataFrame with or
without an index based on the context of the items that you pass.
Parameters
| name | type | description |
|---|---|---|
| items | ColumnsDef | Dictionary mapping item name to its definition. |
| filter_by | Optional[Union[Filter, list[Filter]]] | Optionally specify filters to apply during computation on the server. |
| auto_index | bool | Default True. Enables creation of DataFrame with index depending on the contents of the items. |
| 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. |
Returns
| type | description |
|---|---|
| pandas.DataFrame | A DataFrame instance. |