LookML 信息中心的地图参数

本页介绍了如何使用 dashboard.lkml 文件中的 LookML 信息中心参数创建和修改 type: looker_map 的 LookML 信息中心元素。

如需了解如何通过 Looker 界面构建交互式地图图表,请参阅地图图表选项文档页面。如需了解构建交互式地图图表所需的字段类型,请参阅查询参数部分。

用法示例

N 表示需要提供数值。单引号表示描述性文字,不应包含在实际代码中。


## BASIC PARAMETERS
name: element_name
title: 'Element Title'
type: looker_map
height: N
width: N
top: N
left: N
row: N
col: N
refresh: N (seconds | minutes | hours | days)
note:
  text: 'note text'
  state: collapsed | expanded
  display: above | below | hover

## QUERY PARAMETERS
model: model_name
explore: explore_name
fields: [view_name.field_name, view_name.field_name, …]
dimensions: [view_name.field_name, view_name.field_name, …]
measures: [view_name.field_name, view_name.field_name, …]
sorts: [view_name.field_name asc | desc, view_name.field_name, …]
pivots: [view_name.field_name, view_name.field_name, …]
limit: N
column_limit: N
filters:
  view_name.field_name: 'looker filter expression'
listen:
  dashboard_filter_name: view_name.field_name
query_timezone: 'specific timezone' | user_timezone

## PLOT PARAMETERS
map_plot_mode: points | automagic_heatmap | lines | areas
heatmap_gridlines: true | false
heatmap_gridlines_empty: true | false
heatmap_opacity: 'number between 0 and 1'

## MAP PARAMETERS
map_tile_provider: light | light_no_labels | dark | dark_no_labels | satellite_streets |
                    satellite | streets | outdoors | traffic_day | traffic_night
map_position: fit_data | custom
map_latitude: 'latitude value'
map_longitude: 'longitude value'
map_zoom: N
map_scale_indicator: 'off' | metric | imperial | metric_imperial
map_pannable: true | false
map_zoomable: true | false
show_view_names: true | false
show_legend: true | false
show_region_field: true | false
draw_map_labels_above_data: true | false

## POINT PARAMETERS
map_marker_type: circle | icon | circle_and_icon | none
map_marker_icon_name: default | airplane | ambulance | anchor | beaker | bell | bolt | briefcase |
                      building | camera | car | checkmark | coffee | comment | envelope | file |
                      gamepad | gavel | gift | glass | headphones | heart | house | key | leaf |
                      microphone | music | person | phone | restaurant | school | shopping_cart |
                      star | suitcase | taxi | tree | trophy | truck | university | wrench
map_marker_radius_mode: proportional_value | equal_to_value | fixed
map_marker_radius_fixed: N
map_marker_radius_min: N
map_marker_radius_max: N
map_marker_proportional_scale_type: linear | log
map_marker_units: meters | pixels
map_marker_color_mode: value | fixed
map_marker_color: ['color value']

## VALUE PARAMETERS
map_value_colors: ['one or more color values']
quantize_map_value_colors: true | false
reverse_map_value_colors: true | false
map_value_scale_clamp_min: N
map_value_scale_clamp_max: N

参数定义

参数名称 说明
基本参数
name(适用于元素) 创建元素
title(适用于元素) 更改元素名称向用户的显示方式
type(适用于元素) 确定元素中要使用的可视化图表类型
height(适用于元素) 以 tile_size 为单位定义 layout: tile 和 layout: static 信息中心内元素的高度
width(适用于元素) 定义 layout: tile 和 layout: static 信息中心内元素的宽度(以 tile_size 为单位)
top 定义 layout: static 信息中心内元素从上到下的位置,单位为 tile_size
left 定义 layout: static 信息中心内元素的从左到右位置,单位为 tile_size
row 以行为单位定义 layout: newspaper 信息中心内元素的自上而下位置
col 以列为单位定义 layout: newspaper 信息中心内元素的从左到右位置
refresh(适用于元素) 设置元素自动刷新的间隔
note 开始 LookML 部分,以定义元素的注释。此参数具有子参数 text、state 和 display。
查询参数
model 定义要用于元素查询的模型
explore(适用于元素) 定义要用于元素查询的 Explore
fields 定义要用于元素查询的字段。此参数可用于代替 dimensions 和 measures。
dimensions 定义要用于元素查询的维度
measures 定义要用于元素查询的指标
sorts 定义要用于元素查询的排序
pivots 定义应透视以用于元素查询的维度
limit 定义要用于元素查询的行数限制
column_limit 定义要用于元素查询的列限制
filters(适用于元素) 定义了元素查询无法更改的过滤条件
listen 定义了元素的查询可更改的过滤条件(如果已创建 filters [针对信息中心])
query_timezone 定义运行查询时应使用的时区
绘图参数
map_plot_mode 定义如何将位置数据绘制在 type: looker_map 的元素上
heatmap_gridlines 为热图元素所用的每个网格线添加边框
heatmap_gridlines_empty 对于将 heatmap_gridlines 设置为 true 的热图,在没有关联数据的地图区域周围显示轮廓
heatmap_opacity 定义热图中使用的颜色的不透明度
地图参数
map_tile_provider 定义背景地图的类型以及是否显示地图标签
map_position 定义可见地图的中心点和缩放级别
map_latitude 定义了将 map_position 设置为 custom 的地图的纬度
map_longitude 定义了将 map_position 设置为 custom 的地图的经度
map_zoom 定义了将 map_position 设置为 custom 的地图的缩放级别
map_scale_indicator 设置是否显示地图比例尺以及显示的单位类型
map_pannable 设置用户是否可以通过拖动地图来重新定位地图
map_zoomable 设置用户是否可以放大和缩小地图
show_view_names 设置是否在地图提示中显示视图名称以及字段名称
show_legend 设置是否应在可视化图表的右下角显示地图图例
show_region_field 设置是否在地图的提示中显示区域信息
draw_map_labels_above_data 在热图上方或下方显示地图的标签
点参数
map_marker_type 指定地图上显示的点类型,适用于将 map_plot_mode 设置为 points、lines 或 areas 的元素
map_marker_icon_name 指定要在所有地图标记上显示的图标类型,适用于将 map_marker_type 设置为 icon 或 circle_and_icon 的元素
map_marker_radius_mode 设置圆圈的大小调整方式,适用于 map_marker_type 设置为 circle 或 circle_and_icon 的元素
map_marker_radius_fixed 为所有地图标记设置一个固定半径,适用于 map_marker_type 设置为 circle 或 circle_and_icon 且 map_marker_radius_mode 设置为 fixed 的元素
map_marker_radius_min 为将 map_marker_radius_mode 设置为 proportional_value 的元素设置圆形的最小半径
map_marker_radius_max 为 map_marker_radius_mode 设置为 proportional_value 的元素设置圆的最大半径
map_marker_proportional_scale_type 指定对于 map_marker_type 设置为 circle 或 circle_and_icon 且 map_marker_radius_mode 设置为 proportional_value 的元素,圆圈大小是基于线性比例还是对数比例
map_marker_units 将圆半径所用的单位设置为 meters 或 pixels,适用于将 map_marker_type 设置为 circle 或 circle_and_icon 的元素
map_marker_color_mode 指定地图标记的颜色是固定的,还是根据底层查询的值动态分配给标记
map_marker_color 指定要应用于所有地图标记的单一颜色,适用于将 map_marker_color_mode 设置为 fixed 的元素
价值参数
map_value_colors 指定地图点的颜色,或者定义要使用的颜色范围(如果您要根据某项指标进行颜色编码)
quantize_map_value_colors 将色阶从平滑渐变更改为仅包含您设置的特定颜色
reverse_map_value_colors 切换图表中指示高值和低值的颜色,反转颜色渐变
map_value_scale_clamp_min 设置颜色范围的最小值
map_value_scale_clamp_max 设置颜色范围的最大值

基本参数

定义 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 查询参数指定值。

对于 type: looker_map 的 LookML 信息中心元素,您还必须指定至少一个地理位置字段作为 dimensions 或 fields 参数的值。地理位置字段可以是以下任一字段:

  • 一种基于经度和纬度数据的维度,在 LookML 中定义为 type: location 维度。
  • 已分配地图图层的维度。LookML 开发者可以使用 map_layer_name 参数向度量添加内置地图图层或自定义地图图层。
  • 邮政编码维度。邮政编码地区基于 2010 年邮政编码制表区域 (ZCTA)。如果您要直观呈现邮政编码,邮政编码与用于地图可视化的 ZCTA 之间可能不存在一一对应的关系,因此可能无法在地图中直观呈现所有点。

您可以使用其他查询参数来控制数据在信息中心元素中的显示方式。如需详细了解使用 Looker 界面构建交互式地图图表的要求,请参阅地图图表选项文档页面中的构建交互式地图图表部分。

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 参数文档页面。

fields

fields 参数用于定义元素查询所使用的字段。使用 view_name.dimension_name 语法指定字段。

## single field example
- name: orders_by_date
  fields: order.order_date

## multiple fields example
- name: orders_by_date
  fields: [order.order_date, order.order_count]

如果您使用 fields 参数,则无需使用 dimensions 和 measures 参数。

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

column_limit

column_limit 参数用于定义元素查询应使用的列限制。此限制适用于应用任何透视后的列数。

- name: orders_by_date
  column_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

绘图参数

本部分中介绍的参数对应于地图图表的可视化图表编辑器中的“绘制”部分中的选项。

您可与 type: looker_map 的元素搭配使用的参数取决于您的查询是否包含 type: location 维度或是否具有关联的地图图层。

map_plot_mode

map_plot_mode 参数用于定义如何根据 type: location 维度在 type: looker_map 元素上绘制数据。此参数不适用于基于具有关联地图图层的维度或邮政编码维度的地图。map_plot_mode 参数接受以下值:

points

将 map_plot_mode 设置为 points 会将底层数据表中的每一行绘制为地图上的一个离散点。

维度为 type: location 时,地图上会显示大小和颜色相同的点。向查询中添加衡量指标后,可以使用 map_marker_radius_mode 和 map_marker_color_mode 参数按颜色或大小缩放点。

automagic_heatmap

将 map_plot_mode 设置为 automagic_heatmap 会以热力图网格的形式显示基础查询中的数据。它的工作原理是将可见地图划分为大小相等的正方形,然后计算数据中的哪些值适合每个正方形。正方形会根据您选择的指标着色。放大或缩小此地图会促使 Looker 重新计算网格,以便粒度与缩放级别相适应。

您的查询必须同时包含维度 type: location 和度量,才能使此图表类型正常运行。

lines

将 map_plot_mode 设置为 lines 会从查询中提取两个维度(type: location),并在可视化图表中将它们连接在一起。向查询中添加度量后,您就可以为折线添加色阶。

areas

将 map_plot_mode 设置为 areas 会提取 type: location 的一个维度,并按您对所有点进行排序的顺序连接这些点。这会在地图元素上形成区域边界。向查询中添加度量后,您可以设置构成区域边界的各个位置点的尺寸和颜色格式。

heatmap_gridlines

对于热图元素,将 heatmap_gridlines 设置为 true 会在用于热图的每个网格线周围添加边框。当您绘制维度为 type: location 且 map_plot_mode 设置为 automagic_heatmap 的图表时,或者当您绘制邮政编码维度或具有关联地图图层的维度时,此参数可用。


heatmap_gridlines: true | false

heatmap_gridlines_empty

如果将热图元素的 heatmap_gridlines 设置为 true,则将 heatmap_gridlines_empty 设置为 true 会在没有关联数据的地图区域周围显示轮廓。


heatmap_gridlines_empty: true | false

heatmap_opacity

对于热图元素,您可以使用 heatmap_opacity 指定热图中使用的颜色的不透明度。将 heatmap_opacity 的值指定为介于 0 和 1 之间的数字,其中 0 表示无颜色,1 表示完全不透明。


heatmap_opacity: 0.5

地图参数

本部分中描述的大多数参数都对应于柱形图的可视化图表编辑器中的映射部分中的选项。

map_tile_provider

map_tile_provider 参数适用于所有地图,可用于更改背景地图的类型,并指定是否显示地图标签(例如城市和街道)。

  • light:一种浅色调的精细地图,旨在提供地理背景信息,同时突出显示您的数据
  • light_no_labels:与 light 相同,但地图会省略标签,例如城市名称
  • dark:一种精细的深色地图,旨在提供地理位置背景信息,同时突出显示您的数据
  • dark_no_labels:与 dark 相同,但地图会省略标签,例如城市名称
  • satellite_streets:显示全球卫星和航拍图像的地图
  • satellite:与 satellite_streets 相同,但地图会省略标签,例如城市名称
  • streets:强调道路和公交网络清晰样式的通用地图
  • outdoors:专为远足、骑行和其他户外用途量身打造的通用地图
  • traffic_day:浅色地图,突出显示公交网络和道路,包括当前的交通信息
  • traffic_night:深色地图,突出显示公交网络和道路,包括当前路况信息

map_tile_provider: light | light_no_labels | dark | dark_no_labels | satellite_streets |
                    satellite | streets | outdoors | traffic_day | traffic_night

map_position

您可以使用 map_position 参数设置可见地图的中心点和缩放级别。您可以通过以下两种方式指定此位置:

  • fit_data:自动居中并缩放地图,以便显示查询的所有数据点
  • custom:可让您使用 map_latitude、map_longitude 和 map_zoom 参数手动指定纬度、经度和缩放级别

map_position: fit_data | custom

map_latitude

map_latitude 参数用于指定 map_position 设置为 custom 的地图元素的纬度。


map_latitude: -5.804047131379801

map_longitude

map_longitude 参数用于指定将 map_position 设置为 custom 的地图元素的经度。


 map_longitude: 113.34732055664064

map_zoom

借助 map_zoom 参数,您可以为 map_position 设置为 custom 的地图元素指定缩放级别。数值越大,缩放级别越近。


map_zoom: 10

map_scale_indicator

map_scale_indicator 参数的默认值为 'off',可用于指定是否显示地图比例尺,以及设置显示的单位类型。


map_scale_indicator: 'off' | metric | imperial | metric_imperial

map_pannable

map_pannable 参数用于指定用户是否可以通过拖动地图来重新定位地图。此选项默认处于启用状态。


map_pannable: true | false

map_zoomable

map_zoomable 参数用于指定用户是否可以放大和缩小地图元素。此选项默认处于启用状态。


map_zoomable: true | false

show_view_names

show_view_names 参数用于指定是否在地图提示中显示视图名称以及字段名称,这些提示会在用户点击地图数据点时显示。


show_view_names: true | false

show_legend

指定是否应在可视化图表的右下角显示地图图例。如果您已向可视化图表添加指标,图例会显示您使用的色阶。

指定以下绘图选项后,即可使用 show_legend 参数:


show_legend: true | false

show_region_field

对于基于地图图层或邮政编码的地图,show_region_field 参数会在地图的提示中显示相应信息。用户可以点击地图上的某个点来查看相应区域的名称。


show_region_field: true | false

draw_map_labels_above_data

对于地图图层地图或基于邮政编码维度的地图,您可以使用 draw_map_labels_above_data 参数在热图上方或下方显示地图标签。如果热力图不透明度值较高,这一点尤为重要。如果热图是不透明的,则标签不会显示,除非它们显示在数据上方。


draw_map_labels_above_data: true | false

点参数

如果将 map_plot_mode 设置为 automagic_heatmap,则无法为地图设置点选项。

map_marker_type

对于基于位置维度且 map_plot_mode 设置为 points、lines 或 areas 的地图,map_marker_type 参数用于定义地图元素上显示的点类型。map_marker_type 参数接受以下值:

  • circle
  • icon
  • circle_and_icon
  • none

您为 map_marker_type 指定的值会影响可用于设置地图上显示的点格式的参数。

map_marker_icon_name

如果 map_marker_type 设置为 icon 或 circle_and_icon,您可以使用 map_marker_icon_name 参数设置要在所有地图标记上显示的图标类型。


map_marker_icon_name: default | airplane | ambulance | anchor | beaker | bell | bolt | briefcase |
                      building | camera | car | checkmark | coffee | comment | envelope | file |
                      gamepad | gavel | gift | glass | headphones | heart | house | key | leaf |
                      microphone | music | person | phone | restaurant | school | shopping_cart |
                      star | suitcase | taxi | tree | trophy | truck | university | wrench

map_marker_radius_mode

对于将 map_marker_type 设置为 circle 或 circle_and_icon 的地图,您可以使用 map_marker_radius_mode 参数根据以下选项设置圆圈的大小:

  • proportional_value:此选项会根据您添加到查询中的指标调整圆圈的相对大小。您可以将 map_marker_radius_min 和 map_marker_radius_max 参数与此选项搭配使用,以设置圆形的最小半径和最大半径。您还可以使用 map_marker_proportional_scale_type 参数来设置是使用线性还是对数比例来调整圆圈的大小。
  • equal_to_value:此设置可将圆圈的半径调整为基础查询中的实际指标值。
  • fixed:此选项可让您使用 map_marker_radius_fixed 参数为所有地图标记设置固定半径。默认值为 500。

map_marker_radius_mode: proportional_value | equal_to_value | fixed

map_marker_radius_fixed

当 map_marker_radius_mode 设置为 fixed 且 map_marker_type 设置为 circle 或 circle_and_icon 时,您可以使用 map_marker_radius_fixed 参数设置适用于所有地图标记的固定半径。


map_marker_type: circle
map_marker_radius_mode: fixed
map_marker_radius_fixed: 60

map_marker_radius_min

对于将 map_marker_type 设置为 circle 或 circle_and_icon 且将 map_marker_radius_mode 设置为 proportional_value 的地图,您可以使用 map_marker_radius_min 参数来定义圆的最小半径。


map_marker_type: circle
map_marker_radius_mode: proportional_value
map_marker_radius_min: 5

map_marker_radius_max

对于将 map_marker_type 设置为 circle 或 circle_and_icon 且将 map_marker_radius_mode 设置为 proportional_value 的地图,您可以使用 map_marker_radius_max 参数来定义圆的最大半径。


map_marker_type: circle
map_marker_radius_mode: proportional_value
map_marker_radius_max: 50

map_marker_proportional_scale_type

对于 map_marker_type 设置为 circle 或 circle_and_icon 且 map_marker_radius_mode 设置为 proportional_value 的地图,您可以使用 map_marker_proportional_scale_type 参数将圆圈大小设置为基于线性或对数比例。此形参的值可以是 linear 或 log。


map_marker_radius_mode: proportional_value
map_marker_proportional_scale_type: linear | log

map_marker_units

对于将 map_marker_type 设置为 circle 或 circle_and_icon 的地图,您可以使用 map_marker_units 参数将圆半径所用的单位设置为 meters 或 pixels。


map_marker_units: meters | pixels

map_marker_color_mode

您可以使用 map_marker_color_mode 设置地图标记的颜色:

  • 如果 map_marker_color_mode 设置为 value,系统会根据基础查询的值动态为标记分配颜色。您可以使用值参数来配置此选项的图例中的颜色。
  • 如果 map_marker_color_mode 设置为 fixed,您可以使用 map_marker_color 参数为所有地图标记设置一种颜色。颜色值可以采用 RGB 十六进制字符串(如 2ca6cd)或 CSS 颜色名称(如 mediumblue)的格式。

map_marker_color

当 map_marker_color_mode 设置为 fixed 时,请设置要用于所有地图标记的单一颜色。


map_marker_color: [mediumblue]

值形参

当 map_marker_color_mode 设置为 value 时,您可以使用这些参数来配置将根据基础查询的值动态分配给标记的颜色;或者,对于 map_plot_mode 设置为 automagic_heatmap、lines 或 areas 的地图元素,您可以使用这些参数来配置颜色。

map_value_colors

您可以使用 map_value_colors 参数设置地图点的颜色,或者,如果您要根据某项指标进行颜色编码,则可以使用该参数定义要使用的颜色范围。您可以输入十六进制字符串列表(例如 #2ca6cd)或 CSS 颜色名称(例如 mediumblue)。您最先列出的颜色与最低值相关联。


map_value_colors: [green, mediumblue]

quantize_map_value_colors

如果设置为 true,quantize_map_value_colors 会将颜色比例从平滑渐变更改为仅包含您设置的特定颜色。此参数默认设置为 false。


quantize_map_value_colors: true | false

reverse_map_value_colors

如果设置为 true,reverse_map_value_colors 参数会切换图表中指示高值和低值的颜色,从而反转颜色渐变。


reverse_map_value_colors: true | false

map_value_scale_clamp_min

您可以使用 map_value_scale_clamp_min 参数设置颜色范围的最小值。这样一来,您就可以使用 map_value_colors 参数指定的最低颜色,为低于特定阈值(指定数值)的所有点设置颜色编码。默认情况下,图例中应用的最小值是查询中的最小值。


map_value_scale_clamp_min: 1000

map_value_scale_clamp_max

您可以使用 map_value_scale_clamp_max 参数设置颜色范围的最大值,这样一来,您就可以使用 map_value_colors 参数指定的最高颜色,为高于指定数值的所有点进行颜色编码。默认情况下,图例中应用的最大值是查询中的最大值。


map_value_scale_clamp_max: 50000