API Reference › presentation-components › All

presentation-components

Classes

Name Description
ContentDataProvider Base class for all presentation-driven content providers.
FavoritePropertiesDataFilterer IPropertyDataFilterer implementation which filters favorite properties
FavoritePropertiesDataProvider Presentation Rules-driven element favorite properties data provider implementation.
InstanceKeyValueRenderer Property value renderer for instance keys.
NavigationPropertyEditor Editor for navigation properties.
NavigationPropertyTargetEditor Component that renders navigation property target selector for navigation property value editing.
PresentationLabelsProvider Presentation Rules-driven labels provider implementation.
PresentationPropertyDataProvider Presentation Rules-driven property data provider implementation.
PresentationTreeDataProvider Presentation Rules-driven tree data provider.
UnifiedSelectionTreeEventHandler Tree event handler that handles unified selection.

Constants

Name Description
DEFAULT_PROPERTY_GRID_RULESET Default presentation ruleset used by PresentationPropertyDataProvider.
navigationPropertyEditorContext Context used to store data for NavigationPropertyEditor.

Enumerations

Name Description
PresentationComponentsLoggerCategory Logger categories used by this package

Global Functions

Name Description
convertToInstanceFilterDefinition Converts PresentationInstanceFilter built by PresentationInstanceFilterBuilder component into
customizeTreeNodeItem Applies customization from Node to TreeNodeItem. Deprecated
isPresentationInfoTreeNodeItem Function that checks if supplied TreeNodeItem is PresentationInfoTreeNodeItem.
isPresentationInstanceFilterConditionGroup Function that checks if supplied PresentationInstanceFilter is PresentationInstanceFilterConditionGroup.
isPresentationTreeNodeItem Function that checks if supplied TreeNodeItem is PresentationTreeNodeItem.
PresentationInstanceFilterBuilder Component for building complex instance filters for filtering Content and Nodes produced by PresentationManager.
PresentationInstanceFilterDialog Dialog component that renders PresentationInstanceFilterBuilder inside.
PresentationTreeNodeRenderer Component for rendering tree nodes produced by PresentationTreeDataProvider.
PresentationTreeRenderer Tree renderer component that enables hierarchy level filtering in trees using PresentationTreeDataProvider.
TableCellRenderer Renderer for single table cell.
UnifiedSelectionContextProvider Unified Selection context provider.
useControlledPresentationTreeFiltering A custom hook that creates filtered model source and node loader for supplied filter.
useHierarchyLevelFiltering Custom hook that creates callbacks for filtering hierarchy levels in the tree.
useNavigationPropertyEditingContext Custom hook that creates value for navigationPropertyEditorContext.
usePresentationInstanceFilteringProps Custom hook that extracts properties and classes from Descriptor and creates props that can be used by InstanceFilterBuilder component.
usePresentationTable Custom hook that loads data for generic table component.
usePresentationTableWithUnifiedSelection Custom hook that load data for generic table component.
usePresentationTreeNodeLoader Custom hooks which creates PagedTreeNodeLoader with PresentationTreeDataProvider using
usePropertyDataProviderWithUnifiedSelection A React hook that adds unified selection functionality to the provided data provider.
useRulesetRegistration Custom hook which registers supplied Ruleset on mount and removes on unmount.
useUnifiedSelectionContext Returns Unified Selection context provided by UnifiedSelectionContextProvider.
useUnifiedSelectionTreeEventHandler A custom hook which creates and disposes UnifiedSelectionTreeEventHandler
viewWithUnifiedSelection A HOC component that adds unified selection functionality to the supplied

Interfaces

Name Description
CacheInvalidationProps Properties for invalidating content cache.
ContentDataProviderProps Properties for creating a ContentDataProvider instance.
ControlledPresentationTreeFilteringProps Parameters for useControlledPresentationTreeFiltering hook
DiagnosticsProps Settings for capturing diagnostics data.
FavoritePropertiesDataFiltererProps Props for FavoritePropertiesDataFilterer.
FavoritePropertiesDataProviderProps Props for FavoritePropertiesDataProvider
IContentDataProvider Interface for all presentation-driven content providers.
IFavoritePropertiesDataProvider An data provider interface for returning favorite properties for the given elements
IFilteredPresentationTreeDataProvider Filtered presentation tree data provider.
IPresentationDataProvider Interface for a presentation data provider
IPresentationLabelsProvider Interface for presentation rules-driven labels provider.
IPresentationTreeDataProvider Presentation tree data provider.
IUnifiedSelectionComponent An interface for all unified selection components
NavigationPropertyEditorContextProps Data structure that describes navigationPropertyEditorContext value.
PresentationInfoTreeNodeItem Data structure that describes tree node item created by PresentationTreeDataProvider
PresentationInstanceFilterBuilderProps Props for PresentationInstanceFilterBuilder component.
PresentationInstanceFilterCondition Data structure that describes single filter condition.
PresentationInstanceFilterConditionGroup Data structure that describes group of filter condition joined by logical operator.
PresentationInstanceFilterDialogProps Props for PresentationInstanceFilterDialog component.
PresentationInstanceFilterInfo Data structure that stores information about filter built by PresentationInstanceFilterBuilder.
PresentationLabelsProviderProps Properties for creating a LabelsProvider instance.
PresentationPropertyDataProviderProps Properties for creating a PresentationPropertyDataProvider instance.
PresentationTreeDataProviderDataSourceEntryPoints Definitions of methods used by PresentationTreeDataProvider to get nodes' data.
PresentationTreeDataProviderProps Properties for creating a PresentationTreeDataProvider instance.
PresentationTreeNodeItem Data structure that describes tree node item created by PresentationTreeDataProvider.
PresentationTreeNodeItemFilteringInfo Data structure that describes information for tree item hierarchy level filtering.
PresentationTreeNodeLoaderProps Properties for usePresentationTreeNodeLoader hook.
PresentationTreeNodeLoaderResult Return type for usePresentationTreeNodeLoader hook.
PresentationTreeNodeRendererProps Props for PresentationTreeNodeRenderer component.
PresentationTreeRendererProps Props for PresentationTreeRenderer component.
PropertyDataProviderWithUnifiedSelectionProps Props for the usePropertyDataProviderWithUnifiedSelection hook
TableCellDefinition Data structure that defined table cell.
TableCellRendererProps Props for TableCellRenderer component.
TableColumnDefinition Data structure that defines table column.
TableRowDefinition Data structure that defined table row.
UnifiedSelectionContext Interface for accessing and modifying Unified Selection within React components.
UnifiedSelectionContextProviderProps Props for Unified Selection context provider.
UnifiedSelectionTreeEventHandlerParams Data structure that describes parameters for UnifiedSelectionTreeEventHandler
UseHierarchyLevelFilteringProps Props for useHierarchyLevelFiltering hook.
UsePresentationTableProps Props for usePresentationTable hook.
UsePresentationTableResult Return type of usePresentationTable hook.
UsePropertyDataProviderWithUnifiedSelectionResult usePropertyDataProviderWithUnifiedSelection return type.
ViewWithUnifiedSelectionProps Props that are injected to the ViewWithUnifiedSelection HOC component.

Namespaces

Name Description
CacheInvalidationProps

Type Aliases

Name Description
IPresentationPropertyDataProvider Interface for presentation rules-driven property data provider.
PresentationInstanceFilter Type that describes instance filter based on Descriptor fields.
UnifiedSelectionState

Last Updated: 26 April, 2023