Class: Storymap

ol.control. Storymap

A control with scroll-driven navigation to create narrative maps


new Storymap( [options])

Parameters:
Name Type Argument Description
options Object <optional>

Control options.

Properties
Name Type Argument Default Description
className String

class of the control (scrollLine, scrollBox or any)

html Element | string | undefined <optional>

The storymap content

target Element | string | undefined <optional>

The target element to place the story. If no html is provided the content of the target will be used.

minibar boolean <optional>
false

add a mini scroll bar

Fires:
  • event:scrollto
  • event:clickimage

Extends

Methods


setChapter(name)

Scroll to a chapter

Parameters:
Name Type Description
name string

Name of the chapter to scroll to


setStory(name)

Scroll to a chapter

Parameters:
Name Type Description
name string

Name of the chapter to scroll to