gcbg名前空間

このセクションでは、JavaScript APIのgcbgメンバ インターフェースについて詳述しています。 gcbgのメンバでは、次のJavaScriptインターフェースを提供します。

gcbg モジュール

gcbg.RaySheet クラス

gcbg.RaySheet.actions クラス

gcbgのメンバの具体的な利用例は次のページを参照してください。

gcbg モジュール

function getRaySheet(id: string | number)

RaySheetオブジェクトを取得します。

パラメータ

  • id

    NumberまたはString型です。このパラメータはオプションです。idが未設定の場合は、現在のページの最初のRaySheetオブジェクトを返します。それ以外の場合は、idがインデックスまたはDOM idとして使用され、RaySheetオブジェクトが検索されます。

戻り値

取得したRaySheetオブジェクトを返します。指定したidが見つからない場合はnullを返します。

gcbg.RaySheet クラス

function showView(object: string, viewId: string)

RaySheetに指定したオブジェクトとビューを表示します。指定したオブジェクトまたはビューが見つからない場合、または権限がない場合には警告ダイアログを表示します。オブジェクトモードの場合のみ使用できます。

パラメータ

  • object

    表示するオブジェクトを示すString型の値です。有効なSalesforce SObject API名である必要があります。

  • viewId

    表示するRaySheetのビューのSalesforce idを示すString型の値です。このパラメータはオプションです。ビューは、指定されたオブジェクトに対してデザインする必要があります。指定されていない場合、このオブジェクトの最初に見つかったビューが表示されます。

戻り値

戻り値はありません。

function showFolderView(folderId: string, viewId: string)

RaySheetに指定したフォルダとビューを表示します。指定したフォルダまたはビューが見つからない場合、または権限がない場合には警告ダイアログを表示します。フォルダモードの場合のみ使用できます。

パラメータ

  • folderId

    表示するフォルダのSalesforce idを示すString型の値です。有効なフォルダである必要があります。そうでない場合、ローカルストレージで最後に選択されたフォルダが見つかるか、現在の組織の最初のフォルダーが表示されます。

  • viewId

    表示するRaySheetのビューのSalesforce idを示すString型の値です。このパラメータはオプションです。ビューは、指定されたフォルダに対してデザインする必要があります。指定されていない場合、このオブジェクトの最初に見つかったビューが表示されます。

戻り値

戻り値はありません。

function getViewMode()

現在のビューのビューモードを取得します。

パラメータ

パラメータはありません。

戻り値

  • “SheetMode”

    現在のビューがシートモードである場合

  • “PivotMode”

    現在のビューがピボットモードである場合

function refreshLayout()

RaySheetのレイアウトを更新するときに使用します。既定ではWebブラウザのリサイズ後にRaySheetが配置されますが、DOMコンテナが変更された場合には、手動でレイアウトを更新する必要があります。

パラメータ

パラメータはありません。

戻り値

戻り値はありません。

function onSelectedRecordChanged(handler: (id: string) => void)

シートの選択されたレコードが変更されたときにonSelectedRecordChangedを使用してコードを実行できます。ピボットモードでは使用できません。

パラメータ

  • handler

    レコード変更イベントのハンドラーを示す関数型の値です。文字列型の入力パラメーターを持ち、戻り値のない関数でなければなりません。

戻り値

戻り値はありません。

function onSaved(handler: (updatedResult: UpdatedResult) => void)

シートのレコードを保存したときにonSavedを使用してコードを実行できます。

パラメータ

  • handler

    レコード保存イベントのハンドラーを示す関数型の値です。UpdatedResult型の入力パラメーターを持ち、戻り値のない関数でなければなりません。

    UpdatedResult型

    メンバ 型 説明
    totalCount number 処理対象レコードの総数
    successCount number 処理に成功したレコードの数
    failedCount number 処理に失敗したレコードの数
    cancelCount number 処理をキャンセルしたレコードの数
    errorMessages string[] 失敗したレコードのエラーメッセージ
    isMasterTable boolean 更新されたエリアがメインのエリアか、「シートモードの関連オブジェクト」または「ピボットモードの詳細エリア」かを示します。メインのエリアであれば真。それ以外の場合は「シートモードの関連オブジェクト」または「ピボットモードの詳細エリア」です。 
    
UpdatedResult
{
    totalCount: number,
    successCount: number,
    failedCount: number,
    cancelCount: number,
    errorMessages: string[],
    isMasterTable: boolean,
}

戻り値

戻り値はありません。

function onDeleted(handler: (updatedResult: UpdatedResult) => void)

シートのレコードが削除されたときにonDeletedを使用してコードを実行できます。

パラメータ

  • handler

    レコード削除イベントのハンドラーを示す関数型の値です。UpdatedResult型の入力パラメーターを持ち、戻り値のない関数でなければなりません。

    UpdatedResult型

    メンバ 型 説明
    totalCount number 処理対象レコードの総数
    successCount number 処理に成功したレコードの数
    failedCount number 処理に失敗したレコードの数
    cancelCount number 処理をキャンセルしたレコードの数
    errorMessages string[] 失敗したレコードのエラーメッセージ
    isMasterTable boolean シートモードの場合、更新されたエリアがメインのエリアか、関連オブジェクトかを示します。メインのエリアであれば真。それ以外の場合は関連オブジェクトです。
    ピボットモードの場合は常に偽です。    		 
    UpdatedResult
{
    totalCount: number,
    successCount: number,
    failedCount: number,
    cancelCount: number,
    errorMessages: string[],
    isMasterTable: boolean,
}

戻り値

戻り値はありません。

function setUserFilterProvider(providerClass: string)

RaySheetのインスタンスにユーザフィルタプロバイダを設定します。

パラメータ

  • providerClass

    IUserFilterProviderインターフェースまたはIUserFilterProvider2インターフェースを実装したユーザフィルタープロバイダーのApexクラス名を示す文字列型の値です。指定されたプロバイダークラスが見つからない場合、RaySheetはユーザフィルターなしで動作します。

戻り値

戻り値はありません。

function setUserFilterProviderContext(context: Dictionary<object>)

RaySheetのインスタンスにユーザフィルタプロバイダコンテキストを設定します。このコンテキストは、ApexインターフェースIUserFilterProvider2を実装したフィルタープロバイダーで使用します。

パラメータ

  • context

    ApexインターフェースIUserFilterProvider2を実装したユーザフィルタープロバイダーで使用するパラメータを示すディクショナリ型の値です。

戻り値

戻り値はありません。

function setDisplaySettingItemValue(displaySettingItemName: string, displaySettingItemValue: string | number | boolean)

RaySheetインスタンスの指定された表示設定を設定します。

パラメータ

  • displaySettingItemName

    RaySheetインスタンスの表示設定名を示す文字列型の値です。有効なRaySheet表示設定名である必要があります。

  • displaySettingItemValue

    RaySheetインスタンスの表示設定値を示す文字列型または数値型、ブール型の値です。

戻り値

戻り値はありません。

function getDisplaySettingItemValue(displaySettingItemName: string)

RaySheetインスタンスの指定された表示設定を取得します。

パラメータ

  • displaySettingItemName

    RaySheetのインスタンスの表示設定名を示す文字列型の値です。有効なRaySheet表示設定名である必要があります。

戻り値

RaySheetインスタンスの指定された表示設定値を返します。

function setAllDisplaySettings(displaySettings: string)

指定されたすべての表示設定のjson形式の文字列をRaySheetインスタンスに対して有効にします。

パラメータ

  • displaySettings

    RaySheetインスタンスのすべての表示設定のjson形式の文字列。

戻り値

戻り値はありません。

function getAllDisplaySettings()

RaySheetインスタンスのすべての表示設定をjson形式の文字列に保存します。

パラメータ

パラメータはありません。

戻り値

RaySheetインスタンスのすべての表示設定のjson形式の文字列。

function getSelectedRecordIds()

選択されたレコードのすべてのIDをターゲットのエリアから取得します。選択されたレコードがない場合は、空の配列を返します。「シートモードの関連オブジェクト」または「ピボットモードの詳細エリア」をターゲットのエリアに指定する場合はdetailTableプロパティを使用します。

パラメータ

パラメータはありません。

戻り値

選択されたレコードのすべてのIDが格納された文字列型の配列を返します。

ターゲットのエリアの指定方法

メインのエリア（シートモードのみ）

function getSelectedIds () {
    var sheet = gcbg.getRaySheet();
    var selectedIds = sheet.getSelectedRecordIds();
    ...
}

「シートモードの関連オブジェクト」または「ピボットモードの詳細エリア」

function getSelectedIds () {
    var sheet = gcbg.getRaySheet();
    var selectedIds = sheet.detailTable.getSelectedRecordIds();
    ...
}

property detailTable

detailTableオブジェクトを取得します。

property actions

Actionオブジェクトを取得します。Actionオブジェクトを使ってgcbg.RaySheet.actionsクラスにあるインターフェイスを使用することができます。

gcbg.RaySheet.actions クラス

function refresh()

ターゲットのエリアのデータを再取得します。「シートモードの関連オブジェクト」または「ピボットモードの詳細エリア」をターゲットのエリアに指定する場合はdetailTableプロパティを使用します。

パラメータ

  • ignoreChanges

    データ再取得の前に未保存の変更のチェックを行うかどうかのブール型の値です。falseの場合は確認ダイアログが表示され、trueの場合は保存されていないすべての変更を自動的に破棄します。既定はfalse です。

戻り値

戻り値はありません。

ターゲットのエリアの指定方法

メインのエリア

function getSelectedIds () {
    var ignoreChanges = true;
    var sheet = gcbg.getRaySheet();
    sheet.actions.refresh(ignoreChanges);
}

「シートモードの関連オブジェクト」または「ピボットモードの詳細エリア」

function getSelectedIds () {
    var ignoreChanges = true;
    var sheet = gcbg.getRaySheet();
    sheet.detailTable.actions.refresh(ignoreChanges);
}
Copyright © 2024 MESCIUS inc. All rights reserved.