LookML 信息中心的按钮参数

只有具有以下设置的 LookML 信息中心支持按钮：

此页面演示了如何在 dashboard.lkml 文件中使用 LookML 信息中心参数添加和自定义 type: button 的 LookML 信息中心元素。按钮可用于在信息中心内放置链接。您可以链接到 Looker 内容（例如 Look 和信息中心）或其他网站。

如需了解如何通过 Looker 界面向信息中心添加按钮，请参阅创建用户定义的信息中心文档页面。

用法示例


## BASIC PARAMETERS
type: button
name: text
height: N
width: N
row: N
col: N

## BUTTON PARAMETER
rich_content_json: '{
 "text": "button text",
 "description": "description",
 "newTab": true | false,
 "alignment": "left" | "right" | "center",
 "size": "small" | "medium" | "large",
 "style": "OUTLINED" | "FILLED" | "TRANSPARENT",
 "color": "hex string or css color",
 "href": "link"
 }'

参数定义

参数名称 说明
基本参数
type（适用于元素） 确定要在元素中使用的可视化图表类型
name（适用于元素） 创建元素
height（适用于元素） 定义按钮元素的平铺框的高度。对于 layout: newspaper 信息中心，高度以行为单位
width（适用于元素） 定义按钮元素的图块框的宽度。对于 layout: newspaper 信息中心，宽度以列为单位
row 定义按钮元素的平铺框（以行为单位）在 layout: newspaper 信息中心内的自上而下位置
col 定义按钮元素的图块框（以列为单位）在 layout: newspaper 信息中心内的从左到右的位置
按钮参数
rich_content_json 一个 JSON 对象，包含有关按钮的键值对

基本参数

定义 type: button 的 LookML 信息中心元素时，您必须至少为 name 和 type 参数指定值。

height、width、row 和 col 参数适用于按钮元素的平铺框，而不是按钮本身。

name

本部分指的是属于信息中心元素的 name 参数。

name 还可以用作信息中心过滤条件的一部分，如信息中心参数文档页面中所述。

每个 name 声明都会创建一个新的信息中心元素并为其分配一个名称。元素名称必须是唯一的。

提供给按钮的 name 不会显示在信息中心界面中。

- name: orders_by_date

type

本部分指的是属于信息中心元素的 type 参数。

type 还可以用作信息中心过滤条件的一部分，如信息中心参数文档页面中所述。

type 还可以用作联接的一部分，如 type（用于联接）参数文档页面中所述。

type 还可以用作维度的一部分，如维度、过滤条件和参数类型文档页面中所述。

type 还可以用作指标的一部分，如指标类型文档页面中所述。

type 参数用于确定元素中使用的可视化图表类型。

- name: element_name
  type: text | looker_grid | table | single_value | looker_single_record |
        looker_column | looker_bar | looker_scatter | looker_line | looker_area |
        looker_pie | looker_donut_multiples | looker_funnel | looker_timeline |
        looker_map | looker_geo_coordinates | looker_geo_choropleth | looker_waterfall |
        looker_wordcloud | looker_boxplot | button

如需大致了解不同类型的 LookML 信息中心元素，请参阅 type（适用于 LookML 信息中心）文档页面。

height

本部分指的是属于信息中心元素的 height 参数。

height 还可以用作信息中心行的一部分，如信息中心参数文档页面中所述。

height 参数用于定义按钮元素的平铺框的高度，以行为单位。

按钮元素功能块框的默认高度为 6 行。最小高度为 1 行。更改按钮元素的高度可能会影响信息中心内的其他元素，但不会影响按钮本身的高度。

例如，以下代码将按钮的平铺框设置为 12 行高：

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    height: 12
    ...

width

本部分指的是属于信息中心元素的 width 参数。

width 还可以用作信息中心的一部分，如信息中心参数文档页面中所述。

width 参数用于定义按钮元素的平铺框的宽度（以列为单位）。

按钮元素的平铺框的宽度默认为 8 列，即信息中心全宽的三分之一。按钮的平铺框的最小宽度为 2。

例如，以下代码将按钮的平铺框设置为信息中心宽度的一半：

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    width: 12
    ...

如果按钮的平铺框内有空间，按钮的宽度会增加，以容纳 text 中定义的长文本字符串。不过，按钮的宽度不会超过 width 参数中设置的值；如有必要，系统会在按钮上截断 text 中定义的字符串。

row

row 参数用于定义按钮元素的 平铺框的顶部边缘所在的行。

信息中心从顶部的第 0 行开始。信息中心按钮元素的默认元素高度为 6 行，这意味着信息中心顶部的元素 (row: 0) 默认会占据第 0-5 行。

在以下示例中，代码将按钮的平铺框设置为放置在信息中心内元素的第二行，假设元素的高度设置为默认高度：

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    row: 6
    ...

col

col 参数用于定义按钮元素的平铺框左边缘所在的列。

信息中心分为 24 列。信息中心从信息中心左侧的第 0 列开始。采用报纸布局的信息中心的默认元素宽度为 8 列，这意味着信息中心左侧的元素 (col: 0) 默认会占据第 0-7 列。

例如，以下代码将元素设置为在信息中心的第三列元素中设置：

- dashboard: sales_overview
  layout: newspaper
  ...

  elements:
  - name: orders_by_date
    col: 16
    ...

按钮参数

本部分中描述的参数可用于向 type: button 的 LookML 信息中心元素添加内容。

rich_content_json

rich_content_json 是一个 JSON 对象，包含多个用于定义信息中心按钮特征的键值对。

rich_content_json: '{
 "text": "Go to Sales Dashboard",
 "description": "View sales from the last 18 months.",
 "newTab": true,
 "alignment": "center",
 "size": "medium",
 "style": "FILLED",
 "color": "forestgreen",
 "href":"https://instance_name.looker.com/dashboards/152?State=California&Created+Fiscal+Quarter=2022"
 }'

text

text 用于定义将显示在信息中心界面中的按钮上的文字。按钮的宽度会扩展以适应文本，直到达到 width 参数设置的限制，此时文本将被截断。

description

description 用于定义当光标悬停在按钮上时显示的弹出式提示文字。如果未提供说明，则默认显示 href 中提供的链接。

newTab

newTab 是一个布尔值，用于定义按钮链接是在新标签页 (true) 中打开还是在当前标签页 (false) 中打开。newTab 的默认值为 true。

alignment

alignment 用于设置按钮在按钮元素的平铺框内的对齐方式。alignment 默认为 center。

大小

size 将按钮及其文字的大小设置为 small、medium 或 large。size 的值不会影响按钮元素的平铺框的大小或 height 参数。

style

style 将按钮的样式设置为以下值之一：

  • FILLED：按钮的正文填充了 color 中设置的颜色。按钮的文字为白色。这是默认值。
  • OUTLINED：按钮边缘有轮廓，但正文是透明的。按钮文字的颜色由 color 设置。
  • TRANSPARENT：按钮的正文是透明的。按钮文字的颜色由 color 设置。

color

color 用于设置按钮或按钮文字的颜色，具体取决于 style 设置。color 默认为 Looker 实例的默认类别颜色集合中的第一种颜色。

颜色值可以采用十六进制字符串格式（例如 #2ca6cd），也可以采用 CSS 颜色名称格式（例如 mediumblue）。

href

href 用于设置按钮将用户定向到的网址。指向其他 Looker 信息中心的链接可以包含将信息中心过滤条件设置为特定值的过滤条件参数。

在嵌入式体验中，指向信息中心的链接应在链接网址中包含 embed/。