メインコンテンツまでスキップ

ダッシュボードの編集

ダッシュボードの編集は主にエンドユーザー機能ですが、開発者がさまざまな編集イベントに応答したり、UI 要素を表示/非表示にして編集エクスペリエンスを制御したり、編集を完全に無効にしたりするのに役立つ API が多数あります。

プロパティ​

availableChartTypes​

このプロパティは、表示形式を作成および編集するためにエンドユーザーが使用できるチャート タイプを定義するために使用されます。

RevealView.availableChartTypes コレクションのチャート タイプのみがエンドユーザーに表示されます。

デフォルトでは、サポートされているすべてのチャート タイプを使用できます。

少数のチャート タイプを使用する場合は、すべてのチャート タイプを削除して、使用可能にしたいチャートのみを追加する方が簡単な場合があります。これを行うには、RevealView.AvailableChartTypes プロパティを、ユーザーが利用できるようにするチャートの種類のみを含む配列に設定します。

revealView.availableChartTypes = [$.ig.RVChartType.BarChart, $.ig.RVChartType.ColumnChart];

RevealView.availableChartTypes から特定のチャート タイプを削除するには、この例のようなコードを使用して、RevealView.AvailableChartTypes から RVChartType.AreaChart、RVChartType.Indicator、および RVChartType.IndicatorTarget (KPI とも呼ばれます) を削除します。

var chartTypesToRemove = [$.ig.RVChartType.AreaChart, $.ig.RVChartType.Indicator, $.ig.RVChartType.IndicatorTarget];
revealView.availableChartTypes = revealView.availableChartTypes.filter(t => !chartTypesToRemove.includes(t));

RVChartType 列挙体の値は次のとおりです:

  • AreaChart
  • BarChart
  • BubbleChart
  • BulletGraph
  • CandlestickChart
  • Choropleth
  • ColumnChart
  • ComboChart
  • DIY
  • DoughnutChart
  • FunnelChart
  • Grid
  • Image
  • Indicator
  • IndicatorTarget
  • LabelGauge
  • LineChart
  • LinearGauge
  • OHLC_Chart
  • PieChart
  • Pivot
  • RadialGauge
  • RadialLineChart
  • ScatterChart
  • ScatterMap
  • ScriptPython
  • ScriptR
  • Sparkline
  • SplineChart
  • SplineAreaChart
  • StackedAreaChart
  • StackedBarChart
  • StackedColumnChart
  • StepAreaChart
  • StepLineChart
  • TextBox
  • TextView
  • TimeSeriesChart
  • TreeMap
備考

AvailableChartTypes.Clear メソッドを呼び出したが、コレクションにチャート タイプを追加しなかった場合、サポートされているすべてのチャート タイプが引き続き使用可能です。

canAddCalculatedFields​

このプロパティは、表示形式エディターの [計算フィールド] メニュー項目を表示/非表示にします。

revealView.canAddCalculatedFields = false;

canAddDashboardFilter​

このプロパティは、ダッシュボードの [ダッシュボード フィルターの追加] メニュー項目を表示/非表示にします。

revealView.canAddDashboardFilter = false;

canAddDateFilter​

このプロパティは、ダッシュボードの [日付フィルターの追加] メニュー項目を表示/非表示にします。

revealView.canAddDateFilter = false;

canAddPostCalculatedFields​

このプロパティは、表示形式視覚化エディターのフィールド セクションの F(x) メニュー項目を表示/非表示にします。

revealView.canAddPostCalculatedFields = false;

canAddVisualization​

このプロパティは、編集モードのときにダッシュボードの [+ 追加] ボタンを表示/非表示にします。

revealView.canAddVisualization = false;

canChangeVisualizationBackgroundColor​

このプロパティを使用すると、表示形式エディターの [設定] タブで表示形式の背景色を指定できます。

revealView.canChangeVisualizationBackgroundColor = true;

このプロパティを使用する場合は、次の依存関係をクライアント アプリケーションにインストールする必要があります:

  • Spectrum v 1.8.0 以降
<link href="https://cdnjs.cloudflare.com/ajax/libs/spectrum/1.8.0/spectrum.min.css" rel="stylesheet" type="text/css" >
<script src="https://cdnjs.cloudflare.com/ajax/libs/spectrum/1.8.0/spectrum.min.js"></script>

canCopyVisualization​

このプロパティは、表示形式の [コピー] メニュー項目を表示/非表示にします。

revealView.canCopyVisualization = false;

canDuplicateVisualization​

このプロパティは、表示形式の [複製] メニュー項目を表示/非表示にします。

revealView.canDuplicateVisualization = false;

canEdit​

このプロパティは、ダッシュボードの [編集] メニュー項目を表示/非表示にします。

revealView.canEdit = false;

RevealView.canEdit プロパティが false に設定されている場合、ダッシュボード編集は完全に無効になります。

canMaximizeVisualization​

このプロパティは、表示形式の最大化ボタンを表示/非表示にします。

revealView.canMaximizeVisualization = false;

canSaveAs​

このプロパティは、ダッシュボード メニューの [名前を付けて保存] ボタンを表示/非表示にします。

revealView.canSaveAs = false;

showChangeDataSource​

このプロパティは、表示形式エディターの [データ] タブにある [データ ソースの変更] ボタンを表示/非表示にします。

revealView.showChangeDataSource = false;

showEditDataSource​

このプロパティは、表示形式エディターでデータ ソースの [編集] メニュー項目を表示/非表示にします。

revealView.showEditDataSource = false;

showExportImage​

このプロパティは、エクスポート メニューから [画像] 項目を表示/非表示にします。

revealView.showExportImage = false;

showExportToExcel​

このプロパティは、エクスポート メニューから [Excel] 項目を表示/非表示にします。

revealView.showExportToExcel = false;

showExportToPDF​

このプロパティは、エクスポート メニューから [PDF] 項目を表示/非表示にします。

revealView.showExportToPDF = false;

showExportToPowerPoint​

このプロパティは、エクスポート メニューから [PowerPoint] 項目を表示/非表示にします。

revealView.showExportToPowerPoint = false;

showFilters​

このプロパティは、ダッシュボード フィルターを表示/非表示にします。

revealView.showFilters = false;

showHeader​

このプロパティは、ダッシュボードのタイトルとダッシュボード メニューを含むダッシュボード ヘッダー全体を表示/非表示にします。

revealView.showHeader = false;

showMenu​

このプロパティは、RevealView の右上隅に配置されているダッシュボード メニューを表示/非表示にします。

revealView.showMenu = false;

showRefresh​

このプロパティは、ダッシュボード メニューの [更新] ボタンを表示/非表示にします。

revealView.showRefresh = false;

startInEditMode​

true に設定すると、このプロパティは、ダッシュボードが最初に読み込まれたときに RevealView を「編集モード」にします。

revealView.startInEditMode = false;

startWithNewVisualization​

true に設定すると、このプロパティはすぐに [新しい表示形式] ダイアログを起動し、データ ソースを選択するように求めます。

revealView.startWithNewVisualization = false;
備考

既存のダッシュボードを読み込んでいて、RevealView.startInEditMode プロパティを true に設定していない場合、このプロパティは機能しません。

Events​

onVisualizationEditorOpening​

表示形式エディターが開く前にアプリケーション ロジックを実行したい場合や、条件が満たされるまでエディターが開かないようにしたい場合もあります。これを行うには、イベント ハンドラーを RevealView.onVisualizationEditorOpening イベントに追加します。

revealView.onVisualizationEditorOpening = function (args) {
    if(args.isNewVisualization == false){ //the user is trying to edit an existing visualization
        args.cancel = true; //prevent it
    }
};

VisualizationEditorOpeningArgs には、次のプロパティが含まれています:

  • cancel - イベントをキャンセルするかどうかを示す値を取得または設定します。イベントをキャンセルする必要がある場合は true。それ以外の場合は false。
  • isNewVisualization - true の場合、表示形式は新しく追加された表示形式です。false の場合、それは既存の表示形式です。
  • visualization - 編集および/または追加された表示形式
備考

VisualizationEditorOpeningArgs.cancel を true に設定すると、表示形式視覚化エディターは開きません。

onVisualizationEditorOpened​

表示形式エディターを開いた後、既存の表示形式を編集するとき、または新しい表示形式を作成するときに通知を受け取りたい場合は、RevealView.onVisualizationEditorOpened イベントにイベント ハンドラーを追加できます。

revealView.onVisualizationEditorOpened = function (args) {
    if(args.isNewVisualization == false) { 
        //the user is editing an existing visualization
    }
};

VisualizationEditorOpenedEventArgs には、次のプロパティが含まれています:

  • isNewVisualization - true の場合、表示形式は新しく追加された表示形式です。false の場合、それは既存の表示形式です。
  • visualization - 編集および/または追加された表示形式

onVisualizationEditorClosing​

表示形式エディターが閉じる前にアプリケーション ロジックを実行したい場合や、条件が満たされるまでエディターが閉じないようにしたい場合もあります。これを行うには、RevealView.onVisualizationEditorClosing イベントにイベント ハンドラーを追加します。

revealView.onVisualizationEditorClosing = function (args) {
    if(args.isNewVisualization == false) {  //the user is editing
         args.resetVisualization = true; //puts the widget to the state when it was when the user started editing it
    }
};

VisualizationEditorClosingArgs には、次のプロパティが含まれています:

  • cancel - イベントをキャンセルするかどうかを示す値を取得または設定します。イベントをキャンセルする必要がある場合は true。それ以外の場合は false。
  • isNewVisualization - true の場合、表示形式は新しく追加された表示形式です。false の場合、それは既存の表示形式です。
  • resetVisualization - true の場合、表示形式を編集前の状態にリセットします。
  • visualization - 編集および/または追加された表示形式
備考

VisualizationEditorClosingArgs.cancel を true に設定すると、表示形式視覚化エディターは閉じません。

onVisualizationEditorClosed​

エンドユーザーが RevealView で単一の表示形式を編集するときはいつでも、エディターが閉じられた後に RevealView.onVisualizationEditorClosed イベントが発生します。これは、既存の表示形式の編集、または新しい表示形式の追加に対応する場合があります。RevealView.onVisualizationEditorClosed イベントにイベント ハンドラーを追加することで、このイベントに応答できます。

revealView.onVisualizationEditorClosed = function (args) {
    if(args.isNewVisualization == false) { 
    }
};

VisualizationEditorClosedEventArgs には、次のプロパティが含まれています:

  • isCancelled - 表示形式エディターが X ボタン (false) または Check ボタン (true) のどちらで閉じられたかを決定します。
  • isNewVisualization - true の場合、表示形式は新しく追加された表示形式です。false の場合、それは既存の表示形式視覚化です。
  • visualization - 編集および/または追加された表示形式