Skip to main content
`Ctrl`+`K`

# Reference/API

## Capabilities

### astropy.table Package

#### Functions

`dstack`(tables[, join_type, metadata_conflicts]) | Stack columns within tables depth-wise.
`hstack`(tables[, join_type, uniq_col_name, ...]) | Stack tables along columns (horizontally).
`join`(left, right[, keys, join_type, ...]) | Perform a join of the left table with the right table on specified keys.
`join_distance`(distance[, kdtree_args, ...]) | Helper function to join table columns using distance matching.
`join_skycoord`(distance[, distance_func]) | Helper function to join on SkyCoord columns using distance matching.
`represent_mixins_as_columns`(tbl[, ...]) | Represent input Table `tbl` using only `Column` or `MaskedColumn` objects.
`setdiff`(table1, table2[, keys]) | Take a set difference of table rows.
`unique`(input_table[, keys, silent, keep]) | Return a new table with unique rows, sorted by `keys`.
`vstack`(tables[, join_type, metadata_conflicts]) | Stack tables vertically (along rows).

#### Classes

`BST`(data, row_index[, unique]) | A basic binary search tree in pure Python, used as an engine for indexing.
`Column`([data, name, dtype, shape, length, ...]) | Define a data column for use in a Table object.
`ColumnGroups`(parent_column[, indices, keys]) |
`ColumnInfo`([bound]) | Container for meta information like name, description, format.
`Conf`() | Configuration parameters for `astropy.table`.
`JSViewer`([use_local_files, display_length]) | Provides an interactive HTML export of a Table.
`MaskedColumn`([data, name, mask, fill_value, ...]) | Define a masked data column for use in a Table object.
`NdarrayMixin`(obj, *args, **kwargs) | Mixin column class to allow storage of arbitrary numpy ndarrays within a Table.
`PprintIncludeExclude`([default]) | Maintain tuple that controls table column visibility for print output.
`QTable`([data, masked, names, dtype, meta, ...]) | A class to represent tables of heterogeneous data.
`Row`(table, index) | A class to represent one row of a Table object.
`SCEngine`(data, row_index[, unique]) | Fast tree-based implementation for indexing, using the `sortedcontainers` package.
`SerializedColumn` | Subclass of dict used to serialize mixin columns.
`SortedArray`(data, row_index[, unique]) | Implements a sorted array container using a list of numpy arrays.
`StringTruncateWarning` | Warning class for when a string column is assigned a value that gets truncated because the base (numpy) string length is too short.
`Table`([data, masked, names, dtype, meta, ...]) | A class to represent tables of heterogeneous data.
`TableAttribute`([default]) | Descriptor to define a custom attribute for a Table subclass.
`TableColumns`([cols]) | OrderedDict subclass for a set of columns.
`TableFormatter`() |
`TableGroups`(parent_table[, indices, keys]) |
`TableMergeError` |
`TableReplaceWarning` | Warning class for cases when a table column is replaced via the Table.__setitem__ syntax e.g. t['a'] = val.

#### Class Inheritance Diagram

## Notebook Backends

### astropy.table.notebook_backends Module

Backend implementations for `Table` interface with Jupyter notebooks.

#### Functions

`classic`(table[, tableid, css, ...]) | Render the table in HTML and show it in the Jupyter notebook.
`ipydatagrid`(table, **kwargs) | Render the table in HTML with `ipydatagrid` and show it in the Jupyter notebook.