TimelineJS options
When you create a timeline manually by calling TL.Timeline
, you may pass in an optional third parameter which contains a variety of presentation options.
This third parameter should be a Javascript object with keys matching the value in the Name
column and corresponding values appropriate to the specific key. For example:
var options = { hash_bookmark: false, initial_zoom: 5 } var timeline = new TL.Timeline('timeline-embed', 'https://docs.google.com/spreadsheets/d/1cWqQBZCkX9GpzFtxCWHoqFXCHg-ylTVUWlnrdYMzKUI/pubhtml', options);
If you use our authoring tool, you can pass most of these as URL parameters. Add &option_name=value
for each. To demonstrate using the same options
as above: https://cdn.knightlab.com/libs/timeline3/latest/embed/index.html?source=1cWqQBZCkX9GpzFtxCWHoqFXCHg-ylTVUWlnrdYMzKUI&font=Default&lang=en&initial_zoom=3&height=650&hash_bookmark=false
debug
false
true
, copious console logging will be enabled.
height
this._el.container.offsetHeight
width
this._el.container.offsetWidth
is_embed
false
true
, the class tl-timeline-embed
is added to the outer Timeline container. Typically only used to support Timeline iframe embeds.
hash_bookmark
false
true
, TimelineJS will update the browser URL each time a slide advances, so that people can link directly to specific slides.
default_bg_color
white
r
, g
, and b
properties from 0-255.
scale_factor
initial_zoom
zoom_sequence
series used to scale the Timeline when it is first created. Takes precedence over scale_factor
.
zoom_sequence
scale_factor
, which means that at any given level, the full timeline
would require that many screens to display all events.
timenav_position
top
or bottom
.
optimal_tick_width
base_class
timenav_height
timenav_height_percentage
.
timenav_height_percentage
timenav_mobile_height_percentage
timenav_height_min
marker_height_min
marker_width_min
marker_padding
start_at_slide
start_at_end
false
menubar_height
use_bc
false
duration
ease
TL.Ease.easeInOutQuint
dragging
true
trackResize
true
slide_padding_lr
slide_default_fade
language
ga_property_id
track_events
script_path