xorbits.pandas.Index.item#

Index.item()#

Return the first element of the underlying data as a Python scalar.

Returns

The first element of Series or Index.

Return type

scalar

Raises

ValueError – If the data is not length = 1.

Examples

>>> s = pd.Series([1])  
>>> s.item()  
1

For an index:

>>> s = pd.Series([1], index=['a'])  
>>> s.index.item()  
'a'

Warning

This method has not been implemented yet. Xorbits will try to execute it with pandas.

This docstring was copied from pandas.core.indexes.base.Index.