models/joyfill.chart/ChartField

ChartField

interface ChartField : ChartComponent, Field

Field that renders a data visualization (chart) within a document.

Couples the generic Field behavior with ChartComponent data and rendering semantics. Useful for dashboards, summaries, or reports where quantitative data should be visualized for clarity.

TODO: get this re-evaluated

xTitle is never evaluated as null and if null in underlying map it is evaluated as empty
yTitle is never evaluated as null and if null in underlying map it is evaluated as empty

Properties

abstract val decorators: List<Decorator>

Optional list of decorators (icon/label chips) shown to the right of the field title.

abstract val disabled: Boolean

Whether this field is non-interactive (read-only/disabled) for the end user.

abstract val formulas: MutableList<FormularApplication>

Collection of formulas applied to this field. Order may determine execution precedence.

abstract var hidden: Boolean

Whether the element is hidden by default.

abstract val hiddenViews: List<String>

abstract var id: String

Stable identifier of this schema node.

abstract var identifier: String

Unique key that identifies this field within a document. Must be stable across updates.

initialHiddenState

abstract val initialHiddenState: Boolean

Whether the field starts hidden before any logic evaluation occurs.

abstract val logic: FieldLogic?

Optional FieldLogic describing visibility logic for the field

abstract val metadata: JoyMap

Arbitrary key-value map for custom extensions or analytics. Persisted alongside the field.

permanentlyHidden

open val permanentlyHidden: Boolean

When true, the field/column is permanently hidden on the current active view and cannot be shown via conditional logic.

abstract var required: Boolean

Whether a value is mandatory for this schema.

abstract val tip: ToolTip?

Optional ToolTip to assists users with context, instructions, or hints.

abstract var title: String

Human-readable label used in editors or viewers.

abstract var type: Type

Discriminant describing the concrete schema/component kind.

abstract val value: Any?

Runtime value payload; variance is specialized by sub-interfaces.

abstract val xMax: Double?

Optional maximum bound for the X-axis.

abstract val xMin: Double?

Optional minimum bound for the X-axis.

abstract val xTitle: String?

Optional label for the X-axis.

abstract val yMax: Double?

Optional maximum bound for the Y-axis.

abstract val yMin: Double?

Optional minimum bound for the Y-axis.

abstract val yTitle: String?

Optional label for the Y-axis.

Functions

abstract fun toJsonObject(): JsonObject

Serializes this instance to a structured JsonObject.

abstract fun toJsonString(): String

Serializes this instance to a compact JSON string.

abstract fun toMap(): MutableMap<String, Any?>

Converts this instance into a mutable key-value map suitable for mutation and re-serialization.