IModelTransformContext Interface @beta

The supported transformation context exposed by an IModelTransformer.

Use context to obtain this context. It records source-to-target mappings, accepts explicit mapping and geometry-filtering rules, and resolves transformed entities. Element cloning, database access, native resource management, and context persistence remain implementation details of the transformer.

Methods

Name Description
filterSubCategory(sourceSubCategoryId: string): void Exclude geometry belonging to a source SubCategory from cloned geometry streams.  
findTargetAspectId(sourceAspectId: string): string Find the target element aspect corresponding to a source element aspect.  
findTargetCodeSpecId(sourceCodeSpecId: string): string Find the target CodeSpec corresponding to a source CodeSpec.  
findTargetElementId(sourceElementId: string): string Find the target element corresponding to a source element.  
findTargetEntityId(sourceEntityId: | | | ): Promise< | | | > Find the target entity corresponding to a typed source entity reference.  
isSubCategoryFiltered(sourceSubCategoryId: string): boolean Determine whether a source SubCategory is currently filtered.  
remapCodeSpec(sourceCodeSpecName: string, targetCodeSpecName: string): void Add or replace a mapping from a source CodeSpec to a target CodeSpec.  
remapElement(sourceElementId: string, targetElementId: string): void Add or replace a mapping from a source element to a target element.  
remapElementAspect(sourceAspectId: string, targetAspectId: string): void Add or replace a mapping from a source element aspect to a target element aspect.  
remapElementClass(sourceClassFullName: string, targetClassFullName: string): void Add or replace a mapping from a source element class to a target element class.  
removeElement(sourceElementId: string): void Remove the mapping for a source element.  
removeElementAspect(sourceAspectId: string): void Remove the mapping for a source element aspect.  

Properties

Name Type Description
hasSubCategoryFilter Readonly boolean Whether any SubCategories are currently filtered.  
isBetweenIModels Readonly boolean Whether this context maps entities between two different iModels.  

Defined in

Last Updated: 25 August, 2026