PropertyGrid

Classes and components for working with a PropertyGrid.

Classes

Name Description  
CompositePropertyDataFilterer Composite PropertyData filter which can join two filters using logic operators Beta
DisplayValuePropertyDataFilterer Property data filterer which matches on Primitive Property Record display value text. Beta
FilteringPropertyDataProvider IPropertyDataProvider implementation which will filter wrapped provider PropertyData using passed IPropertyDataFilterer. Beta
LabelPropertyDataFilterer PropertyData filter which matches on any record type label and includes descendant nodes on match Beta
MutableCategorizedArrayProperty Mutable wrapper object for PropertyRecord with array valueFormat which provides methods for working with and managing record children hierarchies. Beta
MutableCategorizedPrimitiveProperty Mutable wrapper object for PropertyRecord with primitive valueFormat. Beta
MutableCategorizedProperty Base class for all Mutable CategorizedProperties Beta
MutableCategorizedStructProperty Mutable wrapper object for PropertyRecord with struct valueFormat which provides methods for working with and managing record children hierarchies. Beta
MutableFlatPropertyGridItem Base class for all FlatPropertyGrid items Beta
MutableGridCategory Mutable wrapper object for PropertyCategory which provides methods for working with and managing category and record children hierarchies Beta
MutableGridItemFactory Implementation of IMutableGridItemFactory for creating MutableGridItem objects. Beta
MutablePropertyGridModel Implementation of PropertyGridModel for working with and converting PropertyData to mutable FlatGridItems Beta
PropertyCategoryBlock PropertyCategoryBlock React component  
PropertyCategoryDataFiltererBase PropertyDataFilter base which is suited for only Category filtering Beta
PropertyCategoryLabelFilterer PropertyData filterer which matches on PropertyCategory's label. Beta
PropertyCategoryRendererManager Keeps a record of currently registered property category renderers and determines which renderers get invoked for Beta
PropertyDataChangeEvent An event broadcasted on property data changes  
PropertyDataFiltererBase PropertyDataFilter base which helps implement common logic between all IPropertyDataFilterer Beta
PropertyFilterChangeEvent An event broadcasted when property filter changes Beta
PropertyGrid PropertyGrid React component.  
PropertyGridEventHandler Handles events and changes on PropertyGridModel data. Beta
PropertyGridModelChangeEvent An event broadcasted on property grid model changes Beta
PropertyGridModelSource Controls property grid model. Beta
PropertyList A React component that renders multiple properties within a category as a list.  
PropertyRecordDataFiltererBase PropertyDataFilter base which is suited for only Record filtering Beta
SimplePropertyDataProvider Implementation of [IPropertyDataProvider] that uses an associative array.  
VirtualizedPropertyGrid VirtualizedPropertyGrid React component. Beta

Enumerations

Name Description  
CompositeFilterType Logical operator for composite filterer. Beta
FilteredType Enumeration of possible component filtered types Beta
FlatGridItemType Types of FlatGridItems for differentiating what property FlatGridItem is wrapping. Beta

Global Functions

Name Description  
usePropertyData Custom hook that gets propertyData from data provider and subscribes to further data changes. Beta
usePropertyGridEventHandler Custom hook that creates memoized version of PropertyGridEventHandler that modifies given modelSource Beta
usePropertyGridModel Custom hook that automatically listens and retrieves latest model from model source Beta
usePropertyGridModelSource Custom hook that creates a PropertyGridModelSource and subscribes it to data updates from the data provider. Beta
VirtualizedPropertyGridWithDataProvider VirtualizedPropertyGrid React Component which takes dataProvider and Beta

Interfaces

Name Description  
CategorizedPropertyItem Data structure which describes methods and properties present on immutable CategorizedPropertyItem objects Beta
CategoryRecordsDict Category name to PropertyRecord[] key pair interface used to describe which records belong to which category. Beta
CommonPropertyGridProps Common Property Grid Props to be used by Property Grid Variants  
FilteredPropertyData Data returned by FilteringPropertyDataProvider Beta
FlatGridItemBase Base immutable data structure defining common methods and properties for categories and categorized properties Beta
GridCategoryItem Data structure which describes methods and properties present on immutable GridCategoryItem Beta
IMutableCategorizedPropertyItem Data structure which describes methods and properties to be held by Mutable CategorizedPropertyItems Beta
IMutableFlatPropertyGridItem Base mutable data structure defining common methods and properties for both CategorizedProperties and GridCategoryItems Beta
IMutableGridCategoryItem Data structure which describes methods and properties to be held by Mutable GridCategoryItems Beta
IMutableGridItemFactory IMutableGridItemFactory interface for creating MutableGridItem objects Beta
IMutablePropertyGridModel PropertyGridModel interface for working with mutable FlatGridItems Beta
IPropertyDataFilterer Interface to be implemented by Property Data Filter classes Beta
IPropertyDataProvider An interface for property data provider which returns  
IPropertyGridEventHandler Handles events and changes on PropertyGridModel data. Beta
IPropertyGridModel PropertyGridModel interface for working with immutable FlatGridItems Beta
IPropertyGridModelSource Beta
PropertyCategory Contains metadata about a group of Properties.  
PropertyCategoryBlockProps Properties for the PropertyCategoryBlock React component  
PropertyCategoryRendererProps Props that property category renderer receives. Beta
PropertyData Interface for property data provided to the PropertyGrid React component.  
PropertyDataFilterResult Data structure for storing IPropertyDataFilterer matching results Beta
PropertyEditingArgs Arguments for the Property Editing event callback  
PropertyGridCategory Property Category in the PropertyGrid state Deprecated
PropertyGridContextMenuArgs Arguments for PropertyGridProps.onPropertyContextMenu callback  
PropertyGridProps Properties for PropertyGrid React component  
PropertyListProps Properties of PropertyList React component  
VirtualizedPropertyGridContext Context of the surrounding VirtualizedPropertyGrid component. Beta
VirtualizedPropertyGridProps Properties for VirtualizedPropertyGrid React component Beta
VirtualizedPropertyGridWithDataProviderProps Properties for VirtualizedPropertyGridWithDataProvider React component Beta

Type Aliases

Name Description  
CategorizedPropertyTypes Type which extracts FlatGridItemTypes relevant for working with CategorizedProperties Beta
FlatGridItem Type which describes immutable GridCategoryItem or CategorizedPropertyItem Beta
IMutableFlatGridItem Type which describes mutable GridCategoryItem or CategorizedProperty Beta
PropertyCategoryRenderer Factory function that produces custom property category components. Beta
PropertyDataChangesListener A signature for property data change listeners  
PropertyFilterChangesListener A signature for property data change listeners Beta
PropertyGridModelChangeListener A signature for property grid model change listeners Beta

Last Updated: 25 August, 2021