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 | group

如需简要了解不同类型的 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 参数定义了按钮元素的图块框上边缘所在的行。如果使用 group 参数将按钮放置在功能块组内,则 row 会定义按钮相对于组容器 (row: 0) 顶部的行位置。

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

在以下示例中,代码将按钮的图块框设置为放置在信息中心内的第二行元素上,假设元素设置为默认高度:

- dashboard: sales_overview
  layout: newspaper
  ...

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

col

col 参数定义按钮元素的图块框左边缘所在的列。如果使用 group 参数将按钮放置在功能块组内,则 col 会定义按钮相对于组容器 (col: 0) 左边缘的列位置。

信息中心分为 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"
 }'

以下示例用法演示了一个可前往信息中心内某个标签页的信息中心按钮。

rich_content_json: '{
 "text": "Go to Users tab",
 "description": "View user data from the last 18 months.",
 "newTab": false,
 "alignment": "center",
 "size": "medium",
 "style": "FILLED",
 "color": "forestgreen",
 "targetTabName":"Users"
 "href":""
 }'

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)格式。

targetTabName

如果您的信息中心有标签页,targetTabName 会设置按钮将用户带到的信息中心标签页。

详细了解标签页式信息中心。

href

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