サーバーのエクスポート

ダッシュボードは、UI を必要とせずに、サーバー上の Excel、PDF、または PowerPoint にエクスポートできます。「ヘッドレスエクスポート」とも呼ばれます。サーバー上のダッシュボードのエクスポートは、IDashboardExporter を使用して実行されます。

IDashboardExporter は、次のように ASP.NET コントローラーまたは最小限の API 関数に挿入することで取得できます。

app.MapGet("/dashboards/export/{name}", async (string name, IDashboardExporter dashboardExporter) =>
{

}

ダッシュボードをエクスポートする方法

IDashboardExporter は、ダッシュボードをファイルストリームとして、またはディスク上のファイルパスにエクスポートするための API を提供します。サポートされている各エクスポート形式には、エクスポートプロセスを簡素化するための API があります。

Excel

//export to stream
var stream = await dashboardExporter.ExportToExcel(dashboardName);

//export to file
await dashboardExporter.ExportToExcel(dashboardName, filePath);

PDF

//export to stream
var stream = await dashboardExporter.ExportToPdf(dashboardName);

//export to file
await dashboardExporter.ExportToPdf(dashboardName, filePath);

PowerPoint

//export to stream
var stream = await dashboardExporter.ExportToPowerPoint(dashboardName);

//export to file
await dashboardExporter.ExportToPowerPoint(dashboardName, filePath);

備考

PDF または PowerPoint 形式へのエクスポートには、時間がかかる場合があります。UI からサーバー側のエクスポートを呼び出す場合は、エクスポートが処理中であることを視覚的に示すインジケーターをユーザーに提供してください。

ユーザーコンテキストの提供

ダッシュボードには、Reveal SDK ユーザーコンテキストを必要とするデータソースがある場合があります。この場合、エクスポートメソッドの引数として Reveal SDK の IRVUserContext を指定して、ダッシュボードのエクスポートを確実に成功させる必要があります。

IRVUserContext を取得する最初の手順は、IRVUserContextProvider と IHttpContextAccessor を ASP.NET コントローラーまたは最小限の API 関数に挿入することです。次に、引数として IHttpContextAccessor.HttpContext を渡して IRVUserContextProvider.GetUserContext を呼び出します。

app.MapGet("/dashboards/export/{name}", async (string name, IDashboardExporter dashboardExporter, 
    IRVUserContextProvider userContextProvider, IHttpContextAccessor httpContextAccessor) =>
{
    var userContext = userContextProvider.GetUserContext(httpContextAccessor.HttpContext);
}

IRVUserContext インスタンスを取得したら、それを引数として export メソッドに渡すことができます。

//export to stream
var stream = await dashboardExporter.ExportToExcel(dashboardName, userContext);

//export to file
await dashboardExporter.ExportToExcel(dashboardName, filePath, userContext);

エクスポートオプション

各エクスポート形式は、ダッシュボードをエクスポートする際のさまざまなオプションをサポートしています。たとえば、各ページのヘッダーに著者名を追加したり、各ページのフッターに会社名を追加したりできます。

各エクスポート形式には、特定のオプションオブジェクトがあります:

Excel: ExcelExportOptions オブジェクトを使用
PDF: PdfExportOptions オブジェクトを使用
PowerPoint: PowerPointExportOptions オブジェクトを使用

ダッシュボードエクスポートのオプションを設定するには、エクスポート形式オプションクラスのインスタンスを作成し、それを引数として export メソッドに提供します。

//create Pdf options
var pdfOptions = new PdfExportOptions()
{
    Landscape = true
};

//export Pdf to stream
var stream = await dashboardExporter.ExportToPdf(dashboardName, options: pdfOptions);

例: サーバーでのエクスポート

この例では、形式に基づいてダッシュボードをエクスポートするサービスエンドポイントを作成します。

サーバープロジェクト内、ダッシュボードエクスポート用の新しいルートを作成します。ダッシュボード名とエクスポート形式をルートパラメーターとして定義します。また、エクスポートを実行するために IDashboardExporter を挿入する必要があります。次に、エクスポート形式のルートパラメーターに基づいて、正しいエクスポートを実行するためのロジックを作成します。エクスポートの結果を返すときは、必ず正しいコンテンツタイプを指定してください。

ASP.NET
Java
Node.js

app.MapGet("/dashboards/export/{name}", async (string name, string format, IDashboardExporter dashboardExporter) =>
{
    Stream stream;
    string contentType = "application/pdf";
    if (format=="xlsx")
    {
        stream = await dashboardExporter.ExportToExcel(name);
        contentType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
    }
    else if (format == "pptx")
    {
        stream = await dashboardExporter.ExportToPowerPoint(name);
        contentType = "application/vnd.openxmlformats-officedocument.presentationml.presentation";
    }
    else
    {
        stream = await dashboardExporter.ExportToPdf(name);
    }
    
    return Results.File(stream, contentType);
});

@Component
@Path("dashboards/export/")
public class RevealExportController {

    @GET
    @Path("{name}")
    public void getDashboardExport(@Suspended final AsyncResponse response, @PathParam("name") String name, @QueryParam("format") String format) throws IOException {
        IDashboardExporter exporter = RevealEngineLocator.dashboardExporter;

        if (format.equalsIgnoreCase("xlsx")) {
            exporter.exportToExcel(name, new ExportStreamCallback() {
                @Override
                public void onFailure(Exception e) {
                    response.resume(e);
                }
    
                @Override
                public void onSuccess(InputStream stream) {
                    ResponseBuilder resp = Response.ok(stream).type("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
                    response.resume(resp.build());
                } 
            });
        }
        else if (format.equalsIgnoreCase("pptx")) {
            exporter.exportToPowerPoint(name, new ExportStreamCallback() {
                @Override
                public void onFailure(Exception e) {
                    response.resume(e);
                }
    
                @Override
                public void onSuccess(InputStream stream) {
                    ResponseBuilder resp = Response.ok(stream).type("application/vnd.openxmlformats-officedocument.presentationml.presentation");
                    response.resume(resp.build());
                } 
            });            
        }
        else {
            exporter.exportToPdf(name, new ExportStreamCallback() {
                @Override
                public void onFailure(Exception e) {
                    response.resume(e);
                }
    
                @Override
                public void onSuccess(InputStream stream) {
                    ResponseBuilder resp = Response.ok(stream).type("application/pdf");
                    response.resume(resp.build());
                } 
            });
        }
    }
}

app.get("/dashboards/export/:name", async (req, resp) => {
	const name = req.params.name;
	const format = req.query.format;
	let stream: ReadStream | void;
	let contentType = "application/pdf";

	if (format === "xlsx"){
		contentType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";	
		stream = await revealServer.exporter.exportExcel(name, null, null, null);
	}
	else if (format === "pptx") {
		contentType = "application/vnd.openxmlformats-officedocument.presentationml.presentation";
		stream = await revealServer.exporter.exportPowerPoint(name, null, null, null);
	}
	else {
		stream = await revealServer.exporter.exportPdf(name, null, null, null);
	}

	if (stream) {
		resp.setHeader("Content-Type", contentType);
		stream.pipe(resp);
	}
	else {
		resp.send(404);
	}
});

クライアントアプリケーションで、サービスエンドポイントを呼び出す関数を実行する一連のボタンを作成します。

<button onclick="onExportButtonClicked('pdf')">Export as PDF</button>
<button onclick="onExportButtonClicked('xlsx')">Export as Excel</button>
<button onclick="onExportButtonClicked('pptx')">Export as Power Point</button>

この例では、Sales という名前のダッシュボードをエクスポートしています。これは、クリックされたボタンによって提供されたエクスポート形式を使用します。

function onExportButtonClicked(format) {
    fetch(`http://localhost:5111/dashboards/export/Sales?format=${format}`)
    .then(resp => resp.blob())
    .then(blob => 
    {
        downloadFile(blob, format);
    });
}

function downloadFile(blob, format) {
    var a = document.createElement("a");
    a.download = `Sales.${format}`;
    a.href = window.URL.createObjectURL(blob);
    a.click();
}

コードの取得

このサンプルのソースコードは GitHub にあります。

ダッシュボードをエクスポートする方法​

ユーザー コンテキストの提供​

エクスポート オプション​

例: サーバーでのエクスポート​

ダッシュボードをエクスポートする方法

ユーザーコンテキストの提供

エクスポートオプション

例: サーバーでのエクスポート