Class AbstractNodeAbstract

Base class for Node and Variation.

Hierarchy (view full)

Methods

addNag clearNags clearTags comment filterNags filterTags hasNag id isLongComment isVariation nags play removeNag tag tags

Methods

AbstractaddNag

  • addNag(nag): void

  • Add the given NAG to the current node or variation.

    Parameters

    • nag: number

    Returns void

AbstractclearNags

  • clearNags(): void

  • Remove all the NAGs from the current node or variation.

    Returns void

AbstractclearTags

  • clearTags(): void

  • Remove all the key-value tag pairs from the the current node or variation.

    Returns void

    See

    AbstractNode.tags for more details on tags.

Abstractcomment

  • comment(): undefined | string

  • Get the text comment (if any) associated to the current node or variation.

    Returns undefined | string

  • comment(value, isLongComment?): void

  • Set the text comment associated to the current node or variation.

    Parameters

    • value: undefined | string

      If undefined, the existing value (if any) is erased.

    • OptionalisLongComment: boolean

      false by default.

    Returns void

AbstractfilterNags

  • filterNags(filter): void

  • Remove from the the current node or variation the NAGs for which the given filter evaluates to false (and keep those for which it evaluates to true).

    Parameters

    • filter: ((nag: number) => boolean)
        • (nag): boolean

        • Parameters

          • nag: number

          Returns boolean

    Returns void

AbstractfilterTags

  • filterTags(filter): void

  • Remove from the the current node or variation the key-value tag pairs for which the given filter evaluates to false (and keep those for which it evaluates to true).

    Parameters

    • filter: ((tagKey: string, tagValue: string) => boolean)
        • (tagKey, tagValue): boolean

        • Parameters

          • tagKey: string
          • tagValue: string

          Returns boolean

    Returns void

    See

    AbstractNode.tags for more details on tags.

AbstracthasNag

  • hasNag(nag): boolean

  • Check whether the current node or variation has the given NAG or not.

    Parameters

    • nag: number

    Returns boolean

Abstractid

  • id(): string

  • Identifier of the current Node or Variation within its parent Game.

    WARNING: the ID may change when variations are modified (added, removed, swapped, promoted...) among the parents the current node.

    Returns string

AbstractisLongComment

  • isLongComment(): boolean

  • Whether the text comment associated to the current node or variation is long or short.

    Returns boolean

    false if no comment is defined.

AbstractisVariation

  • isVariation(): boolean

  • Returns boolean

    Deprecated

    Use obj instanceof Variation instead.

Abstractnags

  • nags(): number[]

  • NAGs associated to the current node or variation.

    Returns number[]

    array sorted in increasing order.

Abstractplay

  • play(move): Node

  • Create a new node representing the given move, and append it to the current node or variation.

    If there are some pre-existing subsequent nodes, they are all erased.

    Parameters

    • move: string

      SAN representation of the move, or '--' for a null-move.

    Returns Node

    The newly created Node.

    Throws

    exception.InvalidNotation if the move notation cannot be parsed, or if the parsed move would correspond to an illegal move.

AbstractremoveNag

  • removeNag(nag): void

  • Remove the given NAG from the current node or variation.

    Parameters

    • nag: number

    Returns void

Abstracttag

  • tag(tagKey): undefined | string

  • Get the value associated to the given tag key on the current node or variation.

    Parameters

    • tagKey: string

    Returns undefined | string

    See

    AbstractNode.tags for more details on tags.

  • tag(tagKey, value): void

  • Set the value associated to the given tag key on the current node or variation.

    Parameters

    • tagKey: string
    • value: undefined | string

      If undefined, the existing value (if any) is erased.

    Returns void

    See

    AbstractNode.tags for more details on tags.

Abstracttags

  • tags(): string[]

  • Return the keys of the tags associated to the current node or variation.

    The tag mechanism is a key-value associative container allowing to store some arbitrary data on each node or variation. In PGN, the tags are represented as [%tagKey tagValue] strings appended to text comments.

    The tag keys must be non-empty, and can contain only alphanumeric or underscore characters.

    Returns string[]

    array sorted in increasing order.

Settings

Member Visibility

On This Page

Methods