Ephtracking-viz NPM

ephtracking-viz

Environmental Public Health Visualizations

The ephtracking-viz library helps you to embed visualizations with data from the EPH Portal:

The National Environmental Public Health Tracking Network (Tracking Network) brings together health data and environment data from national, state, and city sources and provides supporting information to make the data easier to understand. The Tracking Network has data and information on environments and hazards, health effects, and population health.

The Tracking Network Data Application Program Interface (API) is an alternate way for developers to query data from the Environmental Public Health Tracking Network. The Tracking API provides a standard Uniform Resource Locator (URL) interface with a JavaScript Object Notation (JSON) formatted response.

National Environmental Public Health Tracking Network

Tracking Network Data Application Program Interface (API)

Getting started

Install

Install using npm or yarn:

yarn add ephtracking-viz

npm install --save ephtracking-viz

You can also use the latest relase from the global CDN unpkg.com/ephtracking-viz:

<!-- D3 dependency -->
<script src="https://d3js.org/d3.v4.min.js"></script>
<!-- ephtracking-viz library -->
<script src="https://unpkg.com/ephtracking-viz/dist/index.umd.min.js"></script>

Usage

Define a svg and specify the size for the visualization:

<svg id="viz" width="600" height="400"></svg>

Call the visualization library:

  var options = {

    // required
    // select type of visualization ('line-chart' or 'choropleth' or 'bubble')
    type: 'line-chart',

    // add a title to the chart, optional but recommended
    title: 'Age-adjusted rate of death from Ischemic Heart Disease among persons 35 and older per 100,000 population',

    // choropleth map only: show or hide legend, default true, optional
    showLegend: true,

    // choropleth map only, number of break groups, min 3, default 8, optional
    breakGroups: 6,

    // choropleth map only, name of color scheme, default 'schemeYlGn'
    // names see https://github.com/d3/d3-scale-chromatic
    colorScheme: 'schemePuBu',

    // define data parameter
    data: {
      // required
      // the id of the measure to visualize
      measureId: '551',

      // optional, default '1' (state)
      // '2': county
      // set stratification level
      stratificationLevelId: '2',

      // optional, default '1' (state)
      // type 'choropleth: not supported
      geographicTypeIdFilter: '2',

      // required
      // string of one fips code or an array of many fips codes (string)
      // type 'choropleth: not supported
      geographicItemsFilter: ['36005', '36047', '36081', '36085', '36061'], // NYC counties

      // optional, default 2000-present
      // array of years (string YYYY), date range in years (string YYYY-YYYY) or year (string YYYY)
      temporal: '2000-2014',

      // optional, default '0', not smoothed
      isSmoothed: '0',

      // optional, query parameters for stratifications like Gender or AgeGroup
      queryParams: ''
      }
    };
  ephtrackingViz.createVisualization('svg#viz', options);

This assistant helps you to generate the options: EPH Tracking Viz Assistant