ホーム > リファレンス > JavaScript API > gcbg名前空間

gcbg名前空間

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

gcbg モジュール

getRaySheet function

gcbg.RaySheet クラス

showView function
showFolderView function
refreshLayout function
onSelectedRecordChanged function
setUserFilterProvider function
setUserFilterProviderContext function
setDisplaySettingItemValue function
getDisplaySettingItemValue function
setAllDisplaySettings function
getAllDisplaySettings function

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

Visualforceページ開発

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 refreshLayout()

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

パラメータ

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

戻り値

戻り値はありません。

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

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

パラメータ

handler

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

戻り値

戻り値はありません。

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形式の文字列。