Interface TimelineDisplayField

Configuration for displaying a field within a timeline card. Used for both summary fields (always visible) and expanded fields (visible when expanded).

Example

const field: TimelineDisplayField = {
  fieldName: 'AssignedTo',
  label: 'Assignee',
  icon: 'fa-solid fa-user',
  formatter: (value) => value?.toString().toUpperCase() ?? 'Unassigned'
};
interface TimelineDisplayField {
    cssClass?: string;
    fieldName: string;
    format?: string;
    formatter?: ((value) => string);
    hideLabel?: boolean;
    icon?: string;
    label?: string;
}

Properties

cssClass? fieldName format? formatter? hideLabel? icon? label?

Properties

Optional cssClass

cssClass?: string

Additional CSS class(es) to apply to this field's container.

fieldName

fieldName: string

The field name to extract from the record. For BaseEntity objects, this is passed to .Get(). For plain objects, this is used as a property key.

Optional format

format?: string

Format string for dates/numbers. For dates, uses Angular DatePipe format strings. For numbers, uses Angular DecimalPipe format strings.

Optional formatter

formatter?: ((value) => string)

Custom formatter function for complex value transformations. Takes precedence over the format property.

Type declaration

    • (value): string

    • Parameters

      • value: unknown

        The raw field value

      Returns string

Returns

Formatted string to display

Optional hideLabel

hideLabel?: boolean

If true, only shows the value without the label.

Default

false

Optional icon

icon?: string

Font Awesome icon class to display before the label.

Example

'fa-solid fa-user'

Optional label

label?: string

Display label shown before the value. If not provided, defaults to the fieldName.

Settings

Member Visibility

Theme

On This Page

cssClassfieldNameformatformatterhideLabeliconlabel