Detail: Index: Display

Overview: 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_labels(labels, *, name)         Index    Constructor          Construct an Inde...
from_pandas(value)                   Index    Constructor          Given a Pandas in...
to_html(config, style_config)        Index    Exporter             Return an HTML ta...
to_html_datatables(fp, *, show, c... Index    Exporter             Return a complete...
to_pandas()                          Index    Exporter             Return a Pandas I...
to_series()                          Index    Exporter             Return a Series w...
to_visidata()                        Index    Exporter             Open an interacti...
STATIC                               Index    Attribute            bool(x) -> bool R...
depth                                Index    Attribute            int([x]) -> integ...
dtype                                Index    Attribute            Return the dtype ...
index_types                          Index    Attribute            Return a Series o...
memory                               Index    Attribute            Return a MemoryDi...
mloc                                 Index    Attribute            The memory locati...
name                                 Index    Attribute            A hashable label ...
names                                Index    Attribute            Provide a suitabl...
nbytes                               Index    Attribute            Return the total ...
...                                  ...      ...                  ...
via_re(pattern, flags).sub(repl, ... Index    Accessor Regular ... Return the string...
via_re(pattern, flags).subn(repl,... Index    Accessor Regular ... Perform the same ...
via_hashlib(include_name, include... Index    Accessor Hashlib     Return the byte s...
via_hashlib(include_name, include... Index    Accessor Hashlib
via_hashlib(include_name, include... Index    Accessor Hashlib
via_hashlib(include_name, include... Index    Accessor Hashlib
via_hashlib(include_name, include... Index    Accessor Hashlib
via_hashlib(include_name, include... Index    Accessor Hashlib
via_hashlib(include_name, include... Index    Accessor Hashlib
via_hashlib(include_name, include... Index    Accessor Hashlib
via_hashlib(include_name, include... Index    Accessor Hashlib
via_hashlib(include_name, include... Index    Accessor Hashlib
via_type_clinic.to_hint()            Index    Accessor Type Clinic Return the type h...
via_type_clinic.check(hint, *, fa... Index    Accessor Type Clinic Given a hint (a t...
via_type_clinic.warn(hint, *, fai... Index    Accessor Type Clinic Given a hint (a t...
via_type_clinic.__call__(hint, *,... Index    Accessor Type Clinic Given a hint (a t...
via_type_clinic.__repr__()           Index    Accessor Type Clinic Return a compact ...
<<U90>                               <<U5>    <<U27>               <<U83>
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>

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