This docs on this page refers to a PREVIOUS VERSION. For the latest stable release, go to https://docs.bokeh.org/

Archived docs for versions <= 1.0.4 have had to be modified from their original published configuration, and may be missing some features (e.g. source listing)

All users are encourage to update to version 1.1 or later, as soon as they are able.

<code class="docutils literal"><span class="pre">bokeh.models.widgets.icons</span></code> — Bokeh 0.12.1 documentation

bokeh.models.widgets.icons

Various kinds of icon widgets.

class AbstractIcon(**kwargs)

Bases: bokeh.models.widgets.widget.Widget

An abstract base class for icon widgets. AbstractIcon is not generally useful to instantiate on its own.

JSON Prototype
{
  "disabled": false,
  "height": null,
  "id": "dded144a-ea8f-4c14-ba33-e25c385fef23",
  "name": null,
  "sizing_mode": "fixed",
  "tags": [],
  "width": null
}
class Icon(**kwargs)

Bases: bokeh.models.widgets.icons.AbstractIcon

A “stock” icon based on FontAwesome.

flip

property type: flip:Enum(‘horizontal’, ‘vertical’)

Optionally flip the icon horizontally or vertically.

icon_name

property type: icon_name:Enum(‘adjust’, ‘adn’, ‘align-center’, ‘align-justify’, ‘align-left’, ‘align-right’, ‘ambulance’, ‘anchor’, ‘android’, ‘angellist’, ‘angle-double-down’, ‘angle-double-left’, ‘angle-double-right’, ‘angle-double-up’, ‘angle-down’, ‘angle-left’, ‘angle-right’, ‘angle-up’, ‘apple’, ‘archive’, ‘area-chart’, ‘arrow-circle-down’, ‘arrow-circle-left’, ‘arrow-circle-o-down’, ‘arrow-circle-o-left’, ‘arrow-circle-o-right’, ‘arrow-circle-o-up’, ‘arrow-circle-right’, ‘arrow-circle-up’, ‘arrow-down’, ‘arrow-left’, ‘arrow-right’, ‘arrow-up’, ‘arrows’, ‘arrows-alt’, ‘arrows-h’, ‘arrows-v’, ‘asterisk’, ‘at’, ‘automobile’, ‘backward’, ‘ban’, ‘bank’, ‘bar-chart’, ‘bar-chart-o’, ‘barcode’, ‘bars’, ‘beer’, ‘behance’, ‘behance-square’, ‘bell’, ‘bell-o’, ‘bell-slash’, ‘bell-slash-o’, ‘bicycle’, ‘binoculars’, ‘birthday-cake’, ‘bitbucket’, ‘bitbucket-square’, ‘bitcoin’, ‘bold’, ‘bolt’, ‘bomb’, ‘book’, ‘bookmark’, ‘bookmark-o’, ‘briefcase’, ‘btc’, ‘bug’, ‘building’, ‘building-o’, ‘bullhorn’, ‘bullseye’, ‘bus’, ‘cab’, ‘calculator’, ‘calendar’, ‘calendar-o’, ‘camera’, ‘camera-retro’, ‘car’, ‘caret-down’, ‘caret-left’, ‘caret-right’, ‘caret-square-o-down’, ‘caret-square-o-left’, ‘caret-square-o-right’, ‘caret-square-o-up’, ‘caret-up’, ‘cc’, ‘cc-amex’, ‘cc-discover’, ‘cc-mastercard’, ‘cc-paypal’, ‘cc-stripe’, ‘cc-visa’, ‘certificate’, ‘chain’, ‘chain-broken’, ‘check’, ‘check-circle’, ‘check-circle-o’, ‘check-square’, ‘check-square-o’, ‘chevron-circle-down’, ‘chevron-circle-left’, ‘chevron-circle-right’, ‘chevron-circle-up’, ‘chevron-down’, ‘chevron-left’, ‘chevron-right’, ‘chevron-up’, ‘child’, ‘circle’, ‘circle-o’, ‘circle-o-notch’, ‘circle-thin’, ‘clipboard’, ‘clock-o’, ‘close’, ‘cloud’, ‘cloud-download’, ‘cloud-upload’, ‘cny’, ‘code’, ‘code-fork’, ‘codepen’, ‘coffee’, ‘cog’, ‘cogs’, ‘columns’, ‘comment’, ‘comment-o’, ‘comments’, ‘comments-o’, ‘compass’, ‘compress’, ‘copy’, ‘copyright’, ‘credit-card’, ‘crop’, ‘crosshairs’, ‘css3’, ‘cube’, ‘cubes’, ‘cut’, ‘cutlery’, ‘dashboard’, ‘database’, ‘dedent’, ‘delicious’, ‘desktop’, ‘deviantart’, ‘digg’, ‘dollar’, ‘dot-circle-o’, ‘download’, ‘dribbble’, ‘dropbox’, ‘drupal’, ‘edit’, ‘eject’, ‘ellipsis-h’, ‘ellipsis-v’, ‘empire’, ‘envelope’, ‘envelope-o’, ‘envelope-square’, ‘eraser’, ‘eur’, ‘euro’, ‘exchange’, ‘exclamation’, ‘exclamation-circle’, ‘exclamation-triangle’, ‘expand’, ‘external-link’, ‘external-link-square’, ‘eye’, ‘eye-slash’, ‘eyedropper’, ‘facebook’, ‘facebook-square’, ‘fast-backward’, ‘fast-forward’, ‘fax’, ‘female’, ‘fighter-jet’, ‘file’, ‘file-archive-o’, ‘file-audio-o’, ‘file-code-o’, ‘file-excel-o’, ‘file-image-o’, ‘file-movie-o’, ‘file-o’, ‘file-pdf-o’, ‘file-photo-o’, ‘file-picture-o’, ‘file-powerpoint-o’, ‘file-sound-o’, ‘file-text’, ‘file-text-o’, ‘file-video-o’, ‘file-word-o’, ‘file-zip-o’, ‘files-o’, ‘film’, ‘filter’, ‘fire’, ‘fire-extinguisher’, ‘flag’, ‘flag-checkered’, ‘flag-o’, ‘flash’, ‘flask’, ‘flickr’, ‘floppy-o’, ‘folder’, ‘folder-o’, ‘folder-open’, ‘folder-open-o’, ‘font’, ‘forward’, ‘foursquare’, ‘frown-o’, ‘futbol-o’, ‘gamepad’, ‘gavel’, ‘gbp’, ‘ge’, ‘gear’, ‘gears’, ‘gift’, ‘git’, ‘git-square’, ‘github’, ‘github-alt’, ‘github-square’, ‘gittip’, ‘glass’, ‘globe’, ‘google’, ‘google-plus’, ‘google-plus-square’, ‘google-wallet’, ‘graduation-cap’, ‘group’, ‘h-square’, ‘hacker-news’, ‘hand-o-down’, ‘hand-o-left’, ‘hand-o-right’, ‘hand-o-up’, ‘hdd-o’, ‘header’, ‘headphones’, ‘heart’, ‘heart-o’, ‘history’, ‘home’, ‘hospital-o’, ‘html5’, ‘ils’, ‘image’, ‘inbox’, ‘indent’, ‘info’, ‘info-circle’, ‘inr’, ‘instagram’, ‘institution’, ‘ioxhost’, ‘italic’, ‘joomla’, ‘jpy’, ‘jsfiddle’, ‘key’, ‘keyboard-o’, ‘krw’, ‘language’, ‘laptop’, ‘lastfm’, ‘lastfm-square’, ‘leaf’, ‘legal’, ‘lemon-o’, ‘level-down’, ‘level-up’, ‘life-bouy’, ‘life-buoy’, ‘life-ring’, ‘life-saver’, ‘lightbulb-o’, ‘line-chart’, ‘link’, ‘linkedin’, ‘linkedin-square’, ‘linux’, ‘list’, ‘list-alt’, ‘list-ol’, ‘list-ul’, ‘location-arrow’, ‘lock’, ‘long-arrow-down’, ‘long-arrow-left’, ‘long-arrow-right’, ‘long-arrow-up’, ‘magic’, ‘magnet’, ‘mail-forward’, ‘mail-reply’, ‘mail-reply-all’, ‘male’, ‘map-marker’, ‘maxcdn’, ‘meanpath’, ‘medkit’, ‘meh-o’, ‘microphone’, ‘microphone-slash’, ‘minus’, ‘minus-circle’, ‘minus-square’, ‘minus-square-o’, ‘mobile’, ‘mobile-phone’, ‘money’, ‘moon-o’, ‘mortar-board’, ‘music’, ‘navicon’, ‘newspaper-o’, ‘openid’, ‘outdent’, ‘pagelines’, ‘paint-brush’, ‘paper-plane’, ‘paper-plane-o’, ‘paperclip’, ‘paragraph’, ‘paste’, ‘pause’, ‘paw’, ‘paypal’, ‘pencil’, ‘pencil-square’, ‘pencil-square-o’, ‘phone’, ‘phone-square’, ‘photo’, ‘picture-o’, ‘pie-chart’, ‘pied-piper’, ‘pied-piper-alt’, ‘pinterest’, ‘pinterest-square’, ‘plane’, ‘play’, ‘play-circle’, ‘play-circle-o’, ‘plug’, ‘plus’, ‘plus-circle’, ‘plus-square’, ‘plus-square-o’, ‘power-off’, ‘print’, ‘puzzle-piece’, ‘qq’, ‘qrcode’, ‘question’, ‘question-circle’, ‘quote-left’, ‘quote-right’, ‘ra’, ‘random’, ‘rebel’, ‘recycle’, ‘reddit’, ‘reddit-square’, ‘refresh’, ‘remove’, ‘renren’, ‘reorder’, ‘repeat’, ‘reply’, ‘reply-all’, ‘retweet’, ‘rmb’, ‘road’, ‘rocket’, ‘rotate-left’, ‘rotate-right’, ‘rouble’, ‘rss’, ‘rss-square’, ‘rub’, ‘ruble’, ‘rupee’, ‘save’, ‘scissors’, ‘search’, ‘search-minus’, ‘search-plus’, ‘send’, ‘send-o’, ‘share’, ‘share-alt’, ‘share-alt-square’, ‘share-square’, ‘share-square-o’, ‘shekel’, ‘sheqel’, ‘shield’, ‘shopping-cart’, ‘sign-in’, ‘sign-out’, ‘signal’, ‘sitemap’, ‘skype’, ‘slack’, ‘sliders’, ‘slideshare’, ‘smile-o’, ‘soccer-ball-o’, ‘sort’, ‘sort-alpha-asc’, ‘sort-alpha-desc’, ‘sort-amount-asc’, ‘sort-amount-desc’, ‘sort-asc’, ‘sort-desc’, ‘sort-down’, ‘sort-numeric-asc’, ‘sort-numeric-desc’, ‘sort-up’, ‘soundcloud’, ‘space-shuttle’, ‘spinner’, ‘spoon’, ‘spotify’, ‘square’, ‘square-o’, ‘stack-exchange’, ‘stack-overflow’, ‘star’, ‘star-half’, ‘star-half-empty’, ‘star-half-full’, ‘star-half-o’, ‘star-o’, ‘steam’, ‘steam-square’, ‘step-backward’, ‘step-forward’, ‘stethoscope’, ‘stop’, ‘strikethrough’, ‘stumbleupon’, ‘stumbleupon-circle’, ‘subscript’, ‘suitcase’, ‘sun-o’, ‘superscript’, ‘support’, ‘table’, ‘tablet’, ‘tachometer’, ‘tag’, ‘tags’, ‘tasks’, ‘taxi’, ‘tencent-weibo’, ‘terminal’, ‘text-height’, ‘text-width’, ‘th’, ‘th-large’, ‘th-list’, ‘thumb-tack’, ‘thumbs-down’, ‘thumbs-o-down’, ‘thumbs-o-up’, ‘thumbs-up’, ‘ticket’, ‘times’, ‘times-circle’, ‘times-circle-o’, ‘tint’, ‘toggle-down’, ‘toggle-left’, ‘toggle-off’, ‘toggle-on’, ‘toggle-right’, ‘toggle-up’, ‘trash’, ‘trash-o’, ‘tree’, ‘trello’, ‘trophy’, ‘truck’, ‘try’, ‘tty’, ‘tumblr’, ‘tumblr-square’, ‘turkish-lira’, ‘twitch’, ‘twitter’, ‘twitter-square’, ‘umbrella’, ‘underline’, ‘undo’, ‘university’, ‘unlink’, ‘unlock’, ‘unlock-alt’, ‘unsorted’, ‘upload’, ‘usd’, ‘user’, ‘user-md’, ‘users’, ‘video-camera’, ‘vimeo-square’, ‘vine’, ‘vk’, ‘volume-down’, ‘volume-off’, ‘volume-up’, ‘warning’, ‘wechat’, ‘weibo’, ‘weixin’, ‘wheelchair’, ‘wifi’, ‘windows’, ‘won’, ‘wordpress’, ‘wrench’, ‘xing’, ‘xing-square’, ‘yahoo’, ‘yelp’, ‘yen’, ‘youtube’, ‘youtube-play’, ‘youtube-square’)

What icon to use. See http://fortawesome.github.io/Font-Awesome/icons/ for the list of available icons.

size

property type: size:Float

The size multiplier (1x, 2x, ..., 5x).

spin

property type: spin:Bool

Indicates a spinning (animated) icon. This value is ignored for icons that do not support spinning.

JSON Prototype
{
  "disabled": false,
  "flip": null,
  "height": null,
  "icon_name": "check",
  "id": "c64dcbde-a55c-4814-88ee-03e0330e97ae",
  "name": null,
  "size": null,
  "sizing_mode": "fixed",
  "spin": false,
  "tags": [],
  "width": null
}