{"id":16375219,"url":"https://github.com/eblondel/ol-loadingpanel","last_synced_at":"2025-07-30T16:37:01.831Z","repository":{"id":69392774,"uuid":"46720747","full_name":"eblondel/ol-loadingpanel","owner":"eblondel","description":"OpenLayers LoadingPanel control","archived":false,"fork":false,"pushed_at":"2021-06-21T07:08:54.000Z","size":216,"stargazers_count":20,"open_issues_count":2,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-06-11T19:44:18.872Z","etag":null,"topics":["javascript","loader","ol3","openlayers","plugin"],"latest_commit_sha":null,"homepage":"https://github.com/eblondel/ol-loadingpanel","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eblondel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-11-23T13:06:09.000Z","updated_at":"2024-07-07T07:50:38.565Z","dependencies_parsed_at":null,"dependency_job_id":"fed7f6c4-b98a-418e-936f-1900121a6931","html_url":"https://github.com/eblondel/ol-loadingpanel","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/eblondel/ol-loadingpanel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eblondel%2Fol-loadingpanel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eblondel%2Fol-loadingpanel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eblondel%2Fol-loadingpanel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eblondel%2Fol-loadingpanel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eblondel","download_url":"https://codeload.github.com/eblondel/ol-loadingpanel/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eblondel%2Fol-loadingpanel/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267899905,"owners_count":24163001,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","loader","ol3","openlayers","plugin"],"created_at":"2024-10-11T03:19:59.422Z","updated_at":"2025-07-30T16:37:01.808Z","avatar_url":"https://github.com/eblondel.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenLayers Loading Panel\n\nLoading panel control for an [OpenLayers](https://github.com/openlayers/openlayers) map.\n\n\nThis module has been initially developed for the needs of the OpenFIGIS [FigisMap](https://github.com/openfigis/FigisMap) project used as web-mapping framework in the FAO Fisheries \u0026 Aquaculture [website](http://www.fao.org/fishery/en), principally through the Fisheries Global Information System (FIGIS).\n\nBeyond the capacity to display a simple animated GIF, the ol-loadingpanel allows to provide the actual **layer loading progress**, e.g. by means of a progress bar. Depending on the application needs, the plugin is **customizable with loading events listeners** (start, progress, end).\n\nInitially  developed for Openlayers 3, the plugin is under revision for supporting later versions of OpenLayers.\n\n## Status\n\nThe plugin has been **successfully tested** and, for information, it is used in production in [FIGIS](http://www.fao.org/fishery/topic/18042/en) and several map viewers built on the [OpenFairViewer](https://github.com/eblondel/OpenFairViewer) framework\n\nFor users/developers interested in contributing, contributions, bug reporting and/or fixing are more than welcome! If you have questions or suggestions, please do not hesitate to [contact me](mailto:emmanuel.blondel1@gmail.com)\n\n## Examples\n\n_UNDER REVIEW (CURRENT UPGRADE TO OPENLAYERS 6)_\n\n## API\n\n_UNDER REVIEW (CURRENT UPGRADE TO OPENLAYERS 6)_\n\n### `new LoadingPanel(opt_options)`\n\nOpenLayers Loading Panel.\n\nSee [the examples](./examples) for usage.\n\n#### Parameters:\n\nThe ``LoadingPanel`` accepts a single ``opt_options`` parameter (of type ``Object``), and accepts the following properties:\n\n|Name|Type|Description|\n|:---|:---|:----------|\n|`className`|`String`| control CSS class name. Default value is ``ol-loading-panel``|\n|`widget`|`String`| widget type: ``animatedgif`` (default value) or ``progressbar``|\n|`progressMode`|`String`| mode to use for reporting progress: ``tile`` (default) or ``layer``|\n|`showPanel`|`Boolean`| If the loading panel has to be shown. Default value is ``true``. Value ``false`` can be used if an external loading panel element is used, together with the ``ol.control.LoadingPanel`` ``events``|\n|`onstart`|`Object`| a function to register on load start ``event``, with no parameter.|\n|`onprogress`|`Object`| a function to register on load progress ``event`` defined as ``function(loaded, toload){...}`` where ``loaded`` is the number of ``tiles`` (or ``layers``) loaded, and ``toload`` is the total number of ``tiles`` (or ``layers``) to be loaded |\n|`onend`|`Object`| a function to register on load end  ``event``, with no parameter.|\n\n#### Extends\n\n`ol/control/Control`\n\n#### Methods\n\n##### `show()`\n\nShow the loading panel.\n\n##### `hide()`\n\nHide the loading panel.\n\n##### `progressDetails()`\n\nReturns an array of [loaded,toload] values.\n\n##### `progress()`\n\nReturns a number between 0 and 1.\n\n##### `setMap(map)`\n\nSet the map instance the control is associated with.\n\n###### Parameters:\n\n|Name|Type|Description|\n|:---|:---|:----------|\n|`map`|`ol/Map`| The map instance. |\n\n## License\n\nMIT (c) 2015 Emmanuel Blondel\n\n## Contributors\n\n* [Marco Balestra](https://github.com/marcobalestra)\n\n## Applications\n\n* [FigisMap](https://github.com/openfigis/FigisMap) Javascript API for the Fisheries Global Information System (FIGIS)\n* [OpenFairViewer](https://github.com/eblondel/OpenFairViewer) \n\n## Sponsors\n\n* UN FAO FI Department, as part of the [Fisheries Global Information System](http://www.fao.org/fishery/topic/18042/en) (FIGIS)\n[![FIGIS](http://www.fao.org/figis/servlet/IRS?iid=17437)](http://www.fao.org/fishery/topic/18042/e)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feblondel%2Fol-loadingpanel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feblondel%2Fol-loadingpanel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feblondel%2Fol-loadingpanel/lists"}