An open API service indexing awesome lists of open source software.

https://github.com/uPortal-Attic/MapPortlet


https://github.com/uPortal-Attic/MapPortlet

campus-locations map-portlet portal portlet uportal

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

        

# Map Portlet

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.jasig.portlet.map/MapPortlet/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.jasig.portlet.map/MapPortlet)
[![build status](https://github.com/uPortal-Project/MapPortlet/workflows/CI/badge.svg?branch=master)](https://github.com/uPortal-Project/MapPortlet/actions)

The Map Portlet is a JSR-286 portlet includes an API for representing campus locations, including geo coordinates, addresses, categories, etc. Users can search/browse to find particular locations

## Features

* Display Map with markers
* API for representing campus locations
* Search or Browse locations

## Configuration Information

The portlet has one property file: *configuration.properties* and one map file: *map.json*

1. Check out project from
2. Configure *src/main/resources/configuration.properties*
3. Run `mvn install`
4. Deploy the war

### Map Properties

| Field | Description |
| ------------ | ---------------------------------------------------------------------- |
| latitude | latitude of location |
| longitude | longitude of location |
| name | Name of location. Displayed to user and available in searches |
| abbreviation | Abbreviation of location. Displayed to user and available in searches |
| address | Postal address of location |
| description | Description to display to users when location is selected |
| img | URL of image to display to user |
| searchText | Do not specify. Field is constructed from name and abbreviation |
| searchKeys | List of additional strings included in user searches |
| categories | List of categories for 'Browse by category' function. |
| campuses | |

### Portlet Preferences

| Preference Name | Default | Description |
| --------------- | ---------- | ----------------------------------------- |
| apiKey | | API key to use for Google Maps |
| latitude | 41.300937 | Latitude to display for initial map view |
| longitude | -72.932103 | Longitude to display for initial map view |
| zoom | 17 | |
| mapTypeControl | true | |
| panControl | false | |
| zoomControl | true | |
| streetView | true | |
| scaleControl | true | |
| rotateControl | false | |
| overviewControl | false | |

### Sample Data

The portlet has sample data in the webapp/demo directory