{
"cells": [
{
"cell_type": "markdown",
"metadata": {
"collapsed": true
},
"source": [
"#### New to Plotly?\n",
"Plotly's Python library is free and open source! [Get started](https://plotly.com/python/getting-started/) by downloading the client and [reading the primer](https://plotly.com/python/getting-started/).\n",
" You can set up Plotly to work in [online](https://plotly.com/python/getting-started/#initialization-for-online-plotting) or [offline](https://plotly.com/python/getting-started/#initialization-for-offline-plotting) mode, or in [jupyter notebooks](https://plotly.com/python/getting-started/#start-plotting-online).\n",
" We also have a quick-reference [cheatsheet](https://images.plot.ly/plotly-documentation/images/python_cheat_sheet.pdf) (new!) to help you get started!"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### Online Configuration Options\n",
"Config options set via our API libraries are overridden on graphs hosted on plot.ly (i.e. when working online). \n",
"To set configutation options online, you can edit the plot's embed url. Visit our embed tutorial: http://help.plot.ly/embed-graphs-in-websites/#step-8-customize-the-iframe for more information on customizing the embed url to remove the \"Edit Chart\" link, hide the modebar, or autosize the plot."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"#### Offline Configuration Options\n",
"Now you can pass a `config` dictionary with all configurations options such as `showLink`, `linkText`, `scrollZoom`, and `displayModeBar`. For the complete list of config options check out: https://github.com/plotly/plotly.js/blob/master/src/plot_api/plot_config.js\n",
"\n",
"
that contains the graph and the script to generate the\n",
" graph.\n",
" Use 'file' if you want to save and view a single graph at a time\n",
" in a standalone HTML file.\n",
" Use 'div' if you are embedding these graphs in an HTML file with\n",
" other graphs or HTML markup, like a HTML report or an website.\n",
" include_plotlyjs (default=True) -- If True, include the plotly.js\n",
" source code in the output file or string.\n",
" Set as False if your HTML file already contains a copy of the plotly.js\n",
" library.\n",
" filename (default='temp-plot.html') -- The local filename to save the\n",
" outputted chart to. If the filename already exists, it will be\n",
" overwritten. This argument only applies if `output_type` is 'file'.\n",
" auto_open (default=True) -- If True, open the saved file in a\n",
" web browser after saving.\n",
" This argument only applies if `output_type` is 'file'.\n",
" image (default=None |'png' |'jpeg' |'svg' |'webp') -- This parameter sets\n",
" the format of the image to be downloaded, if we choose to download an\n",
" image. This parameter has a default value of None indicating that no\n",
" image should be downloaded. Please note: for higher resolution images\n",
" and more export options, consider making requests to our image servers.\n",
" Type: `help(py.image)` for more details.\n",
" image_filename (default='plot_image') -- Sets the name of the file your\n",
" image will be saved to. The extension should not be included.\n",
" image_height (default=600) -- Specifies the height of the image in `px`.\n",
" image_width (default=800) -- Specifies the width of the image in `px`.\n",
" config (default=None) -- Plot view options dictionary. Keyword arguments\n",
" `show_link` and `link_text` set the associated options in this\n",
" dictionary if it doesn't contain them already.\n",
"\n"
]
}
],
"source": [
"import plotly.offline as offline\n",
"help(offline.plot)"
]
},
{
"cell_type": "code",
"execution_count": 9,
"metadata": {},
"outputs": [
{
"data": {
"text/html": [
""
],
"text/plain": [
""
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
""
],
"text/plain": [
""
]
},
"metadata": {},
"output_type": "display_data"
},
{
"name": "stderr",
"output_type": "stream",
"text": [
"/Users/chelsea/venv/venv2/lib/python2.7/site-packages/IPython/nbconvert.py:13: ShimWarning:\n",
"\n",
"The `IPython.nbconvert` package has been deprecated since IPython 4.0. You should import from nbconvert instead.\n",
"\n",
"/Users/chelsea/venv/venv2/lib/python2.7/site-packages/publisher/publisher.py:53: UserWarning:\n",
"\n",
"Did you \"Save\" this notebook before running this command? Remember to save, always save.\n",
"\n"
]
}
],
"source": [
"from IPython.display import display, HTML\n",
"\n",
"display(HTML(''))\n",
"display(HTML(''))\n",
"\n",
"#!pip install git+https://github.com/plotly/publisher.git --upgrade\n",
"import publisher\n",
"publisher.publish(\n",
" 'config_opts.ipynb', 'python/configuration-options/', 'Configuration',\n",
" 'How to set configuration options of plotly graphs in python. Examples of both online and offline configurations.',\n",
" title = 'Configuration | plotly',\n",
" name = 'Configuration',\n",
" language='python', has_thumbnail= True,\n",
" thumbnail= 'thumbnail/modebar-icons.png',\n",
" display_as='file_settings', order=7, uses_plotly_offline=True,\n",
" ipynb= '~notebook_demo/97')"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [],
"source": []
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 2",
"language": "python",
"name": "python2"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 2
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython2",
"version": "2.7.14"
}
},
"nbformat": 4,
"nbformat_minor": 1
}