This documentation is for an older version of GoodData.
Go to the latest version of this article.
DataFrameFactory.
indexed
indexed(index_by: IndexDef, columns: ColumnsDef, filter_by: Optional[Union[Filter, list[Filter]]], on_execution_submitted: Optional[Callable[[Execution], None]], is_cancellable: bool) ->
pandas.DataFrame
Creates a data frame indexed by values of the label. The data frame columns will be created from either
metrics or other label values. Note that depending on the composition of the labels, the DataFrame's index may or may not be unique.
Parameters
| name | type | description |
|---|---|---|
| index_by | IndexDef | One or more labels to index by. |
| columns | ColumnsDef | Dictionary mapping column name to its definition. |
| filter_by | Optional[Union[Filter, list[Filter]]] | Optional filters to apply during computation on the server. |
| 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. |