API Reference > presentation-common > PresentationRules > ExtendedDataRule

ExtendedDataRule Interface

Rule used to inject some extended data into presentation data objects (nodes, records).

A couple of typical use cases:

  • Table is showing models and elements polymorphically and application wants to handle all models and all elements differently. The rule can be used to inject some flag that tells whether table row represents a model or an element.
  • Tree shows a hierarchy of models and elements. Then element node is clicked, application needs to additionally know element model's ID. The rule can be used to inject that ID into element's node.

see More details

Extends

Properties

Name Type Description
condition undefined | string Defines a condition for the rule, which needs to be met in order for it to be used.  
items { T } A map of items that define the values stored in the extended data structure.  
ruleType ExtendedData Used for serializing to JSON.  

Inherited properties

Name Type Inherited from Description
onlyIfNotHandled undefined | boolean RuleBase Should this rule should be ignored if there is already an existing
priority undefined | number RuleBase Defines the order in which presentation rules will be evaluated and executed.
requiredSchemas undefined | RequiredSchemaSpecification[] RuleBase Schema requirements for this rule.

Defined in

Last Updated: 12 June, 2024