Detail: IndexHierarchy: Display#

Overview: IndexHierarchy: Display

IndexHierarchy.interface#

A Frame documenting the interface of this class.

>>> ih = sf.IndexHierarchy.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih
<IndexHierarchy: ('x', 'y', 'z')>
a                                 1024    1517-04-01
a                                 2048    1789-12-31
b                                 0       1620-11-21
<<U1>                             <int64> <datetime64[D]>
>>> ih.interface
<Frame>
<Index>                              cls_name       group                doc                  <<U18>
<Index: signature>
__init__(indices, /, *, indexers, n… IndexHierarchy Constructor          Initializer. Args: …
from_difference(*others)             IndexHierarchy Constructor          Construct a new Ind…
from_index_items(items, /, *, index… IndexHierarchy Constructor          Given an iterable o…
from_intersection(*others)           IndexHierarchy Constructor          Construct a new Ind…
from_labels(labels, /, *, name, reo… IndexHierarchy Constructor          Construct an IndexH…
from_labels_delimited(labels, /, *,… IndexHierarchy Constructor          Construct an IndexH…
from_names(names, /)                 IndexHierarchy Constructor          Construct a zero-le…
from_pandas(value, /)                IndexHierarchy Constructor          Given a Pandas inde…
from_product(*, name, index_constru… IndexHierarchy Constructor          Given groups of ite…
from_tree(tree, /, *, name, index_c… IndexHierarchy Constructor          Convert into a Inde…
from_union(*others)                  IndexHierarchy Constructor          Construct a new Ind…
from_values_per_depth(values, /, *,… IndexHierarchy Constructor          Construct an IndexH…
to_frame()                           IndexHierarchy Exporter             Return Frame versio…
to_frame_go()                        IndexHierarchy Exporter             Return a FrameGO ve…
to_html(config, /, *, style_config)  IndexHierarchy Exporter             Return an HTML tabl…
to_html_datatables(fp, /, *, show, … IndexHierarchy Exporter             Return a complete H…
to_pandas()                          IndexHierarchy Exporter             Return a Pandas Mul…
…                                    …              …                    …
via_re(pattern, flags, /).sub(repl,… IndexHierarchy Accessor Regular Ex… Return the string o…
via_re(pattern, flags, /).subn(repl… IndexHierarchy Accessor Regular Ex… Perform the same op…
via_hashlib(*, include_name, includ… IndexHierarchy Accessor Hashlib     Return the byte sig…
via_hashlib(*, include_name, includ… IndexHierarchy Accessor Hashlib
via_hashlib(*, include_name, includ… IndexHierarchy Accessor Hashlib
via_hashlib(*, include_name, includ… IndexHierarchy Accessor Hashlib
via_hashlib(*, include_name, includ… IndexHierarchy Accessor Hashlib
via_hashlib(*, include_name, includ… IndexHierarchy Accessor Hashlib
via_hashlib(*, include_name, includ… IndexHierarchy Accessor Hashlib
via_hashlib(*, include_name, includ… IndexHierarchy Accessor Hashlib
via_hashlib(*, include_name, includ… IndexHierarchy Accessor Hashlib
via_hashlib(*, include_name, includ… IndexHierarchy Accessor Hashlib
via_type_clinic.to_hint()            IndexHierarchy Accessor Type Clinic Return the type hin…
via_type_clinic.check(hint, /, *, f… IndexHierarchy Accessor Type Clinic Given a hint (a typ…
via_type_clinic.warn(hint, /, *, fa… IndexHierarchy Accessor Type Clinic Given a hint (a typ…
via_type_clinic.__call__(hint, /, *… IndexHierarchy Accessor Type Clinic Given a hint (a typ…
via_type_clinic.__repr__()           IndexHierarchy Accessor Type Clinic Return a compact st…
<<U91>                               <<U14>         <<U27>               <<U81>
IndexHierarchy.__repr__()#

Return repr(self).

>>> ih = sf.IndexHierarchy.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> repr(ih)
<IndexHierarchy: ('x', 'y', 'z')>
a                                 1024    1517-04-01
a                                 2048    1789-12-31
b                                 0       1620-11-21
<<U1>                             <int64> <datetime64[D]>
IndexHierarchy.__str__()#

Return str(self).

>>> ih = sf.IndexHierarchy.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> str(ih)
<IndexHierarchy: ('x', 'y', 'z')>
a                                 1024    1517-04-01
a                                 2048    1789-12-31
b                                 0       1620-11-21
<<U1>                             <int64> <datetime64[D]>
IndexHierarchy.display(config=None, /, *, style_config=None)[source]#

Return a static_frame.Display, capable of providing a string representation.

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> ih = sf.IndexHierarchy.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.display()
<IndexHierarchy: ('x', 'y', 'z')>
a                                 1024    1517-04-01
a                                 2048    1789-12-31
b                                 0       1620-11-21
<<U1>                             <int64> <datetime64[D]>
>>> ih.display(sf.DisplayConfig(type_show=False))
a 1024 1517-04-01
a 2048 1789-12-31
b 0    1620-11-21
IndexHierarchy.display_tall(config=None, /)#

Maximize vertical presentation. Return a static_frame.Display, capable of providing a string representation.

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> ih = sf.IndexHierarchy.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.display_tall()
<IndexHierarchy: ('x', 'y', 'z')>
a                                 1024    1517-04-01
a                                 2048    1789-12-31
b                                 0       1620-11-21
<<U1>                             <int64> <datetime64[D]>
IndexHierarchy.display_wide(config=None, /)#

Maximize horizontal presentation. Return a static_frame.Display, capable of providing a string representation.

Parameters:

config – A static_frame.DisplayConfig instance. If not provided, the static_frame.DisplayActive will be used.

>>> ih = sf.IndexHierarchy.from_labels((('a', 1024, '1517-04-01'), ('a', 2048, '1789-12-31'), ('b', 0, '1620-11-21')), index_constructors=(sf.Index, sf.Index, sf.IndexDate), name=('x', 'y', 'z'))
>>> ih.display_wide()
<IndexHierarchy: ('x', 'y', 'z')>
a                                 1024    1517-04-01
a                                 2048    1789-12-31
b                                 0       1620-11-21
<<U1>                             <int64> <datetime64[D]>

IndexHierarchy: Constructor | Exporter | Attribute | Method | Dictionary-Like | Display | Selector | Iterator | Operator Binary | Operator Unary | Accessor Values | Accessor Datetime | Accessor String | Accessor Transpose | Accessor Regular Expression | Accessor Hashlib | Accessor Type Clinic