models/joyfill.multi_select/MultiSelectField

MultiSelectField

interface MultiSelectField : Field, MultiSelectComponent

Field that allows users to select multiple values from a predefined list.

Extends the generic Field contract with the multi-choice semantics of MultiSelectComponent. Ideal for tagging, categorization, and other scenarios where more than one option may apply.

Implementations should clearly convey selection state and support efficient addition/removal of choices.

Properties

Link copied to clipboard
abstract val decorators: List<Decorator>

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

Link copied to clipboard
abstract val disabled: Boolean

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

Link copied to clipboard
abstract val formulas: MutableList<FormularApplication>

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

Link copied to clipboard
abstract var hidden: Boolean

Whether the element is hidden by default.

Link copied to clipboard
abstract val hiddenViews: List<String>
Link copied to clipboard
abstract var id: String

Stable identifier of this schema node.

Link copied to clipboard
abstract var identifier: String

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

Link copied to clipboard
abstract val initialHiddenState: Boolean

Whether the field starts hidden before any logic evaluation occurs.

Link copied to clipboard
abstract val logic: FieldLogic?

Optional FieldLogic describing visibility logic for the field

Link copied to clipboard
abstract val metadata: JoyMap

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

Link copied to clipboard
abstract val multi: Boolean
Link copied to clipboard
abstract val options: List<Option>

Available selectable Option entries.

Link copied to clipboard
open val permanentlyHidden: Boolean

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

Link copied to clipboard
abstract var required: Boolean

Whether a value is mandatory for this schema.

Link copied to clipboard
abstract val tip: ToolTip?

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

Link copied to clipboard
abstract var title: String

Human-readable label used in editors or viewers.

Link copied to clipboard
abstract var type: Type

Discriminant describing the concrete schema/component kind.

Link copied to clipboard
abstract val value: Any?

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

Functions

Link copied to clipboard
abstract fun toJsonObject(): JsonObject

Serializes this instance to a structured JsonObject.

Link copied to clipboard
abstract fun toJsonString(): String

Serializes this instance to a compact JSON string.

Link copied to clipboard
abstract fun toMap(): MutableMap<String, Any?>

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