Interface DetailRelationViaOptions

JSON Forms UISchemaElement.options.relationVia — render an array of reification / intermediate nodes as a list of the entity each node points at.

interface DetailRelationViaOptions {
    dividers?: boolean;
    groupByTarget?: boolean;
    occurrenceUiSchema?: UISchemaElement;
    qualifierEmptyText?: Record<string, string>;
    qualifierPlacement?: "trailing" | "below";
    qualifierProperties?: string[];
    qualifierSeparator?: string;
    sortDirection?: "asc" | "desc";
    sortOccurrencesBy?: string;
    target: string;
    targetAs?: ViewSize;
}

Properties

dividers? groupByTarget? occurrenceUiSchema? qualifierEmptyText? qualifierPlacement? qualifierProperties? qualifierSeparator? sortDirection? sortOccurrencesBy? target targetAs?

Properties

Optionaldividers

dividers?: boolean

Divider between target rows. Default true.

OptionalgroupByTarget

groupByTarget?: boolean

Merge repeated occurrences of the same target into one row. Default true.

OptionaloccurrenceUiSchema

occurrenceUiSchema?: UISchemaElement

Full escape hatch: UISchema dispatched against the item schema, one per occurrence.

OptionalqualifierEmptyText

qualifierEmptyText?: Record<string, string>

Text substituted when a qualifier value is nullish, e.g. { to: "today" }.

OptionalqualifierPlacement

qualifierPlacement?: "trailing" | "below"

"trailing" (right-aligned beside the target) or "below". Default "trailing".

OptionalqualifierProperties

qualifierProperties?: string[]

Item properties rendered per occurrence. Default: all except target, @id, @type.

OptionalqualifierSeparator

qualifierSeparator?: string

Joined between qualifier values of one occurrence. Default " – ".

OptionalsortDirection

sortDirection?: "asc" | "desc"

OptionalsortOccurrencesBy

sortOccurrencesBy?: string

Dot path inside the item used to order occurrences within a group.

target

target: string

Property on the intermediate item holding the displayed entity. Required.

OptionaltargetAs

targetAs?: ViewSize

View size for the target. Default "listItem".

Settings

Member Visibility

On This Page

Properties