Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@matthiasstein
matthiasstein committed Nov 18, 2024
1 parent d03880a commit a0cd746
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 94 deletions.
124 changes: 30 additions & 94 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,104 +2,40 @@

This bundle allows to add portal content

## Usage
[![devnet-bundle-snapshot](/~https://github.com/conterra/mapapps-portal-item-loader/actions/workflows/devnet-bundle-snapshot.yml/badge.svg)](/~https://github.com/conterra/mapapps-portal-item-loader/actions/workflows/devnet-bundle-snapshot.yml)
![Static Badge](https://img.shields.io/badge/tested_for_map.apps-4.18.3-%20?labelColor=%233E464F&color=%232FC050)

1. First you need to add the bundle dn_mapapps-portal-item-loader to your app.
2. Then you can configure it.
3. The last thing you need to do is add the portalContentToggleTool
# Portal Item Loader

The Portal Item Loader allows you to add portal content to your app.

![Screenshot App](/~https://github.com/conterra/mapapps-portal-item-loader/blob/master/screenshot.JPG)

### Configurable Components of dn_portalitemloader:
## Build Status

#### ActivateLayerAction
```
[![devnet-bundle-snapshot](/~https://github.com/conterra/mapapps-portal-item-loader/actions/workflows/devnet-bundle-snapshot.yml/badge.svg)](/~https://github.com/conterra/mapapps-portal-item-loader/actions/workflows/devnet-bundle-snapshot.yml)

## Sample App

https://demos.conterra.de/mapapps/resources/apps/downloads_portalitemloader/index.html

## Installation Guide

[dn_portalitemloader Documentation](/~https://github.com/conterra/mapapps-portal-item-loader/tree/master/src/main/js/bundles/dn_portalitemloader)

## Quick start

Clone this project and ensure that you have all required dependencies installed correctly (see [Documentation](https://docs.conterra.de/en/mapapps/latest/developersguide/getting-started/set-up-development-environment.html)).

Then run the following commands from the project root directory to start a local development server:

```bash
# install all required node modules
$ mvn initialize

# start dev server
$ mvn compile -Denv=dev -Pinclude-mapapps-deps

"dn_portalitemloader": {
"Config": {
"portals": [
{
"id": "arcgis",
"title": "ArcGIS Online",
"url": "https://arcgis.com"
}
],
"rowsPerPageItems": [
10,
25,
50,
100
],
"pagination": {
"rowsPerPage": 10
},
"spaceFilter": "all",
"typeFilters": [
"Feature Service",
"Vector Tile Service",
"Image Service",
"Scene Service",
"MapService"
],
"typeFilter": "all",
"sortAscending": false,
"sortByField": "modified",
"sortByFields": [
{
"id": "modified",
"title": "${ui.sortByFields.modified}"
},
{
"id": "title",
"title": "${ui.sortByFields.title}"
},
{
"id": "uploaded",
"title": "${ui.sortByFields.uploaded}"
},
{
"id": "username",
"title": "${ui.sortByFields.username}"
},
{
"id": "created",
"title": "${ui.sortByFields.created}"
},
{
"id": "type",
"title": "${ui.sortByFields.type}"
},
{
"id": "owner",
"title": "${ui.sortByFields.owner}"
},
{
"id": "avg-rating",
"title": "${ui.sortByFields.avg-rating}"
},
{
"id": "num-ratings",
"title": "${ui.sortByFields.num-ratings}"
},
{
"id": "num-comments",
"title": "${ui.sortByFields.num-comments}"
},
{
"id": "num-view",
"title": "${ui.sortByFields.num-view}"
}
]
}
}
# run unit tests
$ mvn test -P run-js-tests,include-mapapps-deps
```
| Property | Type | Possible Values | Default | Description |
|------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|
| typeFilters | Array | ```Feature Service ``` | ```Vector Tile Service ``` | ```Image Service ``` | ```Scene Service ``` | ```MapService ``` | ```all ``` | ```Feature Service ``` | ```Vector Tile Service ``` | ```Image Service ``` | ```Scene Service ``` | ```MapService ``` | All filter types |
| typeFilter | Array | ```Feature Service ``` | ```Vector Tile Service ``` | ```Image Service ``` | ```Scene Service ``` | ```MapService ``` | ```all ``` | ```all ``` | Filter type |
| sortbyFields | Array | ``` modified ``` | ```title``` | ```uploaded ``` | ```username``` | ```created ``` | ```type ``` | ```owner ``` | ```avg-rating ``` | ```num-ratings ``` | ```num-comments ``` | ```num-views" ``` | ``` modified ``` | Sort fields |
| portals | Object | | | used portal |
| rowsPerPageItems | Array | ``` 10 ``` |``` 25``` |```50``` |```100``` | ``` 10 ``` |``` 25``` |```50``` |```100``` | possible number of rows per page |
| pagination | Object | [``` 10 ``` |``` 25``` |```50``` |```100``` ] | ``` 10 ``` | number of rows per page |
| spaceFilter | Array | ```all``` | ``` orgarnisation``` | ```my-content``` | ```all``` | all possible filter portal spaces |
| spaceFilters | Array | ```all``` | ``` orgarnisation``` | ```my-content``` | ```all``` | filter portal space | Filter portal space |
Binary file added screenshot.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a0cd746

Please sign in to comment.