BisCore

alias: bis

version: 1.0.4

The BIS core schema contains classes that all other domain schemas extend.

displayLabel: BIS Core

Contains the core classes which define the base classes used by all BIS Domain schemas.

The BisCore schema also defines the database structure for an iModel. Other schemas may not add to the db schema without explicit permission from BisCore.

Entity Classes

AnnotationElement2d (2D Annotation Element)

typeName: EntityClass

description: bis:AnnotationElement2d is a bis:GraphicalElement2d used to annotate drawings and sheets.

baseClass: BisCore:GraphicalElement2d

AnnotationFrameStyle (Annotation Frame Style) Sealed

typeName: EntityClass

description: <No description>

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description Description of the style string
Data Encoded style properties binary

AnnotationLeaderStyle (Annotation Leader Style) Sealed

typeName: EntityClass

description: <No description>

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description Description of the style string
Data Encoded style properties binary

AnnotationTextStyle (Annotation Text Style) Sealed

typeName: EntityClass

description: <No description>

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description Description of the style string
Data Encoded style properties binary

AuxCoordSystem (Auxiliary Coordinate System) Abstract

typeName: EntityClass

description: <No description>

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Type int
Description string

AuxCoordSystem2d (2D Auxiliary Coordinate System)

typeName: EntityClass

description: A 2D coordinate system.

baseClass: BisCore:AuxCoordSystem

Properties

Name Description Type Extended Type
Origin point2d
Angle double

AuxCoordSystem3d (3D Auxiliary Coordinate System)

typeName: EntityClass

description: A 3D coordinate system.

baseClass: BisCore:AuxCoordSystem

Properties

Name Description Type Extended Type
Origin point3d
Yaw double
Pitch double
Roll double

AuxCoordSystemSpatial (Spatial Auxiliary Coordinate System)

typeName: EntityClass

description: A spatial coordinate system.

baseClass: BisCore:AuxCoordSystem3d

Category Abstract

typeName: EntityClass

description: A bis:Category categorizes a bis:GeometricElement and its geometry. Every bis:GeometricElement is in one and only one bis:Category. The visibility (on/off) of a bis:Category may be controlled per-view. Categories are similar to levels in DGN, layers in DWG, and categories in RVT.

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description string
Rank int

CategorySelector (Category Selector)

typeName: EntityClass

description: <No description>

baseClass: BisCore:DefinitionElement

CodeSpec (Code Specification) Sealed

typeName: EntityClass

description: A bis:CodeSpec (code specification) captures the rules for encoding and decoding significant business information into and from a Code (string). This specification is used to generate and validate Codes.

Properties

Name Description Type Extended Type
Name The unique name of the bis:CodeSpec. A best practice is to incorporate the schema alias or domain name into the bis:CodeSpec name to ensure uniqueness. string
JsonProperties A JSON string containing scope and fragment specifications used to generate and validate code values string Json

ColorBook (Color Book) Sealed

typeName: EntityClass

description: <No description>

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description string

DefinitionElement (Definition Element) Abstract

typeName: EntityClass

description: A bis:DefinitionElement holds configuration-related information that is meant to be referenced/shared.

baseClass: BisCore:InformationContentElement

Properties

Name Description Type Extended Type
IsPrivate If true, this bis:DefinitionElement should not be displayed in the GUI. boolean

DefinitionModel (Definition Model)

typeName: EntityClass

description: A container for persisting bis:DefinitionElement instances.

baseClass: BisCore:InformationModel

DefinitionPartition (Definition Partition) Sealed

typeName: EntityClass

description: A bis:DefinitionPartition element indicates that there is a definition-related modeling perspective within the overall information hierarchy. A bis:DefinitionPartition is always parented to a bis:Subject and broken down by a bis:DefinitionModel.

baseClass: BisCore:InformationPartitionElement

DictionaryModel (Dictionary Model) Sealed

typeName: EntityClass

description: The singleton container for repository-specific bis:DefinitionElement instances.

baseClass: BisCore:DefinitionModel

DisplayStyle (Display Style) Abstract

typeName: EntityClass

description: A bis:DisplayStyle defines the 'styling' parameters for rendering the contents of a view. It determines how graphics are rendered, not which elements are rendered. A bis:DisplayStyle can be shared by many Views.

baseClass: BisCore:DefinitionElement

DisplayStyle2d (2D Display Style)

typeName: EntityClass

description: A bis:DisplayStyle2d defines the 'styling' parameters for rendering the contents of a 2D View.

baseClass: BisCore:DisplayStyle

DisplayStyle3d (3D Display Style)

typeName: EntityClass

description: A bis:DisplayStyle3d defines the 'styling' parameters for rendering the contents of a 3D View.

baseClass: BisCore:DisplayStyle

Document (Document) Abstract

typeName: EntityClass

description: A bis:Document is a social artifact designed with the distinct purpose to convey information in a manner that maximizes reach and lifespan and minimize dependency on other artifacts. Although there is often a one-to-one relationship between a bis:Document and an electronic file, this does not imply that a document is a file; instead, a document can be realized in many different media (such as paper) or have more than one file supporting it.

baseClass: BisCore:InformationContentElement

DocumentCarrier (Document Carrier) Abstract Deprecated

typeName: EntityClass

description: DEPRECATED: A Document Carrier is an Information Carrier that carries a Document. An electronic file is a good example.

baseClass: BisCore:InformationCarrierElement

DocumentListModel (Document List)

typeName: EntityClass

description: A container for persisting bis:Document elements.

baseClass: BisCore:InformationModel

DocumentPartition (Document Partition) Sealed

typeName: EntityClass

description: A bis:DocumentPartition element indicates that there is a document-related modeling perspective within the overall information hierarchy. A bis:DocumentPartition is always parented to a bis:Subject and broken down by a bis:DocumentListModel.

baseClass: BisCore:InformationPartitionElement

Drawing

typeName: EntityClass

description: A bis:Drawing is a bis:Document of a 2D drawing.

baseClass: BisCore:Document

DrawingCategory (Drawing Category) Sealed

typeName: EntityClass

description: A bis:DrawingCategory is used for classifying bis:GeometricElement2d elements via the bis:GeometricElement2dIsInCategory (concrete and sealed) relationship.

baseClass: BisCore:Category

DrawingGraphic (Drawing Graphic)

typeName: EntityClass

description: bis:DrawingGraphic is a bis:GraphicalElement2d used to persist graphics for use in drawings.

baseClass: BisCore:GraphicalElement2d

DrawingModel (Drawing Model)

typeName: EntityClass

description: A container for persisting bis:DrawingGraphic elements.

baseClass: BisCore:GraphicalModel2d

DrawingViewDefinition (Drawing View Definition)

typeName: EntityClass

description: A bis:DrawingViewDefinition specifies parameters for a view of a bis:DrawingModel.

baseClass: BisCore:ViewDefinition2d

DriverBundleElement (Driver Bundle Element) Abstract

typeName: EntityClass

description: A bis:DriverBundleElement is used in conjunction with bis:ElementDrivesElement relationships to bundle multiple inputs before driving the output bis:Element.

baseClass: BisCore:InformationContentElement

Element Abstract

typeName: EntityClass

description: A bis:Element is the smallest individually identifiable building block for modeling the real world. Each bis:Element represents an entity in the real world. Sets of bis:Elements (contained in bis:Models) are used to model other bis:Elements that represent larger scale real world entities. Using this recursive modeling strategy, bis:Elements can represent entities at any scale. Elements can represent physical things, abstract concepts or simply be information records.

Properties

Name Description Type Extended Type
Model The bis:Model that contains this bis:Element. navigation
LastMod The last modified time of the bis:Element. This is maintained by the core framework and should not be set directly by applications. dateTime
CodeSpec The CodeSpec property identifies the bis:CodeSpec used to generate and validate the code for this bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeScope The CodeScope property identifies the bis:Element that provides the uniqueness scope for the code value. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. navigation
CodeValue The CodeValue property stores the formal name (business key) for a bis:Element. The combination of CodeSpec, CodeScope, and CodeValue properties must be unique for each bis:Element instance. string
UserLabel An optional friendly name given by the user (as opposed to the formal name stored in the CodeValue property). string
Parent The parent bis:Element that owns this bis:Element. navigation
FederationGuid The GUID used to federate this bis:Element across repositories. binary BeGuid
JsonProperties A string property that users and/or applications can use to persist ad hoc JSON values. string Json

ElementAspect (Element Aspect) Abstract

typeName: EntityClass

description: A bis:ElementAspect is a class that defines a set of properties that are related to (and owned by) a single bis:Element. Semantically, a bis:ElementAspect can be considered part of the bis:Element. Thus, a bis:ElementAspect is deleted if its owning bis:Element is deleted.

ElementMultiAspect (Element Multi-Aspect) Abstract

typeName: EntityClass

description: A bis:ElementMultiAspect is a bis:ElementAspect where there can be N instances of the bis:ElementAspect class per bis:Element.

baseClass: BisCore:ElementAspect

Properties

Name Description Type Extended Type
Element The bis:Element that owns this bis:ElementMultiAspect. navigation

ElementUniqueAspect (Element Unique Aspect) Abstract

typeName: EntityClass

description: A bis:ElementUniqueAspect is a bis:ElementAspect where there can be only zero or one instance of the bis:ElementAspect class per bis:Element.

baseClass: BisCore:ElementAspect

Properties

Name Description Type Extended Type
Element The bis:Element that owns this bis:ElementUniqueAspect navigation

typeName: EntityClass

description: A bis:EmbeddedFileLink is a bis:LinkElement that links to a file embedded within the iModel.

baseClass: BisCore:LinkElement

Properties

Name Description Type Extended Type
Name string
Description string

ExternalSourceAspect (External Source Aspect)

typeName: EntityClass

description: A bis:ElementMultiAspect that stores syncrhonization information for a bis:Element originating from an external source.

baseClass: BisCore:ElementMultiAspect

Properties

Name Description Type Extended Type
Scope The context in which the combination of (Kind, Identifier) identifies the object uniquely within the source repository. Scope is the Id of a bis:Element in the iModel (not the source) that corresponds to the scope or container in the source that owns, contains, or qualifies the identity of the source object. navigation
Identifier The identifier of the object in the source repository string
Kind The kind of object within the source repository string
Version An optional value that is typically a version number or a psuedo version number like last modified time. It will be used by the synchronization process to detect that a source object is unchanged so that computing a cryptographic hash can be avoided. If present, this value must be guaranteed to change when any of the source object's content changes. string
Checksum The cryptographic hash (any algorithm) of the source object's content. It must be guaranteed to change when the source object's content changes. string
JsonProperties A place where additional JSON properties can be stored. For example, provenance information or properties relating to the synchronization process. string Json

GeometricElement (Geometric Element) Abstract

typeName: EntityClass

description: bis:GeometricElement ia an abstract base class used to model real world entities that intrinsically have geometry.

baseClass: BisCore:Element

GeometricElement2d (2D Geometric Element) Abstract

typeName: EntityClass

description: bis:GeometricElement2d is an abstract base class used to model information entities that intrinsicly have 2D geometry.

baseClass: BisCore:GeometricElement

Properties

Name Description Type Extended Type
Category The bis:DrawingCategory used to categorize this bis:GeometricElement2d instance. navigation
Origin The placement origin of this bis:Element. point2d
Rotation The placement rotation (in degrees) of this bis:Element. double
BBoxLow The 'low' point of the element-aligned bounding box of this bis:Element. point2d
BBoxHigh The 'high' point of the element-aligned bounding box of this bis:Element. point2d
GeometryStream Binary stream used to persist the geometry of this bis:Element. binary GeometryStream
TypeDefinition navigation

GeometricElement3d (3D Geometric Element) Abstract

typeName: EntityClass

description: bis:GeometricElement3d is an abstract base class used to model real world entities that intrinsically have 3D geometry.

baseClass: BisCore:GeometricElement

Properties

Name Description Type Extended Type
Category The bis:SpatialCategory used to categorize this bis:GeometricElement3d navigation
InSpatialIndex If true, this element will have an entry in the Spatial Index. boolean
Origin The placement origin of this bis:Element. point3d
Yaw The Yaw angle (in degrees) of the orientation of this bis:Element. double
Pitch The Pitch angle (in degrees) of the orientation of this bis:Element. double
Roll The Roll angle (in degrees) of the orientation of this bis:Element. double
BBoxLow The 'low' point of the element-aligned bounding box of this bis:Element. point3d
BBoxHigh The 'high' point of the element-aligned bounding box of this bis:Element. point3d
GeometryStream Binary stream used to persist the geometry of this bis:Element. binary GeometryStream
TypeDefinition navigation

GeometricModel (Geometric Model) Abstract

typeName: EntityClass

description: A container for persisting bis:GeometricElement instances.

baseClass: BisCore:Model

GeometricModel2d (2D Geometric Model) Abstract

typeName: EntityClass

description: A container for persisting bis:GeometricElement2d instances.

baseClass: BisCore:GeometricModel

Properties

Name Description Type Extended Type
GlobalOrigin The actual coordinates of (0,0) in modeling coordinates. An offest applied to all modeling coordinates. point2d

GeometricModel3d (3D Geometric Model) Abstract

typeName: EntityClass

description: A container for persisting bis:GeometricElement3d instances.

baseClass: BisCore:GeometricModel

GeometryPart (Geometry Part)

typeName: EntityClass

description: A bis:DefinitionElement that specifies a collection of geometry that is meant to be reused across bis:GeometricElement instances. Leveraging bis:GeometryParts can help reduce file size and improve display performance.

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
GeometryStream binary GeometryStream
BBoxLow point3d
BBoxHigh point3d

GraphicalElement2d (2D Graphical Element) Abstract

typeName: EntityClass

description: bis:GraphicalElement2d is an abstract base class for 2D geometric elements that are used to convey information within graphical presentations (like drawings).

baseClass: BisCore:GeometricElement2d

GraphicalElement3d (3D Graphical Element) Abstract

typeName: EntityClass

description: A bis:GrapicalElement3d element conveys information within 3D graphical presentations.

baseClass: BisCore:GeometricElement3d

GraphicalModel2d (2D Graphical Model) Abstract

typeName: EntityClass

description: A container for persisting bis:GraphicalElement2d instances.

baseClass: BisCore:GeometricModel2d

GraphicalType2d (2D Graphical Type) Abstract

typeName: EntityClass

description: Defines a shared set of properties (the 'type') that can be associated with a bis:GraphicalElement2d instance.

baseClass: BisCore:TypeDefinitionElement

GroupInformationElement (Group Information) Abstract

typeName: EntityClass

description: bis:GroupInformationElement is an abstract base class used for modeling entities whose main purpose is to group related elements.

baseClass: BisCore:InformationReferenceElement

GroupInformationModel (Group Information Model) Abstract

typeName: EntityClass

description: A container for persisting bis:GroupInformationElement instances.

baseClass: BisCore:InformationModel

GroupInformationPartition (Group Information Partition) Sealed

typeName: EntityClass

description: A bis:GroupInformationPartition element indicates that there is a group-information-related modeling perspective within the overall information hierarchy. A bis:GroupInformationPartition is always parented to a bis:Subject and broken down by a bis:GroupInformationModel.

baseClass: BisCore:InformationPartitionElement

InformationCarrierElement (Information Carrier) Abstract Deprecated

typeName: EntityClass

description: DEPRECATED: An Information Carrier carries information, but is not the information itself. For example, the arrangement of ink on paper or the sequence of electronic bits are information carriers.

baseClass: BisCore:Element

InformationContentElement (Information Content Element) Abstract

typeName: EntityClass

description: bis:InformationContentElement is an abstract base class for modeling pure information entities. Only the core framework should directly subclass from bis:InformationContentElement. Domain and application developers should start with the most appropriate subclass of bis:InformationContentElement.

baseClass: BisCore:Element

InformationModel (Information Model) Abstract

typeName: EntityClass

description: A container for persisting bis:InformationContentElement instances.

baseClass: BisCore:Model

InformationPartitionElement (Information Partition) Abstract

typeName: EntityClass

description: Instances of bis:InformationPartitionElement ared used to indicate that there is a new modeling perspective within the overall information hierarchy. A bis:InformationPartitionElement is always parented to a bis:Subject and broken down by a bis:Model.

baseClass: BisCore:InformationContentElement

Properties

Name Description Type Extended Type
Description string

InformationRecordElement (Information Record Element) Abstract

typeName: EntityClass

description: bis:InformationRecordElement is an abstract base class for modeling information records. The bis:InformationRecordElement class is the default choice if no other subclass of bis:InformationContentElement makes sense.

baseClass: BisCore:InformationContentElement

InformationRecordModel (Information Record Model)

typeName: EntityClass

description: A container for persisting bis:InformationRecordElement instances

baseClass: BisCore:InformationModel

InformationRecordPartition (Information Record Partition) Sealed

typeName: EntityClass

description: A bis:InformationRecordPartition element indicates that there is an information-record-related modeling perspective within the overall information hierarchy. A bis:InformationRecordPartition is always parented to a bis:Subject and broken down by a bis:InformationRecordModel.

baseClass: BisCore:InformationPartitionElement

InformationReferenceElement (Information Reference) Abstract

typeName: EntityClass

description: bis:InformationReferenceElement is an abstract base class used for modeling entities whose main purpose is to reference something else.

baseClass: BisCore:InformationContentElement

LightLocation (Light Location) Sealed

typeName: EntityClass

description: The spatial location of a light source

baseClass: BisCore:SpatialLocationElement

Properties

Name Description Type Extended Type
Enabled boolean

LineStyle (Line Style) Sealed

typeName: EntityClass

description: <No description>

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description Description of the style string
Data Encoded style properties string Json

LinkElement (Link) Abstract

typeName: EntityClass

description: A bis:LinkElement is a bis:InformationReferenceElement that specifies a link.

baseClass: BisCore:InformationReferenceElement

LinkModel (Link Model)

typeName: EntityClass

description: A container for persisting bis:LinkElement instances.

baseClass: BisCore:InformationModel

LinkPartition (Link Partition) Sealed

typeName: EntityClass

description: A bis:LinkPartition element indicates that there is a link-related modeling perspective within the overall information hierarchy. A bis:LinkPartition is always parented to a bis:Subject and broken down by a bis:LinkModel.

baseClass: BisCore:InformationPartitionElement

Model Abstract

typeName: EntityClass

description: A bis:Model is a container for persisting a collection of related elements.

Properties

Name Description Type Extended Type
ParentModel The parent bis:Model contains the modeled bis:Element which is above this bis:Model in the information hierarchy. navigation
ModeledElement The bis:Model that is modeling (describing or breaking down) a bis:Element which is at a higher level of the information hierarchy. navigation
IsPrivate If IsPrivate is true then this bis:Model should not appear in lists shown to the user. boolean
IsTemplate If IsTemplate is true then this bis:Model is used as a template for creating new instances. boolean
JsonProperties A string property that users and/or applications can use to persist ad hoc JSON values. string Json

ModelSelector (Model Selector)

typeName: EntityClass

description: <No description>

baseClass: BisCore:DefinitionElement

OrthographicViewDefinition (Orthographic Spatial View)

typeName: EntityClass

description: A spatial view that always shows a parallel projection.

baseClass: BisCore:SpatialViewDefinition

PhysicalElement (Physical Element) Abstract

typeName: EntityClass

description: A bis:PhysicalElement is spatially located, has mass, and can be 'touched'.

baseClass: BisCore:SpatialElement

PhysicalMaterial (Physical Material) Abstract

typeName: EntityClass

description: A bis:PhysicalMaterial defines the matter of which physical objects are made. bis:PhysicalMaterials are not used to define rendering characteristics (see bis:RenderMaterial).

baseClass: BisCore:DefinitionElement

PhysicalModel (Physical Model)

typeName: EntityClass

description: A container for persisting bis:PhysicalElement and bis:SpatialLocationElement instances used to model physical space.

baseClass: BisCore:SpatialModel

PhysicalPartition (Physical Partition) Sealed

typeName: EntityClass

description: A bis:PhysicalPartition element indicates that there is a physical modeling perspective within the overall information hierarchy. A bis:PhysicalPartition is always parented to a bis:Subject and broken down by a bis:PhysicalModel.

baseClass: BisCore:InformationPartitionElement

PhysicalPortion (Physical Portion) Abstract Deprecated

typeName: EntityClass

description: DEPRECATED: A Physical Portion represents an arbitrary portion of a larger Physical Element that will be broken down in more detail in a separate (sub) Physical Model.

baseClass: BisCore:PhysicalElement

PhysicalType (Physical Type) Abstract

typeName: EntityClass

description: Defines a shared set of properties (the 'type') that can be associated with a bis:PhysicalElement. A bis:PhysicalType has a strong correlation with something that can be ordered from a catalog since all instances share a common set of properties.

baseClass: BisCore:TypeDefinitionElement

RecipeDefinitionElement (Recipe Definition) Abstract

typeName: EntityClass

description: Defines a recipe for generating a type.

baseClass: BisCore:DefinitionElement

RenderMaterial (Render Material) Sealed

typeName: EntityClass

description: A bis:RenderMaterial defines the rendering properties of materials for display.

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
PaletteName string
Description string

typeName: EntityClass

description: A bis:RepositoryLink is a bis:UrlLink element that links to a repository.

baseClass: BisCore:UrlLink

Properties

Name Description Type Extended Type
RepositoryGuid binary BeGuid

RepositoryModel (Repository Model) Sealed

typeName: EntityClass

description: The singleton container of repository-related information elements.

baseClass: BisCore:DefinitionModel

RoleElement (Role Element) Abstract

typeName: EntityClass

description: A real world entity is modeled as a bis:RoleElement when a set of external circumstances define an important role (one that is worth tracking) that is not intrinsic to the entity playing the role. For example, a person can play the role of a teacher or a rock can play the role of a boundary marker.

baseClass: BisCore:Element

RoleModel (Role Model)

typeName: EntityClass

description: A container for persisting bis:RoleElement instances.

baseClass: BisCore:Model

SectionDrawing (Section Drawing)

typeName: EntityClass

description: A bis:SectionDrawing is a bis:Document of a 2D section drawing.

baseClass: BisCore:Drawing

SectionDrawingModel (Section Drawing Model)

typeName: EntityClass

description: A container for persisting section bis:DrawingGraphic elements.

baseClass: BisCore:DrawingModel

Sheet

typeName: EntityClass

description: A bis:Sheet is a bis:Document of a 2D sheet.

baseClass: BisCore:Document

Properties

Name Description Type Extended Type
Scale double
Height double
Width double
SheetTemplate navigation

SheetBorder (Sheet Border)

typeName: EntityClass

description: <No description>

baseClass: BisCore:DrawingGraphic

Properties

Name Description Type Extended Type
BorderTemplate navigation

SheetBorderTemplate (Sheet Border Template)

typeName: EntityClass

description: <No description>

baseClass: BisCore:Document

Properties

Name Description Type Extended Type
Height double
Width double

SheetModel (Sheet Model)

typeName: EntityClass

description: A container for persisting sheet views and graphics.

baseClass: BisCore:GraphicalModel2d

SheetTemplate (Sheet Template)

typeName: EntityClass

description: <No description>

baseClass: BisCore:Document

Properties

Name Description Type Extended Type
Height double
Width double
Border navigation

SheetViewDefinition (Sheet View Definition)

typeName: EntityClass

description: A bis:SheetViewDefinition specifies parameters for a view of a bis:SheetModel.

baseClass: BisCore:ViewDefinition2d

SpatialCategory (Spatial Category) Sealed

typeName: EntityClass

description: A bis:SpatialCategory is used for classifying bis:GeometricElement3d elements via the bis:GeometricElement3dIsInCategory (concrete and sealed) relationship.

baseClass: BisCore:Category

SpatialElement (Spatial Element) Abstract

typeName: EntityClass

description: A bis:SpatialElement is a bis:GeometricElement3d that occupies real world space.

baseClass: BisCore:GeometricElement3d

SpatialIndex (Spatial Index) Sealed

typeName: EntityClass

description: The Spatial Index contains information used to optimize spatial queries. Like other database indices, it is automatically maintained by the system.

Properties

Name Description Type Extended Type
MinX Minimum X value of the axis-aligned range box that encloses the spatial element double
MaxX Maximum X value of the axis-aligned range box that encloses the spatial element double
MinY Minimum Y value of the axis-aligned range box that encloses the spatial element double
MaxY Maximum Y value of the axis-aligned range box that encloses the spatial element double
MinZ Minimum Z value of the axis-aligned range box that encloses the spatial element double
MaxZ Maximum Z value of the axis-aligned range box that encloses the spatial element double

SpatialLocationElement (Spatial Location Element) Abstract

typeName: EntityClass

description: A bis:SpatialLocationElement identifies a 'tracked' real world location but has no mass and cannot be 'touched'.

baseClass: BisCore:SpatialElement

SpatialLocationModel (Spatial Location Model)

typeName: EntityClass

description: A container for persisting bis:SpatialLocationElement instances.

baseClass: BisCore:SpatialModel

SpatialLocationPartition (Spatial Location Partition) Sealed

typeName: EntityClass

description: A bis:SpatialLocationPartition element indicates that there is a spatial-location-related modeling perspective within the overall information hierarchy. A bis:SpatialLocationPartition is always parented to a bis:Subject and broken down by a bis:SpatialLocationModel.

baseClass: BisCore:InformationPartitionElement

SpatialLocationPortion (Spatial Location Portion) Abstract Deprecated

typeName: EntityClass

description: DEPRECATED: A Spatial Location Portion represents an arbitrary portion of a larger Spatial Location Element that will be broken down in more detail in a separate (sub) Spatial Location Model.

baseClass: BisCore:SpatialLocationElement

SpatialLocationType (Spatial Location Type) Abstract

typeName: EntityClass

description: Defines a shared set of properties (the 'type') that can be associated with a bis:SpatialLocationElement instance.

baseClass: BisCore:TypeDefinitionElement

SpatialModel (Spatial Model) Abstract

typeName: EntityClass

description: A container for persisting bis:GeometricElement3d instances that are spatially located.

baseClass: BisCore:GeometricModel3d

SpatialViewDefinition (Spatial View Definition)

typeName: EntityClass

description: A view of a spatially located volume.

baseClass: BisCore:ViewDefinition3d

Properties

Name Description Type Extended Type
ModelSelector navigation

SubCategory (Sub-Category) Sealed

typeName: EntityClass

description: A bis:SubCategory is a subdivision of a bis:Category. SubCategories allow GeometricElements to have multiple pieces of Geometry that can be independently visible and styled (color, linesStyle, transparency, etc.). It is important to understand that a bis:SubCategory is not a bis:Category (i.e. Categories do not nest). bis:GeometricElements are always related to a bis:Category, not a bis:SubCategory.

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description string
Properties string Json

Subject Sealed

typeName: EntityClass

description: A bis:Subject is an information element that describes what this repository (or part thereof) is about.

baseClass: BisCore:InformationReferenceElement

Properties

Name Description Type Extended Type
Description string

TemplateRecipe2d (2D Template Recipe)

typeName: EntityClass

description: A recipe that uses a 2D template for creating new instances.

baseClass: BisCore:RecipeDefinitionElement

TemplateRecipe3d (3D Template Recipe)

typeName: EntityClass

description: A recipe that uses a 3D template for creating new instances.

baseClass: BisCore:RecipeDefinitionElement

TemplateViewDefinition2d (2D Template View Definition)

typeName: EntityClass

description: A bis:ViewDefinition2d used to display a 2D template model.

baseClass: BisCore:ViewDefinition2d

TemplateViewDefinition3d (3D Template View Definition)

typeName: EntityClass

description: A bis:ViewDefinition3d used to display a 3D template model.

baseClass: BisCore:ViewDefinition3d

TextAnnotation2d (2D Text Annotation)

typeName: EntityClass

description: <No description>

baseClass: BisCore:AnnotationElement2d

TextAnnotation3d (3D Text Annotation)

typeName: EntityClass

description: <No description>

baseClass: BisCore:GraphicalElement3d

TextAnnotationData (Text Annotation Data) Sealed

typeName: EntityClass

description: The aspect used to store text annotation data for bis:TextAnnotation2d an bis:TextAnnotation3d elements.

baseClass: BisCore:ElementUniqueAspect

Properties

Name Description Type Extended Type
TextAnnotation binary

TextAnnotationSeed (Text Annotation Seed) Sealed

typeName: EntityClass

description: <No description>

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description Description of the style string
Data Encoded style properties binary

Texture Sealed

typeName: EntityClass

description: A bis:Texture represents a named texture used for rendering purposes. The texture data is stored as a binary blob interpreted according to the specified texture format.

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description string
Data Encoded texture data binary
Format Format of the encoded texture data int
Width int
Height int
Flags int

TypeDefinitionElement (Type Definition) Abstract

typeName: EntityClass

description: Defines a shared set of properties (the 'type') that can be associated with a bis:Element.

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Recipe navigation

typeName: EntityClass

description: A bis:UrlLink is a bis:LinkElement that specifies a URL link.

baseClass: BisCore:LinkElement

Properties

Name Description Type Extended Type
Url string
Description string

ViewAttachment (View Attachment)

typeName: EntityClass

description: <No description>

baseClass: BisCore:GraphicalElement2d

Properties

Name Description Type Extended Type
View The view that is to be attached navigation

ViewDefinition (View Definition) Abstract

typeName: EntityClass

description: A bis:ViewDefinition specifies the area/volume that is viewed, and refers to a bis:DisplayStyle and a bis:CategorySelector to be used. Subclasses of bis:ViewDefinition determine which model(s) are viewed.

baseClass: BisCore:DefinitionElement

Properties

Name Description Type Extended Type
Description string
CategorySelector navigation
DisplayStyle navigation

ViewDefinition2d (2D View Definition) Abstract

typeName: EntityClass

description: A view of a 2D model that has its own local coordinate system.

baseClass: BisCore:ViewDefinition

Properties

Name Description Type Extended Type
BaseModel navigation
Origin Lower left corner of the viewed area. point2d
Extents Size of the view diagonal point2d
RotationAngle Rotation angle in degrees of the viewed area. double

ViewDefinition3d (3D View Definition) Abstract

typeName: EntityClass

description: A bis:ViewDefinition3d specifies the volume that is viewed on referenced 3D bis:Models. It refers to a bis:DisplayStyle3d and a bis:CategorySelector to be used.

baseClass: BisCore:ViewDefinition

Properties

Name Description Type Extended Type
Origin Origin of the viewed volume on the lower, back, rear point3d
Extents Size of the view diagonal point3d
Yaw Yaw component of the view direction in degrees double
Pitch Pitch component of the view direction in degrees double
Roll Roll component of the view direction in degrees double
IsCameraOn Is the camera actually turned on? boolean
EyePoint Camera eye point point3d
LensAngle Camera lens angle in degrees double
FocusDistance Camera focus distance double

VolumeElement (Volume Element)

typeName: EntityClass

description: A bis:VolumeElement is a bis:SpatialLocationElement that is restricted to defining a volume.

baseClass: BisCore:SpatialLocationElement

WebMercatorModel (Web Mercator Model)

typeName: EntityClass

description: <No description>

baseClass: BisCore:SpatialModel

Relationship Classes

BaseModelForView2d Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: is base model for

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: has base

multiplicity: (0..*)

Constraint Classes

CategoryOwnsSubCategories

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:ElementOwnsChildElements

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: owns

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: false

roleLabel: is owned by

multiplicity: (0..*)

Constraint Classes

CategorySelectorRefersToCategories Sealed

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:ElementRefersToElements

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: refers to

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is referenced by

multiplicity: (0..*)

Constraint Classes

CodeSpecSpecifiesCode Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: specified code for

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: code is specified by

multiplicity: (0..*)

Constraint Classes

DrawingGraphicRepresentsElement

typeName: RelationshipClass

description: Relates a bis:DrawingGraphic to the bis:Element that it represents.

baseClass: BisCore:ElementRefersToElements

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: represents

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is represented by

multiplicity: (0..*)

Constraint Classes

DrawingModelBreaksDownDrawing

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:ModelModelsElement

Strength: Embedding

strengthDirection: Backward

Source

isPolymorphic: true

roleLabel: breaks down

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is broken down by

multiplicity: (1..1)

Constraint Classes

ElementDrivesElement

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: drives

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is driven by

multiplicity: (0..*)

Constraint Classes

ElementEncapsulatesElements

typeName: RelationshipClass

description: A relationship that indicates that child bis:Elements are meant to be hidden.

baseClass: BisCore:ElementOwnsChildElements

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: encapsulates

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is encapsulated by

multiplicity: (0..*)

Constraint Classes

ElementGroupsMembers

typeName: RelationshipClass

description: A generic relationship used to capture the members of a defined set of bis:Elements.

baseClass: BisCore:ElementRefersToElements

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: groups

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is grouped by

multiplicity: (0..*)

Constraint Classes

typeName: RelationshipClass

description: Associates bis:LinkElements to a bis:Element.

baseClass: BisCore:ElementRefersToElements

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: has

multiplicity: (1..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is referenced by

multiplicity: (0..*)

Constraint Classes

ElementOwnsChildElements

typeName: RelationshipClass

description: Relates a bis:Element to child bis:Elements which represent parts of the entity modeled by the parent bis:Element.

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: owns child

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is owned by parent

multiplicity: (0..*)

Constraint Classes

ElementOwnsExternalSourceAspects

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:ElementOwnsMultiAspects

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: owns

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is owned by

multiplicity: (0..*)

Constraint Classes

ElementOwnsMultiAspects

typeName: RelationshipClass

description: <No description>

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: owns

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is owned by

multiplicity: (0..*)

Constraint Classes

ElementOwnsUniqueAspect

typeName: RelationshipClass

description: <No description>

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: owns

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is owned by

multiplicity: (0..*)

Constraint Classes

ElementRefersToDocuments

typeName: RelationshipClass

description: A general relationship between a bis:Element and a bis:Document. There is no implied owner in this relationship – so it is valid for relationship where the document existed before the referenced element (e.g. design specification) or after (e.g. operational results).

baseClass: BisCore:ElementRefersToElements

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: refers to

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is referenced by

multiplicity: (0..*)

Constraint Classes

ElementRefersToElements Abstract

typeName: RelationshipClass

description: A general relationship between two bis:Elements. These are typically specialized by derived relationship to give more specific meaning.

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: refers to

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is referenced by

multiplicity: (0..*)

Constraint Classes

ElementScopesCode Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: scopes code for

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: code is scoped by

multiplicity: (0..*)

Constraint Classes

ElementScopesExternalSourceIdentifier Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Backward

Source

isPolymorphic: true

roleLabel: scopes

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is scoped by

multiplicity: (0..*)

Constraint Classes

GeometricElement2dHasTypeDefinition Abstract

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: has

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: classifies

multiplicity: (0..1)

Constraint Classes

GeometricElement2dIsInCategory Sealed

typeName: RelationshipClass

description: The relationship that determines the bis:DrawingCategory for a bis:GeometricElement2d.

Strength: Referencing

strengthDirection: Backward

Source

isPolymorphic: true

roleLabel: is in

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: false

roleLabel: categorizes

multiplicity: (1..1)

Constraint Classes

GeometricElement3dHasTypeDefinition Abstract

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: has

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: classifies

multiplicity: (0..1)

Constraint Classes

GeometricElement3dIsInCategory Sealed

typeName: RelationshipClass

description: The relationship that determines the bis:SpatialCategory for a bis:GeometricElement3d.

Strength: Referencing

strengthDirection: Backward

Source

isPolymorphic: true

roleLabel: is in

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: false

roleLabel: categorizes

multiplicity: (1..1)

Constraint Classes

GraphicalElement2dIsOfType

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:GeometricElement2dHasTypeDefinition

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: is of

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: defines

multiplicity: (0..1)

Constraint Classes

GraphicalElement3dRepresentsElement

typeName: RelationshipClass

description: Relates a bis:GraphicalElement3d to the bis:Element that it represents.

baseClass: BisCore:ElementRefersToElements

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: represents

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is represented by

multiplicity: (0..*)

Constraint Classes

GraphicalType2dHasTemplateRecipe

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:TypeDefinitionHasRecipe

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: has

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is referenced by

multiplicity: (0..1)

Constraint Classes

ModelContainsElements Sealed

typeName: RelationshipClass

description: The relationship that enforces that each bis:Element belongs to exactly one bis:Model.

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: contains

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is contained by

multiplicity: (0..*)

Constraint Classes

ModelModelsElement

typeName: RelationshipClass

description: Relates a bis:Model to the bis:Element that it describes or breaks down into more detail.

Strength: Embedding

strengthDirection: Backward

Source

isPolymorphic: true

roleLabel: models

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is modeled by

multiplicity: (0..1)

Constraint Classes

ModelOwnsSubModel Sealed

typeName: RelationshipClass

description: The relationship that is used to build a model hierarchy index. This is done for performance reasons, rather than data modeling reasons.

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: owns sub

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is owned by parent

multiplicity: (0..*)

Constraint Classes

ModelSelectorRefersToModels Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: refers to

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is referenced by

multiplicity: (0..*)

Constraint Classes

PartitionOriginatesFromRepository Sealed

typeName: RelationshipClass

description: DEPRECATED

baseClass: BisCore:ElementRefersToElements

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: originates from

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is origin of

multiplicity: (0..*)

Constraint Classes

PhysicalElementAssemblesElements

typeName: RelationshipClass

description: A relationship that indicates a physical assembly of child bis:PhysicalElements.

baseClass: BisCore:ElementOwnsChildElements

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: assembles

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is assembled by

multiplicity: (0..*)

Constraint Classes

PhysicalElementIsOfType

typeName: RelationshipClass

description: A type-instance relation; one that indicates that the specific bis:PhysicalElement is an instance of the defined bis:PhysicalType. E.g. a pump with serial number #AR-23 is of type X-Model-Y.

baseClass: BisCore:GeometricElement3dHasTypeDefinition

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: is of

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: classifies

multiplicity: (0..1)

Constraint Classes

PhysicalModelBreaksDownPhysicalPortion Deprecated

typeName: RelationshipClass

description: DEPRECATED

baseClass: BisCore:ModelModelsElement

Strength: Embedding

strengthDirection: Backward

Source

isPolymorphic: true

roleLabel: breaks down

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is broken down by

multiplicity: (0..1)

Constraint Classes

PhysicalTypeHasTemplateRecipe

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:TypeDefinitionHasRecipe

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: has

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is referenced by

multiplicity: (0..1)

Constraint Classes

RenderMaterialOwnsRenderMaterials

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:ElementOwnsChildElements

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: false

roleLabel: owns child

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: false

roleLabel: is owned by parent

multiplicity: (0..*)

Constraint Classes

SheetBorderHasSheetBorderTemplate Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: has

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: defines

multiplicity: (0..1)

Constraint Classes

SheetHasSheetTemplate Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: has

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: defines

multiplicity: (0..1)

Constraint Classes

SheetModelBreaksDownSheet

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:ModelModelsElement

Strength: Embedding

strengthDirection: Backward

Source

isPolymorphic: true

roleLabel: breaks down

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is broken down by

multiplicity: (1..1)

Constraint Classes

SheetTemplateHasSheetBorder Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: has

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is referenced by

multiplicity: (0..1)

Constraint Classes

SpatialLocationIsOfType

typeName: RelationshipClass

description: A type-instance relation; one that indicates that the specific bis:SpatialLocationElement is an instance of the defined bis:SpatialLocationType. E.g. AssemblyArea#5 if of type FloorSpace.

baseClass: BisCore:GeometricElement3dHasTypeDefinition

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: is of

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: classifies

multiplicity: (0..1)

Constraint Classes

SpatialViewDefinitionUsesModelSelector Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: uses

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is used by

multiplicity: (1..1)

Constraint Classes

SubjectOwnsPartitionElements

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:ElementOwnsChildElements

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: false

roleLabel: owns

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is owned by

multiplicity: (0..*)

Constraint Classes

SubjectOwnsSubjects

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:ElementOwnsChildElements

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: false

roleLabel: owns child

multiplicity: (0..1)

Constraint Classes

Target

isPolymorphic: false

roleLabel: is owned by parent

multiplicity: (0..*)

Constraint Classes

TextAnnotation2dOwnsTextAnnotationData

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:ElementOwnsUniqueAspect

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: owns

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: false

roleLabel: is owned by

multiplicity: (0..1)

Constraint Classes

TextAnnotation3dOwnsTextAnnotationData

typeName: RelationshipClass

description: <No description>

baseClass: BisCore:ElementOwnsUniqueAspect

Strength: Embedding

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: owns

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: false

roleLabel: is owned by

multiplicity: (0..1)

Constraint Classes

TypeDefinitionHasRecipe Abstract

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: has

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is referenced by

multiplicity: (0..1)

Constraint Classes

ViewDefinitionUsesCategorySelector Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: uses

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: false

roleLabel: is used by

multiplicity: (1..1)

Constraint Classes

ViewDefinitionUsesDisplayStyle Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: uses

multiplicity: (0..*)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is used by

multiplicity: (1..1)

Constraint Classes

ViewIsAttached Sealed

typeName: RelationshipClass

description: <No description>

Strength: Referencing

strengthDirection: Forward

Source

isPolymorphic: true

roleLabel: owns

multiplicity: (1..1)

Constraint Classes

Target

isPolymorphic: true

roleLabel: is owned by

multiplicity: (0..*)

Constraint Classes

Enumerations

AutoHandledPropertyStatementType

typeName: Enumeration

Backing Type: int

description: <No description>

Strict: true

Label Value
ReadOnly = Select\ Insert 3
All = Select \ Insert \ Update 7

CustomHandledPropertyStatementType

typeName: Enumeration

Backing Type: int

description: <No description>

Strict: true

Label Value
None 0
Select 1
Insert 2
ReadOnly = Select\ Insert 3
Update 4
InsertUpdate = Insert \ Update 6
All = Select \ Insert \ Update 7

Mixin Classes

IParentElement (Parent Element) Abstract

typeName: Mixin

description: An interface that indicates that this class of bis:Element is capable of being a parent (owning child Elements). This interface is mutually exclusive with bis:ISubModeledElement.

appliesTo: Element

ISubModeledElement (Sub-Modeled Element) Abstract

typeName: Mixin

description: An interface that indicates that a bis:Element can be broken down or described by a (sub) bis:Model. This interface is mutually exclusive with bis:IParentElement.

appliesTo: Element

Custom Attribute Classes

AutoHandledProperty

typeName: CustomAttributeClass

description: Applied to an element's property to indicate that select, update, and insert of the property's value are handled automatically by the platform.

Applies to: AnyProperty

Properties

Name Description Label Category Read Only Priority
StatementTypes false 0

ClassHasHandler

typeName: CustomAttributeClass

description: Applied to an ECClass to indicate that a C++ subclass of DgnDomain::Handler will supply behavior for it at run-time. This custom attribute may only be used by BisCore or other core schemas.

Applies to: Any

Properties

Name Description Label Category Read Only Priority
Restrictions List of actions that are not permitted when the associated handler is not available false 0

CustomHandledProperty

typeName: CustomAttributeClass

description: Applied to an element's property to indicate that the property's value is handled specially by a C++ class.

Applies to: AnyProperty

Properties

Name Description Label Category Read Only Priority
StatementTypes false 0

SchemaHasBehavior

typeName: CustomAttributeClass

description: Applied to an ECSchema to indicate that there is an associated JavaScript library that will provide run-time behavior.

Applies to: Schema

Properties

Name Description Label Category Read Only Priority
Restrictions List of actions that are not permitted when the associated JavaScript library is not available. false 0

Last Updated: 03 June, 2019