VisualRenderAsync Method

Spotfire 14.3 API Reference
Renders the visual asynchronously to a PNG image with the specified settings.

Namespace:  Spotfire.Dxp.Application
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
public Task<RenderResult> RenderAsync(
	RenderResultSettings resultSettings,
	VisualRenderSettings visualSettings,
	CancellationToken cancellationToken
)

Parameters

resultSettings
Type: Spotfire.Dxp.Application.VisualsRenderResultSettings
The result settings.
visualSettings
Type: Spotfire.Dxp.Application.VisualsVisualRenderSettings
The visual settings.
cancellationToken
Type: System.ThreadingCancellationToken
The cancellation token.

Return Value

Type: TaskRenderResult
The started rendering task.
Exceptions
ExceptionCondition
OperationCanceledExceptionWill be thrown if the cancellation token is already already canceled when this method is called.
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference

Visual Class
Spotfire.Dxp.Application Namespace