Packages > pkg.pkl-lang.org/pkl-pantry/pkl.table

pkl.table.table1.1.0

Properties
Methods
Classes
Type Aliases

module pkl.table.table

TableRenderer generates pretty tables!

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/pkl.table@1.1.0#/table.pkl
Pkl version:: 0.25.0 or higher
Source code:: table.pkl
Known subtypes:
Known usages:
All versions:: 1.1.0, 1.0.1, 1.0.0

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

boxDrawingLightStyle: TableStyle Source

TableStyle using unicode box drawing characters (light variants)
link

boxDrawingHeavyStyle: TableStyle Source

TableStyle using unicode box drawing characters (heavy variants)
link

markdownStyle: TableStyle Source

TableStyle that renders Markdown-compatible tables
link

htmlStyle: TableStyleHTML Source

TableStyle that renders HTML tables

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function

Column(_key: String): Column Source

Classes

link

class

Column Source
link

open class

RowDirective Source

Used to provide fully custom content for an entire table row One possible usage is to express colspan in HTML tables
link

open class

TableStyle Source

Style options used to draw the table Default values produce a table consisting of simple ASCII characters
link

open class

TableStyleHTML extends TableStyle Source

Style options specific to HTML tables Default values produce a table with two-space indentation
link

class

TableRenderer extends ValueRenderer Source

pkl.ValueRenderer subclass used to render pretty-printed tables

Type Aliases

link

typealias

ColumnKey = String Source
link

typealias

ListLike = List|Listing|Dynamic(toMap().isEmpty)Source
link

typealias

HorizontalPosition = "left"|"inner"|"right"Source
link

typealias

VerticalPosition = "top"|"inner"|"bottom"Source
link

typealias

Alignment = "left"|"right"Source