blackboxopt.visualizations.visualizer

create_hover_information(sections)

Create a hovertemplate which is used to render hover hints in plotly charts.

The data for the chart hovertext has to be provided as custom_data attribute to the chart and can be e.g a list of column names.

One oddness is, that in the template the columns can't be referenced by name, but only by index. That's why it is important to have the same ordering in the template as in the custom_data and the reason why this is done together in this function.

Parameters:

Name	Type	Description	Default
sections	dict	Sections to render. The kyeys will show up as the section titles, values are expected to be a list of column names to be rendered under the section. E.g.: { "info": ["Objective #1", "Objective #2", "fidelity"] }	required

Returns:

Type	Description
Tuple[str, List]	(plotly hover template, data column names)

Source code in blackboxopt/visualizations/visualizer.py

def create_hover_information(sections: dict) -> Tuple[str, List]:
    """
    Create a [hovertemplate](https://plotly.com/python/reference/pie/#pie-hovertemplate)
    which is used to render hover hints in plotly charts.

    The data for the chart hovertext has to be provided as `custom_data` attribute to
    the chart and can be e.g a list of column names.

    One oddness is, that in the template the columns can't be referenced by name, but
    only by index. That's why it is important to have the same ordering in the template
    as in the `custom_data` and the reason why this is done together in this function.

    Args:
        sections: Sections to render. The kyeys will show up as the section titles,
            values are expected to be a list of column names to be rendered under
            the section. E.g.: { "info": ["Objective #1", "Objective #2", "fidelity"] }

    Returns:
        (plotly hover template, data column names)
    """
    template = ""
    idx = 0
    for section, columns in sections.items():
        template += f"<br><b>{section.replace('_', ' ').title()}</b><br>"
        for column in columns:
            template += f"{column}: %{{customdata[{idx}]}}<br>"
            idx += 1
    template += "<extra></extra>"

    data_columns: list = sum(sections.values(), [])

    return template, data_columns