Global

Type Definitions


areaChartData

Type:
  • Array.<Object>
Properties:
Name Type Description
date String Date of the entry in ISO8601 format (required)
name String Name of the entry (required)
value Number Value of the entry (required)
Source:
Example
[
    {
        date: "2011-01-05T00:00:00Z",
        name: "Direct",
        value: 0
    }
]

BarChartData

Type:
  • Array.<Object>
Properties:
Name Type Description
value Number Value of the group (required)
name String Name of the group (required)
Source:
Example
[
    {
        value: 1,
        name: 'glittering'
    },
    {
        value: 1,
        name: 'luminous'
    }
]

BrushChartData

Type:
  • Array.<Object>
Properties:
Name Type Description
value Number Value to chart (required)
date Date Date of the value in ISO8601 format (required)
Source:
Example
[
    {
        value: 1,
        date: '2011-01-06T00:00:00Z'
    },
    {
        value: 2,
        date: '2011-01-07T00:00:00Z'
    }
]

BulletChartData

Type:
  • Object
Properties:
Name Type Argument Description
ranges Array.<Number> Range that encodes the qualitative measure
measures Array.<Number> Range that encodes the performance measure
markers Array.<Number> Marker lines that encode the comparative measure
title String <optional>
String that sets identification for the measure
subtitle String <optional>
String that provides more details on measure identification
Source:
Example
{
     ranges: [130, 160, 250],
     measures: [150, 180],
     markers: [175]
}

D3Selection

Type:
  • Array.<Array>
Properties:
Name Type Description
length Number Size of the selection
parentNode DOMElement Parent of the selection
Source:

DonutChartData

Type:
  • Array.<Object>
Properties:
Name Type Description
quantity Number Quantity of the group (required)
percentage Number Percentage of the total (optional)
name String Name of the group (required)
id Number Identifier for the group required for legend feature (optional)
Source:
Example
[
    {
        quantity: 1,
        percentage: 50,
        name: 'glittering',
        id: 1
    },
    {
        quantity: 1,
        percentage: 50,
        name: 'luminous',
        id: 2
    }
]

GroupedBarChartData

Type:
  • Array.<Object>
Properties:
Name Type Description
name String Name of the entry
group String group of the entry
value Number Value of the entry
Source:
Example
[
    {
        name: "2011-01",
        group: "Direct",
        value: 0
    }
]

HeatmapData

Type:
  • Array.<Array>
Properties:
Name Type Description
week Number
day Number
value Number
Source:
Example
[
    {
        day: 0,
        hour: 0,
        value: 7
    },
    {
        day: 0,
        hour: 1,
        value: 10
    }
]

LegendChartData

Type:
  • Array.<Object>
Properties:
Name Type Description
id Number Id of the group (required)
name String Name of the group (required)
quantity Number Quantity of the group (optional)
Source:
Example
[
    {
        id: 1,
        quantity: 2,
        name: 'glittering'
    },
    {
        id: 2,
        quantity: 3,
        name: 'luminous'
    }
]

LineChartData

The data shape for the line chart. Note that up to version 2.10.1, this required a "dataByTopic" array described on lineChartDataByTopic. The "dataByTopic" schema still works, but we prefer a flat dataset as described here.
Type:
  • Object
Properties:
Name Type Description
data Array.<lineChartFlatData> Data values to chart (required)
Source:
Example
{
    data: [
        {
            topicName: 'San Francisco',
            name: 1,
            date: '2017-01-16T16:00:00-08:00',
            value: 1
        },
        {
            topicName: 'San Francisco',
            name: 1,
            date: '2017-01-17T16:00:00-08:00',
            value: 2
        },
        {
            topicName: 'Oakland',
            name: 2,
            date: '2017-01-16T16:00:00-08:00',
            value: 3
        },
        {
            topicName: 'Oakland',
            name: 2,
            date: '2017-01-17T16:00:00-08:00',
            value: 7
        }
    ]
}

lineChartDataByDate

The Data by Date is calculated internally in the chart in order to pass it to our tooltips
Type:
  • Array.<Object>
Properties:
Name Type Description
date String Date in ISO8601 format (required)
topics Array.<Object> List of topics with values that date (required)
Source:
Example
[
    {
        date: "2015-06-27T07:00:00.000Z",
        topics: [
            {
                "name": 1,
                "value": 1,
                "topicName": "San Francisco"
            },
            {
                "name": 2,
                "value": 20,
                "topicName": "Los Angeles"
            },
            {
                "name": 3,
                "value": 10,
                "topicName": "Oakland"
            }
        ]
    },
    {...}
]

lineChartDataByTopic

Former data standard, it is currently calculated internally if not passed
Type:
  • Object
Properties:
Name Type Description
topicName String Topic name (required)
topic Number Topic identifier (required)
dates Array.<Object> All date entries with values for that topic in ISO8601 format (required)
Source:
Example
{
    topicName: 'San Francisco',
    topic: 123,
    dates: [
        {
            date: '2017-01-16T16:00:00-08:00',
            value: 1
        },
        {
            date: '2017-01-16T17:00:00-08:00',
            value: 2
        }
    ]
}

lineChartFlatData

Type:
  • Object
Properties:
Name Type Description
topicName String Topic name (required)
topic Number Topic identifier (required)
dates Array.<Object> All date entries with values for that topic in ISO8601 format (required)
Source:
Example
[
    {
        topicName: 'San Francisco',
        name: 123,
        date: '2017-01-16T16:00:00-08:00',
        value: 1
    }
]

ScatterPlotData

Type:
  • Array.<Object>
Properties:
Name Type Description
name String Name of the category or topic for data point
x Number Data point's position value relative to x-axis
y Number Data point's position value relative to y-axis
Source:
Example
[
    {
        name: 'topic',
        x: 123,
        y: 24,
    },
    {
        name: 'topic1',
        x: 53,
        y: 31,
    },
    {
        name: 'topic2',
        x: 631,
        y: 321,
    },
    {
        name: 'topic1',
        x: 231,
        y: 111,
    }
]

SparklineChartData

Type:
  • Array.<Object>
Properties:
Name Type Description
value Number Value of the group (required)
name String Name of the group (required)
Source:
Example
[
    {
        value: 1,
        date: '2011-01-06T00:00:00Z'
    },
    {
        value: 2,
        date: '2011-01-07T00:00:00Z'
    }
]

stackedBarData

Type:
  • Array.<Object>
Properties:
Name Type Description
name String Name of the entry
stack String Stack of the entry
value Number Value of the entry
Source:
Example
[
    {
        name: "2011-01",
        stack: "Direct",
        value: 0
    }
]

StepChartData

Type:
  • Array.<Object>
Properties:
Name Type Description
key String Key we measure (required)
value Number value of the key (required)
Source:
Example
[
    {
        value: 1,
        key: 'glittering'
    },
    {
        value: 1,
        key: 'luminous'
    }
]