Entities
Definitions of the "props" interfaces and types that define the wire format for communication between the frontend and backend about entities (models, elements, etc) contained in an iModel.
Classes
Name | Description | |
---|---|---|
EntityMetaData | Metadata for an Entity. | Beta |
PropertyMetaData | Metadata for a property. | Beta |
RelatedElement | The Id and relationship class of an Element that is somehow related to another Element | |
TypeDefinition | A RelatedElement relationship that describes the TypeDefinitionElement of an element. |
Enumerations
Name | Description | |
---|---|---|
PrimitiveTypeCode | The primitive types of an Entity property. | Beta |
Rank | The rank for a Category | |
SectionType | An enumeration of the different types of SectionDrawings. | |
TextureFlags | Beta |
Interfaces
Name | Description | |
---|---|---|
CalloutProps | ||
CategoryProps | Parameters of a Category | |
ChannelRootAspectProps | Properties of an ChannelRootAspect that identifies an Element as the root of a channel which is a subset of the overall iModel hierarchy that is independently maintained. | |
CustomAttribute | A custom attribute instance | Beta |
DefinitionElementProps | Properties of a DefinitionElement | |
DisplayStyleLoadProps | Options for loading a DisplayStyleProps. | |
ElementAspectProps | Properties of an ElementAspect | |
ElementLoadProps | Parameters to specify what element to load for IModelDb.Elements.getElementProps. | |
ElementProps | Properties of an Element | |
EntityMetaDataProps | Beta | |
EntityProps | The properties of an Entity as they are read/stored from/to the iModel. | |
EntityQueryParams | Parameters for performing a query on Entity classes. | |
ExternalSourceAspectProps | Properties of an ExternalSourceAspect that stores synchronization information for an element originating from an external source. | |
FunctionalElementProps | ||
GeometricElement2dProps | Properties that define a GeometricElement2d | |
GeometricElement3dProps | Properties that define a GeometricElement3d | |
GeometricElementProps | Properties of a GeometricElement | |
GeometricModel2dProps | Properties that define a GeometricModel2d | |
GeometricModel3dProps | Properties that define a GeometricModel3d | |
GeometricModelProps | Properties that describe a GeometricModel | |
GeometryPartProps | Properties of a GeometryPart | |
InformationPartitionElementProps | Properties of a InformationPartitionElement | |
LineStyleProps | Properties of a LineStyle | Beta |
ModelLoadProps | Properties that specify what model should be loaded. | |
ModelProps | Properties that define a Model | |
ModelQueryParams | Parameters for performing a query on Model classes. | |
PhysicalElementProps | Properties that define a PhysicalElement | |
PhysicalTypeProps | Properties of a PhysicalType | |
Placement2dProps | Properties of a Placement2d | |
Placement3dProps | Properties of a Placement3d | |
PropertyMetaDataProps | Beta | |
RelatedElementProps | Properties of a NavigationProperty. | |
RelationshipProps | Properties that are common to all types of link table ECRelationships | |
RepositoryLinkProps | Parameters of a RepositoryLink | |
SectionDrawingLocationProps | Properties that define a SectionDrawingLocation | Beta |
SectionDrawingProps | Properties that define a SectionDrawing. | Beta |
SheetBorderTemplateProps | Properties of a SheetBorderTemplate | Beta |
SheetProps | Properties of a Sheet | Beta |
SheetTemplateProps | Properties of a SheetTemplate | Beta |
SourceAndTarget | Specifies the source and target elements of a Relationship instance. | |
SubCategoryProps | Parameters of a SubCategory | |
SubjectProps | Properties of a Subject | |
TextureProps | Properties that define a Texture | Beta |
TypeDefinitionElementProps | Properties of a TypeDefinitionElement | |
UrlLinkProps | Parameters of a UrlLink | |
ViewAttachmentLabelProps | ||
ViewAttachmentProps | Properties for a ViewAttachment |
Type Aliases
Name | Description | |
---|---|---|
PlacementProps | ||
PropertyCallback | A callback function to process properties of an Entity | Beta |
Last Updated: 21 December, 2020