phovea_clue
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • AVisInstance
    • VerticalStoryVis

Implements

  • IEventHandler
  • IVisInstance

Index

Constructors

constructor

  • new VerticalStoryVis(data: ProvenanceGraph, parent: Element, options?: any): VerticalStoryVis

Properties

data

data: ProvenanceGraph

id

id: any = uniqueId('vis')

parent

parent: Element

player

player: Player = null

story

story: SlideNode = null

Static MIN_HEIGHT

MIN_HEIGHT: number = 20

Static MULTI_EVENT_SEPARATOR

MULTI_EVENT_SEPARATOR: "," = ","

Accessors

isBuilt

isBuilt:

node

node:

rawSize

rawSize:

size

size:

Methods

destroy

  • destroy(): void

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

locate

  • locate(...range: Range[]): any
  • Parameters

    • Rest ...range: Range[]

    Returns any

locateById

  • locateById(...range: Range[]): any
  • Parameters

    • Rest ...range: Range[]

    Returns any

locateImpl

  • locateImpl(range: Range): any
  • Parameters

    • range: Range

    Returns any

Protected markReady

  • markReady(built?: boolean): void
  • Parameters

    • Default value built: boolean = true

    Returns void

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

onSlideClick

  • onSlideClick(d: SlideNode): void

option

  • option(name: string, val?: any): any
  • Parameters

    • name: string
    • Optional val: any

    Returns any

persist

  • persist(): any
  • Returns any

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

pushAnnotation

  • pushAnnotation(ann: IStateAnnotation): void

restore

  • restore(persisted: any): Promise
  • Parameters

    • persisted: any

    Returns Promise

stopPropagation

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

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

    Returns void

switchTo

  • switchTo(story: SlideNode): void

transform

  • transform(scale?: [number, number], rotate?: number): object
  • Parameters

    • Optional scale: [number, number]
    • Default value rotate: number = 0

    Returns object

    • rotate: number
    • scale: Object

update

  • update(): 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