Map parameters for LookML dashboards

This page describes the parameters for creating and editing LookML dashboard elements oftype: looker_map with LookML dashboard parameters in adashboard.lkml file.

For information about building an interactive map chart through the Looker UI, see theMap chart options documentation page. For information about the types of fields required to build an interactive map chart, see theQuery parameters section.

Example usage

AnN indicates that a numeric value is required. Single quotation marks indicate descriptive text and should not be included in live code.

## BASIC PARAMETERSname: element_nametitle: 'Element Title'type: looker_mapheight: Nwidth: Ntop: Nleft: Nrow: Ncol: Nrefresh: N (seconds | minutes | hours | days)note:  text: 'note text'  state: collapsed | expanded  display: above | below | hover## QUERY PARAMETERSmodel: model_nameexplore: explore_namefields: [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: Ncolumn_limit: Nfilters:  view_name.field_name: 'looker filter expression'listen:  dashboard_filter_name: view_name.field_namequery_timezone: 'specific timezone' | user_timezone## PLOT PARAMETERSmap_plot_mode: points | automagic_heatmap | lines | areasheatmap_gridlines: true | falseheatmap_gridlines_empty: true | falseheatmap_opacity: 'number between 0 and 1'## MAP PARAMETERSmap_tile_provider: light | light_no_labels | dark | dark_no_labels | satellite_streets |                    satellite | streets | outdoors | traffic_day | traffic_nightmap_position: fit_data | custommap_latitude: 'latitude value'map_longitude: 'longitude value'map_zoom: Nmap_scale_indicator: 'off' | metric | imperial | metric_imperialmap_pannable: true | falsemap_zoomable: true | falseshow_view_names: true | falseshow_legend: true | falseshow_region_field: true | falsedraw_map_labels_above_data: true | false## POINT PARAMETERSmap_marker_type: circle | icon | circle_and_icon | nonemap_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 | wrenchmap_marker_radius_mode: proportional_value | equal_to_value | fixedmap_marker_radius_fixed: Nmap_marker_radius_min: Nmap_marker_radius_max: Nmap_marker_proportional_scale_type: linear | logmap_marker_units: meters | pixelsmap_marker_color_mode: value | fixedmap_marker_color: ['color value']## VALUE PARAMETERSmap_value_colors: ['one or more color values']quantize_map_value_colors: true | falsereverse_map_value_colors: true | falsemap_value_scale_clamp_min: Nmap_value_scale_clamp_max: N

Parameter definitions

Parameter NameDescription
Basic Parameters
name (for elements)Creates an element
title (for elements)Changes the way an element name appears to users
type (for elements)Determines the type of visualization to be used in the element
height (for elements)Defines the height of an element in units oftile_size forlayout: tile andlayout: static dashboards
width (for elements)Defines the width of an element in units oftile_size forlayout: tile andlayout: static dashboards
topDefines the top-to-bottom position of an element in units oftile_size forlayout: static dashboards
leftDefines the left-to-right position of an element in units oftile_size forlayout: static dashboards
rowDefines the top-to-bottom position of an element in units of rows forlayout: newspaper dashboards
colDefines the left-to-right position of an element in units of columns forlayout: newspaper dashboards
refresh (for elements)Sets the interval at which the element will automatically refresh
noteStarts a section of LookML to define a note for an element. This parameter has subparameterstext,state, anddisplay.
Query Parameters
modelDefines the model to be used for the element's query
explore (for elements)Defines the Explore to be used for the element's query
fieldsDefines the fields to be used for the element's query. This can be used in place ofdimensions andmeasures.
dimensionsDefines the dimensions to be used for the element's query
measuresDefines the measures to be used for the element's query
sortsDefines the sorts to be used for the element's query
pivotsDefines the dimensions that should be pivoted to be used for the element's query
limitDefines the row limit to be used for the element's query
column_limitDefines the column limit to be used for the element's query
filters (for elements)Defines the filters thatcannot be changed for the element's query
listenDefines the filters thatcan be changed for the element's query, iffilters (for dashboard) have been created
query_timezoneDefines thetime zone that should be used when the query is run
Plot Parameters
map_plot_modeDefines how your location data is plotted on an element oftype: looker_map
heatmap_gridlinesAdds a border around each of the gridlines used for a heatmap element
heatmap_gridlines_emptyFor heatmaps withheatmap_gridlines set totrue, displays an outline around map regions that have no associated data
heatmap_opacityDefines the opacity of the colors used in a heatmap
Map Parameters
map_tile_providerDefines the type of background map and whether map labels are displayed
map_positionDefines the center point and zoom level of the visible map
map_latitudeDefines the latitude for a map withmap_position set tocustom
map_longitudeDefines the longitude for a map withmap_position set tocustom
map_zoomDefines the zoom for a map withmap_position set tocustom
map_scale_indicatorSets whether a map scale will be shown and the type of units displayed
map_pannableSets whether users can reposition the map by dragging it
map_zoomable Sets whether users can zoom in and out of the map
show_view_names Sets whether to show the view name along with the field name in map tooltips
show_legendSets whether a map legend should be displayed in the lower right of the visualization
show_region_fieldSets whether to display the region information in the tooltip of the map
draw_map_labels_above_dataDisplays the map's labels above or below the heatmap
Point Parameters
map_marker_typeSpecifies the type of point displayed on the map, for elements withmap_plot_mode set topoints,lines, orareas
map_marker_icon_nameSpecifies the type of icon to display on all map markers, for elements withmap_marker_type set toicon orcircle_and_icon
map_marker_radius_modeSets the way the circles are sized, for elements withmap_marker_type set tocircle orcircle_and_icon
map_marker_radius_fixedSets a fixed radius to apply to all map markers, for elements withmap_marker_type set tocircle orcircle_and_icon andmap_marker_radius_mode set tofixed
map_marker_radius_minSets the minimum radius for circles, for elements withmap_marker_radius_mode set toproportional_value
map_marker_radius_maxSets the maximum radius for circles, for elements withmap_marker_radius_mode set toproportional_value
map_marker_proportional_scale_typeSpecifies whether the circle size is based on a linear or logarithmic scale, for elements withmap_marker_type set tocircle orcircle_and_icon andmap_marker_radius_mode set toproportional_value
map_marker_unitsSets the units used for the radius of a circle tometers orpixels, for elements withmap_marker_type set tocircle orcircle_and_icon
map_marker_color_modeSpecifies whether the color of the map markers is fixed or the colors are dynamically assigned to markers based on the values of the underlying query
map_marker_colorSpecifies a single color to apply to all map markers, for elements withmap_marker_color_mode set tofixed
Value Parameters
map_value_colorsSpecifies the colors of map points, or defines the range of colors to be used if you are color coding according to a measure
quantize_map_value_colorsChanges the color scale from a smooth gradient to only the specific colors you have set
reverse_map_value_colorsSwitches the colors that indicate high and low values on the chart, reversing the color gradient
map_value_scale_clamp_minSets the minimum value of the color range
map_value_scale_clamp_maxSets the maximum value of the color range

Basic parameters

When defining a LookML dashboard element, you must specify values for at least thename andtype basic parameters. Other basic parameters, such astitle,height, andwidth, affect the appearance and position of an element on a dashboard.

name

This section refers to thename parameter that is part of adashboard element.

name can also be used as part of a dashboard filter, described on theDashboard parameters documentation page.

Eachname declaration creates a new dashboard element and assigns it a name. Element names must be unique. Names are sometimes referenced in theelements parameter when you're usinglayout: grid dashboards.

- name: orders_by_date

title

This section refers to thetitle parameter that is part of adashboard element.

title can also be used as part of a dashboard, described on theDashboard parameters documentation page.

title can also be used as part of a dashboard filter, described on theDashboard parameters documentation page.

Thetitle parameter lets you change how an element's name will appear to users. If unspecified, the title defaults to the elementname.

Consider this example:

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

If you used this format, instead of the element appearing asSales Overview, it would appear as1) Sales Overview.

type

This section refers to thetype parameter that is part of adashboard element.

type can also be used as part of a dashboard filter, described on theDashboard parameters documentation page.

type can also be used as part of a join, described on thetype (for joins) parameter documentation page.

type can also be used as part of a dimension, described on theDimension, filter, and parameter types documentation page.

type can also be used as part of a measure, described on theMeasure types documentation page.

Thetype parameter determines the type of visualization to be used in the element.

- 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

See thetype (for LookML dashboards) documentation page for an overview of the different types of LookML dashboard elements.

height

This section refers to theheight parameter that is part of adashboard element.

height can also be used as part of a dashboard row, described on theDashboard parameters documentation page.

For dashboards withtile orstatic layouts

Theheight parameter defines the height of an element, in units oftile_size (which is defined in pixels), forlayout: tile andlayout: static dashboards.

For example, the following code specifiestile_size: 100 andheight: 4, making theorders_by_date element 400 pixels in height.

- dashboard: sales_overview  tile_size: 100  ...  elements:  - name: orders_by_date    height: 4    ...

For dashboards withnewspaper layout

Theheight parameter defines the height of an element, in units ofrow, forlayout: newspaper dashboards.

A dashboard with newspaper layout defaults to an element height of 6 rows, or about 300 pixels. The minimum height is 1 row for dashboards with apreferred viewer parameter set todashboards-next. The minimum height is 2 rows for dashboards with apreferred viewer parameter set todashboards.

For example, the following code sets an element to be 12 rows tall, or twice as tall as other elements that are set to the default:

- dashboard: sales_overview  layout: newspaper  ...  elements:  - name: orders_by_date    height: 12    ...

width

This section refers to thewidth parameter that is part of adashboard element.

width can also be used as part of a dashboard, described on theDashboard parameters documentation page.

Thewidth parameter defines the width of an element, in units oftile_size, forlayout: tile andlayout: static dashboards.

For example, the following code specifiestile_size: 100 andwidth: 4, making theorders_by_date element 400 pixels in width.

- dashboard: sales_overview  tile_size: 100  ...  elements:  - name: orders_by_date    width: 4    ...

Thewidth parameter defines the width of an element, in units of columns, forlayout: newspaper dashboards.

A dashboard with newspaper layout defaults to a width of 24 columns.

For example, the following code sets the element to half the width of the dashboard:

- dashboard: sales_overview  layout: newspaper  ...  elements:  - name: orders_by_date    width: 12    ...

top

Thetop parameter defines the top-to-bottom position of an element, in units oftile_size, forlayout: static dashboards.

For example, the following code specifiestile_size: 100 andtop: 4, positioning the top edge of theorders_by_date element 400 pixels from the top of the dashboard.

- dashboard: sales_overview  tile_size: 100  ...  elements:  - name: orders_by_date    top: 4    ...

left

Theleft parameter defines the left-to-right position of an element, in units oftile_size, forlayout: static dashboards.

For example, the following code specifiestile_size: 100 andleft: 4, positioning the left edge of theorders_by_date element 400 pixels from the left side of the dashboard.

- dashboard: sales_overview  tile_size: 100  ...  elements:  - name: orders_by_date    left: 4    ...

row

Forlayout: newspaper dashboards, therow parameter defines the row that the top edge of an element is placed on.

A dashboard begins with row 0 at the top of the dashboard. A dashboard with newspaper layout defaults to an element height of 6 rows, meaning the dashboard elements at the top of a dashboard (row: 0) would default to taking up rows 0-5.

Each row is 50 pixels tall, which means the default element height of 6 rows is 300 pixels.

For example, the following code sets an element to be set on the second row of elements in the dashboard, assuming elements are set at the default height:

- dashboard: sales_overview  layout: newspaper  ...  elements:  - name: orders_by_date    row: 6    ...

col

Forlayout: newspaper dashboards, thecol parameter defines the column that the left edge of the element is placed on.

Dashboards are divided into 24 columns. A dashboard begins with column 0 at the left of the dashboard. A dashboard with newspaper layout defaults to an element width of 8 columns, meaning the dashboard elements at the left of a dashboard (col: 0) would default to taking up columns 0-7.

For example, the following code sets an element to be set in the third column of elements in the dashboard:

- dashboard: sales_overview  layout: newspaper  ...  elements:  - name: orders_by_date    col: 16    ...

refresh

This section refers to therefresh parameter that is part of adashboard element.

refresh can also be used as part of a dashboard, described on theDashboard parameters documentation page.

Therefresh parameter allows an element to reload automatically on some periodic basis, thereby retrieving fresh data. This is often helpful in settings where a dashboard is constantly displayed, such as on an office TV. Note that the dashboard must be open in a browser window for this parameter to have an effect. This setting does not run in the background to "pre-warm" the dashboard cache.

The refresh rate can be any number (without decimals) of seconds, minutes, hours, or days. For example:

- name: orders_by_date  refresh: 2 hours

Use caution when setting short refresh intervals. If the query behind the element is resource-intensive, certain elements may strain your database more than desired.

note

You can add descriptive notes to elements like this:

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

note has the subparameterstext,state, anddisplay.

text

Thetext subparameter specifies the text displayed in the note. The text can belocalized.

state

Thestate subparameter determines whether the note will becollapsed orexpanded if it is too big to fit on a single row within the element's width. If you choosecollapsed and the note is too long, the note will end in a clickable ellipsis (...) that can be used to read the full note.

display

Thedisplay subparameter determines where the note is displayed on an element.above places the note at the top of an element,below places it at the bottom of an element, andhover requires the user to hover their mouse over the element to see the note.

Query parameters

When defining a LookML dashboard element, you must specify values for at least themodel andexplore query parameters.

For LookML dashboard elements oftype: looker_map, you must also specify at least one geographic field as the value of either thedimensions or thefields parameter. A geographic field can be one of the following:

  • A dimension based on latitude and longitude data, defined in LookML as a dimension oftype: location.
  • A dimension with a map layer assigned to it. LookML developers can add abuilt-in map layer or acustom map layer to a measure using themap_layer_name parameter.
  • A zip code dimension. Zip code regions are based on the 2010 zip code tabulation areas (ZCTAs). If you are visualizing zip codes, there may not be a one-to-one correspondence between zip codes and the ZCTAs used for map visualizations, so it's possible that not all points will be visualized in the map.

You can use the other query parameters to control the way data is displayed in a dashboard element. For more information on the requirements for building an interactive map chart with the Looker UI, see theBuilding an interactive map chart section of theMap chart options documentation page.

model

Themodel parameter defines the model to use for the element query. If unspecified, it will default to the model where the dashboard resides.

- name: orders_by_date  model: ecommerce

Themodel parameter acceptsLookML constants. You can define a constant in themanifest file for your project, then use the syntax"@{constant_name}" to set the constant as the value formodel. Using a constant lets you define the name of a model in one place, which is particularly useful if you're updating the name of a model that is used by multiple dashboard elements.

For more information and an example of using constants with LookML dashboards, see theconstant parameter documentation page.

explore

This section refers to theexplore parameter that is part of adashboard element.

explore can also be used as part of a model, described on theexplore parameter documentation page.

explore can also be used as part of a dashboard filter, described on theDashboard parameters documentation page.

Theexplore parameter defines the Explore to use for the element query.

- name: orders_by_date  explore: order

Theexplore parameter acceptsLookML constants. You can define a constant in themanifest file for your project, then use the syntax"@{constant_name}" to set the constant as the value forexplore. Using a constant lets you define the name of an Explore in one place, which is particularly useful if you're updating the name of an Explore that is used by multiple dashboard elements.

For more information and an example of using constants with LookML dashboards, see theconstant parameter documentation page.

fields

Thefields parameter defines the fields to use for the element query. Use the syntaxview_name.dimension_name to specify the fields.

## 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]

If you use thefields parameter, you do not need to use thedimensions andmeasures parameters.

dimensions

Thedimensions parameter defines the dimension or dimensions to use for the element query. Use the syntaxview_name.dimension_name to specify the dimension. Don't includedimensions if the query doesn't have any.

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

Themeasures parameter defines the measure or measures to use for the element query. Use the syntaxview_name.measure_name to specify the measure. Don't includemeasures if the query doesn't have any.

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

sorts

Thesorts parameter defines the sorts to be used for the element query. The primary sort is listed first, then the secondary sort, and so on. Use the syntaxview_name.field_name to specify the dimension or measure. Don't includesorts if you want to use Looker's default sort order. Descending sorts are suffixed withdesc; ascending sorts don't need a suffix.

## single sort example- name: orders_by_date  sorts: order.order_date desc## multiple sort example- name: orders_by_date  sorts: [order.order_date desc, customer.name]

pivots

Thepivots parameter defines the dimensions that should be pivoted for the element query. Use the syntaxview_name.dimension_name to specify the dimension. Don't includepivots if the query doesn't have any.

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

limit

Thelimit parameter defines the row limit that should be used for the element query. The limit applies to the number of rowsbefore any pivots are applied.

- name: orders_by_date  limit: 100

column_limit

Thecolumn_limit parameter defines the column limit that should be used for the element query. The limit applies to the number of columnsafter any pivots are applied.

- name: orders_by_date  column_limit: 100

filters

This section refers to thefilters parameter that is part of adashboard element.

filters can also be used as part of a dashboard, described on theDashboard parameters documentation page.

filters can also be used as part of a measure, described on thefilters parameter documentation page.

Thefilters parameter defines the non-changeable filters that should be used for the element's query. If you would like filters that a usercan change in the dashboard, you should set up the filters usingfilters for dashboards, then apply them to the elements usinglisten.

The syntax forfilters is:

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

Each filter can accept a Lookerfilter expression or a value constant. You can also use the_localization or_user_attributes Liquid variables in the filter expression for flexible filter values.

listen

Dashboard filters let viewers interactively refine the data that is shown in dashboard elements. Define dashboard filters with thefilters parameter for LookML dashboards. Then, use thelisten parameter to link dashboard elements to the dashboard filter.

The syntax forlisten is as follows:

- 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

Add thelisten parameter to an element, and then provide the name of the filter followed by a colon and a reference to the field to which the filter should apply, using theview_name.field_name syntax. For example, you might create a filter calledDate that requires a user to enter a date into the filter field in the UI. You could then apply the value that the user enters to theorders_by_date element like this:

- dashboard: sales_overview  ...  filters:  - name: date    type: date_filter  elements: - name: orders_by_date    listen:      date: order.order_date    ...

For additional examples of using thefilters parameter and thelisten parameter to apply dashboard filters to individual dashboard elements, seeBuilding LookML dashboards.

query_timezone

Thequery_timezone parameter specifies the time zone in which the query will be run. The time zone options are shown on theValues fortimezone documentation page. If you want the query to run using the viewer's time zone, you can assign the value asuser_timezone.

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

Plot parameters

The parameters described in this section correspond to the options in thePlot section of the visualization editor for map charts.

The parameters you can use with an element oftype: looker_map depend on whether your query includes a dimension oftype: location or has amap layer associated with it.

map_plot_mode

Themap_plot_mode parameter defines the way your data is plotted on atype: looker_map element that is based on a dimension oftype: location. This parameter is not available for maps based on a dimension with an associated map layer or for zip code dimensions. Themap_plot_mode parameter accepts the following values:

points

Settingmap_plot_mode topoints plots each row in the underlying data table as a discrete point on the map.

A dimension oftype: location on its own places points of uniform size and color on the map. Adding a measure to the query lets the points be scaled by color or size using themap_marker_radius_mode andmap_marker_color_mode parameters.

automagic_heatmap

Settingmap_plot_mode toautomagic_heatmap displays the data in the underlying query as a heatmap grid. It works by dividing the visible map into equal squares and then calculating which values in your data fit into each square. The squares are colored according to a measure that you choose. Zooming this map in or out will prompt Looker to re-calculate the grid, so that the granularity is appropriate to the zoom level.

Your query must include both a dimension oftype: location and a measure for this plot type to work correctly.

lines

Settingmap_plot_mode tolines takes two dimensions oftype: location from your query and connects them together in the visualization. Adding a measure to your query lets you add color scale to the lines.

areas

Settingmap_plot_mode toareas takes one dimension oftype: location and connects all the points in the order you've sorted them. This forms boundaries of an area on the map element. Adding a measure to the query lets you format the size and color of the individual location points that make up the boundaries of the area.

heatmap_gridlines

For heatmap elements, settingheatmap_gridlines totrue adds a border around each of the gridlines used for the heatmap. This parameter is available when you're plotting a dimension oftype: location withmap_plot_mode set toautomagic_heatmap, or when you're plotting a zip code dimension or a dimension with an associated map layer.

heatmap_gridlines: true | false

heatmap_gridlines_empty

Whenheatmap_gridlines is set totrue for heatmap elements, settingheatmap_gridlines_empty totrue displays an outline around the map regions that have no associated data.

heatmap_gridlines_empty: true | false

heatmap_opacity

For heatmap elements, you can useheatmap_opacity to specify the opacity of the colors used in the heatmap. Specify a number between 0 and 1 as the value forheatmap_opacity, where0 means no color and1 means totally opaque.

heatmap_opacity: 0.5

Map parameters

Most of the parameters described in this section correspond to the options in theMap section of the visualization editor for column charts.

map_tile_provider

Available for all maps, themap_tile_provider parameter lets you change the type of background map and specify whether map labels (like cities and streets) are displayed.

  • light: Subtle, light-colored map designed to provide geographic context while highlighting your data
  • light_no_labels: Same aslight, except the map omits labels such as city names
  • dark: Subtle, dark-colored map designed to provide geographic context while highlighting your data
  • dark_no_labels: Same asdark, except the map omits labels such as city names
  • satellite_streets: Map displaying global satellite and aerial imagery
  • satellite: Same assatellite_streets, except the map omits labels such as city names
  • streets: General-purpose map that emphasizes legible styling of road and transit networks
  • outdoors: General-purpose map tailored to hiking, biking, and other outdoor uses
  • traffic_day: Light-colored map emphasizing transit networks and roads, including current traffic information
  • traffic_night: Dark-colored map emphasizing transit networks and roads, including current traffic information
map_tile_provider: light | light_no_labels | dark | dark_no_labels | satellite_streets |                    satellite | streets | outdoors | traffic_day | traffic_night

map_position

You can use themap_position parameter to set the center point and zoom level of the visible map. There are two options for specifying this position:

  • fit_data: Automatically centers and zooms the map such that all the data points of your query are visible
  • custom: Lets you manually specify latitude, longitude, and zoom level using themap_latitude,map_longitude, andmap_zoom parameters
map_position: fit_data | custom

map_latitude

Themap_latitude parameter specifies the latitude for a map element withmap_position set tocustom.

map_latitude: -5.804047131379801

map_longitude

Themap_longitude parameter specifies the longitude for a map element withmap_position set tocustom.

 map_longitude: 113.34732055664064

map_zoom

Themap_zoom parameter lets you specify the zoom level for a map element withmap_position set tocustom. Higher numbers create a closer zoom level.

map_zoom: 10

map_scale_indicator

Set to'off' by default, themap_scale_indicator parameter lets you specify whether a map scale is shown and set the types of units that are displayed.

map_scale_indicator: 'off' | metric | imperial | metric_imperial

map_pannable

Themap_pannable parameter specifies whether users can reposition the map by dragging it. This option is enabled by default.

map_pannable: true | false

map_zoomable

Themap_zoomable parameter specifies whether users can zoom in and out of the map element. This option is enabled by default.

map_zoomable: true | false

show_view_names

Theshow_view_names parameter specifies whether to show the view name along with the field name in map tooltips, which are displayed when users click on map data points.

show_view_names: true | false

show_legend

Specify whether a map legend should be displayed in the lower right of the visualization. The legend shows the color scale you are using, if you've added a measure to your visualization.

Theshow_legend parameter is available when the followingplot options have been specified:

show_legend: true | false

show_region_field

For maps based on a map layer or zip code, theshow_region_field parameter displays the information in the tooltip of the map. Users can click on a point on the map to see the name of the region.

show_region_field: true | false

draw_map_labels_above_data

For map layer maps or maps based on a zip code dimension, you can use thedraw_map_labels_above_data parameter to display the map's labels above or below the heatmap. This is especially significant with higher heatmapopacity values. If your heatmap is opaque, the labels will not show unless they are displayed above the data.

draw_map_labels_above_data: true | false

Point parameters

Point options are not available for maps withmap_plot_mode set toautomagic_heatmap.

map_marker_type

For maps based on a location dimension and withmap_plot_mode set topoints,lines, orareas, themap_marker_type parameter defines the type of point displayed on the map element. Themap_marker_type parameter accepts the following values:

  • circle
  • icon
  • circle_and_icon
  • none

The value you specify formap_marker_type impacts the parameters that are available for formatting the points displayed on the map.

map_marker_icon_name

Ifmap_marker_type is set toicon orcircle_and_icon, you can use themap_marker_icon_name parameter to set the type of icon to display on all map markers.

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

For maps withmap_marker_type set tocircle orcircle_and_icon, you can use themap_marker_radius_mode parameter to set the sizes of the circles according to the following options:

  • proportional_value: This option adjusts the relative size of the circles according to the measures you've added to your query. You can use themap_marker_radius_min andmap_marker_radius_max parameters with this option to set a minimum radius and a maximum radius for the circles. You can also use themap_marker_proportional_scale_type parameter to set whether a linear or a logarithmic scale is used to size the circles.
  • equal_to_value: This setting adjust the radius of the circles to the actual measure values in your underlying query.
  • fixed: This option lets you set a fixed radius to apply to all map markers using themap_marker_radius_fixed parameter. The default value is500.
map_marker_radius_mode: proportional_value | equal_to_value | fixed

map_marker_radius_fixed

Whenmap_marker_radius_mode is set tofixed andmap_marker_type is set tocircle orcircle_and_icon, you can use themap_marker_radius_fixed parameter to set a fixed radius that applies to all map markers.

map_marker_type: circlemap_marker_radius_mode: fixedmap_marker_radius_fixed: 60

map_marker_radius_min

For maps withmap_marker_type set tocircle orcircle_and_icon andmap_marker_radius_mode set toproportional_value, you can use themap_marker_radius_min parameter to define the minimum radius for a circle.

map_marker_type: circlemap_marker_radius_mode: proportional_valuemap_marker_radius_min: 5

map_marker_radius_max

For maps withmap_marker_type set tocircle orcircle_and_icon andmap_marker_radius_mode set toproportional_value, you can use themap_marker_radius_max parameter to define the maximum radius for a circle.

map_marker_type: circlemap_marker_radius_mode: proportional_valuemap_marker_radius_max: 50

map_marker_proportional_scale_type

For maps withmap_marker_type set tocircle orcircle_and_icon andmap_marker_radius_mode set toproportional_value, you can use themap_marker_proportional_scale_type parameter to set the circle size to be based on either a linear or a logarithmic scale. This parameter's value can be eitherlinear orlog.

map_marker_radius_mode: proportional_valuemap_marker_proportional_scale_type: linear | log

map_marker_units

For maps withmap_marker_type set tocircle orcircle_and_icon, you can use themap_marker_units parameter to set the units used for the radius of a circle tometers orpixels.

map_marker_units: meters | pixels

map_marker_color_mode

You can use themap_marker_color_mode to set the colors of the map markers:

  • Ifmap_marker_color_mode is set tovalue, colors are dynamically assigned to markers based on the values of your underlying query. You can usevalue parameters to configure the colors in the legend for this option.
  • Ifmap_marker_color_mode is set tofixed, you can use themap_marker_color parameter to set a single color to use for all map markers. The color value can be formatted as an RGB hex string, like2ca6cd, or as aCSS color name likemediumblue.

map_marker_color

Whenmap_marker_color_mode is set tofixed, set a single color to use for all map markers.

map_marker_color: [mediumblue]

Value parameters

You can use these parameters to configure the colors that will be dynamically assigned to markers based on the values of your underlying query whenmap_marker_color_mode is set tovalue, or for map elements withmap_plot_mode set toautomagic_heatmap,lines, orareas.

map_value_colors

You can use themap_value_colors parameter to set the color of map points or, if you are color coding according to a measure, to define the range of colors to be used. You can input a list of hex strings, such as#2ca6cd, orCSS color names, such asmediumblue. The colors you list first are associated with the lowest values.

map_value_colors: [green, mediumblue]

quantize_map_value_colors

When set totrue,quantize_map_value_colors changes the color scale from a smooth gradient to only the specific colors you have set. This parameter is set tofalse by default.

quantize_map_value_colors: true | false

reverse_map_value_colors

When set totrue, thereverse_map_value_colors parameter switches the colors that indicate high and low values on the chart, reversing the color gradient.

reverse_map_value_colors: true | false

map_value_scale_clamp_min

You can use themap_value_scale_clamp_min parameter to set the minimum value for the color range. This lets you color code all points below a certain threshold (the number specified) with the lowest color specified with themap_value_colors parameter. By default, the minimum value applied on the legend is the minimum value from your query.

map_value_scale_clamp_min: 1000

map_value_scale_clamp_max

You can use themap_value_scale_clamp_max parameter to set the maximum value for the color range, which lets you color code all points above the number specified with the highest color specified with themap_value_colors parameter. By default, the maximum value applied on the legend is the maximum value from your query.

map_value_scale_clamp_max: 50000

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-18 UTC.