仪表盘中的 Markdown

如何在仪表盘中使用 Markdown 以获得乐趣和收益。

构建有效的仪表盘通常需要为人们提供背景信息,让他们了解计算的存在方式或原因。虽然精确的标题、描述和标记的轴可以在很大程度上澄清您的可视化效果,但 Metabase 还允许您向仪表盘添加灵活的文本框。这篇文章将向您展示如何充分利用 Markdown 语法这一功能。

向仪表盘添加文本

选择您想要添加文本的仪表盘,然后单击铅笔图标以编辑仪表盘。单击仪表盘工具栏中的文本框按钮(显示为 Aa)。将出现一个文本框,您可以像移动问题框一样移动它。要调整文本框的大小,请单击并拖动其右下角。

Adding question and text box to dashboard.

在文本框中书写

要与文本框互动,您需要处于仪表盘的编辑模式。单击仪表盘右上角仪表盘工具栏中的铅笔图标

Metabase 中的文本框有两种模式。

  • 编辑文本(铅笔图标)。
  • 渲染视图(眼睛图标)。

Metabase 中的文本编辑器采用了一种名为 Markdown 的轻量级标记语言。如果您以前从未使用过 Markdown,则需要一些时间来适应,但您很快就会学会欣赏它的简洁性。Markdown 可以让作者感觉像程序员,让程序员感到宾至如归。

Markdown 的工作原理

要创建像这样的不同标题级别

Headings as Metabase renders them in a text card on a dashboard.

您需要编写

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6

纯文本 ## Heading 2 被渲染为 HTML 代码

<h2>
  Heading
  <h2></h2>
</h2>

您可以使用 Markdown 语法添加链接、图像、gif、列表、代码块、块引用等。这是一个包含标题、段落、块引用和代码块的文本框

Heading, paragraph, and blockquote.

您可以使用 Metabase 中的文本框完成这篇文章所做的一切以及更多。Markdown 的重要之处在于您不必编写繁琐的 HTML,并且 Markdown 即使在 Metabase 渲染之前也是人类可读的。Markdown 的极简功能集将使您专注于内容,并在您的仪表盘中提供标准化的外观。

您可以在本指南中了解有关 Markdown 语法的更多信息,也可以从 Markdown 的原始创建者之一处了解,其中还包括 Markdown 背后的理念。作为奖励,该网站允许您以 Markdown 语法查看其内容。

示例文本框

这是一个包含问题和文本框的仪表盘示例

Dashboard with question and text cards.

以下是上面文本框中使用的 Markdown 代码

# Analysis

Although `Gadgets` outsold `Gizmos` in 2019, we only introduced `Gizmos` and `Doohickeys` in September of 2019. Additionally, both `Gadgets` and `Widgets` were heavily discounted during our spring, summer, and holiday sales.

We expect sales to continue to grow in the `Gizmo` and `Doohickey` product lines.

# SQL query

    SELECT "PRODUCTS__via__PRODUCT_ID"."CATEGORY" AS "CATEGORY",
    sum("PUBLIC"."ORDERS"."QUANTITY") AS "sum"
    FROM "PUBLIC"."ORDERS"
    LEFT JOIN "PUBLIC"."PRODUCTS" "PRODUCTS__via__PRODUCT_ID" ON
    "PUBLIC"."ORDERS"."PRODUCT_ID" = "PRODUCTS__via__PRODUCT_ID"."ID"
    WHERE ("PUBLIC"."ORDERS"."CREATED_AT" >= timestamp with time zone '2019-01-01 00:00:00.000Z'
    AND "PUBLIC"."ORDERS"."CREATED_AT" < timestamp with time zone '2020-01-01 00:00:00.000Z')
    GROUP BY "PRODUCTS__via__PRODUCT_ID"."CATEGORY"
    ORDER BY "sum" ASC, "PRODUCTS__via__PRODUCT_ID"."CATEGORY" ASC

# Contact

If you have questions, reach out to us on the [\#product](https://fakemessageservice.com/product) channel.

假设的分析师提供了一些背景信息、代码和联系方式:但您可以包含任何有助于报告读者的背景信息。

注意:在上面的示例中,分析师粘贴了查询构建器生成的原始 SQL 查询以供参考。您可以通过单击编辑器图标“查看 SQL”来查看查询构建器编写的 SQL,当处于编辑模式时。

您还可以使用文本框作为简单的分隔符,以保持仪表盘的井井有条。

Using a text card as a divider to organize your dashboard.

在文本卡片中使用变量创建动态文本

您可以向文本卡片添加变量并将它们连接到过滤器。Metabase 将获取在过滤器中选择的值,并将这些值插入到文本中的变量中,从而创建在人们更改过滤器值时自动更新的文本卡片。

例如,假设您想要让文本卡片显示仪表盘上计划过滤器中的值,如下所示

Metabase rendering the two plans selected in the filter,

文本卡片中列出的计划将根据过滤器中选择的计划而变化(在本例中,过滤器中选择了 Business 和 Premium 计划,因此文本卡片会显示它们)。

要将文本卡片变量连接到过滤器

  1. 单击铅笔图标进入仪表盘编辑模式。
  2. 向仪表盘添加过滤器
  3. 向仪表盘添加文本卡片
  4. 编写一些 Markdown 并包含一个变量。变量用双大括号括起来

    # Plan
    ## {{PLAN}}
    
  5. 将过滤器连接到文本卡片中的变量。

Adding a variable to your text card.

如果没有值插入过滤器,Metabase 将渲染难看的 {{PLAN}} 变量。为了处理过滤器没有值的情况,您可以设置默认值,或者更好的是,通过用双括号包围变量文本来隐藏文本,使文本成为可选的。

# Plan
[[## {{PLAN}}]]

双括号告诉 Metabase 仅当连接的过滤器至少有一个值时才显示文本。

使用过滤器值创建自定义 URL

您可以像这样向 Markdown 卡片添加 URL

[Google Search](https://google.com)

这将显示为可点击的超链接:Google 搜索

要创建动态 URL,例如 “过滤器值”的 Google 搜索,您可以将 {{variable}} 放在您希望过滤器值文本显示的位置。例如,要向具有发票表格的仪表盘添加动态 URL

  1. 为“计划”创建仪表盘过滤器。
  2. 添加带有 URL 和变量的 Markdown 卡片

    [[ [Google Search for "{{plan}}"](https://google.com/search?q={{plan}}) ]]
    
  3. 将“计划”过滤器连接到 Markdown 卡片.
  4. 可选:为“计划”过滤器设置默认值。

当过滤器为空(未选择值且未设置默认值)时,Markdown 卡片文本中的外层双中括号将默认隐藏 URL。

A custom URL that accepts a filter value.

现在,如果有人转到“计划”过滤器并选择“Basic”,他们将在 Markdown 卡片中看到一个可点击的链接,如下所示:“Basic”的 Google 搜索

带有沙盒属性的自定义 URL

数据沙盒仅在 ProEnterprise 计划(自托管和 Metabase 云端)中可用。

假设您有一个“部门”属性,并且想要创建一个指向用户指南的自定义链接,如下所示

[View Marketing guide](https://your-company-wiki.com/marketing)

要基于人员的 沙盒属性显示自定义 URL

  1. 为沙盒属性创建仪表盘过滤器。
  2. 添加带有 URL 和变量的 Markdown 卡片

    [[ [View {{department}} guide](https://your-company-wiki.com/{{department}}) ]]
    
  3. 将过滤器连接到 Markdown 卡片.

要在过滤器值为空时默认隐藏 URL,请确保在 Markdown 卡片文本中包含外层双中括号。

当沙盒用户查看仪表盘时,他们将看到

如果您的仪表盘是静态嵌入,您可以选择隐藏过滤器小部件

给 GIF 爱好者的最后一个专业提示

图像语法,

![image description](image-link)

也适用于 GIF。因为仪表盘文本框还有更重要的用例

One of these cards is not like the others.

Markdown 愉快!

下一步:使用 Metabase 构建记录查找工具

如何使用 Metabase 构建内部查找工具,以快速查找有关您的客户、订单或其他数据的详细信息。

下一篇文章