Skip to content

Commit

Permalink
[Maps] Update search docs to clarify how to disable global search, gl…
Browse files Browse the repository at this point in the history
…obal time filter, and global refresh for layers (#111625)

* [Maps] Update search docs to clarify how to disable global search, global time filter, and global refresh for layers

* clean up

* make timeslider icon smaller

* use more common headers

* clean up

* review feedback

* global time consistency

* remove links

Co-authored-by: Kibana Machine <[email protected]>
  • Loading branch information
nreese and kibanamachine authored Sep 16, 2021
1 parent d6bf274 commit 6579ade
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 23 deletions.
Binary file added docs/maps/images/timeslider_toggle_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/maps/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Customize each layer to highlight meaningful dimensions in your data. For exampl

[float]
=== Focus on only the data that’s important to you
Search across the layers in your map to focus in on just the data you want. Combine free text search with field-based search using the <<kuery-query,{kib} Query Language>>. Set the time filter to restrict layers by time. Draw a polygon on the map or use the shape from features to create spatial filters. Filter individual layers to compares facets.
Search across the layers in your map to focus on just the data you want. Combine free text search with field-based search using the <<kuery-query,{kib} Query Language>>. Set the time filter to restrict layers by time. Draw a polygon on the map or use the shape from features to create spatial filters. Filter individual layers to compares facets.


--
Expand Down
77 changes: 55 additions & 22 deletions docs/maps/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,72 @@
[[maps-search]]
== Search geographic data

Search across the layers in your map to focus in on just the data you want.
Search across the layers in your map to focus on just the data you want. Combine free text search with field-based search using the <<kuery-query,{kib} Query Language>>. Set the time filter to restrict layers by time.

Layers that request data from {es} are narrowed when you submit a <<kibana-concepts-searching-your-data, search request>>.
This image shows an example of global search and global time narrowing results.

[role="screenshot"]
image::maps/images/global_search_bar.png[global search and global time narrowing results]

Only layers requesting data from {es} are narrowed by global search and global time.
To add a layer that requests data from {es} to your map, click *Add layer*, then select one of the following:

* Documents

* Choropleth

* Clusters and grid

* Heat map

* Point to point

* Top hits per entity

* Tracks

[float]
[[maps-narrow-layer-by-global-search]]
==== Narrow layers by global search

Layers that request data from {es} are narrowed when you submit a <<kibana-concepts-searching-your-data, search>>.
Layers narrowed by semi-structured search and filters contain the filter icon image:maps/images/filter_icon.png[] next to the layer name in the legend.

Layers that request data from {es} using an <<index-patterns, index pattern>> with a configured time field are narrowed by the <<set-time-filter, global time filter>>.
These layers contain the clock icon image:maps/images/clock_icon.png[clock icon] next to the layer name in the legend. Use the time slider to quickly select time slices within the global time filter range.
Click previous and next buttons to advance the time slice backward or forward. Click play to animate your spatial temporal data.
To prevent the global search from applying to a layer, configure the following:

* In *Filtering*, clear the *Apply global search to layer data* checkbox to turn off global search for the layer source.

You can create a layer that requests data from {es} from the following:
* In *Term joins*, clear the *Apply global search to join* checkbox to turn off global search for the <<terms-join, term join>>.

* <<vector-layer>> with:
[float]
[[maps-narrow-layer-by-global-time]]
==== Narrow layers by global time

** Documents
Layers that request data from {es} using an <<index-patterns, index pattern>> with a configured time field are narrowed by the <<set-time-filter, global time>>.
These layers contain the clock icon image:maps/images/clock_icon.png[clock icon] next to the layer name in the legend.

** Clusters and grid
Use the time slider to quickly select time slices within the global time range:

** Point to point
. Click image:maps/images/timeslider_toggle_icon.png[timeslider icon] to open the time slider.
. Click previous and next buttons to advance the time slice backward or forward.
. Click play to animate your spatial temporal data.

** <<terms-join>>
To prevent the global time filter from applying to a layer, configure the following:

** Top hits per entity
* In *Filtering*, clear the *Apply global time to layer data* checkbox to turn off the global time for the layer source.

** Tracks
* In *Term joins*, clear the *Apply global time to join* checkbox to turn off the global time for the <<terms-join, term join>>.

* <<heatmap-layer>>
[float]
[[maps-refresh-layer]]
==== Refresh layer data

Layers that request data from {es} re-fetch data when <<set-time-filter, automatic refresh>> fires and when you click *Refresh*.

To prevent refreshing layer data, configure the following:

* In *Filtering*, clear the *Apply global refresh to layer data* checkbox to turn off refresh for the layer source.

[role="screenshot"]
image::maps/images/global_search_bar.png[]

[role="xpack"]
[[maps-create-filter-from-map]]
Expand Down Expand Up @@ -114,13 +151,9 @@ The most common cause for empty layers are searches for a field that exists in o

[float]
[[maps-disable-search-for-layer]]
==== Disable search for a layer

You can prevent the search bar from applying search context to a layer by configuring the following:

* In *Filtering*, clear the *Apply global filter to layer data* checkbox to turn off the global search context for the layer source.
==== Disable global search for a layer

* In *Term joins*, clear the *Apply global filter to join* checkbox to turn off the global search context for the <<terms-join, term join>>.
One strategy for eliminating unintentional empty layers from a cross index search is to <<maps-narrow-layer-by-global-search, disable global search for a layer>>.

[float]
[[maps-add-index-search]]
Expand Down

0 comments on commit 6579ade

Please sign in to comment.