レコード一覧情報取得

フォローする

Index

レコード一覧のクエリ文字列を取得する

現在開いてるレコード一覧の絞り込み情報をクエリ文字列で取得できます。

  • PC用のみで利用できます。
  • スペースに貼りつけたアプリでは利用できません。
  • 表示件数(limit)や表示開始位置(offset)を取得するには こちら を利用します。
  • アプリの動作確認テスト画面、スペース内アプリも含まれます。
  • 複数の条件の括弧がandやorでつなげられたクエリの場合、各括弧内の条件は最大で14個です。15個以上を指定したクエリの場合はエラーが発生します。表示するレコードの条件を指定と組み合わせて利用する場合にご注意ください。
      例:(xxx1 like "test" or xxx2 like "test") and (xxx1 like "test" or xxx2 like "test")
      →この時、左側と右側の各括弧内の条件は最大で14条件となります。

関数

kintone.app.getQueryCondition()

引数

なし

返り値

  • 文字列または null が返ります。
  • レコード一覧画面で絞り込み条件がない場合は空文字列が返ります。
  • 利用できない画面では null が返ります。

サンプル

 

利用できる画面

  • レコード一覧画面
  • グラフ画面

レコード一覧のクエリ文字列を取得する(order by, limit, offset付き)

現在開いてるレコード一覧の絞り込み情報をクエリ文字列(order by, limit, offset付き)で取得します。

  • PC用のみで利用できます。
  • スペースに貼りつけたアプリでは利用できません。
  • アプリの動作確認テスト画面、スペース内アプリも含まれます。

関数

kintone.app.getQuery()

引数

なし

返り値

  • 文字列または null が返ります。
  • 利用できない画面では null になります。
  • 絞り込みがない場合は、ソート順(order by)、表示件数(limit)、位置(offset)のクエリ文字列が返ります。 ※レコード一覧画面のみ
  • ソート条件がない場合は、表示件数(limit)、位置(offset)のみのクエリ文字列が返ります。 ※レコード一覧画面のみ

サンプル

利用できる画面

  • レコード一覧画面
  • グラフ画面

フィールド要素を取得する

フィールドコードを指定して、レコード一覧から対応するフィールド要素の配列を取得します。

  • PC用のみで利用できます。
  • スペースに貼りつけたアプリでは利用できません。
  • アプリの動作確認テスト画面、スペース内アプリも含まれます。
  • 取得した DOM の style(装飾するための DOM)はサポート対象ですが、それ以外はサポート対象外となります
  • DOM の内部構造を変更するような処理を行うと、kintone のバージョンアップ後に動作しなくなる可能性があります

関数

kintone.app.getFieldElements(fieldCode)

引数

パラメータ名 指定する値 必須 説明
fieldCode 文字列 必須 取得するフィールドのフィールドコードを指定します。

返り値

  • フィールド要素の配列または null が返ります。
  • 利用できない画面では null になります。
  • レコードが 1件もない場合は空配列が返ります。
  • 該当するフィールドがない場合、表示されていないフィールドを指定した場合は null が返ります。

サンプル

取得できないフィールド

以下のフィールドを指定した場合は null が返ります。

  • テーブル
  • テーブルに含まれるフィールド

利用できる画面

  • レコード一覧画面

その他

インライン編集中の状態で関数を使用した場合、編集 UI を含む要素が返ります。

レコード一覧のメニューの右側の空白部分の要素を取得する

  • PC用のみで利用できます。
  • スペースに貼りつけたアプリでは利用できません。

関数

kintone.app.getHeaderMenuSpaceElement()

引数

なし

返り値

  • メニュー(追加・一覧・絞り込み・グラフ)の右側の空白部分の要素を返します。
  • レコード一覧画面以外ではnullを返します。

サンプル

レコード一覧のメニューの下側の空白部分の要素を取得する

  • PC用のみで利用できます。
  • スペースに貼りつけたアプリでは利用できません。

関数

kintone.app.getHeaderSpaceElement()

引数

なし

返り値

  • メニュー(追加・一覧・絞り込みなど)とレコード一覧の間の空白部分の要素を返します
  • レコード一覧画面以外では null を返します。

サンプル

関連レコード一覧の参照先のアプリIDを取得する

関連レコード一覧のフィールドコードを指定して、参照先のアプリIDを取得します。

  • PC用のみで利用できます。
  • スペースに貼りつけたアプリでは利用できません。

詳細は、レコード詳細情報取得 をご覧ください。

ルックアップフィールドの参照先のアプリIDを取得する

ルックアップフィールドのフィールドコードを指定して、参照先のアプリIDを取得します。

  • PC用のみで利用できます。
  • スペースに貼りつけたアプリでは利用できません。

詳細は、レコード詳細情報取得 をご覧ください。

ヘッダーの下側の空白部分の要素を取得する

  • スマートフォン用のみで利用できます。
  • スペースに貼りつけたアプリでは利用できません。

 

詳細は、ヘッダーの下側の空白部分の要素を取得する をご覧ください。

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk