edirom-image-viewer

https://github.com/edirom/edirom-image-viewer

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (11.4%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: Edirom
License: mit
Language: JavaScript
Default Branch: main
Size: 33.2 KB

Statistics

Stars: 0
Watchers: 4
Forks: 0
Open Issues: 2
Releases: 0

Created over 1 year ago · Last pushed over 1 year ago

Metadata Files

Readme License Code of conduct Citation

Edirom Image Viewer Component

This web component displays IIIF tile sources using openseadragon library. It is intended to be used in tbe Edirom Online, but can also be (re-)used in other web applications. No compilation or building is necessary to use the web component. The component uses (https://openseadragon.github.io) library. Note: This repository only contains the bare JavaScript-based component, there is a separate demo suite for web components developed in the Edirom Online Reloaded project, where the component can be seen and tested.

License

The edirom-image-viewer.js comes with the license MIT.

The imported Openseadragon library comes with the license BSD-3-Clause license.

How to use this web component

Clone the repository into a directory of your choice
Include the path to the web component's JavaScript file into the <head> an HTML page html <script src="path/to/edirom-image-viewer.js"></script>
Include a custom element (this is specified and can be processed by the component) into the <body> of the HTML page. The attributes of the custom element are used as parameters at initialization of the component and changing them (manually or programmatically) can control the components state and behaviour during runtime. The state changes of the web component are communicated outwards via custom events (called 'communicate-{change-type}-update'). The component/document that instantiates the web component (its parent) can listen (via event listeners which have to be implemented individually) and react to the communicated state changes if necessary. The separation of inward communication (via custom element's attributes) and outward communication (via custom events) is esp. necessary to handle frequently populated information etween reading and writing info about the component's state. The component should be encapsulated into an html element such as a div. html <edirom-openseadragon preserveviewport='' visibilityratio='' minzoomLevel='' maxzoomLevel='' shownavigationcontrol='' sequencemode='' tileSources=''></edirom-openseadragon>

Parameters

Note: All attribute values are strings internally, the data type information below indicates the necessary format of the attribute value.

The Openseadrgon parameters mentioned below are based on the available Openseadragon library. This list below is can be extended to add additonal Openseadragon parameters. | Parameter | Data type | Description | Default | |------------------------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------| | preserveviewport | string | Preserves the viewport settings when navigating between pages. | "false" | | visibilityratio | string | Sets the visibility ratio of the rendered SVG. | "1.0" | | minzoomLevel | integer | The minimum zoom level for the rendered SVG. | "1" | | maxzoomLevel | integer | The maximum zoom level for the rendered SVG. | "10" | | shownavigationcontrol | string | Controls the visibility of the navigation controls. | "true" | | sequencemode | string | Sets the mode for sequence navigation (e.g., 'continuous', 'discrete'). | "false" | | tilesources | string | URL or array of URLs for the source tiles used in rendering the SVG. e.g., tilesources='["https://libimages1.princeton.edu/loris/pudl0001%2F4609321%2Fs42%2F00000001.jp2/info.json", "https://libimages1.princeton.edu/loris/pudl0001%2F4609321%2Fs42%2F00000002.jp2/info.json"...]' | "" |

Owner

Name: Virtueller Forschungsverbund Edirom
Login: Edirom
Kind: organization
Location: Germany

Website: https://www.edirom.de
Repositories: 83
Profile: https://github.com/Edirom

Citation (CITATION.cff)

cff-version: 1.2.0
title: Edirom Image Viewer Component
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Hizkiel
    family-names: Alemayehu
    email: hizkiel.alemayehu@uni-paderborn.de
    affiliation: Universität Paderborn
repository-code: 'https://github.com/Edirom/edirom-image-viewer'
abstract: >-
  This web component displays IIIF tile sources using the OpenSeadragon library (https://openseadragon.github.io). It is intended to be used in tbe Edirom Online, but can also be (re-)used in other web applications. No compilation or building is necessary to use the web component. 
license: MIT

GitHub Events

Total

Issues event: 4
Push event: 9

Last Year

Issues event: 4
Push event: 9

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 4
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 3
Total pull request authors: 0
Average comments per issue: 0.25
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 3
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 2
Pull request authors: 0
Average comments per issue: 0.0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science