MultiIndex(data=None, dtype=None, *, name=None, session=None)
A multi-level, or hierarchical, index object for pandas objects.
Methods
from_arrays
from_arrays(
arrays,
sortorder: int | None = None,
names=None,
*,
session: Optional[bigframes.session.Session] = None
) -> MultiIndex
Convert arrays to MultiIndex.
Examples:
>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None
>>> arrays = [[1, 1, 2, 2], ['red', 'blue', 'red', 'blue']]
>>> bpd.MultiIndex.from_arrays(arrays, names=('number', 'color'))
MultiIndex([(1, 'red'),
(1, 'blue'),
(2, 'red'),
(2, 'blue')],
names=['number', 'color'])
Parameters | |
---|---|
Name | Description |
arrays |
list / sequence of array-likes
Each array-like gives one level's value for each data point. len(arrays) is the number of levels. |
sortorder |
int or None
Level of sortedness (must be lexicographically sorted by that level). |
names |
list / sequence of str, optional
Names for the levels in the index. |
from_tuples
from_tuples(
tuples: Iterable[tuple[Hashable, ...]],
sortorder: int | None = None,
names: Sequence[Hashable] | Hashable | None = None,
*,
session: Optional[bigframes.session.Session] = None
) -> MultiIndex
Convert list of tuples to MultiIndex.
Examples:
>>> import bigframes.pandas as bpd
>>> bpd.options.display.progress_bar = None
>>> tuples = [(1, 'red'), (1, 'blue'),
... (2, 'red'), (2, 'blue')]
>>> bpd.MultiIndex.from_tuples(tuples, names=('number', 'color'))
MultiIndex([(1, 'red'),
(1, 'blue'),
(2, 'red'),
(2, 'blue')],
names=['number', 'color'])
Parameters | |
---|---|
Name | Description |
tuples |
list / sequence of tuple-likes
Each tuple is the index of one row/column. |
sortorder |
int or None
Level of sortedness (must be lexicographically sorted by that level). |
names |
list / sequence of str, optional
Names for the levels in the index. |