main.cesium.writeTextToCanvas.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
package cesium
/**
* Writes the given text into a new canvas. The canvas will be sized to fit the text.
* If text is blank, returns undefined.
* @param [text] The text to write.
* @return A new canvas with the given text drawn into it. The dimensions object
* from measureText will also be added to the returned canvas. If text is
* blank, returns undefined.
* @see Online Documentation
*/
@JsName("\$cesium__writeTextToCanvas")
external fun writeTextToCanvas(
text: String,
options: WriteTextToCanvasOptions? = definedExternally,
): org.w3c.dom.HTMLCanvasElement?
/**
* @property [font] The CSS font to use.
* Default value - `'10px sans-serif'`
* @property [textBaseline] The baseline of the text.
* Default value - `'bottom'`
* @property [fill] Whether to fill the text.
* Default value - `true`
* @property [stroke] Whether to stroke the text.
* Default value - `false`
* @property [fillColor] The fill color.
* Default value - [Color.WHITE]
* @property [strokeColor] The stroke color.
* Default value - [Color.BLACK]
* @property [strokeWidth] The stroke width.
* Default value - `1`
* @property [backgroundColor] The background color of the canvas.
* Default value - [Color.TRANSPARENT]
* @property [padding] The pixel size of the padding to add around the text.
* Default value - `0`
*/
@JsName("\$cesium__WriteTextToCanvasOptions")
external interface WriteTextToCanvasOptions {
var font: String?
var textBaseline: String?
var fill: Boolean?
var stroke: Boolean?
var fillColor: Color?
var strokeColor: Color?
var strokeWidth: Double?
var backgroundColor: Color?
var padding: Double?
}