ENH 14194: add style option for hiding index and columns

Author: nchmura4

doc/source/style.ipynb

@@ -674,13 +674,14 @@
  "- precision\n",
  "- captions\n",
  "- table-wide styles\n",
+ "- hiding the index or columns\n",
  "\n",
  "Each of these can be specified in two ways:\n",
  "\n",
  "- A keyword argument to `Styler.__init__`\n",
- "- A call to one of the `.set_` methods, e.g. `.set_caption`\n",
+ "- A call to one of the `.set_` or `.hide_` methods, e.g. `.set_caption` or `.hide_columns`\n",
  "\n",
- "The best method to use depends on the context. Use the `Styler` constructor when building many styled DataFrames that should all share the same properties. For interactive use, the`.set_` methods are more convenient."
+ "The best method to use depends on the context. Use the `Styler` constructor when building many styled DataFrames that should all share the same properties. For interactive use, the`.set_` and `.hide_` methods are more convenient."
  ]
  },
  {
@@ -814,6 +815,38 @@
  "We hope to collect some useful ones either in pandas, or preferable in a new package that [builds on top](#Extensibility) the tools here."
  ]
  },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "### Hiding the Index or Columns"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "The index can be hidden from rendering by calling `Styler.hide_index`. Columns can be hidden from rendering by calling `Styler.hide_columns` and passing in the name of a column, or a slice of columns."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "df.style.hide_index()"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "df.style.hide_columns(['C','D'])"
+ ]
+ },
  {
  "cell_type": "markdown",
  "metadata": {},
@@ -875,7 +908,9 @@
  {
  "cell_type": "code",
  "execution_count": null,
- "metadata": {},
+ "metadata": {
+ "collapsed": true
+ },
  "outputs": [],
  "source": [
  "from IPython.html import widgets\n",
@@ -911,7 +946,9 @@
  {
  "cell_type": "code",
  "execution_count": null,
- "metadata": {},
+ "metadata": {
+ "collapsed": true
+ },
  "outputs": [],
  "source": [
  "np.random.seed(25)\n",
@@ -1010,7 +1047,9 @@
  {
  "cell_type": "code",
  "execution_count": null,
- "metadata": {},
+ "metadata": {
+ "collapsed": true
+ },
  "outputs": [],
  "source": [
  "%mkdir templates"
@@ -1027,7 +1066,9 @@
  {
  "cell_type": "code",
  "execution_count": null,
- "metadata": {},
+ "metadata": {
+ "collapsed": true
+ },
  "outputs": [],
  "source": [
  "%%file templates/myhtml.tpl\n",
@@ -1078,7 +1119,9 @@
  {
  "cell_type": "code",
  "execution_count": null,
- "metadata": {},
+ "metadata": {
+ "collapsed": true
+ },
  "outputs": [],
  "source": [
  "MyStyler(df)"
@@ -1094,7 +1137,9 @@
  {
  "cell_type": "code",
  "execution_count": null,
- "metadata": {},
+ "metadata": {
+ "collapsed": true
+ },
  "outputs": [],
  "source": [
  "HTML(MyStyler(df).render(table_title=\"Extending Example\"))"
@@ -1110,7 +1155,9 @@
  {
  "cell_type": "code",
  "execution_count": null,
- "metadata": {},
+ "metadata": {
+ "collapsed": true
+ },
  "outputs": [],
  "source": [
  "EasyStyler = Styler.from_custom_template(\"templates\", \"myhtml.tpl\")\n",
@@ -1127,7 +1174,9 @@
  {
  "cell_type": "code",
  "execution_count": null,
- "metadata": {},
+ "metadata": {
+ "collapsed": true
+ },
  "outputs": [],
  "source": [
  "with open(\"template_structure.html\") as f:\n",
@@ -1147,6 +1196,7 @@
  "cell_type": "code",
  "execution_count": null,
  "metadata": {
+ "collapsed": true,
  "nbsphinx": "hidden"
  },
  "outputs": [],
@@ -1163,7 +1213,7 @@
  ],
  "metadata": {
  "kernelspec": {
- "display_name": "Python 3",
+ "display_name": "Python [default]",
  "language": "python",
  "name": "python3"
  },
@@ -1177,7 +1227,14 @@
  "name": "python",
  "nbconvert_exporter": "python",
  "pygments_lexer": "ipython3",
- "version": "3.6.1"
+ "version": "3.5.3"
+ },
+ "widgets": {
+ "application/vnd.jupyter.widget-state+json": {
+ "state": {},
+ "version_major": 1,
+ "version_minor": 0
+ }
  }
  },
  "nbformat": 4,

doc/source/whatsnew/v0.21.0.txt

@@ -163,6 +163,9 @@ Other Enhancements
 - :func:`Categorical.rename_categories` now accepts a dict-like argument as `new_categories` and only updates the categories found in that dict. (:issue:`17336`)
 - :func:`read_excel` raises ``ImportError`` with a better message if ``xlrd`` is not installed. (:issue:`17613`)
 - :meth:`DataFrame.assign` will preserve the original order of ``**kwargs`` for Python 3.6+ users instead of sorting the column names
+- :class:`pandas.io.formats.style.Styler` now has ``index`` parameter and corresponding method ``hide_index()`` to determine whether the index will be rendered in ouptut (:issue:`14194`)
+- :class:`pandas.io.formats.style.Styler` now has ``hidden_cols`` parameter and corresponding method ``hide_columns()`` to determine whether columns will be hidden in output (:issue:`14194`)
+
 
 
 .. _whatsnew_0210.api_breaking: