Class Cell

Constructed using row and column and optionally placed value Can remove notes Can place value Returns: Row Column Box Value Notes Has note

Hierarchy

  • Cell

Constructors

constructor

Properties

box column notes row value

Methods

getBox getBoxColumnStart getBoxRowStart getColumn getNotes getNotesString getRow getValue hasNote initializeBox isEmpty printNotes removeNote removeNotes resetNotes setNotes setValue calculateBox calculateBoxIndex calculateColumn calculateRow getBoxColumnStart getBoxRowStart

Constructors

constructor

  • Creates cell object using given row/column, throws error if invalid

    Throws

    CustomError Thrown if row or column out of range or if value is invalid

    Parameters

    • row: number

      Row index (0 indexed)

    • column: number

      Column index (0 indexed)

    • Optional value: string

      Optional placed value

    Returns Cell

Properties

Private box

box: number

Private column

column: number

Private notes

notes: Group

Private row

row: number

Private value

value: string

Methods

getBox

  • Get box

    Returns

    box

    Returns number

getBoxColumnStart

  • Get box column start

    Returns

    first column in box

    Returns number

getBoxRowStart

  • Get box row start

    Returns

    first row in box

    Returns number

getColumn

  • Get column

    Returns

    column

    Returns number

getNotes

getNotesString

  • Generates note string for logging

    Returns

    note string in format for logging

    Returns string

getRow

  • Get row

    Returns

    row

    Returns number

getValue

  • Get value

    Returns

    value

    Returns string

hasNote

  • Checks if cell has given note

    Returns

    true if note is in notes

    Parameters

    • note: string

      note

    Returns boolean

Private initializeBox

  • Calculates box cell is in and sets it

    Returns void

isEmpty

  • Checks if cell is empty

    Returns

    true if cell is empty

    Returns boolean

printNotes

  • Prints notes in pretty format

    Returns void

removeNote

  • Remotes note

    Parameters

    • note: string

      note

    Returns void

removeNotes

  • Removes notes

    Parameters

    Returns void

resetNotes

  • Resets notes to contain all possible notes

    Returns void

setNotes

  • Sets all given notes (1 based index)

    Parameters

    • notes: number[]

    Returns void

setValue

  • Sets value

    Parameters

    • value: string

      value

    Returns void

Static calculateBox

  • Given a cells row and column calculate what box it is in

    Returns

    index of box given cell is in

    Parameters

    • row: number

      row cell is in

    • column: number

      column cell is in

    Returns number

Static calculateBoxIndex

  • Given a cells row and column returns its box index (0-8 inclusive, left to right, top to bottom)

    Returns

    box index

    Parameters

    • row: number

      row cell is in

    • column: number

      column cell is in

    Returns number

Static calculateColumn

  • Given a cells box and box index returns what column it is in

    Returns

    column cell is in

    Parameters

    • box: number

      box cell is in

    • index: number

      box index of cell (first row is 0-2, 2nd 3-5, last 6-8)

    Returns number

Static calculateRow

  • Given a cells box and box index returns what row it is in

    Returns

    row cell is in

    Parameters

    • box: number

      box cell is in

    • index: number

      box index of cell (first row is 0-2, 2nd 3-5, last 6-8)

    Returns number

Static getBoxColumnStart

  • Get given box column start

    Returns

    first column in given box

    Parameters

    • box: number

    Returns number

Static getBoxRowStart

  • Get given box row start

    Returns

    first row in given box

    Parameters

    • box: number

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc