Class: Divider

Divider

A divider is the line and spacing that separate tracks and slot.

There are two type of dividers: slot and track. They are accessed from the viewer dividers object:

  • cgv.dividers.track - controlls spacing/lines between tracks.
  • cgv.dividers.slot - controls spacing/lines betweens slots within a track.

If either track or slot has their mirror set to true, then both dividers will be treated as the same. In addition, if only settings for one of the dividers is provided on Viewer creation, then it will be mirrored.

Action and Events

Action Viewer Method Divider Method Event
Update - update() divider-update
Read dividers - -

Attributes

Attribute Type Description
color String A string describing the color [Default: 'black']. See Color for details.
thickness Number Thickness of divider [Default: 1]
spacing Number Spacing between divider and track/slot content [Default: 1]
mirroric Boolean If true, the other dividers will use the same settings as this divider.
visible Boolean Dividers are visible [Default: true]
meta Object Meta data for divider

ic Ignored on Record creation

Examples

new Divider(viewer, name, options, meta)

Divider.js, line 63

Create a divider

Name Type Description
viewer Viewer

The viewer
name String

The name for the divider. One of: track, slot, or mirrored.
options Object

Attributes used to create the divider
meta Object optional

User-defined Meta data to add to the divider

Extends

Members

adjustedSpacingNumber

Get the divider spacing adjusted for zoom level. Even if the divider is not visible, there can still be spacing between the slots/tracks.

adjustedThicknessNumber

Get the divider thickness adjusted for visibility and zoom level.

canvasCanvas

Get the canvas.

colorColor

Get or set the divider color. When setting the color, a string representing the color or a Color object can be used. For details see Color.

layoutLayout

Get the layout.

metaBoolean

Get or Set the meta data of this object. See the meta data tutorial for details.

mirrorBoolean

Get or set the mirroring for this divider. When setting to true, the other divider will be mirrored to this one.

name

Return name of divider (e.g. 'track' or 'slot')

sequenceSequence

Get the sequence.

spacingNumber

Set or get the divider spacing.

thicknessNumber

Set or get the divider thickness. This is the unzoomed thickness.

viewerViewer

Get the viewer.

visibleBoolean

Get or Set the visibility of this object.

Methods

inherited addPluginOptions(id, options)

CGObject.js, line 150

Add a plugin to the object.

Name Type Description
id String

The id of the plugin
options Object

The plugin options

inherited deleteFromObjects()

CGObject.js, line 137

Remove the object from Viewer.objects

inherited hasPlugin(pluginID){Boolean}

CGObject.js, line 191

Does this object have a particular plugin?

Name Type Description
pluginID String

The ID of the plugin
Returns:
Type Description
Boolean
  • Whether the object has the plugin

inherited optionsForPlugin(pluginName){Object}

CGObject.js, line 205

Get the options for a particular plugin.

Name Type Description
pluginName String

The name of the plugin
Returns:
Type Description
Object
  • The options for the plugin or undefined if the plugin is not found

toString(){String}

Divider.js, line 86

Return the class name as a string.

Returns:
Type Description
String
  • 'Divider'

update(attributes)

Divider.js, line 193

Update divider attributes. See updating records for details.

Name Type Description
attributes Object

Object describing the properties to change

inherited updatePluginOptions(id, options)

CGObject.js, line 170

Update plugin options. Merge the new options with the old options.

Name Type Description
id String

The id of the plugin
options Object

The plugin options