Kotlin Notebookがサポートする出力形式

Kotlin Notebookは、テキスト、HTML、画像など、様々な出力タイプをサポートしています。外部ライブラリの助けを借りて、出力オプションを拡張し、チャート、スプレッドシートなどを使ってデータを視覚化できます。

各出力は、Jupiter MIMEタイプをデータにマッピングするJSONオブジェクトです。このマップから、Kotlin Notebookは他のタイプの中で最も優先度の高いサポートされているMIMEタイプを選択し、次のようにレンダリングします。

• テキストはtext/plain MIMEタイプを使用します。
• BufferedImageクラスは、Base64文字列にマッピングされるimage/png MIMEタイプを使用します。
• ImageクラスおよびLaTeX形式は、内部にimgタグを含むtext/html MIMEタイプを使用します。
• Kotlin DataFrameテーブルとKandyプロットは、独自の内部MIMEタイプを使用します。これらは静的なHTMLまたは画像によって支えられています。この方法で、GitHubに表示できます。

例えば、Markdownをセルの出力として使用するために、マッピングを手動で設定できます。

MimeTypedResult(
    mapOf(
        "text/plain" to "123",
        "text/markdown" to "# HEADER",
        //other mime:value pairs
    )
)

あらゆる種類の出力を表示するには、DISPLAY()関数を使用します。これにより、複数の出力を組み合わせることもできます。

DISPLAY(HTML("<h2>Gaussian distribution</h2>"))
DISPLAY(LATEX("f(x) = \\frac{1}{\\sigma \\sqrt{2\\pi}} \\cdot e^{-\\frac{(x - \\mu)^2}{2\\sigma^2}}"))

val experimentX = experimentData.map { it.key }
val experimentY = experimentData.map { it.value }

DISPLAY(plot {
    bars {
        x(experimentX)
        y(experimentY)
    }
})

テキスト

プレーンテキスト

最もシンプルな出力タイプはプレーンテキストです。これは、出力されるステートメント、変数の値、またはコードからのあらゆるテキストベースの出力に使用されます。

val a1: Int = 1
val a2: Int = 2
var a3: Int? = a1 + a2

"My answer is $a3"

• セルの結果がレンダリングされ、いずれかの出力タイプとして表示できない場合、toString()関数を使用してプレーンテキストとして出力されます。
• コードにエラーが含まれている場合、Kotlin Notebookはエラーメッセージとトレースバックを表示し、デバッグのための洞察を提供します。

リッチテキスト

リッチテキストを使用するには、Markdownタイプのセルを選択します。これにより、リスト、テーブル、フォントスタイル、コードブロックなどを使用して、MarkdownおよびHTMLマークアップでコンテンツをフォーマットできます。HTMLにはCSSスタイルとJavaScriptを含めることができます。

## Line magics

| Spell                              | Description                                                                                                      | Example                                                                               |
|------------------------------------|------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|
| <code>%use</code>                  | Injects code for supported libraries: artifact resolution, default imports, initialization code, type renderers. | <code>%use klaxon(5.5), lets-plot</code>                                              |                                         
| <code>%trackClasspath</code>       | Logs any changes of current classpath. Useful for debugging artifact resolution failures.                        | <code>%trackClasspath [on |off]</code>                                                |
| <code>%trackExecution</code>       | Logs pieces of code that are going to be executed. Useful for debugging of libraries support.                    | <code>%trackExecution [all|generated|off]</code>                                      |          
| <code>%useLatestDescriptors</code> | Use latest versions of library descriptors available. By default, bundled descriptors are used.                  | <code>%useLatestDescriptors [on|off]</code>                                           |
| <code>%output</code>               | Output capturing settings.                                                                                       | <code>%output --max-cell-size=1000 --no-stdout --max-time=100 --max-buffer=400</code> |
| <code>%logLevel</code>             | Set logging level.                                                                                               | <code>%logLevel [off|error|warn|info|debug]</code>                                    |

<ul><li><a href="https://github.com/Kotlin/kotlin-jupyter/blob/master/docs/magics.md">Learn more detailes about line magics</a>.</li>
<li><a href="https://github.com/Kotlin/kotlin-jupyter/blob/master/docs/magics.md">See the full list of supported libraries</a>.</li></ul>

HTML

Kotlin NotebookはHTMLを直接レンダリングでき、スクリプトを実行したり、ウェブサイトを埋め込んだりすることもできます。

HTML("""
<p>Counter: <span id="ctr">0</span> <button onclick="inc()">Increment</button></p>
<script>
    function inc() {
        let counter = document.getElementById("ctr")
        counter.innerHTML = parseInt(counter.innerHTML) + 1;
}
</script>
""")

NOTE

スクリプトを実行できるように、ファイルの先頭でノートブックを信頼済みとしてマークしてください。

画像

Kotlin Notebookでは、ファイルからの画像、生成されたグラフ、またはその他のあらゆる視覚メディアを表示できます。静止画は、.png、jpeg、.svgなどの形式で表示できます。

バッファリングされた画像

デフォルトで、BufferedImageクラスを使用して画像を表示できます。

import java.awt.Color
import java.awt.image.BufferedImage

val width = 300
val height = width

val image = BufferedImage(width, height, BufferedImage.TYPE_INT_ARGB)

val graphics = image.createGraphics()
graphics.background = Color.BLACK
graphics.clearRect(0, 0, width, height)
graphics.setRenderingHint(
    java.awt.RenderingHints.KEY_ANTIALIASING,
    java.awt.RenderingHints.VALUE_ANTIALIAS_ON
)
graphics.color = Color.WHITE
graphics.fillRect(width / 10, height * 8 / 10, width * 10 / 20, height / 10)
graphics.dispose()

ロードされた画像

lib-extライブラリの助けを借りて、標準のJupyter機能を拡張し、ネットワークからロードされた画像を表示できます。

%use lib-ext(0.11.0-398)

Image("https://kotlinlang.org/docs/images/kotlin-logo.png", embed = false).withWidth(300)

埋め込み画像

ネットワークからロードされた画像の欠点は、リンクが切れたり、ネットワーク接続が失われたりすると画像が消えてしまうことです。それを回避するため、例えば次のように埋め込み画像を使用します。

val kotlinMascot = Image("https://blog.jetbrains.com/wp-content/uploads/2023/04/DSGN-16174-Blog-post-banner-and-promo-materials-for-post-about-Kotlin-mascot_3.png", embed = true).withWidth(400)
kotlinMascot

数式と方程式

学術分野で広く使用されている組版システムであるLaTeX形式を使用して、数式と方程式をレンダリングできます。

1. Jupyterカーネルの機能をノートブックに拡張するlib-extライブラリを追加します。

   %use lib-ext(0.11.0-398)

2. 新しいセルで、数式を実行します。

   LATEX("c^2 = a^2 + b^2 - 2 a b \\cos\\alpha")

   

データフレーム

Kotlin Notebookでは、データフレームを使って構造化データを視覚化できます。

1. Kotlin DataFrameライブラリをノートブックに追加します。

   %use dataframe

2. データフレームを作成し、新しいセルで実行します。

   val months = listOf(
       "January", "February",
       "March", "April", "May",
       "June", "July", "August",
       "September", "October", "November",
       "December"
   )
   
   // Sales data for different products and months:
   val salesLaptop = listOf(120, 130, 150, 180, 200, 220, 240, 230, 210, 190, 160, 140)
   val salesSmartphone = listOf(90, 100, 110, 130, 150, 170, 190, 180, 160, 140, 120, 100)
   val salesTablet = listOf(60, 70, 80, 90, 100, 110, 120, 110, 100, 90, 80, 70)
    
   // A data frame with columns for Month, Sales, and Product
   val dfSales = dataFrameOf(
       "Month" to months + months + months,
       "Sales" to salesLaptop + salesSmartphone + salesTablet,
       "Product" to List(12) { "Laptop" } + List(12) { "Smartphone" } + List(12) { "Tablet" },
   )

   データフレームはdataFrameOf()関数を使用し、12ヶ月間に販売された製品（ラップトップ、スマートフォン、タブレット）の数を含みます。

3. フレーム内のデータを探索します。例えば、最も売上の高かった製品と月を見つけます。

   dfSales.maxBy("Sales")

   

4. データフレームをCSVファイルとしてエクスポートすることもできます。

   // Export your data to CSV format
   dfSales.writeCSV("sales-stats.csv")

チャート

Kotlin Notebookで直接様々なチャートを作成してデータを視覚化できます。

1. Kandyプロットライブラリをノートブックに追加します。

   %use kandy

2. 同じデータフレームを使用し、新しいセルでplot()関数を実行します。

   val salesPlot = dfSales.groupBy { Product }.plot {
       bars {
           // Access the data frame's columns used for the X and Y axes
           x(Month)
           y(Sales)
           // Access the data frame's column used for categories and sets colors for these categories
           fillColor(Product) {
               scale = categorical(
                   "Laptop" to Color.PURPLE,
                   "Smartphone" to Color.ORANGE,
                   "Tablet" to Color.GREEN
               )
               legend.name = "Product types"
           }
       }
       // Customize the chart's appearance
       layout.size = 1000 to 450
       layout.title = "Yearly Gadget Sales Results"
   }
   
   salesPlot

   

3. プロットを.png、jpeg、.html、または.svg形式でエクスポートすることもできます。

   // Specify the output format for the plot file:
   salesPlot.save("sales-chart.svg")

次のステップ

• DataFrameおよびKandyライブラリを使用してデータを視覚化する
• Kotlin Notebookでのリッチ出力のレンダリングと表示について詳しく学ぶ
• CSVおよびJSONファイルからデータを取得する
• 推奨ライブラリのリストを確認する