bigframes.pandas.DataFrame.rename_axis#

DataFrame.rename_axis(mapper: Union[blocks.Label, Sequence[blocks.Label]]) → DataFrame[source]#

DataFrame.rename_axis(mapper: Union[blocks.Label, Sequence[blocks.Label]], *, inplace: Literal[False], **kwargs) → DataFrame

DataFrame.rename_axis(mapper: Union[blocks.Label, Sequence[blocks.Label]], *, inplace: Literal[True], **kwargs) → None

Set the name of the axis for the index.

Note

Currently only accepts a single string parameter (the new name of the index).

Parameters:

mapper (str) – Value to set the axis name attribute.
inplace (bool) – Default False. Modifies the object directly, instead of creating a new Series or DataFrame.

Returns:

DataFrame with the new index name or None if inplace=True.

Return type:

bigframes.pandas.DataFrame | None