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

RenderOptions

data class RenderOptions(val convertTo: OutputFormat? = null, val converter: PdfConverter? = null, val timezone: String? = null, val lang: String? = null, val complement: JsonElement? = null, val variableStr: String? = null, val reportName: String? = null, val enum: JsonObject? = null, val translations: JsonObject? = null, val currency: CurrencyConversion? = null, val hardRefresh: Boolean = false, val batch: BatchOptions? = null, val preReleaseFeatureIn: Int? = null, val headers: Map<String, String> = emptyMap())

Everything in a render body except data and template, plus extra request headers.

Constructors

constructor(convertTo: OutputFormat? = null, converter: PdfConverter? = null, timezone: String? = null, lang: String? = null, complement: JsonElement? = null, variableStr: String? = null, reportName: String? = null, enum: JsonObject? = null, translations: JsonObject? = null, currency: CurrencyConversion? = null, hardRefresh: Boolean = false, batch: BatchOptions? = null, preReleaseFeatureIn: Int? = null, headers: Map<String, String> = emptyMap())

Types

Builder for RenderOptions.

object Companion

Ready-made RenderOptions and a builder entry point.

Properties

val batch: BatchOptions?

Multi-report generation. Requires an async render (webhook).

val complement: JsonElement?

Extra data reachable through {c.} tags.

val converter: PdfConverter?

PDF engine. Only meaningful when convertTo is OutputFormat.Pdf.

val convertTo: OutputFormat?

Output format; null renders in the template's own format.

val currency: CurrencyConversion?

currencySource / currencyTarget / currencyRates.

val enum: JsonObject?

Enumerations for the convEnum formatter.

val hardRefresh: Boolean

Recompute pagination and TOC at the end of rendering. Requires convertTo.

val headers: Map<String, String>

Extra HTTP headers (e.g. carbone-egress-header-authorization).

val lang: String?

Locale such as fr-fr, drives {t()}, :formatN, :formatC.

preReleaseFeatureIn

val preReleaseFeatureIn: Int?

Opts into a pre-release Carbone feature, by its numeric id.

val reportName: String?

File name in Content-Disposition; may contain Carbone tags.

val timezone: String?

IANA timezone, server default Europe/Paris.

val translations: JsonObject?

Translations keyed by locale, used with {t()} and lang.

val variableStr: String?

variableStr: extra data available to the template as free-form text.