Global

Members

constantCaptionTrackList

CaptionTrackList is a plugin that adds a caption to the map that lists the tracks in the order they are displayed. The caption is updated whenever tracks are added, removed, updated, or moved.

To activate this plugin with the defaults, add the following to the caption's options: { pluginOptions: { pluginCaptionTrackList: {} }

To customize the plugin, add the following options to the caption's options (shown with defaults): { pluginOptions: { pluginCaptionTrackList: { collapseTracks: false, separator: 'return', startFrom: 'outside', }, }, }

OPTIONS:

  • collapseTracks:
    • If true, the plugin will collapse adjacent rings/lanes from the same tracks into a single entry.
    • [Default: false].
  • separator:
    • The separator to use between entries. Options are 'return', 'semicolon', and 'comma'.
    • [Default: return].
  • startFrom:
    • The direction to start listing tracks. Options are 'inside', 'outside', 'backbone'.
    • [Default: outside].

constantPluginsStandard

PluginsStandard is a collection of default plugins that are included with the CGview. These plugins are installed when the CGview is created.

Currently, the following plugins are included:

  • CaptionTrackList

Type Definitions

PointObject

Properties:
Name Type Description
x number

The X Coordinate

y number

The Y Coordinate