Skip to content

Select elements from Model#

There are several ways to get elements from the model using the Revit API. Here we are going to explore some of them. Before starting, make sure you have installed Revit Python Shell. Please note that Revit Python Shell already has imported all the necessary classes and objects from the Revit API, so you can run directly in your RPS Editor all the code used in this story.

API Reference#

Using FilteredElementCollector#

All elements in the model#

1
2
3
4
# The variable doc is already instantiated in Revit Python Shell
elements = FilteredElementCollector(doc).WhereElementIsNotElementType()
for element in elements:
    print(element.Name)

All elements in the active view#

Here we are using the active view, but you can pass the Id of any view to the FilteredElementCollector constructor.

1
2
3
4
5
6
# The variable doc is already instantiated in Revit Python Shell
active_view = doc.ActiveView

elements = FilteredElementCollector(doc, active_view.Id).WhereElementIsNotElementType()
for element in elements:
    print(element.Name)

All elements owned by a view#

For example, an annotation element.

1
2
3
4
5
6
# The variable doc is already instantiated in Revit Python Shell
active_view = doc.ActiveView

elements = FilteredElementCollector(doc).OwnedByView(active_view.Id).WhereElementIsNotElementType()
for element in elements:
    print(element.Name)

All elements of a specific category#

In this example, we are getting all the elements from the model that have the category "Floors".

1
2
3
4
# The variable doc is already instantiated in Revit Python Shell
elements = FilteredElementCollector(doc).OfCategory(BuiltInCategory.OST_Floors).WhereElementIsNotElementType()
for element in elements:
    print(element.Name)

All elements of a specific class#

In this example, we are getting all the elements from the model that are instance of the class ViewSheet (Sheets in the model)

1
2
3
4
# The variable doc is already instantiated in Revit Python Shell
elements = FilteredElementCollector(doc).OfClass(ViewSheet).WhereElementIsNotElementType()
for element in elements:
    print(element.Name)

All type elements of a specific category#

In this example, we are getting all the type elements of category "Floors"

1
2
3
4
# The variable doc is already instantiated in Revit Python Shell
elements = FilteredElementCollector(doc).OfCategory(BuiltInCategory.OST_Floors).WhereElementIsElementType()
for element in elements:
    print(element.Name)

Combining methods in FilteredElementCollector#

Let's get all the elements of category floors from the current view. We can combine method inside the same 

1
2
3
4
5
6
7
FilteredElementCollector instance.
# The variable doc is already instantiated in Revit Python Shell
active_view = doc.ActiveView

elements = FilteredElementCollector(doc, active_view.Id).OfCategory(BuiltInCategory.OST_Floors).WhereElementIsNotElementType()
for element in elements:
    print(element.Name)

Elements from linked models#

The procedure is the same, the only difference is we have to use the "Document" from the linked model, for example:

1
2
3
4
5
6
7
8
# __revit__ is a instance of Autodesk.Revit.UI.UIApplication

for linked_doc in __revit__.Application.Documents:
    if linked_doc.IsLinked:
        elements = FilteredElementCollector(linked_doc).OfCategory(BuiltInCategory.OST_Floors).WhereElementIsNotElementType()
for element in elements:
        for element in elements:
            print(element.Name)

Graphical Selection#

Selected elements in model#

1
2
3
4
5
6
7
8
9
# The variables uidoc and doc already instantiated in Revit Python Shell

# Getting ids from selected objects
element_ids = uidoc.Selection.GetElementIds()
for id in element_ids:

# Getting element from id 
    element = doc.GetElement(id)
    print(element.Name)

Pick elements by rectangle#

1
2
3
4
5
6
# The variable uidoc is already instantiated in Revit Python Shell

# You can specify any prompt message
elements = uidoc.Selection.PickElementsByRectangle("Select elements")
for element in elements:
    print(element.Name)

Pick elements by rectangle and a filter#

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
from Autodesk.Revit.UI.Selection import ISelectionFilter

# Custom filter that takes a category name and filter the elements
# Alternatively you can create any type of filter
class CategoryISelectionFilter(ISelectionFilter):
    def __init__(self, category_name):
        self.category_name = category_name

    def AllowElement(self, e):
        if e.Category.Name == self.category_name:
            return True
        else:
            return False

    def AllowReference(self, ref, point):
        return False

# Instantiating the filter to allow only floors
# Alternatively you can instantiate it with other categories
floors_filter = CategoryISelectionFilter("Floors")

elements = uidoc.Selection.PickElementsByRectangle(floors_filter, "Select floors")
for element in elements:
    print(element.Name)