PresentationRules

Types for defining the presentation ruleset.

Enumerations

Name Description  
ChildNodeSpecificationTypes Used for serializing array of ChildNodeSpecificationTypes.ChildNodeSpecification  
ContentSpecificationTypes Used for serializing array of ContentSpecificationTypes.ContentSpecification  
GroupingSpecificationTypes Available types of GroupingSpecificationTypes.GroupingSpecification  
InstanceLabelOverrideValueSpecificationType Types of possible InstanceLabelOverrideValueSpecificationType.InstanceLabelOverride label value.  
PropertyEditorParameterTypes Used for serializing array of PropertyEditorParameterTypes.PropertyEditorParameters to JSON  
PropertyGroupingValue Used in PropertyGroupingValue.PropertyGroup to specify the type of value to use  
QuerySpecificationTypes Used for serializing array of QuerySpecificationTypes.QuerySpecification to JSON.  
RelatedPropertiesSpecialValues Special values that can be used in RelatedPropertiesSpecification.propertyNames  
RelationshipDirection Defines direction of a relationship that should be followed  
RelationshipMeaning Meaning of the relationship  
RuleTypes Used for serializing RuleTypes.Rule objects to JSON.  
SameLabelInstanceGroupApplicationStage Specifies hierarchy creation stages used to apply SameLabelInstanceGroupApplicationStage.SameLabelInstanceGroup grouping. Beta
VariableValueType Available value types of user-controllable variables  

Interfaces

Name Description  
AllInstanceNodesSpecification Creates nodes for all available instances filtered only by the  
AllRelatedInstanceNodesSpecification Creates nodes for all related instances for parent ECInstance node.  
CalculatedPropertiesSpecification Sub-specification to include additional calculated properties into the content.  
CheckBoxRule Rule that allows configuring check boxes for certain nodes.  
ChildNodeRule Child node rules define nodes that are displayed at  
ChildNodeSpecificationBase Base interface for all ChildNodeSpecificationBase.ChildNodeSpecification implementations.  
ClassGroup Allows grouping ECInstance nodes by their base class.  
ConditionContainer Container of a ConditionContainer.condition property.  
ContentInstancesOfSpecificClassesSpecification Creates content for ECInstance(s) of specified classes.  
ContentModifier Rule that allows supplementing content with additional  
ContentModifiersList Contains various rule attributes that allow modifying returned content.  
ContentRelatedInstancesSpecification Creates content for ECInstance(s) related to current selection.  
ContentRule Defines content that's displayed in content controls (table view,  
ContentSpecificationBase Base interface for all ContentSpecificationBase.ContentSpecification implementations.  
CustomNodeSpecification Creates a custom-defined node.  
CustomQueryInstanceNodesSpecification Creates nodes for instances which are returned by an ECSQL query.  
DefaultGroupingPropertiesContainer A container of default grouping properties.  
DisabledSortingRule Rule to disable sorting for certain ECInstances in the hierarchy and/or content.  
ECPropertyValueQuerySpecification Specification which specifies the name of the parent instance property whose  
ExtendedDataRule Rule used to inject some extended data into presentation data  
GroupingRule Grouping rule is an advanced way to configure node grouping.  
GroupingSpecificationBase Base interface for all GroupingSpecificationBase.GroupingSpecification implementations.  
ImageIdOverride Rule that allows overriding default icon and dynamically define an icon  
InstanceLabelOverride Rule to override labels for instances of specific ECClasses.  
InstanceLabelOverrideBriefcaseIdSpecification Specification that returns ECInstance's briefcase ID in base36 format.  
InstanceLabelOverrideClassLabelSpecification Specification that uses ECClass display label as the label content.  
InstanceLabelOverrideClassNameSpecification Specification that uses ECClass name as the label content.  
InstanceLabelOverrideCompositeValueSpecification Specification that allows creating a label value composited using  
InstanceLabelOverrideLocalIdSpecification Specification that returns ECInstance's local ID in base36 format.  
InstanceLabelOverridePropertyValueSpecification Specification that uses property value as the label content.  
InstanceLabelOverrideStringValueSpecification Specification that uses the specified value as the label content.  
InstanceLabelOverrideValueSpecificationBase Base interface for all InstanceLabelOverrideValueSpecificationBase.InstanceLabelOverrideValueSpecification implementations.  
InstanceNodesOfSpecificClassesSpecification Creates nodes for all instances of specified ECClasses.  
LabelOverride Rule to override labels and descriptions of nodes which pass rule's  
MultiSchemaClassesSpecification Specification for multiple ECClasses that belong to  
NavigationRuleBase Base class for all NavigationRuleBase.NavigationRule implementations.  
NodeArtifactsRule Rule used to create and assign artifacts to specific nodes.  
PropertiesDisplaySpecification Sub-specification to hide / display specified ECInstance properties. Deprecated
PropertyCategorySpecification Specification to define a custom property category. Beta
PropertyEditorJsonParameters Arbitrary JSON parameters for custom property editors  
PropertyEditorMultilineParameters Multiline parameters for property editors that support multiline display  
PropertyEditorParametersBase Base interface for PropertyEditorParametersBase.PropertyEditorParameters.  
PropertyEditorRangeParameters Range parameters for property editors that support ranges  
PropertyEditorSliderParameters Slider parameters for property editors that support slider display  
PropertyEditorSpecification Specification for custom property editor  
PropertyEditorsSpecification Sub-specification to specify custom property editor Deprecated
PropertyGroup Allows grouping by property of the instance  
PropertyOverrides A container structure for possible property overrides Beta
PropertyRangeGroupSpecification Describes a grouping range  
PropertySortingRule Rule to configure sorting for certain ECInstances in the hierarchy and/or content.  
PropertySpecification Specification of an ECProperty and its overrides Beta
QuerySpecificationBase Base interface for all QuerySpecificationBase.QuerySpecification implementations.  
RelatedInstanceNodesSpecification Creates nodes for related instances of specified ECClasses.  
RelatedInstanceSpecification This sub-specification allows joining the primary node instance with any number of related instances and creating  
RelatedPropertiesSpecification Sub-specification to include additional related instance properties  
RootNodeRule Root node rules define the nodes that are displayed  
RuleBase Base interface for all RuleBase.Rule implementations.  
Ruleset Presentation ruleset is a list of rules that define tree hierarchy and content provided by  
SameLabelInstanceGroup Allows grouping multiple instances with the same label into one ECInstance node.  
SchemasSpecification Specification for a list of ECSchemas  
SelectedNodeInstancesSpecification Creates content for current selection.  
SingleSchemaClassSpecification Specification for a single ECClass  
SortingRuleBase Base class for all SortingRuleBase.SortingRule implementations.  
StringQuerySpecification Specification which contains an ECSQL query used to query for instances.  
StyleOverride Rule to override default node style and dynamically define a foreground/background  
SubCondition Defines child node specifications which should only be handled when a condition  
SupplementationInfo Contains supplementation-related information for  
Variable Definition for single user-controllable variable  
VariablesGroup Presentation rules support variables that allow having additional customization of the hierarchy  

Type Aliases

Name Description  
ChildNodeSpecification Navigation rule specifications that define what content the rule results in.  
ContentSpecification Content rule specifications which define what content is returned  
CustomizationRule Customization rules allow customizing each node or content item separately.  
GroupingSpecification Grouping rule specifications  
InstanceLabelOverrideValueSpecification Specification to define how the label for InstanceLabelOverrideValueSpecification.InstanceLabelOverride should be created.  
NavigationRule Navigation rules define the hierarchy that's created for navigation controls.  
PropertyEditorParameters Parameters for PropertyEditorParameters.PropertyEditorsSpecification  
QuerySpecification Query specifications used in QuerySpecification.CustomQueryInstanceNodesSpecification.  
Rule Presentation rules allow configuring the hierarchy and content.  
SortingRule Sorting rule implementations  

Last Updated: 24 January, 2020