Skip to content

Commit 5b4f6ba

Browse files
nreesegchaps
andauthored
[Docs] clean-up vega map reference documenation (#88487) (#88516)
* [Docs] clean-up vega map reference documenation * Update docs/user/dashboard/vega-reference.asciidoc Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
1 parent 1d4d3f3 commit 5b4f6ba

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

docs/user/dashboard/vega-reference.asciidoc

+29-29
Original file line numberDiff line numberDiff line change
@@ -216,24 +216,8 @@ on the currently picked range: `"interval": {"%autointerval%": 10}` will
216216
try to get about 10-15 data points (buckets).
217217

218218
[float]
219-
[[vega-esmfiles]]
220-
=== Access Elastic Map Service files
221-
222-
experimental[] Access the Elastic Map Service files via the same mechanism:
223-
224-
[source,yaml]
225-
----
226-
url: {
227-
// "type" defaults to "elasticsearch" otherwise
228-
type: emsfile
229-
// Name of the file, exactly as in the Region map visualization
230-
name: World Countries
231-
}
232-
// The result is a geojson file, get its features to use
233-
// this data source with the "shape" marks
234-
// https://vega.github.io/vega/docs/marks/shape/
235-
format: {property: "features"}
236-
----
219+
[[vega-with-a-map]]
220+
=== Vega with a Map
237221

238222
To enable Maps, the graph must specify `type=map` in the host
239223
configuration:
@@ -282,6 +266,22 @@ Additionally, you can use `latitude`, `longitude`, and `zoom` signals.
282266
These signals can be used in the graph, or can be updated to modify the
283267
position of the map.
284268

269+
experimental[] You can use Vega's https://vega.github.io/vega/docs/data/[data] element to access https://www.elastic.co/elastic-maps-service[Elastic Maps Service (EMS)] vector shapes of administrative boundaries in your Vega map by setting `url.data` to `emsFile`:
270+
271+
[source,yaml]
272+
----
273+
url: {
274+
// "type" defaults to "elasticsearch" otherwise
275+
type: emsfile
276+
// Name of the file, exactly as in the Region map visualization
277+
name: World Countries
278+
}
279+
// The result is a geojson file, get its features to use
280+
// this data source with the "shape" marks
281+
// https://vega.github.io/vega/docs/marks/shape/
282+
format: {property: "features"}
283+
----
284+
285285
[float]
286286
[[vega-tooltip]]
287287
==== Additional tooltip styling
@@ -308,22 +308,22 @@ a configuration option for changing the tooltip position and padding:
308308
[[vega-url-loading]]
309309
==== Advanced setting to enable URL loading from any domain
310310

311-
Vega can load data from any URL, but this is disabled by default in {kib}.
311+
Vega can load data from any URL, but this is disabled by default in {kib}.
312312
To change this, set `vis_type_vega.enableExternalUrls: true` in `kibana.yml`,
313313
then restart {kib}.
314314

315315
[float]
316316
[[vega-inspector]]
317317
==== Vega Inspector
318-
Use the contextual *Inspect* tool to gain insights into different elements.
318+
Use the contextual *Inspect* tool to gain insights into different elements.
319319
For Vega visualizations, there are two different views: *Request* and *Vega debug*.
320320

321321
[float]
322322
[[inspect-elasticsearch-requests]]
323323
===== Inspect {es} requests
324324

325-
Vega uses the {ref}/search-search.html[{es} search API] to get documents and aggregation
326-
results from {es}. To troubleshoot these requests, click *Inspect*, which shows the most recent requests.
325+
Vega uses the {ref}/search-search.html[{es} search API] to get documents and aggregation
326+
results from {es}. To troubleshoot these requests, click *Inspect*, which shows the most recent requests.
327327
In case your specification has more than one request, you can switch between the views using the *View* dropdown.
328328

329329
[role="screenshot"]
@@ -333,10 +333,10 @@ image::visualize/images/vega_tutorial_inspect_requests.png[]
333333
[[vega-debugging]]
334334
===== Vega debugging
335335

336-
With the *Vega debug* view, you can inspect the *Data sets* and *Signal Values* runtime data.
337-
338-
The runtime data is read from the
339-
https://vega.github.io/vega/docs/api/debugging/#scope[runtime scope].
336+
With the *Vega debug* view, you can inspect the *Data sets* and *Signal Values* runtime data.
337+
338+
The runtime data is read from the
339+
https://vega.github.io/vega/docs/api/debugging/#scope[runtime scope].
340340

341341
[role="screenshot"]
342342
image::visualize/images/vega_tutorial_inspect_data_sets.png[]
@@ -348,15 +348,15 @@ the <<vega-browser-debugging-console, Vega browser debugging process>>.
348348
[[asking-for-help-with-a-vega-spec]]
349349
===== Asking for help with a Vega spec
350350

351-
Because of the dynamic nature of the data in {es}, it is hard to help you with
351+
Because of the dynamic nature of the data in {es}, it is hard to help you with
352352
Vega specs unless you can share a dataset. To do this, click *Inspect*, select the *Vega debug* view,
353353
then select the *Spec* tab:
354354

355355
[role="screenshot"]
356356
image::visualize/images/vega_tutorial_getting_help.png[]
357357

358-
To copy the response, click *Copy to clipboard*. Paste the copied data to
359-
https://gist.github.com/[gist.github.com], possibly with a .json extension. Use the [raw] button,
358+
To copy the response, click *Copy to clipboard*. Paste the copied data to
359+
https://gist.github.com/[gist.github.com], possibly with a .json extension. Use the [raw] button,
360360
and share that when asking for help.
361361

362362
[float]

0 commit comments

Comments
 (0)