Kokopu - v4.12.1
    Preparing search index...

    Class AbstractNodeAbstract

    Base class for Node and Variation.

    Hierarchy (View Summary)

    Index

    Methods

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

    Methods

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

      Parameters

      • nag: number

      Returns void

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

      Returns void

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

      Returns void

      AbstractNode.tags for more details on tags.

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

      Returns undefined | string

    • 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

    • 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

      Returns 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

      Returns void

      AbstractNode.tags for more details on tags.

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

      Parameters

      • nag: number

      Returns boolean

    • 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

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

      Returns boolean

      false if no comment is defined.

    • Returns boolean

      Use obj instanceof Variation instead.

    • NAGs associated to the current node or variation.

      Returns number[]

      array sorted in increasing order.

    • 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.

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

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

      Parameters

      • nag: number

      Returns void

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

      Parameters

      • tagKey: string

      Returns undefined | string

      AbstractNode.tags for more details on tags.

    • 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

      AbstractNode.tags for more details on tags.

    • 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