如需使用按钮参数,您的 Looker 管理员必须启用信息中心的自定义按钮实验室功能。
只有具有以下设置的 LookML 信息中心支持按钮:
preferred_viewer
设置为dashboards-next
layout
设置为newspaper
本页演示如何使用 dashboard.lkml
文件中的 LookML 信息中心参数添加和自定义 type: button
的 LookML 信息中心元素。按钮对于在信息中心内放置链接非常有用。您可以链接到 Looker 内容(例如 Looks 和信息中心)或其他网站。
如需了解如何通过 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/
。