Karbone/com.ekino.oss.karbone.model/RenderOptions/Builder

Builder

Builder for RenderOptions.

Constructors

constructor()

Properties

var batch: BatchOptions?

See RenderOptions.batch.

var complement: JsonElement?

See RenderOptions.complement.

var converter: PdfConverter?

See RenderOptions.converter.

var convertTo: OutputFormat?

See RenderOptions.convertTo.

var currency: CurrencyConversion?

See RenderOptions.currency.

var enum: JsonObject?

See RenderOptions.enum.

var hardRefresh: Boolean

See RenderOptions.hardRefresh.

val headers: MutableMap<String, String>

See RenderOptions.headers.

var lang: String?

See RenderOptions.lang.

preReleaseFeatureIn

var preReleaseFeatureIn: Int?

See RenderOptions.preReleaseFeatureIn.

var reportName: String?

See RenderOptions.reportName.

var timezone: String?

See RenderOptions.timezone.

var translations: JsonObject?

See RenderOptions.translations.

var variableStr: String?

See RenderOptions.variableStr.

Functions

fun build(): RenderOptions

Builds the immutable RenderOptions; request invariants are checked when the options are used.

fun csv(options: CsvOptions = CsvOptions()): RenderOptions.Builder

Sets RenderOptions.convertTo to a CSV output with the given CsvOptions.

fun header(name: String, value: String): RenderOptions.Builder

Adds one extra HTTP request header (see RenderOptions.headers).

fun jpg(options: ImageOptions = ImageOptions()): RenderOptions.Builder

Sets RenderOptions.convertTo to a JPG output with the given ImageOptions.

fun pdf(configure: PdfOptions.Builder.() -> Unit = {}): RenderOptions.Builder

Sets RenderOptions.convertTo to a PDF output configured through the PdfOptions.Builder DSL.

fun png(options: ImageOptions = ImageOptions()): RenderOptions.Builder

Sets RenderOptions.convertTo to a PNG output with the given ImageOptions.