This section documents API usage specific to this template, so for an introduction we suggest you refer to the generic API documentation instead.

Template data

This template does not have any data bindings, so you shouldn't include data or bindings key/value pairs in your opts object that is passed to the API. You should specify the template and template version in the opts object like:

{
    template: "@flourish/mobile-view",
    version: "1",
    ...
}

Template settings

Options for opts.state.

desktop_url string

Desktop URL. For a Flourish visualization, first publish the project, then use the address in the form https://flourish.studio/visualisation/XXXX/embed

mobile_url string

Mobile URL. For a Flourish visualization, first publish the project, then use the address in the form https://flourish.studio/visualisation/XXXX/embed

breakpoint number

Breakpoint. The width at which the graphic should shift between modes

desktop_height string

Desktop height. If specified, sets the height above the breakpoint. Use any css unit. Will be treated as pixels if no unit specified.

mobile_height string

Mobile height. If specified, sets the height below the breakpoint. Use any css unit. Will be treated as pixels if no unit specified.