Skip to content

Latest commit

 

History

History
98 lines (78 loc) · 2.74 KB

README.md

File metadata and controls

98 lines (78 loc) · 2.74 KB
Raw

Build Status

The grails2 branch contains the 1.3.x series of the plugin compatible with Grails 2.x

The master branch hosts version 2.x and forward of the plugin compatible with grails 3.x

Why ?

Charts are used in multiple places within the Atlas. This is an attempt to standardise the display of chart information across the ALA. This plugin is currently only supporting charts on top of biocache services but could be extended to include other services (e.g. logger services, ecodata services).

Versions

  • 1.3.x is built with grails 2.5.x and supports bootstrap 3
  • 1.4.x is built with grails 3.x and supports bootstrap 3

Usage instructions

To use the plugin you need to set up a external JSON configuration file for the charts. The configuration file should be placed in the location:

/data/{appName}/config/charts.json

Heres an example:

{ "biocache" : {
    "cl1000" : {
        "title": "By habitat",
        "chartType": "doughnut",
        "emptyValueMsg": "Habitat not specified",
        "hideEmptyValues" : true
    },
    "month" : {
        "title": "By month",
        "chartType": "bar",
        "emptyValueMsg": "Month not specified",
        "hideEmptyValues" : true
    },
    "year" : {
        "title": "Since 1990",
        "chartType": "bar",
        "emptyValueMsg": "Year not specified",
        "hideEmptyValues" : true,
        "filter": "fq=year:[1990 TO *]"
    },
    "decade" : {
        "title": "By decade",
        "chartType": "bar",
        "emptyValueMsg": "Year not specified",
        "hideEmptyValues" : true
    },
    "data_resource_uid" : {
        "title": "By dataset",
        "chartType": "horizontal-bar"
    },
    "data_provider_uid" : {
        "title": "By data partner",
        "chartType": "horizontal-bar",
        "emptyValueMsg": "Partner not specified",
        "hideEmptyValues" : true
    }
}}

Configuration options

  • title: The title to display over the top of this chart
  • chartType: one of "horizontal-bar", "bar" or "doughnut"
  • emptyValueMsg: What to display for a field name if non available,
  • hideEmptyValues : Whether to hide empty values e.g. month not supplied
  • filter: An additional query filter to be used in the search

For biocache charts, the name of the chart must be an indexed and public field.

Rendering the charts

To use the grails taglib to render the charts:

<asset:script type="text/javascript">
    <charts:biocache
        biocacheServiceUrl="http://biocache.ala.org.au/ws"
        biocacheWebappUrl="http://biocache.ala.org.au"
        q="Macropus"
        qc=""
        fq=""
    />    
</asset:script>