### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »

# Module: `lib.display`

Various display related classes.

Authors : MinRK, gregcaporaso, dannystaple

## 6 Classes

class `IPython.lib.display.``IFrame`(src, width, height, **kwargs)

  Bases: `object`

  Generic class to embed an iframe in an IPython notebook

  `__init__`(src, width, height, **kwargs)

class `IPython.lib.display.``YouTubeVideo`(id, width=400, height=300, **kwargs)

  Bases: `IPython.lib.display.IFrame`

  Class for embedding a YouTube Video in an IPython session, based on its video id.

  e.g. to embed the video on this page:

  https://www.youtube.com/watch?v=foo

  you would do:

  vid = YouTubeVideo(“foo”) display(vid)

  To start from 30 seconds:

  vid = YouTubeVideo(“abc”, start=30) display(vid)

  To calculate seconds from time as hours, minutes, seconds use: start=int(timedelta(hours=1, minutes=46, seconds=40).total_seconds())

  Other parameters can be provided as documented at https://developers.google.com/youtube/player_parameters#parameter-subheader

  `__init__`(id, width=400, height=300, **kwargs)

class `IPython.lib.display.``VimeoVideo`(id, width=400, height=300, **kwargs)

  Bases: `IPython.lib.display.IFrame`

  Class for embedding a Vimeo video in an IPython session, based on its video id.

  `__init__`(id, width=400, height=300, **kwargs)

class `IPython.lib.display.``ScribdDocument`(id, width=400, height=300, **kwargs)

  Bases: `IPython.lib.display.IFrame`

  Class for embedding a Scribd document in an IPython session

  Use the start_page params to specify a starting point in the document Use the view_mode params to specify display type one off scroll | slideshow | book

  e.g to Display Wes’ foundational paper about PANDAS in book mode from page 3

  ScribdDocument(71048089, width=800, height=400, start_page=3, view_mode=”book”)

  `__init__`(id, width=400, height=300, **kwargs)

class `IPython.lib.display.``FileLink`(path, url_prefix='files/', result_html_prefix='', result_html_suffix='<br>')

  Bases: `object`

  Class for embedding a local file link in an IPython session, based on path

  e.g. to embed a link that was generated in the IPython notebook as my/data.txt

  you would do:

      local_file = FileLink("my/data.txt")
      display(local_file)

  or in the HTML notebook, just:

      FileLink("my/data.txt")

  `__init__`(path, url_prefix='files/', result_html_prefix='', result_html_suffix='<br>')

    Parameters:

    path : str

    > path to the file or directory that should be formatted

    directory_prefix : str

    > prefix to be prepended to all files to form a working link [default: ‘files’]

    result_html_prefix : str

    > text to append to beginning to link [default: none]

    result_html_suffix : str

    > text to append at the end of link [default: ‘<br>’]

class `IPython.lib.display.``FileLinks`(path, url_prefix='files/', included_suffixes=None, result_html_prefix='', result_html_suffix='<br>', notebook_display_formatter=None, terminal_display_formatter=None)

  Bases: `IPython.lib.display.FileLink`

  Class for embedding local file links in an IPython session, based on path

  e.g. to embed links to files that were generated in the IPython notebook under my/data

  you would do:

  local_files = FileLinks(“my/data”) display(local_files)

  or in the HTML notebook, just

  FileLinks(“my/data”)

  `__init__`(path, url_prefix='files/', included_suffixes=None, result_html_prefix='', result_html_suffix='<br>', notebook_display_formatter=None, terminal_display_formatter=None)
    included_suffixes : list of filename suffixes to include when
      formatting output [default: include all files]
    See the FileLink (baseclass of LocalDirectory) docstring for
      information on additional parameters.
    notebook_display_formatter : func used to format links for display
      in the notebook. See discussion of formatter function below.
    terminal_display_formatter : func used to format links for display
      in the terminal. See discussion of formatter function below.

### Navigation

- index
- modules |
- next |
- previous |
- home|
- search|
- documentation »
- The IPython API »