LookML 信息中心的单值图表参数

正在建设中:我们正在努力为此页面添加更多内容。在此期间,您可以查看单值图表选项文档页面,了解如何使用可视化图表选项菜单创建和修改单值可视化图表。

本页中介绍的参数适用于 dashboard.lkml 文件中 type: single_value 的 LookML 信息中心元素。

如需了解如何通过 Looker 界面构建单值图表,请参阅单值图表选项文档页面。

基本参数

定义 LookML 信息中心元素时,您必须至少为 name 和 type 参数指定值。其他基本参数(例如 title、height 和 width)会影响信息中心内元素的位置和外观。

name

本部分介绍作为信息中心元素一部分的 name 参数。

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

每个 name 声明都会创建一个新的信息中心元素并为其分配一个名称。元素名称必须是唯一的。使用 layout: grid 信息中心时,有时会在 elements 参数中引用名称。

- name: orders_by_date

title

本部分介绍作为信息中心元素一部分的 title 参数。

title 也可以用作信息中心的一部分,如信息中心参数文档页面中所述。

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

借助 title 参数,您可以更改元素名称向用户的显示方式。如果未指定,则标题默认为元素 name。

请参考下面的示例:

- name: sales_overview
  title: '1) Sales Overview'

如果您使用此格式,元素将显示为 1) 销售概览,而不是 销售概览。

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_google_map | looker_geo_coordinates | looker_geo_choropleth | looker_waterfall | looker_wordcloud | looker_boxplot

如需概览不同类型的 LookML 信息中心元素,请参阅 type(适用于 LookML 信息中心)文档页面。

height

本部分介绍作为信息中心元素一部分的 height 参数。

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

对于采用 tile 或 static 布局的信息中心

height 参数用于为 layout: tile 和 layout: static 信息中心定义元素的高度,以 tile_size 为单位(以像素为单位)。

例如,以下代码指定了 tile_size: 100 和 height: 4,使 orders_by_date 元素的高度为 400 像素。

- dashboard: sales_overview
  tile_size: 100
  ...

  elements:
  - name: orders_by_date
    height: 4
    ...

对于采用 newspaper 布局的信息中心

对于 layout: newspaper 信息中心,height 参数用于定义元素的高度(以行为单位)。

采用报纸布局的信息中心的元素高度默认为 6 行,即大约 300 像素。如果信息中心的 preferred viewer 参数设置为 dashboards-next,则最小高度为 1 行。如果信息中心的 preferred viewer 参数设置为 dashboards,则最低高度为 2 行。

例如,以下代码将某个元素的高度设置为 12 行,即设置为默认高度的其他元素的两倍:

- dashboard: sales_overview
  layout: newspaper
  ...

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

width

本部分介绍作为信息中心元素一部分的 width 参数。

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

width 参数用于定义 layout: tile 和 layout: static 信息中心内元素的宽度(以 tile_size 为单位)。

例如,以下代码指定了 tile_size: 100 和 width: 4,使 orders_by_date 元素的宽度为 400 像素。

- dashboard: sales_overview
  tile_size: 100
  ...

  elements:
  - name: orders_by_date
    width: 4
    ...

对于 layout: newspaper 信息中心,width 参数用于定义元素的宽度(以列为单位)。

采用报纸布局的信息中心默认宽度为 24 列。

例如,以下代码将元素宽度设置为信息中心宽度的一半:

- dashboard: sales_overview
  layout: newspaper
  ...

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

top

top 参数用于定义 layout: static 信息中心内元素的自上而下位置,单位为 tile_size。

例如,以下代码指定了 tile_size: 100 和 top: 4,将 orders_by_date 元素的顶部边缘定位在距离信息中心顶部 400 像素的位置。

- dashboard: sales_overview
  tile_size: 100
  ...

  elements:
  - name: orders_by_date
    top: 4
    ...

left

对于 layout: static 信息中心,left 参数用于定义元素的从左到右位置,单位为 tile_size。

例如,以下代码指定了 tile_size: 100 和 left: 4,将 orders_by_date 元素的左边缘定位在距离信息中心左侧 400 像素的位置。

- dashboard: sales_overview
  tile_size: 100
  ...

  elements:
  - name: orders_by_date
    left: 4
    ...

row

对于 layout: newspaper 信息中心,row 参数用于定义元素顶部边缘所在的行。

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

每行的高度为 50 像素,这意味着 6 行的默认元素高度为 300 像素。

例如,以下代码将某个元素设置为显示在信息中心内元素的第二行,假设元素的高度设置为默认高度:

- dashboard: sales_overview
  layout: newspaper
  ...

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

col

对于 layout: newspaper 信息中心,col 参数用于定义元素左边缘所在的列。

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

例如,以下代码将某个元素设置为在信息中心的第三列元素中设置:

- dashboard: sales_overview
  layout: newspaper
  ...

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

refresh

本部分介绍作为信息中心元素一部分的 refresh 参数。

refresh 也可以用作信息中心的一部分,如信息中心参数文档页面中所述。

借助 refresh 参数,元素可以定期自动重新加载,从而检索最新数据。在需要持续显示信息中心的环境中(例如办公室电视上),此功能通常很有用。请注意,必须在浏览器窗口中打开信息中心,此参数才能生效。此设置不会在后台运行,以“预热”信息中心缓存。

刷新率可以是任意数量(不含小数)的秒、分钟、小时或天。例如:

- name: orders_by_date
  refresh: 2 hours

设置较短的刷新间隔时,请务必谨慎。如果元素背后的查询消耗大量资源,某些元素可能会给数据库带来超出预期的压力。

note

您可以为元素添加说明性备注,如下所示:

- name: element_name
  note:
    text: 'note text'
    state: collapsed | expanded
    display: above | below | hover

note 具有子参数 text、state 和 display。

text

text 子形参用于指定注释中显示的文本。文本可以进行本地化。

state

state 子形参用于确定注释在宽度上是否会超出元素宽度,如果超出,则会显示为 collapsed 还是 expanded。如果您选择 collapsed,但注释过长,则注释将以可点击的省略号 (...) 结尾,您可以使用该省略号阅读完整注释。

display

display 子参数用于确定注释在元素上的显示位置。above 将注释放置在元素的顶部,below 将注释放置在元素的底部,而 hover 则要求用户将鼠标悬停在元素上才能看到注释。

查询参数

定义 LookML 信息中心元素时,您必须为至少 model 和 explore 查询参数指定值,并且必须使用 dimensions 参数或 measures 参数指定至少一个字段。您还可以使用其他查询参数来控制数据在信息中心元素中的显示方式。

model

model 参数用于定义要用于元素查询的模型。如果未指定,则默认为信息中心所在的模型。

- name: orders_by_date
  model: ecommerce

model 参数接受 LookML 常量。您可以在项目的清单文件中定义一个常量,然后使用语法 "@{constant_name}" 将该常量设置为 model 的值。使用常量可让您在一个位置定义模型的名称,如果您要更新多个信息中心元素使用的模型的名称,此功能会特别有用。

如需详细了解如何将常量与 LookML 信息中心搭配使用,并查看相关示例,请参阅 constant 参数文档页面。

explore

本部分介绍作为信息中心元素一部分的 explore 参数。

explore 也可以用作模型的一部分,如 explore 参数文档页面中所述。

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

explore 参数用于定义要用于元素查询的 Explore。

- name: orders_by_date
  explore: order

explore 参数接受 LookML 常量。您可以在项目的清单文件中定义一个常量,然后使用语法 "@{constant_name}" 将该常量设置为 explore 的值。使用常量可让您在一个位置定义探索的名称,如果您要更新多个信息中心元素使用的探索的名称,此功能会特别有用。

如需详细了解如何将常量与 LookML 信息中心搭配使用,并查看相关示例,请参阅 constant 参数文档页面。

dimensions

dimensions 参数用于定义元素查询所用的一个或多个维度。使用 view_name.dimension_name 语法指定维度。如果查询没有任何参数,请勿添加 dimensions。

## single dimension example
- name: orders_by_date
  dimensions: order.order_date

## multiple dimension example
- name: orders_by_date
  dimensions: [order.order_date, customer.name]

measures

measures 参数用于定义要用于元素查询的指标。使用 view_name.measure_name 语法指定指标。如果查询没有任何参数,请勿添加 measures。

## single measure example
- name: orders_by_date
  measures: order.count

## multiple measure example
- name: orders_by_date
  measures: [order.count, order_item.count]

sorts

sorts 参数用于定义元素查询的排序行为。先列出主排序字段,然后列出所有次排序字段。使用 view_name.field_name 语法指定要排序的维度或度量。

如果您省略 sorts 参数,该元素将使用 Looker 的默认排序顺序。升序排序不需要后缀,而降序排序需要 desc 后缀。

以下示例定义了单个排序:

- name: orders_by_date
  sorts: order.order_date desc

以下示例定义了多个排序:

- name: orders_by_date
  sorts: [order.order_date desc, customer.name]

如果透视维度,您可以通过指定指标名称、排序方向和数据表中目标列的从零开始的索引号来对查询结果进行排序。例如,以下元素使用索引 0 按第一个透视列进行排序:

- name: orders_by_category
  sorts: [orders.count desc 0]

如需按行总计排序,请指定总计列的索引。例如,以下元素使用索引 2(表示具有两个透视列的查询的总数列)按行总计进行排序:

- name: orders_by_cohort
  sorts: [users.count desc 2]

pivots

pivots 参数定义了应针对元素查询进行透视的维度。使用 view_name.dimension_name 语法指定维度。如果查询没有任何参数,请勿添加 pivots。

## single pivot example
- name: orders_by_date
  pivots: customer.gender

## multiple pivot example
- name: orders_by_date
  pivots: [customer.gender, customer.age_tier]

limit

limit 参数用于定义元素查询应使用的行限制。此限制适用于应用任何透视之前的行数。

- name: orders_by_date
  limit: 100

filters

本部分介绍作为信息中心元素一部分的 filters 参数。

filters 也可以用作信息中心的一部分,如信息中心参数文档页面中所述。

filters 还可以用作指标的一部分,如 filters 参数文档页面中所述。

filters 参数用于定义应为元素的查询使用的不可更改的过滤条件。如果您希望用户可以在信息中心内更改过滤条件,则应使用信息中心的 filters 设置过滤条件,然后使用 listen 将其应用于元素。

filters 的语法为:

- name: element_name
  filters:
    orders.created_date: 2020/01/10 for 3 days
    orders.status: Shipped
    # You can create multiple filter statements

每个过滤条件都可以接受 Looker 过滤表达式或值常量。您还可以在过滤表达式中使用 _localization 或 _user_attributes Liquid 变量,以实现灵活的过滤值。

listen

借助信息中心过滤条件,观看者可以交互式地优化信息中心元素中显示的数据。使用 LookML 信息中心的 filters 参数定义信息中心过滤条件。然后,使用 listen 参数将信息中心元素与信息中心过滤条件相关联。

listen 的语法如下:

- name: element_name
  listen:
    filter_name_goes_here: dimension or measure on which to apply
                           the filter using view_name.field_name syntax
    # You can add more than one listen statement

向元素添加 listen 参数,然后提供过滤器的名称,后跟英文冒号和对应用过滤器的字段的引用(使用 view_name.field_name 语法)。例如,您可以创建一个名为“日期”的过滤条件,要求用户在界面中的过滤条件字段中输入日期。然后,您可以将用户输入的值应用于 orders_by_date 元素,如下所示:

- dashboard: sales_overview
  ...

  filters:
  - name: date
    type: date_filter

  elements:
 - name: orders_by_date
    listen:
      date: order.order_date
    ...

如果正在监听的过滤条件配置了 vis_filter: true 参数,过滤条件控件会显示在相应可视化图块顶部的过滤条件栏中,而不是显示在信息中心顶部的过滤条件栏中。

如需查看使用 filters 参数和 listen 参数将信息中心过滤条件应用于各个信息中心元素的其他示例,请参阅构建 LookML 信息中心。

query_timezone

query_timezone 参数用于指定运行查询的时区。时区选项显示在 timezone 的值文档页面上。如果您希望查询使用查看者的时区运行,可以将该值分配为 user_timezone。

- name: orders_by_date
  query_timezone: America/Los Angeles
- name: orders_by_customer
  query_timezone: user_timezone

merged_queries

借助 merged_queries 参数,您可以将多个查询的结果合并到单个信息中心元素中。在元素的 merged_queries 参数中定义每个来源查询,并使用 join_fields 子参数指定结果的合并方式。

以下示例 LookML 代码创建了一个合并结果 元素(属于 type: looker_grid)。在此示例中,merged_queries 参数用于创建一个信息中心元素,该元素将两个单独查询中的数据合并到一个表格图表中:

- name: merged_results_element
  title: Merged Results Tile
  type: looker_grid
  merged_queries:
  - model: ecommerce
    explore: users
    type: table
    fields: [users.state, users.count, users.city]
    sorts: [users.count desc 0]
    limit: 5000
    column_limit: 50
    query_timezone: UTC
    listen:
    - State: users.state
  - model: ecommerce
    explore: users
    type: table
    fields: [users.state, users.city]
    sorts: [users.state]
    limit: 500
    column_limit: 50
    query_timezone: UTC
    join_fields:
    - field_name: users.state
      source_field_name: users.state
    - field_name: users.city
      source_field_name: users.city
    listen:
    - State: users.state

在此示例中,信息中心元素合并了两个源查询的数据,这两个源查询均基于 ecommerce 模型中的 users 探索。主查询包含 users.state、users.count 和 users.city 字段,并按 users.count 字段对结果进行排序。第二个源查询包含 users.state 和 users.city 字段,并按 users.state 字段对结果进行排序。

join_field 参数会根据 users.state 和 users.city 字段中的匹配值合并源查询。

listen 参数会对这两个查询应用 State 过滤条件,从而让信息中心查看者能够通过选择特定州来优化信息中心图块中显示的查询结果。

示例:合并公司数据

假设您要创建一个合并查询,将来自两个不同探索(company_info 和 companies)的公司信息合并在一起。您希望基于每个探索中的 ipo.stock_symbol、companies.name 和 companies.contact_email 字段联接查询,以创建一个查询,该查询可返回公司名称、公司联系人电子邮件地址、首次公开募股 (IPO) 年份、股票代码、员工人数和职位数量的结果。您可以在 LookML 中按如下方式定义合并查询元素:

- name: merged_results_element
  title: Merged Results Tile
  merged_queries:
  - model: market_research
    explore: company_info
    fields: [companies.name, companies.contact_email, ipo.public_year, ipo.stock_symbol]
    filters:
      companies.contact_email: "-NULL"
      ipo.valuation_amount: NOT NULL
    sorts: [ipo.public_year desc]
  - model: company_data
    explore: companies
    fields: [companies.name, ipo.stock_symbol, companies.contact_email,
      companies.number_of_employees, jobs.job_count]
    filters:
      companies.number_of_employees: NOT NULL
      ipo.stock_symbol: "-NULL"
      companies.contact_email: "-NULL"
    sorts: [jobs.job_count desc]
    join_fields:
    - field_name: ipo.stock_symbol
      source_field_name: ipo.stock_symbol
    - field_name: companies.name
      source_field_name: companies.name
    - field_name: companies.contact_email
      source_field_name: companies.contact_email

对合并的查询元素应用过滤条件

合并查询元素的上一个示例演示了如何使用 filters 参数直接在每个源查询中应用硬编码的过滤条件。例如,主查询中的过滤条件 companies.contact_email: "-NULL" 和 ipo.valuation_amount: NOT NULL 将结果限制为具有有效联系电子邮件地址和估值的公司。这些查询级过滤条件会在合并查询之前预先过滤数据,并且用户无法更改。

您还可以通过在每个源查询的定义中使用 listen 参数,将信息中心过滤条件应用于合并的查询元素。例如,假设您有一个名为 Industry 的信息中心过滤条件,您已使用 LookML 信息中心的 filters 参数在信息中心级定义了该过滤条件:

filters:
- name: Industry
  title: Industry
  type: field_filter
  ui_config:
    type: dropdown_menu
    display: inline
  model: market_research
  explore: company_info
  field: companies.industry

如需将 Industry 过滤条件应用于两个来源查询中的 companies.industry 字段,请按如下所示将 listen 参数添加到每个合并查询的来源查询定义中:

listen:
  Industry: companies.industry

例如,以下示例代码将 Industry 过滤条件添加到上一个示例中合并结果元素中的两个来源查询。

- name: merged_results_element
  title: Merged Results Tile
  merged_queries:
  - model: market_research
    explore: company_info
    fields: [companies.name, companies.contact_email, ipo.public_year, ipo.stock_symbol]
    filters:
      companies.contact_email: "-NULL"
      ipo.valuation_amount: NOT NULL
    sorts: [ipo.public_year desc]
    listen:
      Industry: companies.industry
  - model: company_data
    explore: companies
    fields: [companies.name, ipo.stock_symbol, companies.contact_email,
      companies.number_of_employees, jobs.job_count]
    filters:
      companies.number_of_employees: NOT NULL
      ipo.stock_symbol: "-NULL"
      companies.contact_email: "-NULL"
    sorts: [jobs.job_count desc]
    join_fields:
    - field_name: ipo.stock_symbol
      source_field_name: ipo.stock_symbol
    - field_name: companies.name
      source_field_name: companies.name
    - field_name: companies.contact_email
      source_field_name: companies.contact_email
    listen:
      Industry: companies.industry

添加此功能后,当用户与 Industry 信息中心过滤条件互动时,合并查询元素中的相应来源查询将相应地进行过滤。

hidden_fields

hidden_fields 参数用于指示查询中使用了哪些字段(如果有),但这些字段在图表中处于隐藏状态。任何隐藏字段都将显示在探索的数据表部分中。

hidden_fields: [inventory_items.count, distribution_centers.id]

样式参数

本部分中介绍的参数对应于单值图表的可视化图表编辑器中样式部分的选项。

colors

colors 参数用于指定序列的颜色列表。列表中的第一种颜色对应于第一个数据系列。如果序列数量多于所列颜色数量,颜色将从头开始。


colors: [blue, orange, yellow, red, purple]

对于指定颜色的所有图表属性,颜色值可以采用十六进制字符串(例如 #2ca6cd)或 CSS 具名颜色字符串(例如 mediumblue)。

custom_color_enabled

将 custom_color_enabled 参数设置为 true 可启用为单值图指定自定义颜色的选项。将此参数与 custom_color 参数搭配使用。


custom_color_enabled: true | false

custom_color

为单值可视化图表中的文字指定自定义颜色。


custom_color: #2ca6cd | mediumblue

show_single_value_title

当此参数设置为 true 时,系统会在查询值下方显示标题。您可以使用 single_value_title 参数指定或更改标题。


show_single_value_title: true | false

single_value_title

指定要与查询值一起显示的标题。标题文字可以进行本地化。


single_value_title: Title

valueFormat

为值指定数字格式或日期格式。此参数接受 Excel 式格式。如果未指定格式,系统将以相应维度或指标的格式显示值。

比较参数

本部分中介绍的参数对应于单值图表的可视化图表编辑器中的比较部分中的选项。

show_comparison

如果设置为 true,您可以使用 show_comparison 参数向 type: single_value 的信息中心元素添加比较信息。


show_comparison: true | false

comparison_type

使用 comparison_type 参数指定如何在 type: single_value 的信息中心元素中使用比较字段。

您可以为 comparison_type 参数指定以下值之一:

  • value:比较字段的值显示在图表底部。
  • change:比较字段的值显示在图表底部。如果值为负数,则三角形指向下方。如果值为正,则三角形指向上方。
  • progress:用于单值可视化图表的字段的值除以比较字段的值。此百分比以进度条的形式显示。
  • progress_percentage:用于单值可视化图表的字段的值除以比较字段的值。此百分比以进度条的形式显示。该条形图上标有百分比和比较字段的值。

comparison_type: value | change | progress | progress_percentage

show_comparison_label

指定是否在比较字段中显示标签。默认情况下,标签是比较字段的名称。


show_comparison_label: true | false

comparison_label

指定要与比较字段一起显示的标签。比较标签文本可以本地化。


show_comparison_label: true
comparison_label: Label

comparison_reverse_colors

如果 comparison_type 设置为 change,您可以将 comparison_reverse_colors 设置为 true,以在比较字段中将负数显示为带有绿色三角形的绿色文本,而将正数显示为带有红色三角形的红色文本。


comparison_type: change
comparison_reverse_colors: true | false