Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FunctionalModule

The class representing a square that is for functionalities

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

  • new FunctionalModule(type: "FINDER" | "SEPARATOR" | "TIMING" | "ALIGNMENT" | "FORMAT_INFO" | "VERSION_INFO" | "Dark", color: boolean): FunctionalModule

  • Create a new FunctionModule instance

    Parameters

    • type: "FINDER" | "SEPARATOR" | "TIMING" | "ALIGNMENT" | "FORMAT_INFO" | "VERSION_INFO" | "Dark"

      The type of the functionality

    • color: boolean

      The binary data represented by boolean

    Returns FunctionalModule

Properties

Protected color

color: boolean = false

TRUE for dark, FALSE for light

Private Readonly type

type: "FINDER" | "SEPARATOR" | "TIMING" | "ALIGNMENT" | "FORMAT_INFO" | "VERSION_INFO" | "Dark"

The type of the functionality

Methods

copy

getColor

  • getColor(): boolean

  • Return the color

    Returns boolean

getType

  • getType(): "FINDER" | "SEPARATOR" | "TIMING" | "ALIGNMENT" | "FORMAT_INFO" | "VERSION_INFO" | "Dark"

  • Return the type of the functionality

    Returns "FINDER" | "SEPARATOR" | "TIMING" | "ALIGNMENT" | "FORMAT_INFO" | "VERSION_INFO" | "Dark"

setColor

  • setColor(value: boolean): void

  • Set the color to a new value

    Parameters

    • value: boolean

      The new color

    Returns void

Generated using TypeDoc