version.md

Version

Kind: global interface

• Version
  • .source : String
  • .image : Object
  • .backgroundColor : Color
  • .layers : Array<Layer>
  • .links : Array<Object>
  • .grid : Object
  • .componentNames : Array<String>

version.source : String

Source application of the version, sketch, xd, figma, psd or bitmap.

Kind: instance property of Version

version.image : Object

Image of the version.

Kind: instance property of Version

Properties

Name	Type
url	String
width	Number
height	Number

version.backgroundColor : Color

Background color of the version.

Kind: instance property of Version

version.layers : Array<Layer>

Layers of the version.

Kind: instance property of Version

version.links : Array<Object>

Links to other screens in the version.

Kind: instance property of Version

Properties

Name	Type	Description
rect	Object	Bounding rectangle of the link.
destination	Object	Destination of the link.
rect.x	Number	—
rect.y	Number	—
rect.width	Number	—
rect.height	Number	—
destination.name	String	Name of the screen destination.
destination.type	String	Type of the destination, screen or previous.

version.grid : Object

Grid (i.e. layout) of the version.

Kind: instance property of Version

Properties

Name	Type
horizontalOffset	Number
vertical	Object
horizontal	Object
vertical.gutterWidth	Number
vertical.columnWidth	Number
vertical.numberOfCols	Number
vertical.guttersOnOutside	Boolean
horizontal.gutterHeight	Number
horizontal.rowHeight	Number

version.componentNames : Array<String>

Names of components used in the version.

Kind: instance property of Version

Related models

• Screen
• Component