Mashmatrix Sheet
Japanese
Japanese
  • Mashmatrix Sheet ユーザガイド
  • はじめに
  • アプリケーションの概要
  • 基本的な使い方
  • ブックおよびシートに関する機能
    • ブックの新規作成
    • ブックの設定変更
    • ブックの複製
    • ブックの削除
    • ブックを新しいタブで開く
    • ブックの移動
    • ブックの画面分割
    • シートの新規作成
    • シートのタブ表示順序の変更
    • シートの設定
      • シートの設定 - 基本
      • シートの設定 - オプション
      • シートの設定 - フィルタ
      • シートの設定 - 列
      • シートの設定 - 書式
      • シートの設定 - アクション
    • シートの最大化
    • シートの非表示
    • シートの複製
    • シートの削除
    • 連動シートの作成
    • カード形式のシートの作成
    • カード形式のシートの設定
    • ビューの設定
    • フォームの設定
  • データ表示に関する機能
    • 列の順序の変更
    • 列の表示幅/高さの変更
    • スクロール時の列の固定表示
    • ソート
    • フィルタ
    • 列の設定
      • 列の設定 - 基本情報
      • 列の設定 - オプション
      • 列の設定 - 書式設定
      • 列の設定 - アクション
    • 列の表示/非表示
    • 列の追加
    • 列の削除
    • 列全体の表示設定
    • 列ヘッダのグループ化
    • 行のグループ化
    • 集計行
    • 数式
    • 関数
      • Salesforce互換の関数
      • 集計関数
      • その他の拡張関数
    • 参照値
    • ページ移動および再読み込み
  • データ編集に関する機能
    • 表示データの編集と保存
    • 値のコピー&ペースト
    • レコードの新規作成
    • レコードの複製
    • レコードの削除
    • レコードの色の変更
    • ルックアップ編集と検索
    • 更新挿入モードでの作業
  • アクションに関する機能
    • アクションボタン
    • 標準アクション
    • マーケティングアクション
    • カスタムアクション
    • 承認申請アクション
  • 高度な機能
    • 時系列マトリックス変換
      • 概要
      • マトリックス列の追加
      • マトリックス列の設定
      • 列の表示/非表示
      • 内部列の追加
      • 内部列の削除
      • 書式設定
      • マトリックス列と数式
      • マトリックス列と参照値
      • 制限事項
    • スクラッチデータシート
  • 管理者による設定
    • ライセンスの割当
    • 権限セットの付与
    • 管理コンソール
      • ブックの管理
      • 権限
      • アクセス制御
      • 組織設定
  • カスタマイズ
    • URLでのシートへのアクセス
    • Sheetコンポーネント
    • Message Channel APIによる連携アプリケーションの開発
    • 動的インタラクションによるコンポーネント間連携
    • Visualforceを利用したシートの埋め込み
    • VisualforceページでのSheetの利用
    • JavaScript API
    • Apexコード / Visualforceページの起動
    • フローの起動
    • Platform Event API によるユーザ操作の捕捉
    • Experience Cloudでの利用
Powered by GitBook
On this page
  • APIメソッド
  • setApplicationParameter(params, options)
  • updateApplicationParameter(params, options)
  • subscribeComponentEvent(compId, path, event, listener)
  • unsubscribeComponentEvent(compId, path, event, listener)
  • イベントの種類
  • selectRecords
  • loadComplete
  • focusCell
  1. カスタマイズ

JavaScript API

PreviousVisualforceページでのSheetの利用NextApexコード / Visualforceページの起動

Last updated 3 years ago

msmxSheet:SheetViewコンポーネントをVisualforceページに配置することで、ページ内に MsmxSheet JavaScriptオブジェクトがグローバルに公開されます。このオブジェクトからAPI呼び出しを行うことで、Sheetの動作および描画を動的に制御することが可能です。

APIメソッド

setApplicationParameter(params, options)

Sheetアプリケーションに対してアプリケーションパラメータを設定します。アプリケーションパラメータはフィルタの値指定の際に参照値として指定が可能です。フィルタに該当するパラメータの参照値が設定されている場合、フィルタの値は参照しているパラメータの値に置き換えられ、自動的にシート表示がリフレッシュされます。

テキスト型やID型のフィルタ、および高度なフィルタ設定では、アプリケーションパラメータの値を参照値として指定し、フィルタの値として利用することができます。詳しくはを参照してください。

// パラメータ名と値のkey valueペアを引数に渡す
MsmxSheet.setApplicationParameter({
  Name: 'Salesforce',
  Type: ['Partner', 'Customer'] // パラメータが複数値を持つ場合は配列で渡します
});

// Typeパラメータを未設定に変更
MsmxSheet.setApplicationParameter({
  Name: 'Salesforce'
}, {
 forceLoad: true // 更新がない場合でもパラメータに依存しているシートのリフレッシュを行う
});

パラメータ

  • params - (必須) アプリケーションパラメータ名と設定する値をKey-Valueペアで設定する

  • options - (オプション) オプション。forceLoadフラグを設定することでリフレッシュを強制することが可能

updateApplicationParameter(params, options)

Sheetアプリケーションに設定されているアプリケーションパラメータを更新します。 setApplicationParameterとの違いは、指定されたパラメータ名の値のみを置き換え、それ以外のパラメータは設定されたままとなる点です。

// 最初はアプリケーションパラメータ未設定の状態

MsmxSheet.updateApplicationParameter({
  Name: 'Mashmatrix'
});
// => { Name: 'Mashmatrix }

MsmxSheet.updateApplicationParameter({
  Type: ['Customer']
});
// => { Name: 'Mashmatrix, Type: ['Customer'] }

// 設定済みのパラメータ設定をクリアする場合はundefinedを設定する
MsmxSheet.updateApplicationParameter({
  Name: undefined
});
// => { Type: ['Customer'] }

パラメータ

  • params - (必須) 更新対象となるアプリケーションパラメータ名とその値をKey-Valueペアで設定する

  • options - (オプション) オプション。forceLoadフラグを設定することでリフレッシュを強制することが可能

subscribeComponentEvent(compId, path, event, listener)

msmxSheet:SheetViewコンポーネント内で表示されているシートから通知されるイベントを購読するリスナを設定します

<msmxSheet:SheetView
  id="comp-01"
  bookId="a002800001O6vOpAAJ"
  sheetID="s1"
  width="100%" height="400px"
/>
// シートのレコードロード完了時のイベントを購読
MsmxSheet.subscribeComponentEvent(
  'comp-01',
  'a002800001O6vOpAAJ/s1',
  'loadComplete',
  function(res) {
    console.log(res.records); // ロードしたレコードの一覧
  }
);

// シートのレコード選択が変更されたときのイベントを購読
MsmxSheet.subscribeComponentEvent(
  'comp-01',
  'a002800001O6vOpAAJ/s1',
  'selectRecords',
  function(res) {
    console.log(res.records); // レコード選択チェックボックスで選択したレコードの一覧
  }
);

パラメータ

  • compId - (必須) 対象とするコンポーネントのID (msmxSheet:SheetViewのid属性で指定)

  • path - (必須) Book IDとSheet IDを"/"で連結したもの

  • event - (必須) 購読するイベント名

  • listener - (必須) イベントが通知されるリスナー関数

unsubscribeComponentEvent(compId, path, event, listener)

msmxSheet:SheetViewコンポーネント内で表示されているシートから発火されるイベントの購読を解除します

パラメータ

  • compId - (必須) 対象とするコンポーネントのID (msmxSheet:SheetViewのid属性で指定)

  • path - (必須) Book IDとSheet IDを"/"で連結したもの

  • event - (必須) 購読しているイベント名

  • listener - (オプション) 購読解除するリスナー関数。未指定の場合は該当するイベントに対するすべての既存購読が解除対象となる

イベントの種類

selectRecords

シートのレコード選択が変更されたときに通知されるイベント

イベントパラメータ

  • records - 選択されたレコードをリスト形式で返します

loadComplete

シートのレコードロードが完了したときに通知されるイベント

イベントパラメータ

  • records - ロードしたレコードの一覧をリスト形式で返します

focusCell

シート内のセルがクリックなどによってフォーカスされたときに通知されるイベント

イベントパラメータ

  • cell - フォーカスされたセルの情報が格納されています

    • recordId - セルに表示されているレコードのID

    • colIndex - セルの列インデックス位置

    • rowIndex - セルの行インデックス位置(全ページ中)

    • value - セル内に表示されている値

「フィルタでの参照値の利用」