Skip to content

Commit 00ecf4c

Browse files
committed
Documenting the use of the component.
1 parent 0ad4673 commit 00ecf4c

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22

33

44

5-
This is a webcomponent to use in HTML or more complex web projects.
5+
Mapping Component Overview:
66

7+
The Mapping component serves as a user-friendly interface to extract metadata from data generated by instruments.Our mappings are designed to align with widely accepted community schemes, custom-tailored for various techniques.
78

89
## Integration
910

1011
If the dependency is up set properly (instructions will follow), the component can be used like this:
1112

13+
Add the Element:
14+
To integrate the Mapping component into your project, insert the following HTML element into your webpage:
15+
1216
```html
1317
<head>
1418
...
@@ -20,6 +24,29 @@ If the dependency is up set properly (instructions will follow), the component c
2024
<mapping-input base-url="http://localhost:8090/" id="input-component"></mapping-input>
2125
</body>
2226
```
27+
Invoke the Download Functionality:
28+
29+
For enabling the download functionality, include the following HTML code in your page:
30+
```html
31+
...
32+
<!-- use the method !-->
33+
34+
`<div class="ui center aligned grid">
35+
<button type="submit" class="ui primary button" id="submit" onclick="
36+
var component = document.getElementById('input-component');
37+
component.executeMapping(true)">Map document
38+
</button>
39+
</div>`
40+
41+
```
42+
43+
The executeMapping(true) method call triggers both the mapping process and the subsequent download of the result.
44+
45+
Adjusting Base URL:
46+
47+
The base-url attribute in the <mapping-input> element allows you to specify the base URL for your Mapping Service instance. You can modify this URL as needed to suit your requirements.
48+
49+
By following these steps, you can easily integrate the Mapping component into your project and utilize its capabilities for extracting metadata from instrument-generated data.
2350

2451
## Attributes
2552

0 commit comments

Comments
 (0)