API Reference > imodeljs-backend > iModels > IModelExporter

IModelExporter Class

Beta

Base class for exporting data from an iModel.

note Most uses cases will not require a custom subclass of IModelExporter. Instead, it is more typical to subclass/customize IModelExportHandler.

see iModel Transformation and Data Exchange, IModelExporter.registerHandler, IModelTransformer, IModelImporter

Methods

Name Description
constructor(sourceDb: IModelDb): IModelExporter Construct a new IModelExporter  
excludeCodeSpec(codeSpecName: string): void Add a rule to exclude a CodeSpec  
excludeElement(elementId: Id64String): void Add a rule to exclude a specific Element.  
excludeElementAspectClass(classFullName: string): void Add a rule to exclude all ElementAspects of a specified class.  
excludeElementCategory(categoryId: Id64String): void Add a rule to exclude all Elements of a specified Category.  
excludeElementClass(classFullName: string): void Add a rule to exclude all Elements of a specified class.  
excludeRelationshipClass(classFullName: string): void Add a rule to exclude all Relationships of a specified class.  
exportAll(): void Export all entity types from the source iModel.  
exportChanges(requestContext: AuthorizedClientRequestContext, startChangeSetId?: GuidString): Promise<void> Export changes from the source iModel.  
exportChildElements(elementId: Id64String): void Export the child elements of the specified element from the source iModel.  
exportCodeSpecById(codeSpecId: Id64String): void Export a single CodeSpec from the source iModel.  
exportCodeSpecByName(codeSpecName: string): void Export a single CodeSpec from the source iModel.  
exportCodeSpecs(): void Export all CodeSpecs from the source iModel.  
exportElement(elementId: Id64String): void Export the specified element, its child elements (if applicable), and any owned ElementAspects.  
exportFontByName(fontName: string): void Export a single font from the source iModel.  
exportFontByNumber(fontNumber: number): void Export a single font from the source iModel.  
exportFonts(): void Export all fonts from the source iModel.  
exportModel(modeledElementId: Id64String): void Export the model container, contents, and sub-models from the source iModel.  
exportModelContents(modelId: Id64String, elementClassFullName: string = Element.classFullName): void Export the model contents.  
exportRelationships(baseRelClassFullName: string): void Exports all relationships that subclass from the specified base class.  
exportSubModels(parentModelId: Id64String): void Export the sub-models directly below the specified model.  
registerHandler(handler: IModelExportHandler): void Register the handler that will be called by IModelExporter.  

Properties

Name Type Description
handler Accessor ProtectedReadOnly IModelExportHandler The handler called by this IModelExporter.  
sourceDb IModelDb The read-only source iModel.  

Defined in

Last Updated: 08 January, 2020