GAP (JupyterKernel) - Chapter 3: Jupyter Renderables

Goto Chapter: Top 1 2 3 4 Ind
[Top of Book] [Contents] [Previous Chapter] [Next Chapter]

[MathJax off]

3 Jupyter Renderables
3.1 Handlers for Jupyter requests
3.1-1 IsJupyterRenderable
3.1-2
3.1-3 JupyterRenderable
3.1-4 JupyterRender
3.1-5 JupyterRenderableData
3.1-6 JupyterRenderableMetadata

### 3 Jupyter Renderables

A `JupyterRenderable` is an object that can be rendered by Jupyter. JupyterRenderables are component object that have to contain at least the components `data` and `metadata`.

These components are themselves GAP records which can contain different representations of an object to be rendered. The record component name is the MIME-Type of the representation and the content is the representation itself.

    render := JupyterRenderable(
          rec( text\/plain := "Integers",
               text\/html := "$\mathbb{Z}$" )
        , rec( ) );

    render2 := JupyterRenderable(
          rec( ("image/svg+xml") := "<svg></svg>"
        , rec( ("image/svg+xml") := rec( width := 500, height := 500 ) ) );

#### 3.1 Handlers for Jupyter requests

##### 3.1-1 IsJupyterRenderable

`‣ IsJupyterRenderable`( arg ) | ( filter )

Returns: `true` or `false`

JupyterRenderable

##### 3.1-2

`‣` ( arg ) | ( filter )

Returns: `true` or `false`

##### 3.1-3 JupyterRenderable

`‣ JupyterRenderable`( data, metadata ) | ( operation )

Returns: A new JupyterRenderable

Basic constructor for JupyterRenderable

##### 3.1-4 JupyterRender

`‣ JupyterRender`( arg ) | ( operation )

Method that provides rich viewing experience if code used inside Jupyter

##### 3.1-5 JupyterRenderableData

`‣ JupyterRenderableData`( arg ) | ( attribute )

Accessor for data in a JupyterRenderable

##### 3.1-6 JupyterRenderableMetadata

`‣ JupyterRenderableMetadata`( arg ) | ( attribute )

Accessor for metadata in a JupyterRenderable

[Top of Book] [Contents] [Previous Chapter] [Next Chapter]
Goto Chapter: Top 1 2 3 4 Ind

generated by GAPDoc2HTML