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.interface
<Frame>
<Index>                              cls_name       group                doc                  <<U18>
<Index: signature>
__init__(indices, *, indexers, na... IndexHierarchy Constructor          Initializer. Args...
from_index_items(items, *, index_... IndexHierarchy Constructor          Given an iterable...
from_labels(labels, *, name, reor... IndexHierarchy Constructor          Construct an Inde...
from_labels_delimited(labels, *, ... IndexHierarchy Constructor          Construct an Inde...
from_names(names)                    IndexHierarchy Constructor          Construct a zero-...
from_pandas(value)                   IndexHierarchy Constructor          Given a Pandas in...
from_product(*, name, index_const... IndexHierarchy Constructor          Given groups of i...
from_tree(tree, *, name, index_co... IndexHierarchy Constructor          Convert into a In...
from_values_per_depth(values, *, ... IndexHierarchy Constructor          Construct an Inde...
to_frame()                           IndexHierarchy Exporter             Return Frame vers...
to_frame_go()                        IndexHierarchy Exporter             Return a FrameGO ...
to_html(config, style_config)        IndexHierarchy Exporter             Return an HTML ta...
to_html_datatables(fp, *, show, c... IndexHierarchy Exporter             Return a complete...
to_pandas()                          IndexHierarchy Exporter             Return a Pandas M...
to_tree()                            IndexHierarchy Exporter             Returns the tree ...
to_visidata()                        IndexHierarchy Exporter             Open an interacti...
STATIC                               IndexHierarchy Attribute            bool(x) -> bool R...
...                                  ...            ...                  ...
via_re(pattern, flags).search(pos... IndexHierarchy Accessor Regular ... Scan through stri...
via_re(pattern, flags).match(pos,... IndexHierarchy Accessor Regular ... If zero or more c...
via_re(pattern, flags).fullmatch(... IndexHierarchy Accessor Regular ... If the whole stri...
via_re(pattern, flags).split(maxs... IndexHierarchy Accessor Regular ... Split string by t...
via_re(pattern, flags).findall(po... IndexHierarchy Accessor Regular ... Return all non-ov...
via_re(pattern, flags).sub(repl, ... IndexHierarchy Accessor Regular ... Return the string...
via_re(pattern, flags).subn(repl,... IndexHierarchy Accessor Regular ... Perform the same ...
via_hashlib(include_name, include... IndexHierarchy Accessor Hashlib     Return the byte s...
via_hashlib(include_name, include... IndexHierarchy Accessor Hashlib
via_hashlib(include_name, include... IndexHierarchy Accessor Hashlib
via_hashlib(include_name, include... IndexHierarchy Accessor Hashlib
via_hashlib(include_name, include... IndexHierarchy Accessor Hashlib
via_hashlib(include_name, include... IndexHierarchy Accessor Hashlib
via_hashlib(include_name, include... IndexHierarchy Accessor Hashlib
via_hashlib(include_name, include... IndexHierarchy Accessor Hashlib
via_hashlib(include_name, include... IndexHierarchy Accessor Hashlib
via_hashlib(include_name, include... IndexHierarchy Accessor Hashlib
<<U90>                               <<U14>         <<U27>               <<U83>
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