Class Color

Model class representing a color used in the pattern.

A Color represents a color used in the pattern. The color is made up of one or more strands of Floss. Each strand can be a different color, allowing blended colors to be defined.

Hierarchy

  • Color

Constructors

constructor

Properties

colorId colorName flossStrands hexCode? patternSymbol

Constructors

constructor

  • Parameters

    • colorId: number

      An ID for the color. Stitches will use this ID to reference which color they are.

    • colorName: string

      A name for the overall color.

    • patternSymbol: string

      The ASCII character used to represent the color on the pattern visually.

    • flossStrands: Floss[]

      An array of Floss objects defining all the strands of floss that make up the color.

    • Optional hexCode: number

      Optionally defines the color's hexadecimal value.

    Returns Color

Properties

colorId

colorId: number

An ID for the color. Stitches will use this ID to reference which color they are.

colorName

colorName: string

A name for the overall color.

flossStrands

flossStrands: Floss[]

An array of Floss objects defining all the strands of floss that make up the color.

Optional hexCode

hexCode?: number

Optionally defines the color's hexadecimal value.

patternSymbol

patternSymbol: string

The ASCII character used to represent the color on the pattern visually.

Settings

Member Visibility

Theme

Generated using TypeDoc