API Reference › presentation-common› PresentationRules › Ruleset

Ruleset Interface

Presentation ruleset is a list of rules that define tree hierarchy and content provided by the presentation library. The ruleset consists of:

  • Ruleset options
  • Hierarchy rules:
    • Root node rules
    • Child node rules
  • Content rules for content you see in content controls like property grid and table.
  • Customization rules used for additional customizations such as styling, labeling, checkboxes, etc.
  • User-controllable variables.

@see Presentation library documentation page

Implemented by

Properties

Name Type Description
id string Ruleset identifier.  
requiredSchemas RequiredSchemaSpecification[] | undefined Schema requirements for this ruleset.  
rules Rule[] Presentation rules used to create hierarchies and content  
supplementationInfo SupplementationInfo | undefined Supplementation-related information for this ruleset  
vars VariablesGroup[] | undefined User-controllable variable definitions  
version string | undefined Version of the presentation ruleset in SemVer format: {major}.{minor}.{patch}.  

Defined in

Last Updated: 13 May, 2024