Detail: Frame: Display#

Overview: Frame: Display

Frame.interface#

A Frame documenting the interface of this class.

>>> f = sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')
>>> f
<Frame: x>
<Index>    a       b      c               <<U1>
<Index>
0          10      False  1517-01-01
1          2       True   1517-04-01
2          8       True   1517-12-31
3          3       False  1517-06-30
<int64>    <int64> <bool> <datetime64[D]>
>>> f.interface
<Frame>
<Index>                              cls_name group           doc                  <<U18>
<Index: signature>
__init__(data, /, *, index, columns… Frame    Constructor     Initializer. Args: …
from_arrow(value, /, *, index_depth… Frame    Constructor     Realize a Frame fro…
from_clipboard(*, delimiter, index_… Frame    Constructor     Create a Frame from…
from_concat(frames, /, *, axis, uni… Frame    Constructor     Concatenate multipl…
from_concat_items(items, /, *, axis… Frame    Constructor     Produce a Frame wit…
from_csv(fp, /, *, index_depth, ind… Frame    Constructor     Specialized version…
from_delimited(fp, /, *, delimiter,… Frame    Constructor     Create a Frame from…
from_dict(mapping, /, *, index, fil… Frame    Constructor     Create a Frame from…
from_dict_fields(fields, /, *, colu… Frame    Constructor     Frame constructor f…
from_dict_records(records, /, *, in… Frame    Constructor     Frame constructor f…
from_dict_records_items(items, /, *… Frame    Constructor     Frame constructor f…
from_display(display, /)             Frame    Constructor     Construct a Frame f…
from_element(element, /, *, index, … Frame    Constructor     Create a Frame from…
from_element_items(items, /, *, ind… Frame    Constructor     Create a Frame from…
from_elements(elements, /, *, index… Frame    Constructor     Create a Frame from…
from_fields(fields, /, *, index, co… Frame    Constructor     Frame constructor f…
from_items(pairs, /, *, index, fill… Frame    Constructor     Frame constructor f…
…                                    …        …               …
reduce.from_func(func, *, fill_valu… Frame    Accessor Reduce For each Frame, and…
reduce.from_func(func, *, fill_valu… Frame    Accessor Reduce For each Frame, and…
reduce.from_map_func(func, *, fill_… Frame    Accessor Reduce For each Frame, red…
reduce.from_map_func(func, *, fill_… Frame    Accessor Reduce For each Frame, red…
reduce.from_map_func(func, *, fill_… Frame    Accessor Reduce For each Frame, red…
reduce.from_map_func(func, *, fill_… Frame    Accessor Reduce For each Frame, red…
reduce.from_map_func(func, *, fill_… Frame    Accessor Reduce For each Frame, red…
reduce.from_label_map(func_map, *, … Frame    Accessor Reduce For Frame, reduce b…
reduce.from_label_map(func_map, *, … Frame    Accessor Reduce For Frame, reduce b…
reduce.from_label_map(func_map, *, … Frame    Accessor Reduce For Frame, reduce b…
reduce.from_label_map(func_map, *, … Frame    Accessor Reduce For Frame, reduce b…
reduce.from_label_map(func_map, *, … Frame    Accessor Reduce For Frame, reduce b…
reduce.from_label_pair_map(func_map… Frame    Accessor Reduce For Frame, reduce b…
reduce.from_label_pair_map(func_map… Frame    Accessor Reduce For Frame, reduce b…
reduce.from_label_pair_map(func_map… Frame    Accessor Reduce For Frame, reduce b…
reduce.from_label_pair_map(func_map… Frame    Accessor Reduce For Frame, reduce b…
reduce.from_label_pair_map(func_map… Frame    Accessor Reduce For Frame, reduce b…
<<U161>                              <<U5>    <<U27>          <<U81>
Frame.__repr__()#

Return repr(self).

>>> f = sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')
>>> repr(f)
<Frame: x>
<Index>    a       b      c               <<U1>
<Index>
0          10      False  1517-01-01
1          2       True   1517-04-01
2          8       True   1517-12-31
3          3       False  1517-06-30
<int64>    <int64> <bool> <datetime64[D]>
Frame.__str__()#

Return str(self).

>>> f = sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')
>>> str(f)
<Frame: x>
<Index>    a       b      c               <<U1>
<Index>
0          10      False  1517-01-01
1          2       True   1517-04-01
2          8       True   1517-12-31
3          3       False  1517-06-30
<int64>    <int64> <bool> <datetime64[D]>
Frame.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.

>>> f = sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')
>>> f.display()
<Frame: x>
<Index>    a       b      c               <<U1>
<Index>
0          10      False  1517-01-01
1          2       True   1517-04-01
2          8       True   1517-12-31
3          3       False  1517-06-30
<int64>    <int64> <bool> <datetime64[D]>
>>> f.display(sf.DisplayConfig(type_show=False))
  a  b     c
0 10 False 1517-01-01
1 2  True  1517-04-01
2 8  True  1517-12-31
3 3  False 1517-06-30
Frame.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.

>>> f = sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')
>>> f.display_tall()
<Frame: x>
<Index>    a       b      c               <<U1>
<Index>
0          10      False  1517-01-01
1          2       True   1517-04-01
2          8       True   1517-12-31
3          3       False  1517-06-30
<int64>    <int64> <bool> <datetime64[D]>
Frame.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.

>>> f = sf.Frame.from_fields(((10, 2, 8, 3), (False, True, True, False), ('1517-01-01', '1517-04-01', '1517-12-31', '1517-06-30')), columns=('a', 'b', 'c'), dtypes=dict(c=np.datetime64), name='x')
>>> f.display_wide()
<Frame: x>
<Index>    a       b      c               <<U1>
<Index>
0          10      False  1517-01-01
1          2       True   1517-04-01
2          8       True   1517-12-31
3          3       False  1517-06-30
<int64>    <int64> <bool> <datetime64[D]>

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