Skip to content

Commit d21a1f4

Browse files
(DOCSP-6549): Updates to location schema analysis (#163)
* (DOCSP-6549): Updates to location schema analysis * updates per Max's feedback
1 parent 8932c22 commit d21a1f4

File tree

4 files changed

+78
-9
lines changed

4 files changed

+78
-9
lines changed
Loading
Loading
385 KB
Loading

source/schema.txt

Lines changed: 78 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,6 @@ particular fields to display and the number of results to return.
8383
.. figure:: /images/compass/query-bar-schema-view.png
8484
:figwidth: 730px
8585

86-
.. include:: /includes/extracts/query-bar-type-schema.rst
87-
8886
.. tip::
8987

9088
In the :guilabel:`Schema` tab, you can also use the :ref:`build-query` to
@@ -213,7 +211,8 @@ GeoJSON and ``[latitude,longitude]`` Arrays
213211
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
214212

215213
Fields that contain GeoJSON data or ``[latitude,longitude]`` arrays are
216-
displayed with interactive maps.
214+
displayed with interactive maps. For more information on interacting
215+
with location data in |compass-short|, see :ref:`analyze-location-data`.
217216

218217
.. figure:: /images/compass/geo-visualization.png
219218
:figwidth: 816px
@@ -253,18 +252,88 @@ elements.
253252
builder and then manually edit the generated filter to your exact
254253
requirements.
255254

256-
Composing ``$OR`` filter conditions is not yet possible with the
257-
clickable query builder, but you can manually enter them in the query
258-
bar.
259-
260255
The following procedure describes the steps involved in
261256
building a complex query with the query bar.
262257

263258
.. include:: /includes/steps/create-query-via-builder.rst
264259

265-
.. note::
260+
.. _analyze-location-data:
261+
262+
Analyze Location Data
263+
---------------------
264+
265+
In the :guilabel:`Schema` tab, you can use interactive maps to filter
266+
and analyze location data. If your field contains
267+
:manual:`GeoJSON data </reference/geojson/>` or
268+
``[latitude,longitude]`` arrays, the :guilabel:`Schema` tab displays
269+
a map containing the points from the field. The data type
270+
for location fields is ``coordinates``.
271+
272+
.. figure:: /images/compass/location-data-example.png
273+
:figwidth: 575px
274+
:alt: Image showing example field with location data
275+
276+
Apply a Location Filter
277+
~~~~~~~~~~~~~~~~~~~~~~~
278+
279+
You can apply a filter to the map to only analyze a specific
280+
range of points. To define a location filter:
281+
282+
1. Click the :guilabel:`Circle` button at the top-right
283+
of the map.
284+
285+
#. Click and drag on the map to draw a circle containing the area of
286+
the map you want to analyze.
287+
288+
#. Repeat this process as desired to include additional areas of
289+
the map in the schema analysis.
290+
291+
.. figure:: /images/compass/location-data-filter.png
292+
:figwidth: 575px
293+
:alt: Image showing map with filter circles drawn
294+
295+
The query bar updates as you draw location filters to show
296+
the exact coordinates used in the
297+
:manual:`$geoWithin </reference/operator/query/geoWithin/>` query
298+
applied to the schema analysis.
299+
300+
If you specify multiple location filters, the query becomes
301+
an :manual:`$or </reference/operator/query/or/>` query
302+
with multiple ``$geoWithin`` operators.
303+
304+
Edit a Location Filter
305+
~~~~~~~~~~~~~~~~~~~~~~
306+
307+
To move or resize a location filter, click :icon-fa5:`edit` on the
308+
right side of the map. You will enter the filter editing mode, which
309+
looks like this:
310+
311+
.. figure:: /images/compass/location-data-filter-edit.png
312+
:figwidth: 575px
313+
:alt: Image showing map filter editing
314+
315+
To move a filter
316+
Click and drag the square in the center of the circle.
317+
318+
To resize a filter
319+
Click and drag the square at the edge of the circle.
320+
321+
After modifying your filters, click :guilabel:`Save`.
322+
323+
Delete a Location Filter
324+
~~~~~~~~~~~~~~~~~~~~~~~~
325+
326+
To delete a location filter from the map:
327+
328+
1. Click :icon-fa5:`trash-alt` on the right side of the map.
329+
330+
#. Either click:
331+
332+
- A location filter to delete that filter.
333+
334+
- :guilabel:`Clear All` to delete all location filters.
266335

267-
You can also use the query builder on data represented as maps.
336+
#. Click :guilabel:`Save`.
268337

269338
.. |query-build-ref| replace:: :ref:`build-query`
270339

0 commit comments

Comments
 (0)