https://github.com/kit-data-manager/com_mapping-service-input
Allows the user to set a file and choose a mapping for a request to our mapping service.
https://github.com/kit-data-manager/com_mapping-service-input
inactive web-component
Last synced: about 1 year ago
JSON representation
Allows the user to set a file and choose a mapping for a request to our mapping service.
- Host: GitHub
- URL: https://github.com/kit-data-manager/com_mapping-service-input
- Owner: kit-data-manager
- License: apache-2.0
- Created: 2023-02-09T14:03:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-01T22:31:27.000Z (about 1 year ago)
- Last Synced: 2025-05-02T04:04:58.071Z (about 1 year ago)
- Topics: inactive, web-component
- Language: TypeScript
- Homepage:
- Size: 420 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# com_mapping-service-input
Mapping Component Overview:
The Mapping component serves as a user-friendly interface to extract metadata from data generated by instruments and map it to metadata schema.Our mappings are designed to align with widely accepted community schemes, custom-tailored for various techniques.
## Integration
If the dependency is up set properly (instructions will follow), the component can be used like this:
**Add the Element**:
To integrate the Mapping component into your project, insert the following HTML element into your webpage:
```html
...
```
**Invoke the Download Functionality**:
For enabling the download functionality, include the following HTML code in your page:
```html
`
Map document
`
```
The executeMapping(true) method call triggers both the mapping process and the subsequent download of the result.
Adjusting Base URL:
The base-url attribute in the element allows you to specify the base URL for your Mapping Service instance. You can modify this URL as needed to suit your requirements.
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.
## How to run - For developers
To start using the component clone this repo to a new directory:
```bash
git clone https://github.com/kit-data-manager/com_mapping-service-input.git
```
and run:(Before running below command make sure node.js is installed in your system. You can check if it is there is your system or not by command: node -v or node --version (dependending on the operating system you are using) in your command prompt.
```bash
npm install
```
To run the component in developement mode
```bash
npm run build
npm run dev
```
## Attributes
- `base-url`: string, base-url to your Mapping Service instance
## Methods
- `executeMapping(true)`: To trigger the mapping process, you can include the following HTML code in your project:
(true in the method argument will trigger mapping + download of the result)