Revitron¶

revitron.analyze¶

The revitron.analyze module helps you to automate analysing the health and status of a model and to extract several types of data and statistics in order to simplifiy BIM quality control. Extracted data is stored as snapshots in a SQLite database to be consumed by other applications or dashboards.

class DataProviderResult(providerClass, providerName, providerConfig)[source]¶

Bases: object

The DataProviderResult object handles the execution of a data provider by creating a unified results object containing the provider name, the resulting value and its data type.

__init__(providerClass, providerName, providerConfig)[source]¶

Inits a new provider class instances and runs the provider’s run() method in order to populate the value property.

Parameters

• providerClass (string) – The class name for the data provider that has to be used

• providerName (string) – A descriptive name to generate the storage field

• providerConfig (dict) – The configuration that is passed to the data provider

property dataType¶

The data type that is used to store the value.

Returns

The data type

Return type

string

property name¶

The name that is used to create a storage field.

Returns

The field name

Return type

string

property value¶

The resulting value.

Returns

The value that is returned by the provider’s run() method

Return type

mixed

class ModelAnalyzer(configJson, cliLog)[source]¶

Bases: object

The ModelAnalyzer class applies a configured set of data providers on a model and creates snapshots with the extracted statistics in a given SQLite database.

__init__(configJson, cliLog)[source]¶

Init a ModelAnalyzer instance.

Parameters

• configJson (string) – The configuration JSON file

• cliLog (CliLog) – The CLI log instance

snapshot()[source]¶

Create a snapshot and store the given DataProviderResult list along with a timestamp using a given storage driver.

revitron.ui¶

The revitron.ui module provides a set of helpers for creating UI elements in pyRevit.

revitron.boundingbox¶

The boundingbox submodule complements the Revit API bounding box methods by a simple helper class for working with bounding box elements.

Classes:

class BoundingBox(element)[source]¶

Bases: object

A BoundingBox class instance is a wrapper element for Revit bounding box object.

Create a new instance as follows:

bbox = revitron.BoundingBox(element)

Or even:

bbox = _(element).getBbox()

Attributes:

Max	The Max point of the bounding box.
Min	The Min point of the bounding box.

Methods:

__init__(element)	Inits a new BoundingBox instance for an element.
containsXY(bbox2)	Checks whether the bounding box contains another bounding box.
getCenterPoint()	Returns the center point of the bounding box.
hasPointXY(point)	Checks whether a point is inside a bounding box.

property Max¶

The Max point of the bounding box.

Returns

A Revit XYZ object

Return type

object

property Min¶

The Min point of the bounding box.

Returns

A Revit XYZ object

Return type

object

__init__(element)[source]¶

Inits a new BoundingBox instance for an element. In case the element has a scope box applied, the scope box’s bounding box is taken. In case the element has no scope box, but is a view plan, the crop box is used. The default Revit bounding box is used for all other elements.

Parameters

element (object) – A Revit Element

containsXY(bbox2)[source]¶

Checks whether the bounding box contains another bounding box. Only in X and Y dimensions.

Example:

contains = _(element1).getBbox().containsXY(_(element2).getBbox())

Parameters

bbox2 (object) – A bounding box object

Returns

True if the bounding box entirely contains bbox2

Return type

boolean

getCenterPoint()[source]¶

Returns the center point of the bounding box.

Returns

A Revit XYZ object.

Return type

object

hasPointXY(point)[source]¶

Checks whether a point is inside a bounding box. Only in X and Y dimensions.

Parameters

point (object) – A point object

Returns

True if the bounding box has the point inside

Return type

boolean

revitron.category¶

To simplify the interaction with Revit categories, the category submodule provides the Category and BuiltInCategory classes in order to access Revit category objects as well as builtin categories by name.

Classes:

class BuiltInCategory(name)[source]¶

Bases: object

A wrapper class for builtin category objects which can be instantiated by name.

You can get the Revit BuitlInCategory class object by providing a name as follows:

bic = revitron.BuiltInCategory('OST_Walls').get()

For convenience reasons, it is also valid to skip the OST_ prefix and simply do:

bic = revitron.BuiltInCategory('Walls').get()

In case you only know the natural category name and want to get the BuiltInCategory instead, you can also use that one. For example to get the OST_BeamAnalyticalTags BuiltInCategory, you can do simply:

bic = revitron.BuiltInCategory('Analytical Beam Tags').get()

A full list of category names can be found here.

Methods:

__init__(name)	Get the BuiltInCategory by its name, its name without the OST_ prefix or even its natural category name.
get()	Return the BuiltInCategory class.

__init__(name)[source]¶

Get the BuiltInCategory by its name, its name without the OST_ prefix or even its natural category name. A full list of category names can be found here.

Example:

bic = revitron.BuiltInCategory('OST_Walls').get()
bic = revitron.BuiltInCategory('Walls').get()

Use the natural name to get for example OST_BeamAnalyticalTags:

bic = revitron.BuiltInCategory('Analytical Beam Tags').get()

Parameters

name (name) – The name, the name without the OST_ prefix or even the natural category name

get()[source]¶

Return the BuiltInCategory class.

Returns

The BuiltInCategory class

Return type

class

class Category(name)[source]¶

Bases: object

A wrapper class for category objects which can be instantiated by a category name.

You can get the Revit Category class object by providing a name as follows:

category = revitron.Category('name').get()

Methods:

__init__(name)	Init a new Category by name.
get()	Returns the category object.
getBic()	Returns the built-in category for a given category.

__init__(name)[source]¶

Init a new Category by name.

Parameters

name (string) – The category name

get()[source]¶

Returns the category object.

Returns

The category object

Return type

object

getBic()[source]¶

Returns the built-in category for a given category.

Returns

The built-in category

Return type

object

revitron.create¶

The create submodule and its Create class contain helpful shorthand methods to create Revit elements and families programatically. For example a centered room tag can be created as follows:

tag = revitron.Create.roomTag(self.element, self.getBboxCenter())

Note that some methods are also directly accessible in element classes such as Room:

tag = _(room).tagCenter()

Classes:

class Create[source]¶

Bases: object

A collection of shorthand methods to create Revit elements.

Methods:

GridLineLinear(start, end, name)	Create a new linear grid line.
familyDoc(template, savePath)	Creates a new familiy document from a given template and saves it.add()
familyExtrusion(familyDoc, curveArrayArray, ...)	Creates an extrusion within a given family document.
familyInstance(familySymbolId, location[, ...])	Creates a new family instance.
roomTag(room, location[, typeId, viewId])	Creates a room tag for a given room element.
view3D()	Create a new 3D view.

static GridLineLinear(start, end, name)[source]¶

Create a new linear grid line.

Parameters

• start (object) – A Revit XYZ element

• end (object) – A Revit XYZ element

• name (string) – The grid name

Returns

A Revit grid element

Return type

object

static familyDoc(template, savePath)[source]¶

Creates a new familiy document from a given template and saves it.add()

Parameters

• template (string) – The template name without the .rft extension.

• savePath (string) – The full path of the family file to be saved as.

Returns

A reference to the newly created family document.

Return type

object

static familyExtrusion(familyDoc, curveArrayArray, sketchPlane, height=10.0, location=False, isSolid=True)[source]¶

Creates an extrusion within a given family document.

Parameters

• familyDoc (object) – A reference to a family document.

• curveArrayArray (object) – A Revit API CurveArrArray.

• sketchPlane (object) – A Revit API SketchPlane.

• height (float, optional) – The extrusion height. Defaults to 10.0.

• location (object, optional) – A Revit API XYZ point object. Defaults to False.

• isSolid (bool, optional) – Soild (True) or void (False). Defaults to True.

Returns

The extrusion element.

Return type

object

static familyInstance(familySymbolId, location, structuralType=False, view=None)[source]¶

Creates a new family instance.

Example:

transaction = revitron.Transaction()
instance = revitron.Create.familyInstance(familySymbolId, location)
transaction.commit()

Parameters

• familySymbolId (object) – A Revit API family symbol ID.

• location (object) – A Revit API XYZ point.

• structuralType (object, optional) – A Revit API structural type of False for NonStructural. Defaults to False.

• view (object, optional) – A Revit view, Defaults to None. Note that structuralType and view can not be used together.

Returns

The family instance.

Return type

object

static roomTag(room, location, typeId=False, viewId=False)[source]¶

Creates a room tag for a given room element.

Parameters

• room (object) – A Revit room element

• location (object) – A Revit point object

• typeId (ElementId, optional) – An optional Id of a tag type. Defaults to False.

• viewId (ElementId, optional) – An optional Id of a view. Defaults to the currently active view.

Returns

The Revit RoomTag element

Return type

object

static view3D()[source]¶

Create a new 3D view.

Returns

A Revit 3D view element

Return type

object

revitron.document¶

The document submodule contains classes to interact with the currently active Revit document or store individual project configurations within a model.

Classes:

class Document(doc=None)[source]¶

Bases: object

A basic wrapper class for Revit documents.

Basic examples are:

path = revitron.Document().getPath()
if revitron.Document().isFamily():
    pass

In case you want to work with any other model than the active one, it is possible to change the context to that model using the with statement. Changing the context to another model will internally redefine the revitron.DOC property within the scope of that with statement. Therefore it is also possible to use a revitron.Filter instance on any model by just using a filter within a with statement:

with revitron.Document(doc):
    fltr = revitron.Filter().noTypes()
    elements = fltr.getElements()

Methods:

__enter__()	Set revitron.DOC to the document of the current Document class instance.
__exit__(execType, execValue, traceback)	Restore the original context.
__init__([doc])	Inits a new Document instance.
getDuplicateInstances([preferOlderElement])	Returns a list of duplicate family instances.
getLinkedDocuments([scope])	Returns a dictionary of all linked documents.
getPath()	Returns the path to the document.
isFamily()	Checks whether the document is a family.
isOpen(path)	Checks whether a document is open by passing its path.
synchronize([compact, comment])	Synchronize the document.

__enter__()[source]¶

Set revitron.DOC to the document of the current Document class instance.

By default that will just be the active document and therefore revitron.DOC stays unchanged.

__exit__(execType, execValue, traceback)[source]¶

Restore the original context.

Parameters

• execType (string) – The execution type

• execValue (string) – The execution value

• traceback (mixed) – The traceback

__init__(doc=None)[source]¶

Inits a new Document instance.

Parameters

doc (object, optional) – Any document instead of the active one. Defaults to None.

getDuplicateInstances(preferOlderElement=False)[source]¶

Returns a list of duplicate family instances. By default, the list contains always the younger more recently created duplicate instance.

Note

This method requires Revit 2018 or newer!

Parameters

preferOlderElement (bool, optional) – Optionally return the list with the older instances. Defaults to False.

Returns

A list with duplicate instances, either the younger or the older ones.

Return type

list

getLinkedDocuments(scope=None)[source]¶

Returns a dictionary of all linked documents. The key is the ID of the link and the value is the actual document object.

Parameters

scope (mixed, optional) – List or view ID. Defaults to None.

Returns

A dictionary of all linked documents.

Return type

dict

getPath()[source]¶

Returns the path to the document.

Returns

The path

Return type

string

isFamily()[source]¶

Checks whether the document is a family.

Returns

True in case the document is a family

Return type

boolean

static isOpen(path)[source]¶

Checks whether a document is open by passing its path.

Parameters

path (string) – The path

Returns

True in case the document is open

Return type

boolean

synchronize(compact=True, comment='')[source]¶

Synchronize the document.

Parameters

• compact (bool, optional) – Compact while synchronizing. Defaults to True.

• comment (str, optional) – A comment for the synch that shows up in the log. Defaults to ‘’.

Returns

True on success

Return type

boolean

class DocumentConfigStorage[source]¶

Bases: object

The DocumentConfigStorage allows for easily storing project configuration items.

Getting configuration items:

config = revitron.DocumentConfigStorage().get('namespace.item')

The returned config item can be a string, a number, a list or a dictionary. It is also possible to define a default value in case the item is not defined in the storage:

from collections import defaultdict
config = revitron.DocumentConfigStorage().get('namespace.item', defaultdict())

Setting configuration items works as follows:

revitron.DocumentConfigStorage().set('namespace.item', value)

Methods:

__init__()	Inits a new DocumentConfigStorage object.
get(key[, default])	Returns storage entry for a given key.
set(key, data)	Updates or creates a config storage entry.

__init__()[source]¶

Inits a new DocumentConfigStorage object.

get(key, default=None)[source]¶

Returns storage entry for a given key.

Example:

config = revitron.DocumentConfigStorage()
item = config.get('name')

Parameters

• key (string) – The key of the storage entry

• default (mixed, optional) – An optional default value. Defaults to None.

Returns

The stored value

Return type

mixed

set(key, data)[source]¶

Updates or creates a config storage entry.

Example:

config = revitron.DocumentConfigStorage()
config.set('name', value)

Parameters

• key (string) – The storage entry key

• data (mixed) – The value of the entry

revitron.element¶

This submodule provides convenient wrappers for the interaction with elements. Getting parameter values or other information can be quite complicated using the plain Revit API. Methods like revitron.Element(element).get(parameter) simplify that process.

For example getting a parameter value or even a bounding box object works as follows:

form revitron import _
value = _(element).get('parameter')
boundingBox = _(element).getBbox()

Or setting parameter values:

_(element).set('parameter', value)

Classes:

class Element(element)[source]¶

Bases: object

A wrapper class for Revit elements.

Example:

value = revitron.Element(element).get('parameter')

Or in short:

from revitron import _
value = _(element).get('parameter')

Methods:

__getattr__(name)	Define default method to be returned on attribute errors.
__init__(element)	Inits a new element instance.
delete()	Delete an element.
get(paramName)	Returns a parameter value.
getBbox()	Returns a bounding box for the element.
getCategoryName()	Returns the category name of the element.
getClassName()	Returns the class name of the element.
getDependent([filterClass])	Returns a list of dependent elements.
getFamilyAndTypeName()	Returns the family name of the element.
getFamilyName()	Returns the family name of the element.
getFromType(paramName)	Returns a parameter value of the element type.
getGeometry()	Return the Revitron Geometry instance for this element.
getParameter(paramName)	Returns a parameter object.
getTags()	Get possibly existing tags of an element.
isNotOwned()	Checks whether an element is owned by another user.
isType()	Checks whether an element is a type or not.
set(paramName, value[, paramType])	Sets a parameter value.

Attributes:

element

The actual Revit element.

__getattr__(name)[source]¶

Define default method to be returned on attribute errors.

Since this is a generic element class that is extended by other more specialized classes such as the Room class, a default method along with an error message is returned when accidently calling a special methods that only exists in one of the derived classes on an element of another class.

Parameters

name (string) – The name of the called method

Returns

An empty method

Return type

method

__init__(element)[source]¶

Inits a new element instance.

Parameters

element (object) – The Revit element or an element ID

delete()[source]¶

Delete an element.

Example:

_(element).delete()

property element¶

The actual Revit element.

Returns

The Revit element object

Return type

object

get(paramName)[source]¶

Returns a parameter value.

Example:

value = _(element).get('name')

Parameters

paramName (string) – The name of the parameter

Returns

The parameter value

Return type

mixed

getBbox()[source]¶

Returns a bounding box for the element.

Returns

The bounding box or false on error

Return type

object

getCategoryName()[source]¶

Returns the category name of the element.

Returns

The category name

Return type

string

getClassName()[source]¶

Returns the class name of the element.

Returns

The class name

Return type

string

getDependent(filterClass=None)[source]¶

Returns a list of dependent elements.

Parameters

filterClass (class, optional) – An optional class to filter the list of dependent elements by. Defaults to None.

Returns

The list with the dependent Revit elements.

Return type

list

getFamilyAndTypeName()[source]¶

Returns the family name of the element.

Returns

The family name

Return type

string

getFamilyName()[source]¶

Returns the family name of the element.

Returns

The family name

Return type

string

getFromType(paramName)[source]¶

Returns a parameter value of the element type.

Example:

value = _(element).getFromType('name')

Parameters

paramName (string) – The name of the parameter

Returns

The parameter value

Return type

mixed

getGeometry()[source]¶

Return the Revitron Geometry instance for this element.

Returns

A Revitron Geometry object

Return type

object

getParameter(paramName)[source]¶

Returns a parameter object.

Parameters

paramName (string) – The name of the parameter

Returns

The parameter object

Return type

object

getTags()[source]¶

Get possibly existing tags of an element.

Returns

A list of Revit tag objects depending on the element class

Return type

list

isNotOwned()[source]¶

Checks whether an element is owned by another user.

Returns

True if the element is not owned by another user.

Return type

boolean

isType()[source]¶

Checks whether an element is a type or not.

Returns

True if element is a type.

Return type

bool

set(paramName, value, paramType=False)[source]¶

Sets a parameter value.

Example:

_(element).set('name', 'value', 'type')

Some possible parameter types are:

• Text

• Integer

• Number

• Length

• Angle

• Material

• YesNo

• MultilineText

• FamilyType

You can find a list of all types here.

Parameters

• paramName (string) – The parameter name

• value (mixed) – The value

• paramType (string, optional) – The parameter type. Defaults to ‘Text’.

Returns

The element instance

Return type

object

revitron.excel¶

This submodule contains helper classes to access and modify Microsoft Excel files. The following example demonstrates how to write data to table cells in a sheet created from a template:

book = revitron.ExcelWorkbook(xlsx)
sheet = book.newWorksheetFromTemplate('Template', 'Name')
sheet.setCell(5, 1, 'Value')

Classes:

class ExcelWorkbook(file)[source]¶

Bases: object

A wrapper class for Excel workbooks.

Methods:

__init__(file)	Inits a new ExcelWorkbook instance.
close([save])	Closes and optionally saves a workbook file.
getWorksheet(name)	Returns a Excel worksheet for a given name
newWorksheetFromTemplate(template, name)	Creates a new worksheet as a copy from a given template.

__init__(file)[source]¶

Inits a new ExcelWorkbook instance.

Parameters

file (string) – The path to the xls file

close(save=True)[source]¶

Closes and optionally saves a workbook file.

Parameters

save (bool, optional) – If True, the file is saved before closing. Defaults to True.

getWorksheet(name)[source]¶

Returns a Excel worksheet for a given name

Parameters

name (string) – The worksheet name

Returns

An Excel worksheet object instance

Return type

object

newWorksheetFromTemplate(template, name)[source]¶

Creates a new worksheet as a copy from a given template.

Parameters

• template (string) – The template name

• name (string) – The name of the new copy

Returns

An ExcelWorksheet instance

Return type

object

class ExcelWorksheet(worksheet)[source]¶

Bases: object

A wrapper class for modifying Excel worksheet cells.

Methods:

__init__(worksheet)	Inits a new ExcelWorksheet instance.
setCell(row, column, value)	Writes data to a cell of the current worksheet.

__init__(worksheet)[source]¶

Inits a new ExcelWorksheet instance.

Parameters

file (object) – An Excel worksheet object

setCell(row, column, value)[source]¶

Writes data to a cell of the current worksheet.

Parameters

• row (integer) – The row

• column (integer) – The column

• value (mixed) – The value

Returns

The ExcelWorkbook instance

Return type

object

revitron.export¶

The export submodule hosts all classes related to sheet export such as DWG and PDF. For example sending the currently active sheet to a PDF printer in the network works as follows:

exporter = revitron.PDFExporter(printerAddress, printerPath)
exporter.printSheet(revitron.ACTIVE_VIEW,
                                   'A0',
                                   'Landscape',
                                   'C:/pdf',
                                   '{Sheet Number}-{Sheet Title}')

Please check out the export tool of the Revitron UI extension to learn how to export a selection of sheets with a felxible configuration stored in a document.

Classes:

class CSVExporter[source]¶

Bases: object

Export a schedule as CSV named by a file naming template.

Methods:

__init__()	Inits a new CSVExporter instance.
exportSchedule(schedule, directory[, ...])	Exports a schedule.

__init__()[source]¶

Inits a new CSVExporter instance.

exportSchedule(schedule, directory, template=False, delimiter=';', hasTitle=False)[source]¶

Exports a schedule.

Parameters

• schedule (object) – A Revit schedule

• directory (string) – A custom output directory. Defaults to False.

• template (string, optional) – A name template. Defaults to ‘{View Name}’.

• delimiter (string, optional) – A csv delimiter. Defaults to ‘;’.

• hasTitle (bool, optional) – Set True to export schedule title. Defaults to False.

Returns

The path of the exported CSV. False on error.

Return type

string

class DWGExporter(setupName)[source]¶

Bases: object

Export sheets as DWG named by a file naming template.

Methods:

__init__(setupName)	Inits a new DWGExporter instance.
exportSheet(sheet, directory, unit[, template])	Exports a sheet.

__init__(setupName)[source]¶

Inits a new DWGExporter instance.

Parameters

setupName (string) – The name of a stored export setup

exportSheet(sheet, directory, unit, template=False)[source]¶

Exports a sheet.

Parameters

• sheet (object) – A Revit sheet

• directory (string) – The export directory

• unit (object) – The export unit

• template (string, optional) – A name template. Defaults to ‘{Sheet Number}-{Sheet Name}’.

Returns

The path of the exported PDF. False on error.

Return type

string

class PDFExporter(printer, output)[source]¶

Bases: object

Export sheets as PDF named by a file naming template.

Methods:

__init__(printer, output)	Inits a new PDFExporter instance.
printSheet(sheet, size[, orientation, ...])	Prints a sheet.
tempOutputPattern(sheet)	Create a glob pattern to identify a printed PDF in the system output directory to be able to move it to its correct location and rename it according to the given template.

__init__(printer, output)[source]¶

Inits a new PDFExporter instance.

Parameters

• printer (string) – The printer network adress

• output (string) – The printer output directory

printSheet(sheet, size, orientation='Landscape', colorMode='Color', directory=False, template=False)[source]¶

Prints a sheet.

Parameters

• sheet (object) – A Revit sheet

• size (string) – A size name like A0 or A4

• orientation (string, optional) – The orientation, ‘Landscape’ or ‘Portrait’. Defaults to ‘Landscape’.

• colorMode (string, optional) – The color setting for the printed sheets. Defaults to ‘Color’.

• directory (string, optional) – A custom output directory. Defaults to False.

• template (string, optional) – A name template. Defaults to ‘{Sheet Number}-{Sheet Name}’.

Returns

The path of the exported PDF. False on error.

Return type

string

tempOutputPattern(sheet)[source]¶

Create a glob pattern to identify a printed PDF in the system output directory to be able to move it to its correct location and rename it according to the given template.

Please note that the PDF network printer has to be configured to save PDFs following the below naming scheme:

[Revit File] - Sheet - [Sheet Number] - [Sheet Name].pdf

For example:

Project1 - Sheet - A101 - Unnamed.pdf

Parameters

sheet (object) – A Revit sheet objetc

Returns

The generated glob pattern

Return type

string

revitron.externalreference¶

This submodule contains a wrapper class for external references within a Revit document.

Classes:

class ExternalReference(ref)[source]¶

Bases: object

An external reference wrapper class.

Methods:

__init__(ref)

Inits a new ExternalReference instance.

__init__(ref)[source]¶

Inits a new ExternalReference instance.

Parameters

ref (object) – A Revit external reference instance.

revitron.failure¶

This is a helper submodule for handling errors and warnings occuring in transactions.

Classes:

class ErrorCatcher(*args: Any, **kwargs: Any)[source]¶

Bases: IFailuresPreprocessor

This class implements the IFailurePreprocessor interface and can be used as a preprocessor for rolling back on errors.

Parameters

IFailuresPreprocessor (interface) – The Revit API IFailuresPreprocessor interface.

Methods:

PreprocessFailures(failuresAccessor)

Preprocess all failures and returns a ProceedWithRollBack result on error.

PreprocessFailures(failuresAccessor)[source]¶

Preprocess all failures and returns a ProceedWithRollBack result on error.

Parameters

failuresAccessor (object) – The Revit API FailuresAccessor object.

Returns

The FailureProcessingResult.ProceedWithRollBack result on error or FailureProcessingResult.Continue.

Return type

object

class FailureHandler[source]¶

Bases: object

A basic failure handler.

Methods:

preprocess(failuresAccessor[, ...])

Preprocess failures by optionally suppressing all warnings and rolling back transactions on error.

static preprocess(failuresAccessor, suppressWarnings=False, rollbackOnError=False)[source]¶

Preprocess failures by optionally suppressing all warnings and rolling back transactions on error.

Parameters

• failuresAccessor (object) – A Revit failure accessor object.

• suppressWarnings (bool, optional) – Optionally suppress all warnings. Defaults to False.

• rollbackOnError (bool, optional) – Optionally roll back on errors. Defaults to False.

Returns

A Revit FailureProcessingResult

Return type

object

class WarningAndErrorCatcher(*args: Any, **kwargs: Any)[source]¶

Bases: IFailuresPreprocessor

This class implements the IFailurePreprocessor interface and can be used as a preprocessor for rolling back on errors and muting all warnings.

Parameters

IFailuresPreprocessor (interface) – The Revit API IFailuresPreprocessor interface.

Methods:

PreprocessFailures(failuresAccessor)

Preprocess all failures and returns a ProceedWithRollBack result on error.

PreprocessFailures(failuresAccessor)[source]¶

Preprocess all failures and returns a ProceedWithRollBack result on error.

Parameters

failuresAccessor (object) – The Revit API FailuresAccessor object.

Returns

The FailureProcessingResult.ProceedWithRollBack result on error or FailureProcessingResult.Continue.

Return type

object

class WarningCatcher(*args: Any, **kwargs: Any)[source]¶

Bases: IFailuresPreprocessor

This class implements the IFailurePreprocessor interface and can be used as a preprocessor for muting all warnings.

Parameters

IFailuresPreprocessor (interface) – The Revit API IFailuresPreprocessor interface.

Methods:

PreprocessFailures(failuresAccessor)

Preprocess all failures and deletes all warnings to suppress dialog boxes.

PreprocessFailures(failuresAccessor)[source]¶

Preprocess all failures and deletes all warnings to suppress dialog boxes.

Parameters

failuresAccessor (object) – The Revit API FailuresAccessor object.

Returns

The FailureProcessingResult.Continue result

Return type

object

revitron.filter¶

The filter submodule is one of the most essential one within the Revitron package. Its main purpose is taking over the heavy lifting of filtering elements in the Revit database and complementing the standard Revit API FilteredElementCollector class with the ability to filter collections by parameter values:

elements = (
    revitron.Filter
    .byStringEquals('param', 'value')
    .noTypes()
    .getElements()
)

Note that you can invert a filter by providing a the third argument for a string filter as follows:

elements = (
    revitron.Filter
    .byStringEquals('param', 'value', True)
    .noTypes()
    .getElements()
)

The document context can be changed as follows:

with revitron.Document(anyOtherDoc):
    fltr = revitron.Filter().noTypes()
    elements = fltr.getElements()

Classes:

class Filter(scope=None)[source]¶

Bases: object

A filter class based on the FilteredElementCollector class.

Methods:

__init__([scope])	Inits a new Filter instance.
byCategory(name)	Filters the collection by a category name or a built-in category name.
byClass(cls)	Filters the collection by class.
byIntersection(element)	Reduces the set of elements to the ones that are intersecting a given element.
byNumberIsEqual(paramName, value[, invert])	Filters the collection by parameter values equal to a given number.
byNumberIsGreater(paramName, value[, invert])	Filters the collection by parameter values greater than a given number.
byNumberIsGreaterOrEqual(paramName, value[, ...])	Filters the collection by parameter values greater than or equal to a given number.
byNumberIsLess(paramName, value[, invert])	Filters the collection by parameter values smaller than a given number.
byNumberIsLessOrEqual(paramName, value[, invert])	Filters the collection by parameter values smaller than or equal to a given number.
byOneInCsv(evaluatorName, paramName, csv[, ...])	Filters the collection by testing whether a string contains at lease one ot the items in a CSV list.
byRegex(paramName, regex[, invert])	Filters a collection by a given regex.
byStringBeginsWith(paramName, value[, invert])	Filters the collection by a string at the beginning of a parameter value.
byStringContains(paramName, value[, invert])	Filters the collection by a string contained in a parameter.
byStringContainsOneInCsv(paramName, csv[, ...])	Filters the collection by testing whether a string contains at lease one ot the items in a CSV list.
byStringEndsWith(paramName, value[, invert])	Filters the collection by a string at the end of a parameter.
byStringEquals(paramName, value[, invert])	Filters the collection by a string that equals a parameter value.
byStringEqualsOneInCsv(paramName, csv[, invert])	Filters the collection by testing whether a string equals at lease one ot the items in a CSV list.
getElementIds()	Get the collection as element IDs.
getElements()	Get the collection as elements.
noTypes()	Removes all types from collection.
onlyTypes()	Reduce to collection to types only.

__init__(scope=None)[source]¶

Inits a new Filter instance.

Parameters

scope (Element ID or list of elements, optional) – The optional scope. It can be either a view Id or a list of elements. Defaults to None.

byCategory(name)[source]¶

Filters the collection by a category name or a built-in category name.

Note that there are basically three valid types that can be used as the filter argument. The first two use the name of a built-in category (with or without the OST_ prefix):

fltr = revitron.Filter().byCategory('Walls')
fltr = revitron.Filter().byCategory('OST_Walls')

The third type uses a natural category name to find a corresponding built-in category to filter, here OST_BeamAnalyticalTags:

fltr = revitron.Filter().byCategory('Analytical Beam Tags')

Parameters

name (string) – A category or built-in category name

Returns

The Filter instance

Return type

object

byClass(cls)[source]¶

Filters the collection by class.

Example:

fltr = revitron.Filter()
cls = Autodesk.Revit.DB.CurveElement
ids = fltr.byClass(cls).noTypes().getElementIds()

Alternatively it is also possible to use a class name as string instead:

fltr = revitron.Filter()
ids = fltr.byClass('CurveElement').noTypes().getElementIds()

Parameters

cls (class) – A class or class name to filter the elements

Returns

The Filter instance

Return type

object

byIntersection(element)[source]¶

Reduces the set of elements to the ones that are intersecting a given element.

Parameters

element (objetc) – A Revit element

Returns

The Filter instance

Return type

object

byNumberIsEqual(paramName, value, invert=False)[source]¶

Filters the collection by parameter values equal to a given number.

Example:

fltr = revitron.Filter()
ids = fltr.byNumberIsEqual('Area', 5).noTypes().getElementIds()

Parameters

• paramName (string) – The parameter name

• value (number) – The numeric value to compare to

• invert (boolean) – Inverts the filter

Returns

The collector

Return type

object

byNumberIsGreater(paramName, value, invert=False)[source]¶

Filters the collection by parameter values greater than a given number.

Example:

fltr = revitron.Filter()
ids = fltr.byNumberIsGreater('Area', 5).noTypes().getElementIds()

Parameters

• paramName (string) – The parameter name

• value (number) – The numeric value to compare to

• invert (boolean) – Inverts the filter

Returns

The collector

Return type

object

byNumberIsGreaterOrEqual(paramName, value, invert=False)[source]¶

Filters the collection by parameter values greater than or equal to a given number.

Example:

fltr = revitron.Filter()
fltr = fltr.byNumberIsGreaterOrEqual('Area', 5).noTypes()
ids = fltr.getElementIds()

Parameters

• paramName (string) – The parameter name

• value (number) – The numeric value to compare to

• invert (boolean) – Inverts the filter

Returns

The collector

Return type

object

byNumberIsLess(paramName, value, invert=False)[source]¶

Filters the collection by parameter values smaller than a given number.

Example:

fltr = revitron.Filter()
ids = fltr.byNumberIsLess('Area', 5).noTypes().getElementIds()

Parameters

• paramName (string) – The parameter name

• value (number) – The numeric value to compare to

• invert (boolean) – Inverts the filter

Returns

The collector

Return type

object

byNumberIsLessOrEqual(paramName, value, invert=False)[source]¶

Filters the collection by parameter values smaller than or equal to a given number.

Example:

fltr = revitron.Filter()
ids = fltr.byNumberIsLessOrEqual('Area', 5).noTypes().getElementIds()

Parameters

• paramName (string) – The parameter name

• value (number) – The numeric value to compare to

• invert (boolean) – Inverts the filter

Returns

The collector

Return type

object

byOneInCsv(evaluatorName, paramName, csv, invert=False)[source]¶

Filters the collection by testing whether a string contains at lease one ot the items in a CSV list.

This method is the base method for the byStringContainsOneInCsv and byStringEqualsOneInCsv methods.

Note

that by setting invert to True, all elements that match one of the items will be removed from the collection.

Parameters

• evaluatorName (method) – The filter method to be used to filter

• paramName (string) – The name of the parameter

• csv (string) – A comma separated list of items

• invert (bool, optional) – Inverts the filter. Defaults to False.

Returns

The Filter instance

Return type

object

byRegex(paramName, regex, invert=False)[source]¶

Filters a collection by a given regex.

Parameters

• paramName (string) – The name of the parameter to be matched.

• regex (string) – The regex.

• invert (bool, optional) – Inverts the filter. Defaults to False.

Returns

The Filter instance

Return type

object

byStringBeginsWith(paramName, value, invert=False)[source]¶

Filters the collection by a string at the beginning of a parameter value.

Example:

fltr = revitron.Filter()
fltr = fltr.byStringBeginsWith('param', 'value').noTypes()
ids = fltr.getElementIds()

Parameters

• paramName (string) – The parameter name

• value (string) – The searched string

• invert (boolean) – Inverts the filter

Returns

The collector

Return type

object

byStringContains(paramName, value, invert=False)[source]¶

Filters the collection by a string contained in a parameter.

Example:

fltr = revitron.Filter()
fltr = fltr.byStringContains('param', 'value').noTypes()
ids = fltr.getElementIds()

Parameters

• paramName (string) – The parameter name

• value (string) – The searched string

• invert (boolean) – Inverts the filter

Returns

The collector

Return type

object

byStringContainsOneInCsv(paramName, csv, invert=False)[source]¶

Filters the collection by testing whether a string contains at lease one ot the items in a CSV list.

Note

that by setting invert to True, all elements that match one of the items will be removed from the collection.

Example:

fltr = revitron.Filter()
fltr = fltr.byStringContainsOneInCsv('Family', 'some, words', False)
fltr = fltr.noTypes()
elements = fltr.getElements()

Parameters

• paramName (string) – The name of the parameter

• csv (string) – A comma separated list of items

• invert (bool, optional) – Inverts the filter. Defaults to False.

Returns

The Filter instance

Return type

object

byStringEndsWith(paramName, value, invert=False)[source]¶

Filters the collection by a string at the end of a parameter.

Parameters

• paramName (string) – The parameter name

• value (string) – The searched string

• invert (boolean) – Inverts the filter

Returns

The collector

Return type

object

byStringEquals(paramName, value, invert=False)[source]¶

Filters the collection by a string that equals a parameter value.

Example:

fltr = revitron.Filter()
ids = fltr.byStringEquals('param', 'value').noTypes().getElementIds()

Parameters

• paramName (string) – The parameter name

• value (string) – The searched string

• invert (boolean) – Inverts the filter

Returns

The collector

Return type

object

byStringEqualsOneInCsv(paramName, csv, invert=False)[source]¶

Filters the collection by testing whether a string equals at lease one ot the items in a CSV list.

Note

that by setting invert to True, all elements that match one of the items will be removed from the collection.

Example:

fltr = revitron.Filter()
fltr = fltr.byStringEqualsOneInCsv('Family', 'some, words', False)
fltr = fltr.noTypes()
elements = fltr.getElements()

Parameters

• paramName (string) – The name of the parameter

• csv (string) – A comma separated list of items

• invert (bool, optional) – Inverts the filter. Defaults to False.

Returns

The Filter instance

Return type

object

getElementIds()[source]¶

Get the collection as element IDs.

Returns

The list of excluded element IDs

Return type

list

getElements()[source]¶

Get the collection as elements.

Returns

The list of excluded elements

Return type

list

noTypes()[source]¶

Removes all types from collection.

Returns

The Filter instance

Return type

object

onlyTypes()[source]¶

Reduce to collection to types only.

Returns

The Filter instance

Return type

object