WireFormats

Definitions of the "props" interfaces and types that define the wire format for communication between the frontend and backend

Classes

Name Description
Metadata for an Entity.
Metadata for a property.
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.

Interfaces

Name Description
CalloutProps
CategoryProps Parameters of a Category
CustomAttribute A custom attribute instance
DefinitionElementProps Properties of a DefinitionElement
ElementAspectProps Properties of an ElementAspect
ElementLoadProps Parameters to specify what element to load for IModelDb.Elements.getElementProps.
ElementProps Properties of an Element
EntityMetaDataProps
EntityProps The properties of an Entity as they are read/stored from/to the iModel.
EntityQueryParams Parameters for performing an ECSQL SELECT query on Entity classes.
FunctionalElementProps
GeometricElement2dProps Properties that define a GeometricElement2d
GeometricElement3dProps Properties that define a GeometricElement3d
GeometricElementProps Properties of a GeometricElement
GeometricModel2dProps Properties that define a GeometricModel2d
GeometryPartProps Properties of a GeometryPart
InformationPartitionElementProps Properties of a InformationPartitionElement
LightLocationProps Properties of a LightLocation
LineStyleProps Properties of a LineStyle
ModelProps Properties that define a Model
ModelQueryParams Interface for querying a set of Models.
Placement2dProps Properties of a Placement2d
Placement3dProps Properties of a Placement3d
PropertyMetaDataProps
RelatedElementProps Properties of a NavigationProperty.
SheetBorderTemplateProps Properties of a SheetBorderTemplate
SheetProps Properties of a Sheet
SheetTemplateProps Properties of a SheetTemplate
SubCategoryProps Parameters of a SubCategory
SubjectProps Properties of a Subject
ThumbnailFormatProps Metadata about a thumbnail.
ThumbnailProps Properties of a thumbnail in an iModel.
TypeDefinitionElementProps Properties of a TypeDefinitionElement
ViewAttachmentLabelProps
ViewAttachmentProps Properties for a ViewAttachment

Type Aliases

Name Description
PlacementProps
PropertyCallback a callback function to process properties of an Entity

Last Updated: 17 December, 2018