graphics engine documentation

historical_timelines.graphics.event_labels(plot: figure, source: ColumnDataSource, x: str, y: str, text: str, y_offset: int = 0, text_font_size: str = '11px', text_color: str = '#555555', text_align: str = 'center') → None

Give events on the plot labels

Args:

plot (figure): The plot events are rendered on source (ColumnDataSource): The data to be rendered x (str): The name of the column of source that lists the event x axis y (str): The name of the column of source that lists the event y axis text (str): The name of the column of source that lists the event label text y_offset (int, optional): The y offset of the labels. Defaults to 0. text_font_size (str, optional): The font size of the labels. Defaults to “11px”. text_color (str, optional): The color of the labels. Defaults to “#555555”. text_align (str, optional): The text alignment of the labels. Defaults to ‘center’.

historical_timelines.graphics.event_tooltips(plot: figure, tooltip_names: list[str]) → None

Give the plot hoverable tooltips for events

Args:

plot (figure): The plot to be modified tooltip_names (list[str]): The categories to be shown in the tooltip

historical_timelines.graphics.format_xaxis(plot: figure, scientific: bool = False) → figure

Modifies a plot to format the x axis as dates.

Args:

plot (figure): The plot to be modified scientific (bool, optional): If true, dates use BCE/CE, if false, dates use BC/AD. Defaults to False.

Returns:

figure: The modified plot

historical_timelines.graphics.get_source_from_event_dict(event_dict: dict) → ColumnDataSource

Convert a dictionary into a ColumnDataSource

Args:

event_dict (dict): The dictionary input

Returns:

ColumnDataSource: The converted data

historical_timelines.graphics.get_y_range(event_dict: dict, period_list: list) → list[str]

Get the labels that populate the y range

Args:

event_dict (dict): The event dictionary period_list (list): The period list

Returns:

list[str]: A list of labels to populate the dictionary

historical_timelines.graphics.output_notebook()

A warper for the bokeh output_notebook function

historical_timelines.graphics.period_labels(plot: figure, period_list: list, text: str, y_offset: int = -8, text_font_size: str = '11px', text_color: str = '#555555', text_align: str = 'center') → None

Give labels to the periods on the plot

Args:

plot (figure): The plot events are rendered on period_list (list): The list of periods to be given labels text (str): The name of the column of source that lists the period label text y_offset (int, optional): The y offset of the labels. Defaults to -8. text_font_size (str, optional): The font size of the labels. Defaults to “11px”. text_color (str, optional): The text color of the labels. Defaults to “#555555”. text_align (str, optional): The text alignment of the labels. Defaults to ‘center’.

historical_timelines.graphics.render_events(plot: figure, source: ColumnDataSource, x: str, y: str, size: int) → None

Render events on the plot

Args:

plot (figure): The plot events are rendered on source (ColumnDataSource): The data to be rendered x (str): The name of the column of source that lists the event x axis y (str): The name of the column of source that lists the event y axis size (int): The size of the events

historical_timelines.graphics.render_periods(plot: figure, period_list: list, height: float = 0.3) → None

Render the periods on the plot

Args:

plot (figure): The plot to be rendered on period_list (list): The list of periods to be rendered height (float, optional): The height of the rendered periods. Defaults to 0.3.

historical_timelines.graphics.render_timeline(output: str, title: str, event_dict: dict, period_list: list, show_timeline: bool = False) → figure

Render a timeline as an image

Args:

output (str): The filename to save the timeline as title (str): The title of the timeline event_dict (dict): The event dict generated by the timeline period_list (list): The period list generated by the timeline show_timeline (bool): Whether to display the timeline rather than saving it

Returns:

figure: The modified plot

historical_timelines.graphics.setup_figure(*args, **kwargs) → figure

Create plot with which to create the timeline on.

This function is essentially a wrapper for the bokeh function figure. See its documentation for more information.

Returns:

figure: A plot on which to create a timeline