Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

  • IEventHandler

Index

Properties

clueManager

clueManager: CLUEGraphManager

graph

graph: Promise<ProvenanceGraph>

Static EVENT_JUMPED_TO

EVENT_JUMPED_TO: "jumped_to" = "jumped_to"

Static EVENT_MODE_CHANGED

EVENT_MODE_CHANGED: "modeChanged" = "modeChanged"

Static MULTI_EVENT_SEPARATOR

MULTI_EVENT_SEPARATOR: "," = ","

Methods

Protected build

Protected Abstract buildImpl

  • buildImpl(body: HTMLElement): object

fire

  • fire(events: string, ...args: any[]): this
  • fires an event

    Parameters

    • events: string

      name(s) of the event

    • Rest ...args: any[]

      additional arguments

    Returns this

getRegisteredHandlerCount

  • getRegisteredHandlerCount(): object
  • list for each registered event the number of listeners

    Returns object

    • [key: string]: number

jumpToState

  • jumpToState(state: number): Promise<this>

jumpToStored

  • jumpToStored(): PromiseLike<this>

jumpToStoredOrLastState

  • jumpToStoredOrLastState(): Promise<this>

jumpToStory

  • jumpToStory(story: number, autoPlay?: boolean): Promise<this>
  • Parameters

    • story: number
    • Default value autoPlay: boolean = this.clueManager.isAutoPlay

    Returns Promise<this>

nextSlide

  • nextSlide(): Promise<SlideNode>

off

  • off(events: string | object, handler?: IEventListener): this
  • unregister a global event handler

    Parameters

    • events: string | object
    • Optional handler: IEventListener

    Returns this

on

  • on(events: string | object, handler?: IEventListener): this
  • register a global event handler

    Parameters

    • events: string | object

      either one event string (multiple are supported using , as separator) or a map of event handlers

    • Optional handler: IEventListener

      the handler in case of a given string

    Returns this

previousSlide

  • previousSlide(): Promise<SlideNode>

propagate

  • propagate(progatee: IEventHandler, ...events: string[]): void
  • registers on the given event handler and propagates the given events to itself

    Parameters

    • progatee: IEventHandler
    • Rest ...events: string[]

    Returns void

stopPropagation

  • stopPropagation(progatee: IEventHandler, ...events: string[]): void
  • Parameters

    • progatee: IEventHandler
    • Rest ...events: string[]

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc