Detail: Index: Display#

Index.interface#

A Frame documenting the interface of this class.

>>> ix = sf.Index((None, 'A', 1024, True), name='x')
>>> ix
<Index: x>
None
A
1024
True
<object>
>>> ix.interface
<Frame>
<Index>                              cls_name group                doc                  <<U18>
<Index: signature>
__init__(labels, /, *, loc_is_iloc,… Index    Constructor          Initializer. Args: …
from_difference(*others)             Index    Constructor          Construct a new Ind…
from_intersection(*others)           Index    Constructor          Construct a new Ind…
from_labels(labels, /, *, name)      Index    Constructor          Construct an Index …
from_pandas(value, /)                Index    Constructor          Given a Pandas inde…
from_union(*others)                  Index    Constructor          Construct a new Ind…
to_html(config, /, *, style_config)  Index    Exporter             Return an HTML tabl…
to_html_datatables(fp, /, *, show, … Index    Exporter             Return a complete H…
to_pandas()                          Index    Exporter             Return a Pandas Ind…
to_series()                          Index    Exporter             Return a Series wit…
to_visidata()                        Index    Exporter             Open an interactive…
STATIC                               Index    Attribute            Returns True when t…
depth                                Index    Attribute            int([x]) -> integer…
dtype                                Index    Attribute            Return the dtype of…
index_types                          Index    Attribute            Return a Series of …
memory                               Index    Attribute            A MemoryDisplay, pr…
mloc                                 Index    Attribute            The memory location…
…                                    …        …                    …
via_re(pattern, flags, /).sub(repl,… Index    Accessor Regular Ex… Return the string o…
via_re(pattern, flags, /).subn(repl… Index    Accessor Regular Ex… Perform the same op…
via_hashlib(*, include_name, includ… Index    Accessor Hashlib     Return the byte sig…
via_hashlib(*, include_name, includ… Index    Accessor Hashlib
via_hashlib(*, include_name, includ… Index    Accessor Hashlib
via_hashlib(*, include_name, includ… Index    Accessor Hashlib
via_hashlib(*, include_name, includ… Index    Accessor Hashlib
via_hashlib(*, include_name, includ… Index    Accessor Hashlib
via_hashlib(*, include_name, includ… Index    Accessor Hashlib
via_hashlib(*, include_name, includ… Index    Accessor Hashlib
via_hashlib(*, include_name, includ… Index    Accessor Hashlib
via_hashlib(*, include_name, includ… Index    Accessor Hashlib
via_type_clinic.to_hint()            Index    Accessor Type Clinic Return the type hin…
via_type_clinic.check(hint, /, *, f… Index    Accessor Type Clinic Given a hint (a typ…
via_type_clinic.warn(hint, /, *, fa… Index    Accessor Type Clinic Given a hint (a typ…
via_type_clinic.__call__(hint, /, *… Index    Accessor Type Clinic Given a hint (a typ…
via_type_clinic.__repr__()           Index    Accessor Type Clinic Return a compact st…
<<U91>                               <<U5>    <<U27>               <<U81>

Index.__repr__()#

Return repr(self).

>>> ix = sf.Index((None, 'A', 1024, True), name='x')
>>> repr(ix)
<Index: x>
None
A
1024
True
<object>

Index.__str__()#

Return str(self).

>>> ix = sf.Index((None, 'A', 1024, True), name='x')
>>> str(ix)
<Index: x>
None
A
1024
True
<object>

Index.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.

>>> ix = sf.Index((None, 'A', 1024, True), name='x')
>>> ix.display()
<Index: x>
None
A
1024
True
<object>
>>> ix.display(sf.DisplayConfig(type_show=False))
None
A
1024
True

Index.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.

>>> ix = sf.Index((None, 'A', 1024, True), name='x')
>>> ix.display_tall()
<Index: x>
None
A
1024
True
<object>

Index.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.

>>> ix = sf.Index((None, 'A', 1024, True), name='x')
>>> ix.display_wide()
<Index: x>
None
A
1024
True
<object>