Ctrl+K

tablate.concat

Contents

tablate.concat#

class tablate.concat(frame_list, container_border=None, container_padding=None, container_width=None, frame_divider=None, background=None, background_padding=None, html_px_multiplier=None, html_container_styles=None, column_styles=None, text_styles=None, html_frame_styles=None, html_column_styles=None, html_text_styles=None)[source]#

Merge a list of Tablate container instances into a new Tablate container instance. (Useful for IPython environment.)

Parameters:

  • frame_list (List[TablateBase]) – A list of Tablate container instances.

  • container_border (Optional[Literal['blank', 'thin', 'thick', 'double']]) – outer border style for the Tablate container instance. [default: ‘thick’]

  • container_padding (Optional[int]) – outer padding (in Unicode character width) for the Tablate container instance. [default: 1]

  • container_width (Optional[int]) – outer width (in Unicode character width) for the Tablate container instance. [default: 120 or terminal width]

  • frame_divider (Optional[Literal['none', 'blank', 'thin', 'thick', 'double']]) – default dividing line between frames within the Tablate container instance. [default: ‘thick’]

  • background (Optional[Literal['white', 'grey', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'dark_red', 'dark_green', 'dark_yellow', 'dark_blue', 'dark_magenta', 'dark_cyan', 'dark_grey', 'black']]) – default background for frames withing the Tablate container instance. [default: None]

  • background_padding (Optional[int]) – additional padding applied to cells with a background color set (ASCII only). [default: 1]

  • html_px_multiplier (Optional[int]) – Multiplier applied to HTML px properties. [default: 1]

  • html_container_styles (Optional[HtmlContainerStylesInput]) – style dictionary for HTML specific styles for Tablate container instance. [default: None]

  • column_styles (Optional[ColumnStylesInput]) – style dictionary for default base column styles. [default: {“column_divider”: ‘thin’, “padding”: 1, “background_padding”: 1}]

  • text_styles (Optional[TextStylesInput]) – style dictionary for default base text styles. [default: { “text_style”: ‘normal’, “text_align”: ‘left’, “text_color”: None }]

  • html_frame_styles (Optional[HtmlFrameStylesInput]) –

    style dictionary for default HTML specific frame styles. [default: {

    “html_frame_divider_style”: “thick”, “html_frame_divider_weight: 1, “html_frame_divider_color”: ‘black’, “html_multiline”: True (False for Table frames), “html_max_lines”: None, “html_background”: None }]

  • html_column_styles (Optional[HtmlColumnStylesInput]) – style dictionary for default HTML specific column styles. [default: { “html_column_divider_style”: ‘thin’, “html_column_divider_weight”: 1, “html_column_divider_color”: ‘black’, “html_padding”: 6px }]

  • html_text_styles (Optional[HtmlTextStylesInput]) – style dictionary for default HTML specific text styles. [default: { “html_text_style”: ‘normal’, “html_text_align”: ‘left’, “html_text_color”: None, “html_text_size”: 16 }]

Returns: A new TablateSet instance.

Contents