project.md

Project

Kind: global interface

• Project
  • .type : String
  • .name : String
  • .textStyles : Array.<TextStyle>
  • .colors : Array.<Color>
  • .density : String
  • .densityDivisor : Number
  • .lengthUnit : String
  • .textLengthUnit : String
  • .findTextStyleByName(name) ⇒ TextStyle
  • .findTextStyleEqual(textStyle) ⇒ TextStyle
  • .findColorByName(name) ⇒ Color
  • .findColorEqual(color) ⇒ Color
  • .findColorByHexAndAlpha(values) ⇒ Color

project.type : String

Type of the project, web, android, ios or macos.

Kind: instance property of Project

project.name : String

Name of the project.

Kind: instance property of Project

project.textStyles : Array.<TextStyle>

Text styles in the Styleguide.

Kind: instance property of Project

project.colors : Array.<Color>

Colors in the Styleguide.

Kind: instance property of Project

project.density : String

Pixel density of the project.

Kind: instance property of Project

project.densityDivisor : Number

Divisor corresponding to the density, used to obtain actual values from unit values.

Kind: instance property of Project

project.lengthUnit : String

Length unit of the project, based on the type, e.g. px for Web, pt for iOS.

Kind: instance property of Project

project.textLengthUnit : String

Text length unit of the project, based on the type, e.g. dp for Android.

Kind: instance property of Project

project.findTextStyleByName(name) ⇒ TextStyle

Finds text style in the project by name.

Kind: instance method of Project

Param	Type
name	String

project.findTextStyleEqual(textStyle) ⇒ TextStyle

Finds text style in the project equal to another text style.

Kind: instance method of Project

Param	Type
textStyle	TextStyle

project.findColorByName(name) ⇒ Color

Finds color in the project by name.

Kind: instance method of Project

Param	Type
name	String

project.findColorEqual(color) ⇒ Color

Finds color in the project equal to another color.

Kind: instance method of Project

Param	Type
color	Color

project.findColorByHexAndAlpha(values) ⇒ Color

Finds color in the project by hex and alpha values.

Kind: instance method of Project

Param	Type	Description
values	Object
values.hex	String	Hex string for RGB components of the color, e.g. rrggbb.
values.alpha	String	Alpha value of the color.