Kotlin Notebook 支援的輸出格式

Kotlin Notebook 支援多種輸出類型，包含文字、HTML 和影像。藉助外部函式庫，您可以擴展輸出選項，並透過圖表、試算表等方式將資料視覺化。

每個輸出都是一個 JSON 物件，它將 Jupiter MIME 類型 對應到某些資料。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 會顯示錯誤訊息和追蹤堆疊 (traceback)，為偵錯提供見解。

富文本

選擇 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 檔案中檢索資料
• 查看推薦函式庫列表