Added documentation on the new df.style.bar options for align and Colors in the documentation.

Author: jmarrec

doc/source/html-styling.ipynb

@@ -1,8 +1,12 @@
 {
  "cells": [
  {
- "cell_type": "markdown",
- "metadata": {},
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {
+ "collapsed": true
+ },
+ "outputs": [],
  "source": [
  "*New in version 0.17.1*\n",
  "\n",
@@ -31,6 +35,24 @@
  "- [Extensibility](#Extensibility)"
  ]
  },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {
+ "collapsed": true
+ },
+ "outputs": [],
+ "source": []
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {
+ "collapsed": true
+ },
+ "outputs": [],
+ "source": []
+ },
  {
  "cell_type": "markdown",
  "metadata": {},
@@ -518,7 +540,7 @@
  "cell_type": "markdown",
  "metadata": {},
  "source": [
- "You can include \"bar charts\" in your DataFrame."
+ "There's also `.highlight_min` and `.highlight_max`."
  ]
  },
  {
@@ -529,14 +551,25 @@
  },
  "outputs": [],
  "source": [
- "df.style.bar(subset=['A', 'B'], color='#d65f5f')"
+ "df.style.highlight_max(axis=0)"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "metadata": {
+ "collapsed": false
+ },
+ "outputs": [],
+ "source": [
+ "df.style.highlight_min(axis=0)"
  ]
  },
  {
  "cell_type": "markdown",
  "metadata": {},
  "source": [
- "There's also `.highlight_min` and `.highlight_max`."
+ "Use `Styler.set_properties` when the style doesn't actually depend on the values."
  ]
  },
  {
@@ -547,7 +580,23 @@
  },
  "outputs": [],
  "source": [
- "df.style.highlight_max(axis=0)"
+ "df.style.set_properties(**{'background-color': 'black',\n",
+ " 'color': 'lawngreen',\n",
+ " 'border-color': 'white'})"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "### Bar charts"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "You can include \"bar charts\" in your DataFrame."
  ]
  },
  {
@@ -558,14 +607,16 @@
  },
  "outputs": [],
  "source": [
- "df.style.highlight_min(axis=0)"
+ "df.style.bar(subset=['A', 'B'], color='#d65f5f')"
  ]
  },
  {
  "cell_type": "markdown",
  "metadata": {},
  "source": [
- "Use `Styler.set_properties` when the style doesn't actually depend on the values."
+ "New in version 0.19.2 is the ability to customize further the bar chart: You can now have the `df.style.bar` be centered on zero or midpoint value (in addition to the already existing way of having the min value at the left side of the cell), and you can pass a list of `[color_negative, color_positive]`.\n",
+ "\n",
+ "The following example shows the behavior of the new align options:"
  ]
  },
  {
@@ -576,9 +627,44 @@
  },
  "outputs": [],
  "source": [
- "df.style.set_properties(**{'background-color': 'black',\n",
- " 'color': 'lawngreen',\n",
- " 'border-color': 'white'})"
+ "import pandas as pd\n",
+ "from IPython.display import HTML\n",
+ "\n",
+ "# Test series\n",
+ "test1 = pd.Series([-100,-60,-30,-20], name='All Negative')\n",
+ "test2 = pd.Series([10,20,50,100], name='All Positive')\n",
+ "test3 = pd.Series([-10,-5,0,90], name='Both Pos and Neg')\n",
+ "\n",
+ "head = \"\"\"\n",
+ "<table>\n",
+ " <thead>\n",
+ " <th>Align</th>\n",
+ " <th>All Negative</th>\n",
+ " <th>All Positive</th>\n",
+ " <th>Both Neg and Pos</th>\n",
+ " </thead>\n",
+ " </tbody>\n",
+ "\n",
+ "\"\"\"\n",
+ "\n",
+ "aligns = ['left','zero','mid']\n",
+ "for align in aligns:\n",
+ " row = \"<tr><th>{}</th>\".format(align)\n",
+ " for serie in [test1,test2,test3]:\n",
+ " s = serie.copy()\n",
+ " s.name=''\n",
+ " row += \"<td>{}</td>\".format(s.to_frame().style.bar(align=align, \n",
+ " color=['#d65f5f', '#5fba7d'], \n",
+ " width=100).render()) #testn['width']\n",
+ " row += '</tr>'\n",
+ " head += row\n",
+ " \n",
+ "head+= \"\"\"\n",
+ "</tbody>\n",
+ "</table>\"\"\"\n",
+ " \n",
+ "\n",
+ "HTML(head)"
  ]
  },
  {
@@ -961,7 +1047,7 @@
  "name": "python",
  "nbconvert_exporter": "python",
  "pygments_lexer": "ipython3",
- "version": "3.5.1"
+ "version": "3.5.2"
  }
  },
  "nbformat": 4,