jkfeditor v1.3.19

JkfEditor

What is JkfEditor ?

JSON棋譜フォーマットで提供される棋譜を編集・新規作成するためのライブラリです。

Documentation

https://makibishi0212.github.io/jkfeditor/

Usage

Use with Node.js

# install
npm install --save jkfeditor

// import
import JkfEditor from "jkfeditor";

// use JkfEditor
const editor = new JkfEditor();

API

initialize

JkfEditor(jkf?, readonly?)

JkfEditorを初期化します。

// 棋譜の新規作成
const jkfeditor = new JkfEditor();

// 棋譜の編集
const jkf = {
  "header": {
    "先手": "makibishi",
    "後手": "kunai"
  },
  "moves": [
    {"comments":["初期盤面"]},
    {"move":{"from":{"x":7,"y":7},"to":{"x":7,"y":6},"color":0,"piece":"FU"}},
    {"move":{"from":{"x":3,"y":3},"to":{"x":3,"y":4},"color":1,"piece":"FU"}}
  ]
}
const neweditor = new JKfEditor(jkf)

// 閲覧のみ
const neweditor = new JKfEditor(jkf, true)

view property & method

Jkfeditorは初期化時、入力されたjkfオブジェクトをもとに、各棋譜分岐で始めに登録されている分岐をたどって指し手の配列を作成します。また、特定の指し手番号における盤面情報を保持しており、この値を変更することでその指し手が適用された時点での盤面を取得できます。

JkfEditor.go(newNum):void

newNumで指定した指し手番号に移動する。

// 現在の指し手番号を表示
console.log(jkfeditor.currentNum)

// 指し手番号を変更
jkfeditor.go(2)

//指し手番号を変更2
jkfeditor.currentNum = 2

JkfEditor.getBoardPiece(kx, ky):Object

指定座標の配置駒情報をjkfフォーマットで定められた形式で返す。

JkfEditor.getKomaMoves(fromX, fromY, reverse?):number

fromX,fromYで指定した位置の駒の移動可能座標の情報を返す。 座標情報は下記のように、移動可能座標を1、移動可能だが成る必要がある座標を2、他を0とした2次元配列で返される。

[0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 1, 0],
[0, 0, 0, 0, 0, 0, 1, 0, 0],
[0, 0, 0, 1, 0, 1, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 1, 0, 0, 0],
[0, 0, 1, 0, 0, 0, 1, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0]

[ 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
[ 2, 0, 2, 0, 0, 0, 0, 0, 0 ],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0 ],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0 ] 

JkfEditor.getMovables(reverse?):number

移動させることができる駒の座標を、移動可能座標を1、他を0とした2次元配列で返す。

JkfEditor.getPutables(komaString,reverse?):number

現在の盤面に指定の駒を持ち駒から配置することが可能な座標の情報を返す。

JkfEditor.haveFork(num):boolean

その指し手番号が次の指し手候補を複数もつ場合はtrue, そうでない場合はfalseを返す。

現在の盤面情報は以下のプロパティで取得できます。

指し手情報は以下のプロパティで取得できます。

また、下記のメソッドで情報を文字列として出力できます。

JkfEditor.dispKifuMoves():string

現在の指し手配列を表示する。

console.log(jkfeditor.dispKifuMoves())
/*
 =>

 0: 初期局面
>1: ☗7六歩
 2: ☖3四歩
 3: ☗7七桂
 4: ☖同角成
 5: ☗同角
 6: ☖3三桂打
*/

JkfEditor.dispNextMoves():string

次の指し手候補を表示する。

console.log(jkfeditor.dispNextMoves())
/*
 =>

 0: ☖3三桂
>1: ☖2二飛
*/

次の指し手を変更する場合は以下のメソッドを利用します。

JkfEditor.switchFork(forkIndex)

次の指し手を変更する。変更した場合指し手配列全体が更新される。

edit method

現在指定している盤面に対して、指し手やコメントの追加を行うことができます。readonlyをtrueにした場合、これらのメソッドは利用できません。

JkfEditor.addBoardMove(fromX,fromY,toX,toY,promote?,comment?)

盤面の駒を移動する指し手を、現在の指し手の次の指し手候補として追加する。

JkfEditor.addHandMove(komaString,toX,toY,comment?)

持ち駒から配置する指し手を、現在の指し手の次の指し手候補として追加する。

JkfEditor.deleteMove(deleteNum)

指定した番号以降の指し手を全て削除する。

JkfEditor.deleteFork(forkIndex)

現在の盤面の次の指し手候補のうち、指定したインデックスの分岐候補を削除する。

JkfEditor.addComment(comment)

現在の指し手にコメントを追加する。

JkfEditor.resetComment()

現在の指し手についたコメントをすべて削除する。

JkfEditor.addInfo(key, value)

編集中の棋譜にヘッダー情報を追加する。

JkfEditor.deleteInfo(key)

編集中の棋譜の指定したキーのヘッダー情報を削除する。

import method

JkfEditor.load(jkf)

JSON棋譜フォーマットによる棋譜を再ロードする。

export method

編集した内容を、jkfフォーマットで出力するには、以下のメソッドを利用します。

JkfEditor.export():Object

現在の状態をjkfフォーマットとして出力する。

API(Move)

Moveは指し手情報のクラスで、以下のプロパティを持ちます。

credit

このライブラリはtypescript-library-starter を利用しています