BlazorビューワのAPI

このページでは、Blazorビューワコンポーネントを初期化時または実行時に使用できるAPIについて説明しています。

RenderMode

説明：初期表示のレンダリングモードを指定します。使用できるモードはPaginatedとGalleyで、既定値はPaginatedです。

型：Enum: RenderMode

有効な値： 'RenderMode.Paginated'、'RenderMode.Galley'

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" RenderMode="RenderMode.Paginated"/>

DefaultExportSettings

説明：カスタムのデフォルトエクスポート設定を含むオブジェクト。エクスポート設定のデフォルト値とエクスポートパネルでの表示/非表示を事前に設定するために使用します。

型： Dictionary<string, Dictionary<string, ExportSetting>>

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" DefaultExportSettings="@defaultExportSettings"/>
@code{ 
  Dictionary<string, Dictionary<string, ExportSetting>> defaultExportSettings = new Dictionary<string, Dictionary<string, ExportSetting>>()
    {
          {
              "xls", new Dictionary<string, ExportSetting>(){
                  {
                      "FileName",  new ExportSetting() {Value = "ar", Visible = true}
                  },
                  {
                      "EnableToggles",  new ExportSetting() {Value = false}
                  }
              }
          }
    };
}

AutoBackgroundColor

説明：設定をtrueにすると、表示エリアの背景色がレポート本体の背景色で塗りつぶされます。このプロパティは RDLXダッシュボードレポートでのみ使用できます。

型：bool

有効な値：'true', 'false'

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" AutoBackgroundColor="true" />

AvailableExports

説明：ビューワのエクスポート機能で使用できるエクスポート形式の配列。

型： ExportTypes[]

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" AvailableExports="availableExportArr"/>
@code{
    ExportTypes[] availableExportArr = new ExportTypes[] {
            ExportTypes.Pdf, ExportTypes.Xlsx, ExportTypes.Xls, ExportTypes.Json
        };
}

Locale

説明：ビューワの表示に使用するロケールを指定します。

型：String

有効な値：'en-US' (英語), 'ja-JP' (日本語), and 'zh-CN' (中国語)

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" Locale="ja-JP"/>

LocaleData

説明：ローカライズされた文字列を含むJSON。

型： String

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" LocaleData="@_localeData" >
@code{
    string _localeData = "{\"viewer\": {\"toolbar\": {\"refresh\": \"更新\"} } }";
}

LocaleUri

説明：ローカライズされた文字列を含むファイルのURL。

型：String

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" LocaleUri="localization.json"/>

PanelsLocation

説明：検索パネル、パラメータパネルなどのパネルの位置を、ビューワの左側（ツールバー）または右側（サイドバー）に設定します。既定値は 'toolbar' です。

型： Enum: PanelsLocation

有効な値：'PanelsLocation.sidebar', 'PanelsLocation.toolbar'

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" PanelsLocation="PanelsLocation.toolbar" />

DisplayMode

説明：単一ページモードまたは連続ページモードを設定します。

型：Enum: ViewMode

有効な値：'ViewMode.Single', 'ViewMode.Continous'

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" DisplayMode="ViewMode.Single" />

Action

説明：ビューワがハイパーリンク、ブックマークリンク、ドリルダウンレポートを開く前、またはレポートコントロールの表示を切り替える前に呼び出されるコールバックです。

型： Method(string, object[])

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" Action="actionMethod" />
@code{
    public void actionMethod(string actionType , object[] actionParams)
    {
        System.Diagnostics.Debug.WriteLine(actionType);
        foreach(var obj in actionParams)
        {
            System.Diagnostics.Debug.WriteLine(obj);
        }
                }
}

Error

説明：レポートを表示する処理中にエラーが発生したときに呼び出されるコールバックです。

型： Method(ErrorInfo obj)

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" Error="errorMethod" />
@code{
    public void errorMethod(ErrorInfo obj)
    {
        System.Diagnostics.Debug.WriteLine("Error Message :" + obj.Message);
                   }
}

HideErrors

説明：ビューワでエラーを表示するかどうかを指定します。既定値はfalseです。

型： bool

有効な値： true、false

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" HideErrors="true" />

InitialZoomMode

説明：ビューワでレポートを開く際のズームモードを設定します。

型：String

有効な値：FitToPage、FitToWidth

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" InitialZoomMode="@ZoomMode.FitToWidth"/>

InitialZoomPercentage

説明：ビューワでレポートを開く際のズームレベルをパーセンテージで設定します。このプロパティを設定すると、InitialZoomModeが無視されます。

型： Integer

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" InitialZoomPercentage="50"/>

パーセンテージ値を25から300の範囲で設定できます。

DocumentLoaded

説明：サーバー上でドキュメントが完全に読み込まれたときに呼び出されるコールバックです。

型： Method()

戻り値：Void

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" DocumentLoaded="DocumentLoaded"/>
@code{
    public void DocumentLoaded()
    {
        System.Diagnostics.Debug.WriteLine("Document Loaded");
    }
}

ReportService

説明：Web API に接続するための設定を構成します。

型：ReportServiceSettings object

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" ReportService="setting" />
@{
    ReportServiceSettings setting = new ReportServiceSettings()
    {
        Url = "http:example.com/api/reporting",
        SecurityToken = "security_Token",
        OnRequest = (OnRequestInfo obj) =>
        {
            obj.Headers.Add("Authorization", "security_Token");
        }
    };
}

ViewerInitialized

説明：ビューワが初期化されたときに呼び出されるコールバックです。

型： Method()

戻り値：Void

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" ViewerInitialized="InitializedViewer"/>
@code{
    private void InitializedViewer()
    {
        System.Diagnostics.Debug.WriteLine("Viewer is initailized now");
                 }
}

ReportLoaded

説明：ビューワが要求されたレポートの情報を取得したときに呼び出されるコールバックです。

型：Method(ReportInfo obj)

戻り値：Void

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" ReportLoaded="ReportLoaded"/>
@code{
    public void ReportLoaded(ReportInfo obj)
    {
        System.Diagnostics.Debug.WriteLine("The report " + obj.Name + " was successfully loaded!");
                   }
}

ParametersPanelSettings

説明：パラメータパネルまたはペインの設定を構成します。

型：ParametersPanelSettings object

列挙型：

ParameterPanelLocation：パラメータパネルの位置を調整します。
有効な値：'Default'、'Top'
ParameterPanelOpen：レポートパラメータに初期値が設定されているか、ユーザーの入力が必要であるかに関係なく、パラメータパネルを自動的に表示します。
有効な値：'Auto'、'Always'

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" ParametersPanelSettings="parametersPanelSetting"/>
@code{
    ParametersPanelSettings parametersPanelSetting = new ParametersPanelSettings()
    {
        Location = ParameterPanelLocation.Default,
        Open = ParameterPanelOpen.Always
               };
}

Sidebar

説明：ビューワのSidebarインスタンスです。サイドバーの表示を切り替えます。

戻り値：Sidebar object

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" ViewerInitialized="InitializedViewer"/>
@{
private ReportViewer _viewer;
  
   private void InitializedViewer()   
   {
Sidebar obj = _viewer.Sidebar;
   }
}

Parameters

説明：レポートの実行に使用されるパラメータを表す{name, value}ペアの配列。

型： Parameter[]

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" Parameters="parameterArray"/>
@code{
    Parameter[] parameterArray = new Parameter[]
    {
        new Parameter
        {
            Name = "Category",
            Values = new string[]{"Business" }
        }
                  };
}

ReportName

説明：ビューワで表示するレポートの名前です。

型： String

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" />
@code{
private ReportViewer _viewer;
private string _currentReport = null;
    protected override void OnInitialized()
    {
reportsList = ReportsService.GetReports().ToList();
_currentReport = reportsList.FirstOrDefault();     
    }
}

Width

説明：ビューワの幅で。既定値は100%です。

型： String

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" Width="50%"/>

Height

説明：ビューワの高さ。既定値は 100% です。

型： String

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" Height="50%"/>

Toolbar

説明：ビューワのToolbarインスタンスです。ツールバーにカスタム項目を追加したり、既存の項目を削除したりするために使用します。

戻り値：Toolbar object

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" ViewerInitialized="InitializedViewer"/>
@{
private ReportViewer _viewer;
  
   private void InitializedViewer()   
   {
Toolbar obj = _viewer.Toolbar;
   }
}

Themes

説明：ビューワにテーマを設定します。ユーザー定義のテーマまたはデフォルトのテーマに設定できます。

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" Themes="@_themes"/>
@code{
    private static readonly ColorTheme _theme = new ColorTheme()
    {
        Name = "testTheme",
        BackgroundPanels = "#fdf7f1",
        BackgroundMain = "#fdf7f1",
        Primary = "blue",
        Secondary = "green",
        Neutral = "grey",
        Error = "red",
        Warning = "yellow",
        FontFamily = "'Open Sans', 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif",
        Type = ColorThemeType.light
    };
    
    private readonly ThemeSettings _themes = new ThemeSettings()
    {
        InitialTheme = "testTheme",
        ThemeSelector = new ThemeSelector()
        {
            Enabled = true,
            AvailableThemes = new []{ ColorThemes.ActiveReportsDark, _theme, "default" }
        }
    };
    
}

BackToParrent

説明：ドリルダウンレポートの親レポートをビューワに表示します。

型： Method

戻り値：Void

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport" ViewerInitialized="InitializedViewer"/>
@code{   
private ReportViewer _viewer;
    private void InitializedViewer()
    {
await  _viewer.BackToParrent();
    }
}

CurrentPage

説明：現在表示されているページ番号を取得します。

型： Method

戻り値：ValueTask<int>

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport"  DocumentLoaded="@DocumentLoaded"/>
@code{   
private async void DocumentLoaded()
    {
     var currentPage = await _viewer.CurrentPage();
     System.Diagnostics.Debug.WriteLine(currentPage);
    }
}

Export

説明：現在表示されているレポートをエクスポートします。

パラメータ：

exportType: エクスポート形式を指定します。
callback: エクスポート結果が利用可能になると呼び出される関数。コールバックにそのURLが渡されます。
saveAsDialog: エクスポート結果が利用可能になると即座に「名前を付けて保存」ダイアログを表示するかどうかを示します。
settings: RenderingExtensions で利用可能なエクスポート設定です。
isCancelRequested: 関数は定期的に呼び出され、エクスポートタスクの取り消し要求があるかどうかを指定します。

型： Method(ExportTypes, Action<string> callback = null, bool = false, Dictionary<string, string> settings = null, Func<bool> isCancelRequested = null, )

戻り値：Void

サンプルコード

<GrapeCity.ActiveReports.Blazor.ReportViewer @ref="_viewer" ReportName="@reportId" DocumentLoaded="
@DocumentLoaded"/>
@code {
 private ReportViewer _viewer;
 private string reportId = "User defined report columns.rdlx";
 private async void DocumentLoaded()
    {
 await _viewer.Export(ExportTypes.Pdf,
 (uri) =>
    {
    //エクスポート結果のURI。
    },
 false,
 new Dictionary<string, string>() { { "Title", "Some Title" } },
 () =>
    {
   //エクスポートのキャンセルをチェックします。
   return false;
    }
 );
    }
}

GetToc

説明：レポートのTOCを取得します。

型： Method

戻り値：ValueTask<BookmarkInfo>

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport"  DocumentLoaded="@DocumentLoaded"/>
@code{   
private async void DocumentLoaded()
    {
        var toc = await _viewer.GetToc();
    }
}

GoToPage

説明：ビューワで特定のページを表示します。ページ番号は1から始まります。

型： int

戻り値： Void

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport"  DocumentLoaded="@DocumentLoaded"/>
@code{   
private async void DocumentLoaded()
    {
                      await _viewer.GoToPage(2);
    }
}

OpenReport

説明：ドリルダウンレポートの親レポートをビューワに表示します。

型：Method(string, Parameter[] = null)

戻り値： Void

サンプルコード

_viewer.OpenReport("TestReport.rdlx");
OR
    Parameter[] parameterArray = new Parameter[]
   {
        new Parameter
        {
            Name = "Category",
            Values = new string[]{"Business" }
        }
   };
_viewer.OpenReport("TestReport.rdlx", parameterArray);

PageCount

説明：現在表示されているレポートのページ数を取得します。

型： Method

戻り値：ValueTask<int>

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport"  DocumentLoaded="@DocumentLoaded"/>
@code{   
private async void DocumentLoaded()
    {
         var countPage = await _viewer.PageCount();
        System.Diagnostics.Debug.WriteLine(countPage);
    }
}

Print

説明：現在表示されているレポートが存在する場合に、そのレポートを印刷します。

型： Method()

戻り値：Void

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport"  DocumentLoaded="@DocumentLoaded"/>
@code{   
private async void DocumentLoaded()
    {
         await _viewer.Print();
    }
}

Refresh

説明：レポートのプレビューを更新します。

型：Method()

戻り値： Void

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport"  DocumentLoaded="@DocumentLoaded"/>
@code{   
private async void DocumentLoaded()
    {
         await _viewer.Refresh();
    }
}

Search

説明：特定の検索オプション（大文字と小文字を区別、単語単位で検索）を使用して特定の用語の検索を実行し、渡された検索結果を使用して特定のコールバックを呼び出します。

パラメータ：

searchTerm: 検索する文字列。
searchOptions:検索オプションを定義します。
callback: 検索を実行した後に呼び出す関数。

型：Method(string, SearchOptions = null, Action<List> = null)

戻り値：Void

サンプルコード

<ReportViewer @ref="_viewer" ReportName="@_currentReport"  DocumentLoaded="@DocumentLoaded"/>
@code{   
private async void DocumentLoaded()
    {
        //レポートでALFKIキーワードを検索します。
        await _viewer.Search("ALFKI", new SearchOptions()
        {
            MatchCase = true,
            WholePhrase = false
        },
        (List<SearchResult> results) =>
        {
            if (results != null && results.Count > 0)
            {
                foreach (var res in results)
                {
                    System.Diagnostics.Debug.WriteLine(res.DisplayText);
                }
                
            }
        });
    }