[skip-ci][Maps] Add tooltip documenation (#48171) (#48805)

* [skip-ci][Maps] Add tooltip documenation

* mention field formatters

* gchap's updates
This commit is contained in:
Nathan Reese 2019-10-21 12:10:51 -06:00 committed by GitHub
parent 2b4a86e099
commit 6aca1693db
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 44 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 576 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 598 KiB

View file

@ -39,7 +39,7 @@ A spatial filter narrows search results to documents that either intersect with,
You can create spatial filters in two ways:
* Click the tool icon image:maps/images/tools_icon.png[], and then draw a polygon or bounding box on the map to define the spatial filter.
* Click *Filter by geometry* in a tooltip, and then use the feature's geometry for the spatial filter.
* Click *Filter by geometry* in a <<maps-vector-tooltip-locking, locked tooltip>>, and then use the feature's geometry for the spatial filter.
+
[role="screenshot"]
image::maps/images/create_spatial_filter.png[]
@ -55,7 +55,7 @@ Spatial filters have the following properties:
==== Phrase filters
A phrase filter narrows search results to documents that contain the specified text.
You can create a phrase filter by clicking the plus icon image:maps/images/gs_plus_icon.png[] in a feature tooltip.
You can create a phrase filter by clicking the plus icon image:maps/images/gs_plus_icon.png[] in a <<maps-vector-tooltip-locking, locked tooltip>>.
[role="screenshot"]
image::maps/images/create_phrase_filter.png[]

View file

@ -29,3 +29,4 @@ The index must contain at least 2 fields mapped as {ref}/geo-point.html[geo_poin
include::vector-style.asciidoc[]
include::vector-style-properties.asciidoc[]
include::vector-tooltips.asciidoc[]

View file

@ -0,0 +1,41 @@
[role="xpack"]
[[vector-tooltip]]
=== Vector tooltips
Vector tooltips display attributes for the features at your mouse location.
These tooltips give users an in-depth insight into what's going on in the map.
If more than one feature exists at a location, the tooltip displays the
attributes for the top feature, and notes the number of features at that location.
The following image shows a tooltip with three features at the current location.
The tooltip displays attributes for the top feature, the green circle.
[role="screenshot"]
image::maps/images/multifeature_tooltip.png[]
[float]
[[maps-vector-tooltip-formatting]]
==== Formatting tooltips
You can format the attributes in a tooltip by adding <<managing-fields, field formatters>> to your
Kibana index pattern. You can use field formatters to round numbers, provide units,
and even display images in your tooltip.
[float]
[[maps-vector-tooltip-locking]]
==== Locking a tooltip at the current location
You can lock a tooltip in place by clicking a location on the map.
With locked tooltips you can:
* Page through features.
* Create a <<maps-phrase-filter, phrase filter>> from a feature attribute value.
* Create a <<maps-spatial-filters, spatial filter>> from a feature's geometry.
This image shows a locked tooltip with features from three layers.
The tooltip displays attributes
for the second feature, the blue New York State polygon. The tooltip includes
controls for paging through the features and a dropdown menu for filtering
the features by layer.
[role="screenshot"]
image::maps/images/locked_tooltip.png[]