xbot.app.databook

この記事の内容
  1. メソッド
  2. get_row()
  3. set_row()
  4. append_row()
  5. insert_row()
  6. remove_row()
  7. get_cell()
  8. set_cell()
  9. set_column()
  10. clear()
  11. get_row_count()
  12. get_range()
  13. set_range()

Dr.Roboに組み込まれているデータテーブルを操作します(行の内容の取得、データテーブルへの行の内容の書き込みなど)。

メソッド

get_row()

データテーブルの指定行の内容を取得します。

get_row(row_num)

入力パラメータ

row_num:取得する行番号を指定します。行番号は1から始まります。

戻り値

List[str]:読み取った内容をリストで返します。例:['a', 'b', 'c', 'd']です。

例1

from xbot import app
def main(args):
    list_value = app.databook.get_row(1)
    print(list_value)

この例の実行ロジック: データテーブルの1行目の内容を読み取ります。 --> 取得結果を出力します。

set_row()

データテーブルの指定列に行の内容を書き込みます。

set_row(row_num, values, begin_column_name = 'A')

パラメータ

row_num:設定するデータテーブルの行番号です。行番号は1から始まります。

values:設定する値です。['a', 'b', 'c']のような文字列のリスト型である必要があります。

begin_column_name:データを書き込む開始列の名前です。省略すると、デフォルト値は"A"です。

戻り値

なし

例1

from xbot import app
def main(args):
    app.databook.set_row(1, ['hello world'], begin_column_name = 'A')

この例の実行ロジック: データテーブルの1行目のA列に「hello world」を書き込みます。

append_row()

データテーブルに1行分の内容を追加します。

append_row(values, begin_column_name = 'A')

入力パラメータ

values:設定する値です。リスト型である必要があります。

begin_column_name:設定を開始するセルの開始列です。省略すると、デフォルト値は"A"です。

戻り値

なし

例1

from xbot import app
def main(args):
    app.databook.append_row([1,2,3,4,5,6,7,8,9,0], begin_column_name = 'B')

この例の実行ロジック: データテーブルの末尾に1行分の内容を追加します。書き込みを開始するセルの列名はB、内容は[1,2,3,4,5,6,7,8,9,0]です。

insert_row()

データテーブルに1行分の内容を挿入します。

insert_row(row_num, values, begin_column_name = 'A')

入力パラメータ

row_num:挿入位置の行番号です。行番号は1から始まります。

values:設定する値です。リスト型である必要があります。

begin_column_name:書き込みを開始するセルの開始列です。省略すると、デフォルト値は"A"です。

戻り値

なし

例1

from xbot import app
def main(args):
    app.databook.insert_row(10, [0,1,2,3,4,5,6,7,8,9], begin_column_name = 'A')

この例の実行ロジック: データテーブルの10行目に、A列から' 0-9 'の10個の数字を書き込みます。

remove_row()

データテーブルの指定行の内容を削除します。

remove_row(row_num)

入力パラメータ

row_num:削除する行番号です。

戻り値

なし

例1

from xbot import app
def main(args):
    app.databook.remove_row(2)

この例の実行ロジック: データテーブルの2行目の内容を削除します。

get_cell()

データテーブルの指定セルの内容を取得します。

get_cell(row_num, col_name)

パラメータ

row_num:指定セルの行番号です。

col_name:指定セルの列名です。

戻り値

str:データテーブルの指定セルの内容です。

例1

from xbot import app
def main(args):
    value = app.databook.get_cell(2, 'B')
    print(value)

この例の実行ロジック: データテーブルの2行目のB列のセルの内容を取得します。 --> 取得結果を出力します。

set_cell()

データテーブルの指定セルに内容を書き込みます。

set_cell(row_num, col_name, value)

パラメータ

row_num:セルの行番号です。

col_name:セルの列名です。

value:セルに書き込む内容です。

戻り値

なし

例1

from xbot import app
def main(args):
    app.databook.set_cell(1, 'A', 'hello')

この例の実行ロジック: データテーブルの1行目のA列に文字列'hello'を書き込みます。

set_column()

データテーブルの指定列に内容を書き込みます。

set_column(col_name, values, begin_row_num = 1)

パラメータ

col_name:列名です。内容を書き込む列の位置を指定します。

values:書き込む値です。リスト型である必要があります。

begin_row_num:列の内容を書き込む開始行番号です。省略すると、デフォルトの行番号は1です。

戻り値

なし

例1

from xbot import app
def main(args):
    app.databook.set_column('A', [0,1,2,3,4,5,6,7,8,9], begin_row_num = 1)

この例の実行ロジック: データテーブルのA列の1行目から、"0-9"の10個の数字を書き込みます。

clear()

データテーブルの内容をクリアします。

clear()

パラメータ

なし

戻り値

なし

例1

from xbot import app
def main(args):
    app.databook.clear()

この例の実行ロジック: データテーブルの内容をクリアします。

get_row_count()

データテーブルの総行数を取得します(ここでは、データが書き込まれている行の総数を指します)。

get_row_count()

パラメータ

なし

戻り値

int:データテーブルの総行数です。

例1

from xbot import app
def main(args):
    count = app.databook.get_row_count()
    print(count)

この例の実行ロジック: データテーブルに現在入っているデータの総行数を取得します。 --> データテーブルの総行数を出力します。

get_range()

データテーブルの指定範囲の内容を取得します。

get_range(area_begin_row_num, area_begin_column_name, area_end_row_num, area_end_column_name)

入力パラメータ

area_begin_row_num:開始セルの行番号です。行番号は1から始まります。

area_begin_column_name:開始セルの列名です。列名はAから始まります。

area_end_row_num:終了セルの行番号です。行番号は1から始まります。

area_end_column_name:終了セルの列名です。列名はAから始まります。

戻り値

List[Tuple]:指定範囲のデータです。型は2次元リストです。

例1

from xbot import app
def main(args):
    list_value = app.databook.get_range(1, 'A', 3, 'F')
    print(list_value)

この例の実行ロジック: データテーブルのA1セルからF3セルまでの内容を取得します。 --> 指定範囲の内容を出力します。

set_range()

データテーブルの指定範囲に内容を書き込みます。

set_range(row_num, col_name, values)

入力パラメータ

row_num:範囲の内容を書き込む開始行番号です。行番号は1から始まります。

col_name:範囲の内容を書き込む開始列の名前です。列名はAから始まります。

values:設定する内容です。2次元配列である必要があります。

戻り値

なし

例1

from xbot import app
def main(args):
    app.databook.set_range(1, 'A', [['1','2','3'],['a','b','c']])

表示結果:

この例の実行ロジック: 1行目のA列に[['1','2','3'],['a','b','c']]を書き込みます。

APIリファレンスの記事一覧ページの先頭へ ↑