module

meteoJS/synview

Source: Synview.js

Properties

tooltip
typeCollection

Methods

appendType(type)
getMap()
getTimeline()
getTooltip()
getTypeCollection()

Abstract type

options

Exports

new (require("meteoJS/synview"))(options)

Parameter

Name Type Optional Description

options

 

 

Options.

Properties

tooltip  (meteoJS/synview/tooltip~Tooltip or undefined)

typeCollection  module:meteoJS/synview/typecollection.TypeCollection

Collection of synview types.

Methods

appendType(type) → meteoJS.synview

Append a type to this synview. Wrapper for getTypeCollection().append(type), but ensures, that the new type has an id different than undefined.

Parameter

Name Type Optional Description

type

meteoJS.synview.type

 

Type to append.
Returns

meteoJS.synview This.

getMap() → meteoJS.synview.map

Returns map object.

Returns

meteoJS.synview.map Map object.

getTimeline() → meteoJS.timeline

Returns timeline object.

Returns

meteoJS.timeline Timeline.

getTooltip() → module:meteoJS/tooltip~Tooltip

Returns the tooltip object.

Returns

module:meteoJS/tooltip~Tooltip - Tooltip object.

getTypeCollection() → meteoJS.synview.typeCollection

Returns collection object of appended types.

Returns

meteoJS.synview.typeCollection Type collection.

Abstract type

inner

options  Object

Options for constructor.

Parameters

Name Type Optional Description

map

(module:meteoJS/synview/map.SynviewMap or undefined)

Yes

Synview map object.

timeline

(module:meteoJS/timeline.Timeline or undefined)

Yes

Timeline object.

tooltip

module:meteoJS/tooltip.Tooltip

Yes

Tooltip object.