この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

ウィジェットパラメータのプロパティリファレンス

widgets セクションの params プロパティは、ダッシュボードのウィジェットの属性を定義します。各ウィジェットには独自の params プロパティがあります。

各ウィジェットに使用できるパラメータは、ウィジェットの type プロパティによって異なります。たとえば、ChartWidget には legend パラメータを指定できますが、TextWidget には指定できません。

一部のパラメータは公開され、ダッシュボードデザイナのユーザインターフェースでウィジェットプロパティとして編集できます。他のパラメータは JSON を介してのみ編集できます。

ダッシュボード JSON ファイルの抜粋である次の例では、1 つの ChartWidget を持つダッシュボードを示します。ChartWidget には、miniBarschartTypesqrtstep という 4 つの一連のパラメータがあります。

1"widgets": {
2  "chart_1": {
3    "params": {
4      “miniBars”: 14,
5      “chartType”: “vbar”,
6      “sqrt”: true,
7      "step": "Customer_Name_1"
8    },
9    "type": "ChartWidget",
10    "pos": {
11      "w": 1000,
12      "zIndex": 0,
13      "y": 20,
14      "h": 500,
15      "x": 20
16    }
17  }
18}

params プロパティで設定されるウィジェットプロパティは、次のとおりです。

プロパティ名 詳細
backgroundColor
string
このウィジェットで使用可能
  • BoxWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
背景色。

rgb(a, b, c, d) の形式で色を指定します。

0 ~ 255 の数値を使用し、a は色の赤の度合い、b は緑の度合い、c は青の度合いを示します。0 の値は色がないことを示し、255 の値は色の度合いが最大であることを示します。

0 ~ 1 の数値を使用し、d は透明度を示します。0 の値は透明を示し、1 の値は不透明を示します。

たとえば、rgb(0, 0, 0, 0.93) は不透明の黒に近い色に設定します。rgb(255, 0, 0, 0.14) は透明に近い赤色に設定します。

または、16 進表記を使用して色を設定することもできます。16 進表記を使用する場合、透明度は設定できません。デフォルトでは、16 進表記の色がすべて不透明になります。#000000 は 16 進表記の黒を示します。#ff0000 は赤を示します。

デフォルト値は、rgba(0, 140, 201, 0.35) です。

borderColor
string
このウィジェットで使用可能
  • BoxWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
境界線の色。

rgb(a, b, c, d) の形式で色を指定します。

0 ~ 255 の数値を使用し、a は色の赤の度合い、b は緑の度合い、c は青の度合いを示します。0 の値は色がないことを示し、255 の値は色の度合いが最大であることを示します。

0 ~ 1 の数値を使用し、d は透明度を示します。0 の値は透明を示し、1 の値は不透明を示します。

たとえば、rgb(0, 0, 0, 0.93) は不透明の黒に近い色に設定します。rgb(255, 0, 0, 0.14) は透明に近い赤色に設定します。

または、16 進表記を使用して色を設定することもできます。16 進表記を使用する場合、透明度は設定できません。デフォルトでは、16 進表記の色がすべて不透明になります。#000000 は 16 進表記の黒を示します。#ff0000 は赤を示します。

デフォルト値は、rgba(0,0,0,0.25) です。

compact
boolean
次のウィジェットで使用可能
  • ListSelector
  • NumberWidget
  • PillBox
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
表示する数値を短縮するか (true)、否か (false) を示します。

たとえば、true の場合、数値 48,081 は 48k と表示されます。数値は丸められているように見えますが、そうではありません。演算を行ったりグラフで使用したりする場合には、値 48,081 が保持されます。false の場合、48,081 は 48,081 と表示されます。

デフォルト値は、false です。

chartType
ConnectWaveChartTypeEnum
次のウィジェットで使用可能
  • ChartWidget
  • LinkWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
データの表示に使用されるグラフの種類。値は次のとおりです。
  • calheatmap — カレンダーヒートマップ
  • hbar — 横棒
  • hdot — 横方向のドットプロット
  • heatmap — ヒートマップ
  • matrix — マトリックス
  • parallelcoords — 平行座標
  • pie — ドーナツ
  • pivottable — ピボットテーブル
  • scatter — 散布図
  • stackhbar — 積み上げ横棒
  • stackvbar — 積み上げ縦棒
  • time — タイムライン
  • hdot — 縦方向のドットプロット
  • vbar — 縦棒
destType
ConnectWaveLinkWidgetDestTypeEnum
このウィジェットで使用可能
  • LinkWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
リンクの対象種別。値は次のとおりです。
  • dashboard — 保存されたダッシュボード
  • explore — 未保存で有効なレンズの探索セッション
  • lens — 保存されたレンズ

デフォルト値は、lens です。

destination
string
このウィジェットで使用可能
  • LinkWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
ダッシュボードまたはレンズの ID。

デフォルト値は、null です。

expanded
boolean
次のウィジェットで使用可能
  • DateSelector
  • ListSelector
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
リスト内の項目を表示するか (true)、非表示にするか (false) を示します。

非表示 (false) の場合、ダッシュボード閲覧者はリストウィジェットをクリックして、リスト項目を表示および変更できます。

デフォルト値は、true です。

exploreLink
boolean
次のウィジェットで使用可能
  • ChartWidget
  • CompareTable
  • ListSelector
  • PillBox
  • ValuesTable
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
ダッシュボード閲覧者がリンクをクリックしてレンズとしてのウィジェットの探索を開始できるか (true)、否か (false) を示します。
デフォルト値は、次のとおりです。
  • ChartWidget: コンパクトフォームレンズに関連付けられているグラフの場合は true、SAQL の場合は false
  • CompareTable: コンパクトフォームレンズに関連付けられているグラフの場合は true、SAQL の場合は false
fit
boolean
このウィジェットで使用可能
  • ChartWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
グラフの軸がデータの中心にあるか (true)、(0, 0) にあるか (false) を示します。

chartTypehdot (横方向のドットプロット)、vdot (縦方向のドットプロット)、parallelcoords (座標グラフ)、または scatter (散布図) に設定されている場合にのみ適用されます。

デフォルト値は、false です。

fontSize
整数
次のウィジェットで使用可能
  • NumberWidget
  • TextWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
数値またはテキストのフォントサイズ。
デフォルト値は、次のとおりです。
  • NumberWidget: 36
  • TextWidget: 26
hideHeaderColumn
boolean
次のウィジェットで使用可能
  • ChartWidget
  • ValuesTable
ダッシュボードデザイナのユーザインターフェースで公開
いいえ。JSON を介してのみ編集できます。
説明
未加工データテーブルの最初の列 (行カウント) を非表示にするか (true)、否か (false) を示します。

デフォルト値は、false です。

imgUrl
ConnectUri
このウィジェットで使用可能
  • BoxWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
表示された画像ファイルのドキュメント Id。セキュリティを保護するため、画像ファイルをドキュメントとして Salesforce にアップロードする必要があります。ドキュメントが画像でないか、対応するドキュメントが存在しない場合は、何も表示されません。

デフォルト値は、null です。

includeState
boolean
このウィジェットで使用可能
  • LinkWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
ダッシュボード閲覧者によって適用された選択内容を閲覧者がリンクをクリックした後で destination に保持するか (true)、否か (false) を示します。選択内容に destination との互換性がないか、null の場合は、保持されません。

デフォルト値は、false です。

instant
boolean
次のウィジェットで使用可能
  • DateSelector
  • ListSelector
  • RangeSelector
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
ダッシュボード閲覧者がウィジェットを操作するときに、facet が設定された他のウィジェットをすぐに更新するか (true)、否か (false) を示します。

false の場合、facet が設定されたウィジェットに変更をカスケードするには、ダッシュボード閲覧者が [更新] をクリックする必要があります。true の場合、[更新] ボタンは非表示になります。

デフォルト値は、次のとおりです。
  • DateSelector: false
  • ListSelector: true
  • RangeSelector: false
legend
boolean
このウィジェットで使用可能
  • ChartWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
凡例を表示するか (true)、否か (false) を示します。

デフォルト値は、ピボットテーブルを除くすべてのグラフで false です。

legendHideHeader
boolean
このウィジェットで使用可能
  • ChartWidget
ダッシュボードデザイナのユーザインターフェースで公開
いいえ。JSON を介してのみ編集できます。
説明
凡例にタイトルがあるか (true)、否か (false) を示します。タイトルは常に、凡例に記述されたディメンションの名前になります。

デフォルト値は、ピボットテーブルを除くすべてのグラフで false です。

legendWidth
整数
このウィジェットで使用可能
  • ChartWidget
ダッシュボードデザイナのユーザインターフェースで公開
いいえ。JSON を介してのみ編集できます。
説明
凡例領域の幅 (ピクセル単位)。

デフォルト値は、ピボットテーブルを除くすべてのグラフで 145 です。

maxColumnWidth
整数
次のウィジェットで使用可能
  • ChartWidget (chartTypehbarheatmappivottablescatterstackhbarstackvbar、または vbar の場合のみ)
  • CompareTable
  • ValuesTable
ダッシュボードデザイナのユーザインターフェースで公開
いいえ。JSON を介してのみ編集できます。
説明
ディメンション項目の表示サイズの最大値 (ピクセル単位)。

デフォルト値は、200 です。

measureField
string
次のウィジェットで使用可能
  • ListSelector
  • NumberWidget
  • PillBox
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
データで実行する数学的関数。

<formula>_<field> の形式で measureField を指定します。

<formula> は、measures step プロパティで指定されたいずれかの数式と一致する必要があります。<formula> に使用できる値は、次のとおりです。
  • avg — 数学的平均値 (中間値) を計算します
  • max — 最大値
  • min — 最小値
  • sum — すべての値を加算します
  • unique — 一意の値の数をカウントします

<field> は、measures で指定された <formula> とペアになっているディメンションの名前と一致する必要があります。

たとえば、measures ステップのプロパティが次のようになっているとします。

1"measures”: [
2  [
3    "sum”,
4    "Profit”
5  ],
6  [
7    "avg”,
8    "Discount”
9  ]
10]

この場合、measureFieldsum_Profit または avg_Discount である必要があります。avgProfitmeasures step プロパティでペアになっていないため、measureFieldavg_Profit にすることはできません。

デフォルト値は、null です。

minColumnWidth
整数
このウィジェットで使用可能
  • ChartWidget (chartTypehbarheatmappivottablescatterstackhbarstackvbar、または vbar の場合のみ)
  • CompareTable
  • ValuesTable
ダッシュボードデザイナのユーザインターフェースで公開
いいえ。JSON を介してのみ編集できます。
説明
ディメンション項目の表示サイズの最小値 (ピクセル単位)。

デフォルト値は、30 です。

miniBars
整数
このウィジェットで使用可能
  • ChartWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
棒グラフでの棒の表示サイズ (ピクセル単位)。

デフォルト値は、0 です (棒グラフと縦棒グラフでのみ使用可能)。

multiMetrics
boolean
このウィジェットで使用可能
  • ChartWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
2 つ以上の基準を各グループの下に隣接する棒として表示するか (true)、個別の隣接するグラフとして表示するか (false) を示します。

デフォルト値は、false です (棒グラフと縦棒グラフでのみ使用可能)。

normalize
boolean
このウィジェットで使用可能
  • ChartWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
グラフを対数スケールを使用して表示するか (true)、線形スケールを使用して表示するか (false) を示します。

デフォルト値は、false です (stackhbarstackvbar でのみ使用可能)。

splitAxis
boolean
このウィジェットで使用可能
  • ChartWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
グラフの各ディメンションを独自の軸で測定するか (true)、共有軸で測定するか (false) を示します。

multiMetricstrue に設定されている場合にのみ適用されます。

デフォルト値は、false です (棒グラフと縦棒グラフでのみ使用可能)。

sqrt
boolean
このウィジェットで使用可能
  • ChartWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
グラフを対数スケールを使用して表示するか (true)、線形スケールを使用して表示するか (false) を示します。

デフォルト値は、false です (棒グラフ、縦棒グラフ、折れ線グラフ、時系列でのみ使用可能)。

step
string
次のウィジェットで使用可能
  • CompareTable
  • DateSelector
  • GlobalFiltersWidget
  • ListSelector
  • NumberWidget
  • PillBox
  • RangeSelector
  • ValuesTable
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
ウィジェットにデータを提供するレンズの名前。

デフォルト値は、null です。

stretch
boolean
このウィジェットで使用可能
  • BoxWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
画像の幅と高さをウィジェットの幅と高さと同じ値に設定するか (true)、否か (false) を示します。

デフォルト値は、false です。

text
string
このウィジェットで使用可能
  • TextWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
テキストウィジェットに表示するメッセージ。たとえば、text“Hello, World!” という値が割り当てられている場合、テキストウィジェットに「Hello, World!」と表示されます。

デフォルト値は、null です。

textAlignment
string
このウィジェットで使用可能
  • NumberWidget
  • TextWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
テキストの配置。使用できる値には、leftcenter、および right があります。値が指定されない場合、テキストの配置はデフォルトの中央揃えになります。
デフォルト値は、次のとおりです。
  • NumberWidget: right
  • TextWidget: center
textColor
string
次のウィジェットで使用可能
  • NumberWidget
  • TextWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明

テキストのフォントの色。

rgb(a, b, c, d) の形式で色を指定します。

0 ~ 255 の数値を使用し、a は色の赤の度合い、b は緑の度合い、c は青の度合いを示します。0 の値は色がないことを示し、255 の値は色の度合いが最大であることを示します。

0 ~ 1 の数値を使用し、d は透明度を示します。0 の値は透明を示し、1 の値は不透明を示します。

たとえば、rgb(0, 0, 0, 0.93) は不透明の黒に近い色に設定します。rgb(255, 0, 0, 0.14) は透明に近い赤色に設定します。

または、16 進表記を使用して色を設定することもできます。16 進表記を使用する場合、透明度は設定できません。デフォルトでは、16 進表記の色がすべて不透明になります。#000000 は 16 進表記の黒を示します。#ff0000 は赤を示します。

デフォルト値は、#000 です。

title
string
次のウィジェットで使用可能
  • DateSelector
  • ListSelector
  • NumberWidget
  • PillBox
  • RangeSelector
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
ウィジェットのタイトル。

デフォルト値は、null です。

totals
boolean
次のウィジェットで使用可能
  • ChartWidget
  • CompareTable
  • ValuesTable
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
基準列にすべての値の合計を表示する行を含めるか (true)、否か (false) を示します。

CompareTableValuesTable に常に適用されます。ChartWidgetpivottable に設定されている場合は、ChartWidget にのみ適用できます。

ChartWidget のデフォルト値は、false です (ピボットテーブルでのみ使用可能)。

trellis
boolean
このウィジェットで使用可能
  • ChartWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
レンズに 2 つ以上のグループと 1 つの基準がある場合、最後に適用されたグルーピングを独自の軸に表示するか (true)、他のグルーピングと同じ軸に表示するか (false) を示します。

ChartWidget のデフォルト値は、false です (棒グラフと縦棒グラフでのみ使用可能)。

videoSize
string
このウィジェットで使用可能
  • YoutubeWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
YouTube ビデオのサイズ。値は次のとおりです。
  • (4/3) 240 x 180
  • (4/3) 420 x 315
  • (4/3) 480 x 360
  • (4/3) 640 x 480
  • (4/3) 960 x 720
  • (16/9) 320 x 180
  • (16/9) 560 x 315
  • (16/9) 640 x 360
  • (16/9) 853 x 480
  • (16/9) 1280 x 720

デフォルト値は、(4/3) 240 x 180 です。

youtubeUrl
ConnectUri
このウィジェットで使用可能
  • YoutubeWidget
ダッシュボードデザイナのユーザインターフェースで公開
はい
説明
YouTube ビデオの URL。

デフォルト値は、null です。