DataFrameFactory.

for_items

for_items(items: ColumnsDef, filter_by: Optional[Union[Filter, list[Filter]]], auto_index: bool, on_execution_submitted: Optional[Callable[[Execution], None]]) -> 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

nametypedescription
itemsColumnsDefDictionary mapping item name to its definition.
filter_byOptional[Union[Filter, list[Filter]]]Optionally specify filters to apply during computation on the server.
auto_indexboolDefault True. Enables creation of DataFrame with index depending on the contents of the items.
on_execution_submittedOptional[Callable[[Execution], None]]Callback to call when the execution was submitted to the backend.

Returns

typedescription
pandas.DataFrameA DataFrame instance.