Skip to content

Latest commit

 

History

History
50 lines (43 loc) · 1.3 KB

chart-config.md

File metadata and controls

50 lines (43 loc) · 1.3 KB
layout title permalink
page
Chart config
/chart-config/

Format

Chart config is stored in a JSON object, broken down in to nested objects for the various components of the chart. The chart config can be stored in the REST API, or used to generate interactive charts or images on the fly.

Parameter types

String Accepts a string, unless a set of valid values are specified.
Integer i.e. 1, 4, 500
Float i.e. 1, 1.0, 50.3
Boolean i.e. true, false, 1, 0
Color Accepts a hex, rgb or rgba string unless otherwise stated. i.e. #ffffff, rgb(255, 255, 255) or rgba(255, 255, 255, 0.5)

If a parameter type is followed by square brackets (i.e. Color[]) it implies you can send an array of that parameter type (e.g. ['#000000', '#ffffff'])

Config object

{% for section_hash in site.data['chart-config'].config %} {% assign sectionKey = section_hash['key'] %} {% assign section = section_hash['data'] %} {% include config/section.html sectionKey = sectionKey section = section %} {% endfor %}