Skip to content
Snippets Groups Projects
Commit 4ad249aa authored by Matthieu Fesselier's avatar Matthieu Fesselier
Browse files

update: solid map documentation

parent de83696e
No related branches found
No related tags found
No related merge requests found
......@@ -5,9 +5,30 @@ Receives the URL of a resource or of a container of resources via its
``data-src`` attribute, and displays it on a **map**. Here is the list
of fields needed to display the resources properly:
- ``name``: name of the event displayed on the calendar
- ``lat``: latitude on which the resource will be displayed
- ``lng``: longitude on which the resource will be displayed
- ``http://www.w3.org/2003/01/geo/wgs84_pos#lat``: latitude on which the resource will be displayed
- ``http://www.w3.org/2003/01/geo/wgs84_pos#lng``: longitude on which the resource will be displayed
Like for solid-display, filters and searching capabilities can be easily
``lat`` and ``lng`` properties are added to the default context to map
respectively ``http://www.w3.org/2003/01/geo/wgs84_pos#lat`` and ``http://www.w3.org/2003/01/geo/wgs84_pos#lng``.
How to use
----------
The ``solid-map`` module needs to be imported independantly from the core, like following:
.. code:: html
<script type="module" src="https://unpkg.com/@startinblox/core/dist/components/solid-map.js"></script>
Attributes
----------
Like for ``solid-display``, fields can be displayed and filters or searching capabilities can be
added to interact with the list of data being displayed.
``fields``
~~~~~~~~~~
List of the fields to display in a popup which opens when a marker is clicked. If the attribute is not defined, no popup will show up.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment