API information
This section documents API usage specific to this template, so for an introduction we suggest you refer to the generic API documentation instead.
template: @lkelly/TimelineTest
version: 1
Template data
There are three different formats in which you can supply data to this template. The most convenient for you to use likely depends on the source of your data, as described below.
1. Array of arrays, and a bindings object
You can supply arrays of arrays to opts.data, which might look
like:
{
data: {
fruit: [
[ "FruitColumn1Value1", "FruitColumn2Value1",
[ "FruitColumn1Value2", "FruitColumn2Value2",
[ "FruitColumn1Value3", "FruitColumn2Value3",
...
]
}
}
where each array of arrays represents the rows in a data sheet.
To tell the API how the values from each column should be
associated with the keys that the template is expecting, you must also supply
an object attached to opts.bindings. (The meanings of the
keys in the bindings object are documented
below.) The minimal bindings you can
supply for this template are as shown in this example:
{
template: "@lkelly/TimelineTest",
version: "1",
bindings: {
fruit: {
label: 0, // index of a column in your data
}
},
data: {
fruit: [
[ "FruitColumn1Value1", "FruitColumn2Value1",
[ "FruitColumn1Value2", "FruitColumn2Value2",
[ "FruitColumn1Value3", "FruitColumn2Value3",
...
]
}
}
All possible bindings that you can supply are shown in this example:
{
template: "@lkelly/TimelineTest",
version: "1",
bindings: {
fruit: {
label: 0, // index of a column in your data
values: [1, 2, ...], // index(es) of column(s) in your data
}
},
data: {
fruit: [
[ "FruitColumn1Value1", "FruitColumn2Value1",
[ "FruitColumn1Value2", "FruitColumn2Value2",
[ "FruitColumn1Value3", "FruitColumn2Value3",
...
]
}
}
2. Array of objects with arbitrary keys, and a bindings object
This format is most likely useful when you have data from an external source,
such as CSV data loaded from d3-dsv.
You should supply this attached to the opts.data, which might look
like:
{
fruit: [
{ "FruitHeader1": ..., "FruitHeader2": ..., ... },
{ "FruitHeader1": ..., "FruitHeader2": ..., ... },
{ "FruitHeader1": ..., "FruitHeader2": ..., ... },
...
]
}
... but with the keys being the column headers from your
source data instead. You must also supply an object attached to
opts.bindings. The minimal bindings you can
supply for this template are as shown in this example:
{
template: "@lkelly/TimelineTest",
version: "1",
bindings: {
fruit: {
label: "FruitHeader1",
}
},
data: {
fruit: [
{ "FruitHeader1": ..., "FruitHeader2": ..., ... },
{ "FruitHeader1": ..., "FruitHeader2": ..., ... },
{ "FruitHeader1": ..., "FruitHeader2": ..., ... },
...
]
}
}
All possible bindings that you can supply are shown in this example:
{
template: "@lkelly/TimelineTest",
version: "1",
bindings: {
fruit: {
label: "FruitHeader1",
values: ["FruitHeader2", "FruitHeader3", ...],
}
},
data: {
fruit: [
{ "FruitHeader1": ..., "FruitHeader2": ..., ... },
{ "FruitHeader1": ..., "FruitHeader2": ..., ... },
{ "FruitHeader1": ..., "FruitHeader2": ..., ... },
...
]
}
}
(As before, the keys containing "Header" would be replaced by column names from your data source.)
3. Array of objects with template-defined keys
There is an alternative format you can use, which is likely to be easier to
use if your data is not from a spreadsheet source. With this alternative format
you supply your data to the template as
an array of objects, attached to opts.data, where the keys must
be those used by the template, as documented below. In this case
there is no need to supply a bindings object, since the key names are already
those expected by the template. The required properties in the data
object are as follows (scroll down for a
description of what each property is):
{
template: "@lkelly/TimelineTest",
version: "1",
data: {
fruit: [
{
label: ...,
values: [...]
},
...
]
},
...
}
And the full list of all possible properties is as follows:
{
template: "@lkelly/TimelineTest",
version: "1",
data: {
fruit: [
{
label: ...,
values: [...]
},
...
]
},
...
}
Meanings of the template data keys:
- fruit.label: Name of fruits
- fruit.values: values
Template settings
Options for opts.state.
Template settings
example_setting number
Example setting. Explanation of example setting
Layout
Layout
layout.body_font font
Font.
layout.max_width number
Maximum width. Leave blank to stretch to container width Min: 50
layout.margin number
Margin.
layout.background_color_enabled boolean
Color. Allowed values:
layout.background_image_enabled boolean
Image. Allowed values:
layout.background_color color
Color.
layout.background_image_src url
Image URL.
layout.background_image_size string
Size. Allowed values:
layout.background_image_position string
Position. Allowed values:
layout.layout_order string
Layout order. Allowed values:
layout.space_between_sections string
Space between sections. Allowed values:
layout.space_between_sections_custom number
Custom. Max: 100
Header
layout.header_align string
Alignment. Allowed values:
layout.title string
layout.title_styling boolean
Change title styles.
layout.title_size string
Size. Allowed values:
layout.title_size_custom number
Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3
layout.title_weight string
Weight. Allowed values:
layout.title_color color
Color.
layout.title_line_height number
Line height. Max: 3
layout.subtitle string
layout.subtitle_styling boolean
Change subtitle styles.
layout.subtitle_size string
Size. Allowed values:
layout.subtitle_size_custom number
Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3
layout.subtitle_weight string
Weight. Allowed values:
layout.subtitle_color color
Color.
layout.subtitle_line_height number
Line height. Max: 3
layout.subtitle_space_above string
Space above. Allowed values:
layout.subtitle_space_above_custom number
Custom. Max: 100
layout.text string
layout.text_styling boolean
Change text styles.
layout.text_size string
Size. Allowed values:
layout.text_size_custom number
Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3
layout.text_weight string
Weight. Allowed values:
layout.text_color color
Color.
layout.text_line_height number
Line height. Max: 3
layout.text_space_above string
Space above. Allowed values:
layout.text_space_above_custom number
Custom. Max: 100
Footer
layout.source_name string
Source name.
layout.source_url string
Source url.
layout.multiple_sources boolean
Multiple sources.
layout.source_name_2 string
Source name.
layout.source_url_2 string
Source url.
layout.source_name_3 string
Source name.
layout.source_url_3 string
Source url.
layout.source_label string
Source label.
layout.note string
Note.
layout.size number
Size.
layout.color color
Color.
layout.footer_align string
Alignment. Allowed values:
layout.logo_url url
Image.
layout.logo_link_url string
Link.
layout.logo_height number
Height.
layout.logo_margin number
Margin.
layout.logo_order string
Position. Allowed values:
layout.footer_align_vertical string
V. align. Allowed values:
