IHaskell.Display

If you are interested in the IHaskell library for the purpose of augmenting the IHaskell notebook or writing your own display mechanisms and widgets, this module contains all functions you need.

In order to create a display mechanism for a particular data type, write a module named (for example) IHaskell.Display.YourThing in a package named ihaskell-yourThing. (Note the capitalization - it's important!) Then, in that module, add an instance of IHaskellDisplay for your data type. Similarly, to create a widget, add an instance of IHaskellWidget.

An example of creating a display is provided in the demo notebook.

Rich display and interactive display typeclasses and types

class IHaskellDisplay a where

A class for displayable Haskell types.

IHaskell's displaying of results behaves as if these two overlapping/undecidable instances also existed:

instance (Show a) => IHaskellDisplay a
instance Show a where shows _ = id

Methods

display :: a -> IO Display

Instances

IHaskellDisplay Display

Defined in IHaskell.Types

Methods

display :: Display -> IO Display

IHaskellDisplay Widget

Defined in IHaskell.Types

Methods

display :: Widget -> IO Display

IHaskellDisplay DisplayData

Defined in IHaskell.Types

Methods

display :: DisplayData -> IO Display

IHaskellDisplay a => IHaskellDisplay (IO a)

these instances cause the image, html etc. which look like:

Display
[Display]
IO [Display]
IO (IO Display)

be run the IO and get rendered (if the frontend allows it) in the pretty form.

Defined in IHaskell.Types

Methods

display :: IO a -> IO Display

IHaskellDisplay a => IHaskellDisplay [a]

Defined in IHaskell.Types

Methods

display :: [a] -> IO Display

data Display

Wrapper for ipython-kernel's DisplayData which allows sending multiple results from the same expression.

Constructors

Display [DisplayData]

ManyDisplay [Display]

Instances

ToJSON Display

Defined in IHaskell.Types

Methods

toJSON :: Display -> Value

toEncoding :: Display -> Encoding

toJSONList :: [Display] -> Value

toEncodingList :: [Display] -> Encoding

Monoid Display

Defined in IHaskell.Types

Methods

mempty :: Display

mappend :: Display -> Display -> Display

mconcat :: [Display] -> Display

Semigroup Display

Defined in IHaskell.Types

Methods

(<>) :: Display -> Display -> Display

sconcat :: NonEmpty Display -> Display

stimes :: Integral b => b -> Display -> Display

Generic Display

Defined in IHaskell.Types

Associated Types

type Rep Display :: Type -> Type

Methods

from :: Display -> Rep Display x

to :: Rep Display x -> Display

Show Display

Defined in IHaskell.Types

Methods

showsPrec :: Int -> Display -> ShowS

show :: Display -> String

showList :: [Display] -> ShowS

Binary Display

Defined in IHaskell.Types

Methods

put :: Display -> Put

get :: Get Display

putList :: [Display] -> Put

IHaskellDisplay Display

Defined in IHaskell.Types

Methods

display :: Display -> IO Display

type Rep Display

Defined in IHaskell.Types

type Rep Display = D1 ('MetaData "Display" "IHaskell.Types" "ihaskell-0.10.3.0-1Y1GeklUisK1aFT1NNWHeo" 'False) (C1 ('MetaCons "Display" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [DisplayData])) :+: C1 ('MetaCons "ManyDisplay" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Display])))

data DisplayData

Data for display: a string with associated MIME type.

Constructors

DisplayData MimeType Text

Instances

Generic DisplayData

Defined in IHaskell.IPython.Types

Associated Types

type Rep DisplayData :: Type -> Type

Methods

from :: DisplayData -> Rep DisplayData x

to :: Rep DisplayData x -> DisplayData

Show DisplayData

Defined in IHaskell.IPython.Types

Methods

showsPrec :: Int -> DisplayData -> ShowS

show :: DisplayData -> String

showList :: [DisplayData] -> ShowS

Binary DisplayData

Defined in IHaskell.IPython.Types

Methods

put :: DisplayData -> Put

get :: Get DisplayData

putList :: [DisplayData] -> Put

IHaskellDisplay DisplayData

Defined in IHaskell.Types

Methods

display :: DisplayData -> IO Display

type Rep DisplayData

Defined in IHaskell.IPython.Types

type Rep DisplayData = D1 ('MetaData "DisplayData" "IHaskell.IPython.Types" "ipython-kernel-0.10.3.0-7rXj2chaGhf4ymDgbYiVwI" 'False) (C1 ('MetaCons "DisplayData" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MimeType) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

class IHaskellDisplay a => IHaskellWidget a where

Display as an interactive widget.

Minimal complete definition

getCommUUID

Methods

targetName :: a -> String

Target name for this widget. The actual input parameter should be ignored. By default evaluate to "jupyter.widget", which is used by IPython for its backbone widgets.

targetModule :: a -> String

Target module for this widget. Evaluates to an empty string by default.

getBufferPaths :: a -> [BufferPath]

Buffer paths for this widget. Evaluates to an empty array by default.

getCommUUID :: a -> UUID

Get the uuid for comm associated with this widget. The widget is responsible for storing the UUID during initialization.

open

Arguments

:: a

Widget to open a comm port with.

-> (Value -> IO ())

A function for sending messages.

-> IO ()

Called when the comm is opened. Allows additional messages to be sent after comm open.

comm

Arguments

:: a

Widget which is being communicated with.

-> Value

Data recieved from the frontend.

-> (Value -> IO ())

Way to respond to the message.

-> IO ()

Respond to a comm data message. Called when a message is recieved on the comm associated with the widget.

close

Arguments

:: a

Widget to close comm port with.

-> Value

Data recieved from the frontend.

-> IO ()

Called when a comm_close is recieved from the frontend.

Instances

IHaskellWidget Widget

Defined in IHaskell.Types

Methods

targetName :: Widget -> String

targetModule :: Widget -> String

getBufferPaths :: Widget -> [BufferPath]

getCommUUID :: Widget -> UUID

open :: Widget -> (Value -> IO ()) -> IO ()

comm :: Widget -> Value -> (Value -> IO ()) -> IO ()

close :: Widget -> Value -> IO ()

Interactive use functions

printDisplay :: IHaskellDisplay a => a -> IO ()

Write to the display channel. The contents will be displayed in the notebook once the current execution call ends.

Constructors for displays

plain :: String -> DisplayData

Generate a plain text display.

html :: String -> DisplayData

Generate an HTML display.

bmp :: Width -> Height -> Base64 -> DisplayData

Generate a BMP display of the given width and height. Data must be provided in a Base64 encoded manner, suitable for embedding into HTML. The base64 function may be used to encode data into this format.

png :: Width -> Height -> Base64 -> DisplayData

Generate a PNG display of the given width and height. Data must be provided in a Base64 encoded manner, suitable for embedding into HTML. The base64 function may be used to encode data into this format.

jpg :: Width -> Height -> Base64 -> DisplayData

Generate a JPG display of the given width and height. Data must be provided in a Base64 encoded manner, suitable for embedding into HTML. The base64 function may be used to encode data into this format.

gif :: Width -> Height -> Base64 -> DisplayData

Generate a GIF display of the given width and height. Data must be provided in a Base64 encoded manner, suitable for embedding into HTML. The base64 function may be used to encode data into this format.

svg :: String -> DisplayData

Generate an SVG display.

latex :: String -> DisplayData

Generate a LaTeX display.

markdown :: String -> DisplayData

Generate a Markdown display.

javascript :: String -> DisplayData

Generate a Javascript display.

json :: String -> DisplayData

Generate a Json display.

vega :: String -> DisplayData

Generate a Vega display.

vegalite :: String -> DisplayData

Generate a Vegalite display.

vdom :: String -> DisplayData

Generate a Vdom display.

widgetdisplay :: String -> DisplayData

Generate a Widget display given the uuid and the view version

custom :: Text -> String -> DisplayData

Generate a custom display. The first argument is the mimetype and the second argument is the payload.

many :: [Display] -> Display

Encode many displays into a single one. All will be output.

Image and data encoding functions

type Width = Int

Possible MIME types for the display data.

type Height = Int

type Base64 = Text

encode64 :: String -> Base64

Convert from a string into base 64 encoded data.

base64 :: ByteString -> Base64

Convert from a ByteString into base 64 encoded data.

Internal only use

displayFromChanEncoded :: IO ByteString

Take everything that was put into the displayChan at that point out, and make a Display out of it.

serializeDisplay :: Display -> ByteString

For internal use within IHaskell. Serialize displays to a ByteString.

data Widget

Constructors

forall a.IHaskellWidget a => Widget a

Instances

Show Widget

Defined in IHaskell.Types

Methods

showsPrec :: Int -> Widget -> ShowS

show :: Widget -> String

showList :: [Widget] -> ShowS

Eq Widget

Defined in IHaskell.Types

Methods

(==) :: Widget -> Widget -> Bool

(/=) :: Widget -> Widget -> Bool

IHaskellDisplay Widget

Defined in IHaskell.Types

Methods

display :: Widget -> IO Display

IHaskellWidget Widget

Defined in IHaskell.Types

Methods

targetName :: Widget -> String

targetModule :: Widget -> String

getBufferPaths :: Widget -> [BufferPath]

getCommUUID :: Widget -> UUID

open :: Widget -> (Value -> IO ()) -> IO ()

comm :: Widget -> Value -> (Value -> IO ()) -> IO ()

close :: Widget -> Value -> IO ()