Skip to content

query

Helper functions to query info and elements from Revit.

Attributes

mlogger = logger.get_logger(__name__) module-attribute

GRAPHICAL_VIEWTYPES = [DB.ViewType.FloorPlan, DB.ViewType.CeilingPlan, DB.ViewType.Elevation, DB.ViewType.ThreeD, DB.ViewType.Schedule, DB.ViewType.DrawingSheet, DB.ViewType.Report, DB.ViewType.DraftingView, DB.ViewType.Legend, DB.ViewType.EngineeringPlan, DB.ViewType.AreaPlan, DB.ViewType.Section, DB.ViewType.Detail, DB.ViewType.CostReport, DB.ViewType.LoadsReport, DB.ViewType.PresureLossReport, DB.ViewType.ColumnSchedule, DB.ViewType.PanelSchedule, DB.ViewType.Walkthrough, DB.ViewType.Rendering] module-attribute

DETAIL_CURVES = (DB.DetailLine, DB.DetailArc, DB.DetailEllipse, DB.DetailNurbSpline) module-attribute

MODEL_CURVES = (DB.ModelLine, DB.ModelArc, DB.ModelEllipse, DB.ModelNurbSpline) module-attribute

BUILTINCATEGORIES_VIEW = [DB.BuiltInCategory.OST_Views, DB.BuiltInCategory.OST_ReferenceViewer, DB.BuiltInCategory.OST_Viewers] module-attribute

GridPoint = namedtuple('GridPoint', ['point', 'grids']) module-attribute

SheetRefInfo = namedtuple('SheetRefInfo', ['sheet_num', 'sheet_name', 'detail_num', 'ref_viewid']) module-attribute

ElementHistory = namedtuple('ElementHistory', ['creator', 'owner', 'last_changed_by']) module-attribute

Classes

Functions

get_name(element, title_on_sheet=False)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def get_name(element, title_on_sheet=False):
    # grab viewname correctly
    if isinstance(element, DB.View):
        view_name = None
        if title_on_sheet:
            titleos_param = \
                element.Parameter[DB.BuiltInParameter.VIEW_DESCRIPTION]
            view_name = titleos_param.AsString()

        # if view name could not be extracted from title_on_sheet
        if view_name:
            return view_name
        else:
            if HOST_APP.is_newer_than('2019', or_equal=True):
                return element.Name
            else:
                return element.ViewName

    # have to use the imported Element otherwise
    # AttributeError occurs
    if PY3:
        return element.Name
    else:
        return Element.Name.__get__(element)

get_type(element)

Get element type.

Parameters:

Name Type Description Default
element Element

source element

 required

Returns:

Type Description
ElementType

type object of given element
Source code in pyrevitlib/pyrevit/revit/db/query.py 
103
104
105
106
107
108
109
110
111
112
113
def get_type(element):
    """Get element type.

    Args:
        element (DB.Element): source element

    Returns:
        (DB.ElementType): type object of given element
    """
    type_id = element.GetTypeId()
    return element.Document.GetElement(type_id)

get_symbol_name(element)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
116
117
def get_symbol_name(element):
    return get_name(element.Symbol)

get_family_name(element)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
120
121
def get_family_name(element):
    return get_name(element.Symbol.Family)

get_episodeid(element)

Extract episode id from element.

Source code in pyrevitlib/pyrevit/revit/db/query.py 
126
127
128
def get_episodeid(element):
    """Extract episode id from element."""
    return str(element.UniqueId)[:36]

get_guid(element)

Extract guid from given element.

Source code in pyrevitlib/pyrevit/revit/db/query.py 
131
132
133
134
135
136
137
def get_guid(element):
    """Extract guid from given element."""
    uid = str(element.UniqueId)
    last_32_bits = int(uid[28:36], 16)
    element_id = int(uid[37:], 16)
    xor = last_32_bits ^ element_id
    return uid[:28] + "{0:x}".format(xor)

get_param(element, param_name, default=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
140
141
142
143
144
145
def get_param(element, param_name, default=None):
    if isinstance(element, DB.Element):
        try:
            return element.LookupParameter(param_name)
        except Exception:
            return default

get_mark(element)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
148
149
150
def get_mark(element):
    mparam = element.Parameter[DB.BuiltInParameter.ALL_MODEL_MARK]
    return mparam.AsString() if mparam else ''

get_location(element)

Get element location point.

Parameters:

Name Type Description Default
element Element

source element

 required

Returns:

Type Description
XYZ

X, Y, Z of location point element
Source code in pyrevitlib/pyrevit/revit/db/query.py 
153
154
155
156
157
158
159
160
161
162
163
def get_location(element):
    """Get element location point.

    Args:
        element (DB.Element): source element

    Returns:
        (DB.XYZ): X, Y, Z of location point element
    """
    locp = element.Location.Point
    return (locp.X, locp.Y, locp.Z)

get_biparam_stringequals_filter(bip_paramvalue_dict)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
def get_biparam_stringequals_filter(bip_paramvalue_dict):
    filters = []
    for bip, fvalue in bip_paramvalue_dict.items():
        bip_id = DB.ElementId(bip)
        bip_valueprovider = DB.ParameterValueProvider(bip_id)
        if HOST_APP.is_newer_than(2022):
            bip_valuerule = DB.FilterStringRule(bip_valueprovider,
                                                DB.FilterStringEquals(),
                                                fvalue)
        else:
            bip_valuerule = DB.FilterStringRule(bip_valueprovider,
                                                DB.FilterStringEquals(),
                                                fvalue,
                                                True)
        filters.append(bip_valuerule)

    if filters:
        return DB.ElementParameterFilter(
            framework.List[DB.FilterRule](filters)
            )
    else:
        raise PyRevitException('Error creating filters.')

get_all_elements(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
190
191
192
193
194
195
196
197
def get_all_elements(doc=None):
            #  .WhereElementIsNotElementType()\
    return DB.FilteredElementCollector(doc or DOCS.doc)\
             .WherePasses(
                 DB.LogicalOrFilter(
                     DB.ElementIsElementTypeFilter(False),
                     DB.ElementIsElementTypeFilter(True)))\
             .ToElements()

get_all_elements_in_view(view)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
200
201
202
203
def get_all_elements_in_view(view):
    return DB.FilteredElementCollector(view.Document, view.Id)\
             .WhereElementIsNotElementType()\
             .ToElements()

get_param_value(targetparam)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
def get_param_value(targetparam):
    value = None
    if isinstance(targetparam, DB.Parameter):
        if targetparam.StorageType == DB.StorageType.Double:
            value = targetparam.AsDouble()
        elif targetparam.StorageType == DB.StorageType.Integer:
            value = targetparam.AsInteger()
        elif targetparam.StorageType == DB.StorageType.String:
            value = targetparam.AsString()
        elif targetparam.StorageType == DB.StorageType.ElementId:
            value = targetparam.AsElementId()
    elif isinstance(targetparam, DB.GlobalParameter):
        return targetparam.GetValue().Value
    return value

get_value_range(param_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
222
223
224
225
226
227
228
229
230
231
232
233
234
235
def get_value_range(param_name, doc=None):
    values = set()
    for element in get_all_elements(doc):
        targetparam = element.LookupParameter(param_name)
        if targetparam:
            value = get_param_value(targetparam)
            if value is not None \
                    and safe_strtype(value).lower() != 'none':
                if isinstance(value, str) \
                        and not value.isspace():
                    values.add(value)
                else:
                    values.add(value)
    return values

get_elements_by_parameter(param_name, param_value, doc=None, partial=False)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
def get_elements_by_parameter(param_name, param_value,
                              doc=None, partial=False):
    # does not work in < 2016
    # spid = framework.Guid('24353a46-1313-46a4-a779-d33ffe9353ab')
    # pid = DB.SharedParameterElement.Lookup(revit.doc, spid)
    # pp = DB.ParameterValueProvider(pid)
    # pe = DB.FilterStringEquals()
    # vrule = DB.FilterDoubleRule(pp, pe, scope_id, True)
    # param_filter = DB.ElementParameterFilter(vrule)
    # elements = DB.FilteredElementCollector(revit.doc) \
    #           .WherePasses(param_filter) \
    #           .ToElementIds()

    found_els = []
    for element in get_all_elements(doc):
        targetparam = element.LookupParameter(param_name)
        if targetparam:
            value = get_param_value(targetparam)
            if partial \
                    and value is not None \
                    and isinstance(value, str) \
                    and param_value in value:
                found_els.append(element)
            elif param_value == value:
                found_els.append(element)
    return found_els

get_elements_by_param_value(param_name, param_value, inverse=False, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
def get_elements_by_param_value(param_name, param_value,
                                inverse=False, doc=None):
    doc = doc or DOCS.doc
    param_id = get_project_parameter_id(param_name, doc)
    if param_id:
        pvprov = DB.ParameterValueProvider(param_id)
        pfilter = DB.FilterStringEquals()
        if HOST_APP.is_newer_than(2022):
            vrule = DB.FilterStringRule(pvprov, pfilter, param_value)
        else:
            vrule = DB.FilterStringRule(pvprov, pfilter, param_value, True)
        if inverse:
            vrule = DB.FilterInverseRule(vrule)
        param_filter = DB.ElementParameterFilter(vrule)
        return DB.FilteredElementCollector(doc)\
                 .WherePasses(param_filter)\
                 .ToElements()
    else:
        return []

get_elements_by_categories(element_bicats, elements=None, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
def get_elements_by_categories(element_bicats, elements=None, doc=None):
    # if source elements is provided
    if elements:
        return [x for x in elements
                if get_builtincategory(x.Category.Name)
                in element_bicats]

    # otherwise collect from model
    cat_filters = [DB.ElementCategoryFilter(x) for x in element_bicats if x]
    elcats_filter = \
        DB.LogicalOrFilter(framework.List[DB.ElementFilter](cat_filters))
    return DB.FilteredElementCollector(doc or DOCS.doc)\
             .WherePasses(elcats_filter)\
             .WhereElementIsNotElementType()\
             .ToElements()

get_elements_by_class(element_class, elements=None, doc=None, view_id=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
def get_elements_by_class(element_class, elements=None, doc=None, view_id=None):
    # if source elements is provided
    if elements:
        return [x for x in elements if isinstance(x, element_class)]

    # otherwise collect from model
    if view_id:
        return DB.FilteredElementCollector(doc or DOCS.doc, view_id)\
                 .OfClass(element_class)\
                 .WhereElementIsNotElementType()\
                 .ToElements()
    else:
        return DB.FilteredElementCollector(doc or DOCS.doc)\
                .OfClass(element_class)\
                .WhereElementIsNotElementType()\
                .ToElements()

get_types_by_class(type_class, types=None, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
322
323
324
325
326
327
328
329
330
def get_types_by_class(type_class, types=None, doc=None):
    # if source types is provided
    if types:
        return [x for x in types if isinstance(x, type_class)]

    # otherwise collect from model
    return DB.FilteredElementCollector(doc or DOCS.doc)\
            .OfClass(type_class)\
            .ToElements()

get_family(family_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
333
334
335
336
337
338
339
340
341
342
343
def get_family(family_name, doc=None):
    families = \
        DB.FilteredElementCollector(doc or DOCS.doc)\
          .WherePasses(
              get_biparam_stringequals_filter(
                  {DB.BuiltInParameter.SYMBOL_FAMILY_NAME_PARAM: family_name}
                  )
              )\
          .WhereElementIsElementType()\
          .ToElements()
    return families

get_family_symbol(family_name, symbol_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
346
347
348
349
350
351
352
353
354
355
356
357
358
def get_family_symbol(family_name, symbol_name, doc=None):
    famsyms = \
        DB.FilteredElementCollector(doc or DOCS.doc)\
          .WherePasses(
              get_biparam_stringequals_filter(
                  {
                      DB.BuiltInParameter.SYMBOL_FAMILY_NAME_PARAM: family_name,
                      DB.BuiltInParameter.SYMBOL_NAME_PARAM: symbol_name
                  }
                  ))\
          .WhereElementIsElementType()\
          .ToElements()
    return famsyms

get_families(doc=None, only_editable=True)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
361
362
363
364
365
366
367
368
369
def get_families(doc=None, only_editable=True):
    doc = doc or DOCS.doc
    families = [x.Family for x in set(DB.FilteredElementCollector(doc)
                                      .WhereElementIsElementType()
                                      .ToElements())
                if isinstance(x, (DB.FamilySymbol, DB.AnnotationSymbolType))]
    if only_editable:
        return [x for x in families if x.IsEditable]
    return families

get_noteblock_families(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
372
373
374
375
def get_noteblock_families(doc=None):
    doc = doc or DOCS.doc
    return [doc.GetElement(x)
            for x in DB.ViewSchedule.GetValidFamiliesForNoteBlock(doc)]

get_elements_by_family(family_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
378
379
380
381
382
383
384
385
386
387
388
def get_elements_by_family(family_name, doc=None):
    famsyms = \
        DB.FilteredElementCollector(doc or DOCS.doc)\
          .WherePasses(
              get_biparam_stringequals_filter(
                  {DB.BuiltInParameter.SYMBOL_FAMILY_NAME_PARAM: family_name}
                  )
              )\
          .WhereElementIsNotElementType()\
          .ToElements()
    return famsyms

get_elements_by_familytype(family_name, symbol_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
391
392
393
394
395
396
397
398
399
400
401
402
403
def get_elements_by_familytype(family_name, symbol_name, doc=None):
    syms = \
        DB.FilteredElementCollector(doc or DOCS.doc)\
          .WherePasses(
              get_biparam_stringequals_filter(
                  {DB.BuiltInParameter.SYMBOL_FAMILY_NAME_PARAM: family_name,
                   DB.BuiltInParameter.SYMBOL_NAME_PARAM: symbol_name
                   }
                  )
              )\
          .WhereElementIsNotElementType()\
          .ToElements()
    return syms

find_workset(workset_name_or_list, doc=None, partial=True)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
def find_workset(workset_name_or_list, doc=None, partial=True):
    workset_clctr = \
        DB.FilteredWorksetCollector(doc or DOCS.doc).ToWorksets()
    if isinstance(workset_name_or_list, list):
        for workset in workset_clctr:
            for workset_name in workset_name_or_list:
                if workset_name in workset.Name:
                    return workset

    elif isinstance(workset_name_or_list, str):
        workset_name = workset_name_or_list

        if partial:
            for workset in workset_clctr:
                if workset_name in workset.Name:
                    return workset
        else:
            for workset in workset_clctr:
                if workset_name == workset.Name:
                    return workset

model_has_family(family_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
428
429
430
def model_has_family(family_name, doc=None):
    collector = get_family(family_name, doc=doc)
    return hasattr(collector, 'Count') and collector.Count > 0

model_has_workset(workset_name, partial=False, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
433
434
def model_has_workset(workset_name, partial=False, doc=None):
    return find_workset(workset_name, partial=partial, doc=doc)

get_sharedparam_definition_file()

Source code in pyrevitlib/pyrevit/revit/db/query.py 
437
438
439
440
441
442
443
444
445
def get_sharedparam_definition_file():
    if HOST_APP.app.SharedParametersFilename:
        sparamf = HOST_APP.app.OpenSharedParameterFile()
        if sparamf:
            return sparamf
        else:
            raise PyRevitException('Failed opening Shared Parameters file.')
    else:
        raise PyRevitException('No Shared Parameters file defined.')

get_defined_sharedparams()

Source code in pyrevitlib/pyrevit/revit/db/query.py 
448
449
450
451
452
453
454
455
456
def get_defined_sharedparams():
    # returns DB.ExternalDefinition
    pp_list = []
    try:
        for def_group in get_sharedparam_definition_file().Groups:
            pp_list.extend([x for x in def_group.Definitions])
    except PyRevitException as ex:
        mlogger.debug('Error getting shared parameters. | %s', ex)
    return pp_list

get_project_parameters(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
def get_project_parameters(doc=None):
    doc = doc or DOCS.doc
    # collect shared parameter names
    shared_params = {x.Name: x for x in get_defined_sharedparams()}

    pp_list = []
    if doc and not doc.IsFamilyDocument:
        param_bindings = doc.ParameterBindings
        pb_iterator = param_bindings.ForwardIterator()
        pb_iterator.Reset()

        while pb_iterator.MoveNext():
            msp = db.ProjectParameter(
                pb_iterator.Key,
                param_bindings[pb_iterator.Key],
                param_ext_def=shared_params.get(pb_iterator.Key.Name, None))
            pp_list.append(msp)

    return pp_list

get_project_parameter_id(param_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
480
481
482
483
484
485
def get_project_parameter_id(param_name, doc=None):
    doc = doc or DOCS.doc
    for project_param in get_project_parameters(doc):
        if project_param.name == param_name:
            return project_param.param_id
    raise PyRevitException('Parameter not found: {}'.format(param_name))

get_project_parameter(param_id_or_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
488
489
490
491
492
def get_project_parameter(param_id_or_name, doc=None):
    pp_list = get_project_parameters(doc or DOCS.doc)
    for msp in pp_list:
        if msp == param_id_or_name:
            return msp

model_has_parameter(param_id_or_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
495
496
def model_has_parameter(param_id_or_name, doc=None):
    return get_project_parameter(param_id_or_name, doc=doc)

get_global_parameters(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
499
500
501
502
def get_global_parameters(doc=None):
    doc = doc or DOCS.doc
    return [doc.GetElement(x)
            for x in DB.GlobalParametersManager.GetAllGlobalParameters(doc)]

get_global_parameter(param_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
505
506
507
508
509
510
def get_global_parameter(param_name, doc=None):
    doc = doc or DOCS.doc
    if features.GLOBAL_PARAMS:
        param_id = DB.GlobalParametersManager.FindByName(doc, param_name)
        if param_id != DB.ElementId.InvalidElementId:
            return doc.GetElement(param_id)

get_project_info(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
513
514
def get_project_info(doc=None):
    return db.ProjectInfo(doc or DOCS.doc)

get_revisions(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
517
518
519
520
def get_revisions(doc=None):
    return list(DB.FilteredElementCollector(doc or DOCS.doc)
                .OfCategory(DB.BuiltInCategory.OST_Revisions)
                .WhereElementIsNotElementType())

get_sheet_revisions(sheet)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
523
524
525
def get_sheet_revisions(sheet):
    doc = sheet.Document
    return [doc.GetElement(x) for x in sheet.GetAdditionalRevisionIds()]

get_current_sheet_revision(sheet)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
528
529
530
def get_current_sheet_revision(sheet):
    doc = sheet.Document
    return doc.GetElement(sheet.GetCurrentRevision())

get_sheets(include_placeholders=True, include_noappear=True, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
533
534
535
536
537
538
539
540
541
542
543
544
def get_sheets(include_placeholders=True, include_noappear=True, doc=None):
    sheets = list(DB.FilteredElementCollector(doc or DOCS.doc)
                  .OfCategory(DB.BuiltInCategory.OST_Sheets)
                  .WhereElementIsNotElementType())
    if not include_noappear:
        sheets = [x for x in sheets
                  if x.Parameter[DB.BuiltInParameter.SHEET_SCHEDULED]
                  .AsInteger() > 0]
    if not include_placeholders:
        return [x for x in sheets if not x.IsPlaceholder]

    return sheets
Source code in pyrevitlib/pyrevit/revit/db/query.py 
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
def get_links(linktype=None, doc=None):
    doc = doc or DOCS.doc

    location = doc.PathName
    if not location:
        raise PyRevitException('PathName is empty. Model is not saved.')

    links = []
    model_path = \
        DB.ModelPathUtils.ConvertUserVisiblePathToModelPath(location)
    if not model_path:
        raise PyRevitException('Model is not saved. Can not read links.')
    try:
        trans_data = DB.TransmissionData.ReadTransmissionData(model_path)
        external_refs = trans_data.GetAllExternalFileReferenceIds()
        for ref_id in external_refs:
            ext_ref = trans_data.GetLastSavedReferenceData(ref_id)
            link = doc.GetElement(ref_id)
            if linktype:
                if ext_ref.ExternalFileReferenceType == linktype:
                    links.append(db.ExternalRef(link, ext_ref))
            else:
                links.append(db.ExternalRef(link, ext_ref))
        return links
    except Exception as data_err:
        raise PyRevitException('Error reading links from model path: {} | {}'
                               .format(model_path, data_err))

get_linked_models(doc=None, loaded_only=False)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
576
577
578
579
580
581
582
583
584
def get_linked_models(doc=None, loaded_only=False):
    doc = doc or DOCS.doc
    linkedmodels = get_links(linktype=DB.ExternalFileReferenceType.RevitLink,
                             doc=doc)
    if loaded_only:
        return [x for x in linkedmodels
                if DB.RevitLinkType.IsLoaded(doc, x.id)]

    return linkedmodels

get_linked_model_doc(linked_model)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
587
588
589
590
591
592
593
594
595
596
597
def get_linked_model_doc(linked_model):
    lmodel = None
    if isinstance(linked_model, DB.RevitLinkType):
        lmodel = db.ExternalRef(linked_model) #pylint: disable=E1120
    elif isinstance(linked_model, db.ExternalRef):
        lmodel = linked_model

    if lmodel:
        for open_doc in DOCS.docs:
            if open_doc.Title == lmodel.name:
                return open_doc

find_first_legend(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
600
601
602
603
604
605
def find_first_legend(doc=None):
    doc = doc or DOCS.doc
    for view in DB.FilteredElementCollector(doc).OfClass(DB.View):
        if view.ViewType == DB.ViewType.Legend and not view.IsTemplate:
            return view
    return None

compare_revisions(src_rev, dest_rev, case_sensitive=False)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
608
609
610
611
612
613
614
def compare_revisions(src_rev, dest_rev, case_sensitive=False):
    return all(db.BaseWrapper.compare_attrs(src_rev, dest_rev,
                                            ['RevisionDate',
                                             'Description',
                                             'IssuedBy',
                                             'IssuedTo'],
                                            case_sensitive=case_sensitive))

get_all_views(doc=None, view_types=None, include_nongraphical=False)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
def get_all_views(doc=None, view_types=None, include_nongraphical=False):
    doc = doc or DOCS.doc
    all_views = DB.FilteredElementCollector(doc) \
                  .OfClass(DB.View) \
                  .WhereElementIsNotElementType() \
                  .ToElements()

    if view_types:
        all_views = [x for x in all_views if x.ViewType in view_types]

    if not include_nongraphical:
        return [x for x in all_views
                if x.ViewType in GRAPHICAL_VIEWTYPES
                and not x.IsTemplate
                and not x.ViewSpecific]

    return all_views

get_all_view_templates(doc=None, view_types=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
636
637
638
639
640
def get_all_view_templates(doc=None, view_types=None):
    return [x for x in get_all_views(doc=doc,
                                     view_types=view_types,
                                     include_nongraphical=True)
            if x.IsTemplate]

get_sheet_by_number(sheet_num, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
643
644
645
646
def get_sheet_by_number(sheet_num, doc=None):
    doc = doc or DOCS.doc
    return next((x for x in get_sheets(doc=doc)
                 if x.SheetNumber == sheet_num), None)

get_viewport_by_number(sheet_num, detail_num, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
649
650
651
652
653
654
655
656
657
658
659
def get_viewport_by_number(sheet_num, detail_num, doc=None):
    doc = doc or DOCS.doc
    sheet = get_sheet_by_number(sheet_num, doc=doc)
    if sheet:
        vps = [doc.GetElement(x) for x in sheet.GetAllViewports()]
        for vp in vps:
            det_num = vp.Parameter[
                DB.BuiltInParameter.VIEWPORT_DETAIL_NUMBER
                ].AsString()
            if det_num == detail_num:
                return vp

get_view_by_sheetref(sheet_num, detail_num, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
662
663
664
665
666
def get_view_by_sheetref(sheet_num, detail_num, doc=None):
    doc = doc or DOCS.doc
    vport = get_viewport_by_number(sheet_num, detail_num, doc=doc)
    if vport:
        return vport.ViewId

is_schedule(view)

Check if given DB.View is a Revit Schedule.

Returns False if given view is a DB.ViewSchedule but is a Schedule View Template, or Titleblock Revision Schedule, or Internal Keynote Schedule, or Keynote Legend Schedule

Source code in pyrevitlib/pyrevit/revit/db/query.py 
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
def is_schedule(view):
    """Check if given DB.View is a Revit Schedule.

    Returns False if given view is a DB.ViewSchedule but is a
        Schedule View Template, or
        Titleblock Revision Schedule, or
        Internal Keynote Schedule, or
        Keynote Legend Schedule
    """
    if isinstance(view, DB.ViewSchedule) and not view.IsTemplate:
        isrevsched = view.IsTitleblockRevisionSchedule
        isintkeynote = view.IsInternalKeynoteSchedule
        iskeynotelegend = view.Definition.CategoryId == \
            get_category(DB.BuiltInCategory.OST_KeynoteTags).Id

        return not (isrevsched or isintkeynote or iskeynotelegend)

    return False

get_all_schedules(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
689
690
691
692
693
694
695
def get_all_schedules(doc=None):
    doc = doc or DOCS.doc
    all_scheds = DB.FilteredElementCollector(doc) \
                   .OfClass(DB.ViewSchedule) \
                   .WhereElementIsNotElementType() \
                   .ToElements()
    return filter(is_schedule, all_scheds)

get_view_by_name(view_name, view_types=None, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
698
699
700
701
702
def get_view_by_name(view_name, view_types=None, doc=None):
    doc = doc or DOCS.doc
    for view in get_all_views(doc=doc, view_types=view_types):
        if get_name(view) == view_name:
            return view

get_all_referencing_elements(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
705
706
707
708
709
710
711
712
713
714
715
def get_all_referencing_elements(doc=None):
    doc = doc or DOCS.doc
    all_referencing_elements = []
    for el in DB.FilteredElementCollector(doc)\
                .WhereElementIsNotElementType()\
                .ToElements():
        if el.Category \
                and isinstance(el, DB.Element) \
                and get_builtincategory(el.Category) in BUILTINCATEGORIES_VIEW:
            all_referencing_elements.append(el.Id)
    return all_referencing_elements

get_all_referencing_elements_in_view(view)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
718
719
720
721
722
723
724
725
726
727
def get_all_referencing_elements_in_view(view):
    all_referencing_elements_in_view = []
    for el in DB.FilteredElementCollector(view.Document, view.Id)\
                .WhereElementIsNotElementType()\
                .ToElements():
        if el.Category \
                and isinstance(el, DB.Element) \
                and get_builtincategory(el.Category) in BUILTINCATEGORIES_VIEW:
            all_referencing_elements_in_view.append(el.Id)
    return all_referencing_elements_in_view

get_schedules_on_sheet(viewsheet, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
730
731
732
733
734
735
736
737
def get_schedules_on_sheet(viewsheet, doc=None):
    doc = doc or DOCS.doc
    all_sheeted_scheds = DB.FilteredElementCollector(doc)\
                           .OfClass(DB.ScheduleSheetInstance)\
                           .ToElements()
    return [x for x in all_sheeted_scheds
            if x.OwnerViewId == viewsheet.Id
            and not doc.GetElement(x.ScheduleId).IsTitleblockRevisionSchedule]

is_sheet_empty(viewsheet)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
740
741
742
743
744
745
def is_sheet_empty(viewsheet):
    sheet_views = viewsheet.GetAllViewports()
    sheet_scheds = get_schedules_on_sheet(viewsheet, doc=viewsheet.Document)
    if sheet_views or sheet_scheds:
        return False
    return True

get_doc_categories(doc=None, include_subcats=True)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
748
749
750
751
752
753
754
755
756
def get_doc_categories(doc=None, include_subcats=True):
    doc = doc or DOCS.doc
    all_cats = []
    cats = doc.Settings.Categories
    all_cats.extend(cats)
    if include_subcats:
        for cat in cats:
            all_cats.extend([x for x in cat.SubCategories])
    return all_cats

get_schedule_categories(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
759
760
761
762
763
764
765
766
767
def get_schedule_categories(doc=None):
    doc = doc or DOCS.doc
    all_cats = get_doc_categories(doc)
    cats = []
    for cat_id in DB.ViewSchedule.GetValidCategoriesForSchedule():
        for cat in all_cats:
            if cat.Id.IntegerValue == cat_id.IntegerValue:
                cats.append(cat)
    return cats

get_key_schedule_categories(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
770
771
772
773
774
775
776
777
778
def get_key_schedule_categories(doc=None):
    doc = doc or DOCS.doc
    all_cats = get_doc_categories(doc)
    cats = []
    for cat_id in DB.ViewSchedule.GetValidCategoriesForKeySchedule():
        for cat in all_cats:
            if cat.Id.IntegerValue == cat_id.IntegerValue:
                cats.append(cat)
    return cats

get_takeoff_categories(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
781
782
783
784
785
786
787
788
789
def get_takeoff_categories(doc=None):
    doc = doc or DOCS.doc
    all_cats = get_doc_categories(doc)
    cats = []
    for cat_id in DB.ViewSchedule.GetValidCategoriesForMaterialTakeoff():
        for cat in all_cats:
            if cat.Id.IntegerValue == cat_id.IntegerValue:
                cats.append(cat)
    return cats

get_category(cat_name_or_builtin, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
792
793
794
795
796
797
798
799
800
801
802
803
804
def get_category(cat_name_or_builtin, doc=None):
    doc = doc or DOCS.doc
    all_cats = get_doc_categories(doc)
    if isinstance(cat_name_or_builtin, str):
        for cat in all_cats:
            if cat.Name == cat_name_or_builtin:
                return cat
    elif isinstance(cat_name_or_builtin, DB.BuiltInCategory):
        for cat in all_cats:
            if cat.Id.IntegerValue == int(cat_name_or_builtin):
                return cat
    elif isinstance(cat_name_or_builtin, DB.Category):
        return cat_name_or_builtin

get_builtincategory(cat_name_or_id, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
807
808
809
810
811
812
813
814
815
816
817
818
819
def get_builtincategory(cat_name_or_id, doc=None):
    doc = doc or DOCS.doc
    cat_id = None
    if isinstance(cat_name_or_id, str):
        cat = get_category(cat_name_or_id)
        if cat:
            cat_id = cat.Id.IntegerValue
    elif isinstance(cat_name_or_id, DB.ElementId):
        cat_id = cat_name_or_id.IntegerValue
    if cat_id:
        for bicat in DB.BuiltInCategory.GetValues(DB.BuiltInCategory):
            if int(bicat) == cat_id:
                return bicat

get_subcategories(doc=None, purgable=False, filterfunc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
def get_subcategories(doc=None, purgable=False, filterfunc=None):
    doc = doc or DOCS.doc
    # collect custom categories
    subcategories = []
    for cat in doc.Settings.Categories:
        for subcat in cat.SubCategories:
            if purgable:
                if subcat.Id.IntegerValue > 1:
                    subcategories.append(subcat)
            else:
                subcategories.append(subcat)
    if filterfunc:
        subcategories = filter(filterfunc, subcategories)

    return subcategories

get_subcategory(cat_name_or_builtin, subcategory_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
839
840
841
842
843
844
845
def get_subcategory(cat_name_or_builtin, subcategory_name, doc=None):
    doc = doc or DOCS.doc
    cat = get_category(cat_name_or_builtin)
    if cat:
        for subcat in cat.SubCategories:
            if subcat.Name == subcategory_name:
                return subcat

get_builtinparameter(element, param_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
848
849
850
851
852
853
854
def get_builtinparameter(element, param_name, doc=None):
    doc = doc or DOCS.doc
    eparam = element.LookupParameter(param_name)
    if eparam:
        for biparam in DB.BuiltInParameter.GetValues(DB.BuiltInParameter):
            if int(biparam) == eparam.Definition.Id.IntegerValue:
                return biparam

get_view_cutplane_offset(view)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
857
858
859
def get_view_cutplane_offset(view):
    viewrange = view.GetViewRange()
    return viewrange.GetOffset(DB.PlanViewPlane.CutPlane)

get_project_location_transform(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
862
863
864
def get_project_location_transform(doc=None):
    doc = doc or DOCS.doc
    return doc.ActiveProjectLocation.GetTransform()

get_all_linkedmodels(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
867
868
869
870
871
def get_all_linkedmodels(doc=None):
    doc = doc or DOCS.doc
    return DB.FilteredElementCollector(doc)\
             .OfClass(DB.RevitLinkType)\
             .ToElements()

get_all_linkeddocs(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
874
875
876
877
878
879
880
def get_all_linkeddocs(doc=None):
    doc = doc or DOCS.doc
    linkinstances = DB.FilteredElementCollector(doc)\
                      .OfClass(DB.RevitLinkInstance)\
                      .ToElements()
    docs = [x.GetLinkDocument() for x in linkinstances]
    return [x for x in docs if x]

get_all_grids(group_by_direction=False, include_linked_models=False, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
def get_all_grids(group_by_direction=False,
                  include_linked_models=False, doc=None):
    doc = doc or DOCS.doc
    target_docs = [doc]
    if include_linked_models:
        target_docs.extend(get_all_linkeddocs())

    all_grids = []
    for tdoc in target_docs:
        if tdoc is not None:
            all_grids.extend(list(
                DB.FilteredElementCollector(tdoc)
                .OfCategory(DB.BuiltInCategory.OST_Grids)
                .WhereElementIsNotElementType()
                .ToElements()
                ))

    if group_by_direction:
        direcs = {db.XYZPoint(x.Curve.Direction) for x in all_grids}
        grouped_grids = {}
        for direc in direcs:
            grouped_grids[direc] = [x for x in all_grids
                                    if direc == db.XYZPoint(x.Curve.Direction)]
        return grouped_grids
    return all_grids

get_gridpoints(grids=None, include_linked_models=False, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
def get_gridpoints(grids=None, include_linked_models=False, doc=None):
    doc = doc or DOCS.doc
    source_grids = grids or get_all_grids(
        doc=doc,
        include_linked_models=include_linked_models
        )
    gints = {}
    for grid1 in source_grids:
        for grid2 in source_grids:
            results = framework.clr.Reference[DB.IntersectionResultArray]()
            intres = grid1.Curve.Intersect(grid2.Curve, results)
            if intres == DB.SetComparisonResult.Overlap:
                gints[db.XYZPoint(results.get_Item(0).XYZPoint)] = \
                    [grid1, grid2]
    return [GridPoint(point=k, grids=v) for k, v in gints.items()]

get_closest_gridpoint(element, gridpoints)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
927
928
929
930
931
932
933
934
def get_closest_gridpoint(element, gridpoints):
    dist = (gridpoints[0].point.unwrap().DistanceTo(element.Location.Point),
            gridpoints[0])
    for grid_point in gridpoints:
        gp_dist = grid_point.point.unwrap().DistanceTo(element.Location.Point)
        if gp_dist < dist[0]:
            dist = (gp_dist, grid_point)
    return dist[1]

get_category_set(category_list, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
937
938
939
940
941
942
943
def get_category_set(category_list, doc=None):
    doc = doc or DOCS.doc
    cat_set = HOST_APP.app.Create.NewCategorySet()
    for builtin_cat in category_list:
        cat = doc.Settings.Categories.get_Item(builtin_cat)
        cat_set.Insert(cat)
    return cat_set

get_all_category_set(bindable=True, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
946
947
948
949
950
951
952
953
954
955
def get_all_category_set(bindable=True, doc=None):
    doc = doc or DOCS.doc
    cat_set = HOST_APP.app.Create.NewCategorySet()
    for cat in doc.Settings.Categories:
        if bindable:
            if cat.AllowsBoundParameters:
                cat_set.Insert(cat)
        else:
            cat_set.Insert(cat)
    return cat_set

get_rule_filters(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
958
959
960
961
962
963
964
def get_rule_filters(doc=None):
    doc = doc or DOCS.doc
    rfcl = DB.FilteredElementCollector(doc)\
             .OfClass(DB.ParameterFilterElement)\
             .WhereElementIsNotElementType()\
             .ToElements()
    return list(rfcl)

get_connected_circuits(element, spare=False, space=False)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
967
968
969
970
971
972
973
974
975
976
977
978
979
980
def get_connected_circuits(element, spare=False, space=False):
    circuit_types = [DB.Electrical.CircuitType.Circuit]
    if spare:
        circuit_types.append(DB.Electrical.CircuitType.Spare)
    if space:
        circuit_types.append(DB.Electrical.CircuitType.Space)
    if HOST_APP.is_newer_than(2021, or_equal=True): # deprecation of ElectricalSystems in 2021
        if element.MEPModel and element.MEPModel.GetElectricalSystems():
            return [x for x in element.MEPModel.GetElectricalSystems()
                    if x.CircuitType in circuit_types]
    else:
        if element.MEPModel and element.MEPModel.ElectricalSystems:
            return [x for x in element.MEPModel.ElectricalSystems
                    if x.CircuitType in circuit_types]

get_element_categories(elements)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
983
984
985
986
def get_element_categories(elements):
    catsdict = {x.Category.Name: x.Category for x in elements}
    uniquenames = set(catsdict.keys())
    return [catsdict[x] for x in uniquenames]

get_category_schedules(category_or_catname, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
989
990
991
992
993
def get_category_schedules(category_or_catname, doc=None):
    doc = doc or DOCS.doc
    cat = get_category(category_or_catname)
    scheds = get_all_schedules(doc=doc)
    return [x for x in scheds if x.Definition.CategoryId == cat.Id]

get_schedule_field(schedule, field_name)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
 996
 997
 998
 999
1000
def get_schedule_field(schedule, field_name):
    for field_idx in schedule.Definition.GetFieldOrder():
        field = schedule.Definition.GetField(field_idx)
        if field.GetName() == field_name:
            return field

get_schedule_filters(schedule, field_name, return_index=False)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
def get_schedule_filters(schedule, field_name, return_index=False):
    matching_filters = []
    field = get_schedule_field(schedule, field_name)
    if field:
        for idx, sfilter in enumerate(schedule.Definition.GetFilters()):
            if sfilter.FieldId == field.FieldId:
                if return_index:
                    matching_filters.append(idx)
                else:
                    matching_filters.append(sfilter)
    return matching_filters

get_sheet_tblocks(src_sheet)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1016
1017
1018
1019
1020
1021
1022
def get_sheet_tblocks(src_sheet):
    sheet_tblocks = DB.FilteredElementCollector(src_sheet.Document,
                                                src_sheet.Id)\
                      .OfCategory(DB.BuiltInCategory.OST_TitleBlocks)\
                      .WhereElementIsNotElementType()\
                      .ToElements()
    return list(sheet_tblocks)

get_sheet_sets(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1025
1026
1027
1028
1029
1030
1031
def get_sheet_sets(doc=None):
    doc = doc or DOCS.doc
    viewsheetsets = DB.FilteredElementCollector(doc)\
                      .OfClass(DB.ViewSheetSet)\
                      .WhereElementIsNotElementType()\
                      .ToElements()
    return list(viewsheetsets)

get_rev_number(revision, sheet=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1034
1035
1036
1037
1038
1039
1040
1041
1042
def get_rev_number(revision, sheet=None):
    # if sheet is provided, get number on sheet
    if sheet and isinstance(sheet, DB.ViewSheet):
        return sheet.GetRevisionNumberOnSheet(revision.Id)
    # otherwise get number from revision
    revnum = revision.SequenceNumber
    if hasattr(revision, 'RevisionNumber'):
        revnum = revision.RevisionNumber
    return revnum

get_pointclouds(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1045
1046
1047
1048
def get_pointclouds(doc=None):
    doc = doc or DOCS.doc
    return get_elements_by_categories([DB.BuiltInCategory.OST_PointClouds],
                                      doc=doc)

get_mep_connections(element)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
def get_mep_connections(element):
    connmgr = None
    if isinstance(element, DB.FamilyInstance):
        connmgr = element.MEPModel.ConnectorManager
    elif isinstance(element, DB.Plumbing.Pipe):
        connmgr = element.ConnectorManager

    if connmgr:
        connelements = [y.Owner
                        for x in connmgr.Connectors
                        for y in x.AllRefs
                        if x.IsConnected
                        and y.Owner.Id != element.Id
                        and y.ConnectorType != DB.ConnectorType.Logical]
        return connelements

get_fillpattern_element(fillpattern_name, fillpattern_target, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
def get_fillpattern_element(fillpattern_name, fillpattern_target, doc=None):
    doc = doc or DOCS.doc
    existing_fp_elements = \
        DB.FilteredElementCollector(doc) \
          .OfClass(framework.get_type(DB.FillPatternElement))

    for existing_fp_element in existing_fp_elements:
        fillpattern = existing_fp_element.GetFillPattern()
        if fillpattern_name == fillpattern.Name \
                and fillpattern_target == fillpattern.Target:
            return existing_fp_element

get_all_fillpattern_elements(fillpattern_target, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1081
1082
1083
1084
1085
1086
1087
1088
def get_all_fillpattern_elements(fillpattern_target, doc=None):
    doc = doc or DOCS.doc
    existing_fp_elements = \
        DB.FilteredElementCollector(doc) \
          .OfClass(framework.get_type(DB.FillPatternElement))

    return [x for x in existing_fp_elements
            if x.GetFillPattern().Target == fillpattern_target]

get_fillpattern_from_element(element, background=True, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
def get_fillpattern_from_element(element, background=True, doc=None):
    doc = doc or DOCS.doc
    def get_fpm_from_frtype(etype):
        fp_id = None
        if HOST_APP.is_newer_than(2018):
            # return requested fill pattern (background or foreground)
            fp_id = etype.BackgroundPatternId \
                if background else etype.ForegroundPatternId
        else:
            fp_id = etype.FillPatternId
        if fp_id:
            fillpat_element = doc.GetElement(fp_id)
            if fillpat_element:
                return fillpat_element.GetFillPattern()

    if isinstance(element, DB.FilledRegion):
        return get_fpm_from_frtype(doc.GetElement(element.GetTypeId()))

get_local_keynote_file(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1110
1111
1112
1113
1114
1115
1116
1117
def get_local_keynote_file(doc=None):
    doc = doc or DOCS.doc
    knote_table = DB.KeynoteTable.GetKeynoteTable(doc)
    if knote_table.IsExternalFileReference():
        knote_table_ref = knote_table.GetExternalFileReference()
        return DB.ModelPathUtils.ConvertModelPathToUserVisiblePath(
            knote_table_ref.GetAbsolutePath()
            )

get_external_keynote_file(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1120
1121
1122
1123
1124
1125
1126
1127
1128
def get_external_keynote_file(doc=None):
    doc = doc or DOCS.doc
    knote_table = DB.KeynoteTable.GetKeynoteTable(doc)
    if knote_table.RefersToExternalResourceReferences():
        refs = knote_table.GetExternalResourceReferences()
        if refs:
            for ref_type, ref in dict(refs).items():
                if ref.HasValidDisplayPath():
                    return ref.InSessionPath

get_keynote_file(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1131
1132
1133
1134
1135
1136
def get_keynote_file(doc=None):
    doc = doc or DOCS.doc
    local_path = get_local_keynote_file(doc=doc)
    if not local_path:
        return get_external_keynote_file(doc=doc)
    return local_path

get_used_keynotes(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1139
1140
1141
1142
1143
1144
def get_used_keynotes(doc=None):
    doc = doc or DOCS.doc
    return DB.FilteredElementCollector(doc)\
             .OfCategory(DB.BuiltInCategory.OST_KeynoteTags)\
             .WhereElementIsNotElementType()\
             .ToElements()

get_visible_keynotes(view=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1147
1148
1149
1150
1151
1152
def get_visible_keynotes(view=None):
    doc = view.Document
    return DB.FilteredElementCollector(doc, view.Id)\
             .OfCategory(DB.BuiltInCategory.OST_KeynoteTags)\
             .WhereElementIsNotElementType()\
             .ToElements()

get_available_keynotes(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1155
1156
1157
1158
def get_available_keynotes(doc=None):
    doc = doc or DOCS.doc
    knote_table = DB.KeynoteTable.GetKeynoteTable(doc)
    return knote_table.GetKeyBasedTreeEntries()

get_available_keynotes_tree(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1161
1162
1163
1164
1165
def get_available_keynotes_tree(doc=None):
    doc = doc or DOCS.doc
    knotes = get_available_keynotes(doc=doc)
    # TODO: implement knotes tree
    raise NotImplementedError()

is_placed(spatial_element)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1168
1169
1170
1171
def is_placed(spatial_element):
    return isinstance(spatial_element,
                      (DB.Architecture.Room, DB.Area, DB.Mechanical.Space)) \
            and spatial_element.Area > 0

get_central_path(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1174
1175
1176
1177
1178
def get_central_path(doc=None):
    doc = doc or DOCS.doc
    if doc.IsWorkshared:
        model_path = doc.GetWorksharingCentralModelPath()
        return DB.ModelPathUtils.ConvertModelPathToUserVisiblePath(model_path)

is_metric(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1181
1182
1183
def is_metric(doc=None):
    doc = doc or DOCS.doc
    return doc.DisplayUnitSystem == DB.DisplayUnit.METRIC

is_imperial(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1186
1187
1188
def is_imperial(doc=None):
    doc = doc or DOCS.doc
    return doc.DisplayUnitSystem == DB.DisplayUnit.IMPERIAL

get_view_sheetrefinfo(view)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
def get_view_sheetrefinfo(view):
    # grab sheet number and name
    # this looks at 'Sheet Number' and 'Sheet Name' parameters of a view
    # if these parameters have value, it means view is placed on a sheet
    sheet_num = \
        view.Parameter[DB.BuiltInParameter.VIEWPORT_SHEET_NUMBER].AsString()
    sheet_name = \
        view.Parameter[DB.BuiltInParameter.VIEWPORT_SHEET_NAME].AsString()
    # grab detail number as well
    detail_num = \
        view.Parameter[DB.BuiltInParameter.VIEWPORT_DETAIL_NUMBER].AsString()

    if sheet_num:
        return SheetRefInfo(
            sheet_num=sheet_num,
            sheet_name=sheet_name,
            detail_num=detail_num,
            ref_viewid=None
            )

    # if not, check 'Referencing Sheet' and 'Referencing Detail' parameters
    # these show that the view is referened by another on that sheet
    ref_sheet_num = \
        view.Parameter[DB.BuiltInParameter.VIEW_REFERENCING_SHEET].AsString()
    ref_sheet = get_sheet_by_number(ref_sheet_num)
    ref_sheet_name = get_name(ref_sheet) if ref_sheet else ''
    # grab referring detail number as well
    ref_detail_num = \
        view.Parameter[DB.BuiltInParameter.VIEW_REFERENCING_DETAIL].AsString()

    if ref_sheet_num:
        return SheetRefInfo(
            sheet_num=ref_sheet_num,
            sheet_name=ref_sheet_name,
            detail_num=ref_detail_num,
            ref_viewid=get_view_by_sheetref(ref_sheet_num, ref_detail_num)
            )

get_all_sheeted_views(doc=None, sheets=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1230
1231
1232
1233
1234
1235
1236
1237
def get_all_sheeted_views(doc=None, sheets=None):
    doc = doc or DOCS.doc
    sheets = sheets or get_sheets(doc=doc)
    all_sheeted_view_ids = set()
    for sht in sheets:
        vp_ids = [doc.GetElement(x).ViewId for x in sht.GetAllViewports()]
        all_sheeted_view_ids.update(vp_ids)
    return all_sheeted_view_ids

is_view_sheeted(view)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1240
1241
def is_view_sheeted(view):
    return view.Id in get_all_sheeted_views(doc=view.Document)

can_refer_other_views(source_view)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1244
1245
1246
def can_refer_other_views(source_view):
    return isinstance(source_view,
                      (DB.ViewDrafting, DB.ViewPlan, DB.ViewSection))

is_referring_to(source_view, target_view)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
def is_referring_to(source_view, target_view):
    # if view can be referring
    doc = source_view.Document
    target_viewname = get_name(target_view)

    if can_refer_other_views(source_view):
        for ref_elid in get_all_referencing_elements_in_view(source_view):
            viewref_el = doc.GetElement(ref_elid)
            targetview_param = \
                    viewref_el.Parameter[
                        DB.BuiltInParameter.REFERENCE_VIEWER_TARGET_VIEW
                        ]
            if targetview_param:
                tvp_view = doc.GetElement(targetview_param.AsElementId())
                if tvp_view and get_name(tvp_view) == target_viewname:
                    return True
            else:
                viewref_name = get_name(viewref_el)
                if viewref_name == target_viewname:
                    return True

yield_referring_views(target_view, all_views=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1271
1272
1273
1274
1275
def yield_referring_views(target_view, all_views=None):
    all_views = all_views or get_all_views(doc=target_view.Document)
    for view in all_views:
        if is_referring_to(view, target_view):
            yield view.Id

yield_referenced_views(doc=None, all_views=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1278
1279
1280
1281
1282
1283
1284
def yield_referenced_views(doc=None, all_views=None):
    doc = doc or DOCS.doc
    all_views = all_views or get_all_views(doc=doc)
    for view in all_views:
        # if it has any referring views, yield
        if next(yield_referring_views(view), None):
            yield view.Id

yield_unreferenced_views(doc=None, all_views=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1287
1288
1289
1290
1291
1292
1293
def yield_unreferenced_views(doc=None, all_views=None):
    doc = doc or DOCS.doc
    all_views = all_views or get_all_views(doc=doc)
    for view in all_views:
        # if it has NO referring views, yield
        if len(list(yield_referring_views(view))) == 0:
            yield view.Id

get_line_categories(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1296
1297
1298
1299
def get_line_categories(doc=None):
    doc = doc or DOCS.doc
    lines_cat = doc.Settings.Categories.get_Item(DB.BuiltInCategory.OST_Lines)
    return lines_cat.SubCategories

get_line_styles(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1302
1303
1304
def get_line_styles(doc=None):
    return [x.GetGraphicsStyle(DB.GraphicsStyleType.Projection)
            for x in get_line_categories(doc=doc)]

get_history(target_element)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1307
1308
1309
1310
1311
1312
1313
1314
def get_history(target_element):
    doc = target_element.Document
    if doc.IsWorkshared:
        wti = DB.WorksharingUtils.GetWorksharingTooltipInfo(doc,
                                                            target_element.Id)
        return ElementHistory(creator=wti.Creator,
                              owner=wti.Owner,
                              last_changed_by=wti.LastChangedBy)

is_detail_curve(element)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1317
1318
def is_detail_curve(element):
    return isinstance(element, DETAIL_CURVES)

is_model_curve(element)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1321
1322
def is_model_curve(element):
    return isinstance(element, MODEL_CURVES)

is_sketch_curve(element)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1325
1326
1327
1328
def is_sketch_curve(element):
    if element.Category:
        cid = element.Category.Id
        return cid == DB.ElementId(DB.BuiltInCategory.OST_SketchLines)

get_all_schemas()

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1331
1332
def get_all_schemas():
    return DB.ExtensibleStorage.Schema.ListSchemas()

get_schema_field_values(element, schema)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
def get_schema_field_values(element, schema):
    field_values = {}
    entity = element.GetEntity(schema)
    if entity:
        for field in schema.ListFields():
            field_type = field.ValueType
            if field.ContainerType == DB.ExtensibleStorage.ContainerType.Array:
                field_type = framework.IList[field.ValueType]
            elif field.ContainerType == DB.ExtensibleStorage.ContainerType.Map:
                field_type = \
                    framework.IDictionary[field.KeyType, field.ValueType]
            try:
                value = entity.Get[field_type](
                    field.FieldName,
                    DB.DisplayUnitType.DUT_UNDEFINED
                    )
            except:
                value = None

            field_values[field.FieldName] = value
    return field_values

get_family_type(type_name, family_doc)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1358
1359
1360
1361
1362
1363
1364
1365
def get_family_type(type_name, family_doc):
    family_doc = family_doc or DOCS.doc
    if family_doc.IsFamilyDocument:
        for ftype in family_doc.FamilyManager.Types:
            if ftype.Name == type_name:
                return ftype
    else:
        raise PyRevitException('Document is not a family')

get_family_parameter(param_name, family_doc)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1368
1369
1370
1371
1372
1373
1374
1375
def get_family_parameter(param_name, family_doc):
    family_doc = family_doc or DOCS.doc
    if family_doc.IsFamilyDocument:
        for fparam in family_doc.FamilyManager.GetParameters():
            if fparam.Definition.Name == param_name:
                return fparam
    else:
        raise PyRevitException('Document is not a family')

get_family_parameters(family_doc)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1378
1379
1380
1381
1382
1383
def get_family_parameters(family_doc):
    family_doc = family_doc or DOCS.doc
    if family_doc.IsFamilyDocument:
        return family_doc.FamilyManager.GetParameters()
    else:
        raise PyRevitException('Document is not a family')

get_family_label_parameters(family_doc)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
def get_family_label_parameters(family_doc):
    family_doc = family_doc or DOCS.doc
    if family_doc.IsFamilyDocument:
        dims = DB.FilteredElementCollector(family_doc)\
                .OfClass(DB.Dimension)\
                .WhereElementIsNotElementType()
        label_params = set()
        for dim in dims:
            try:
                # throws exception when dimension can not be labeled
                if isinstance(dim.FamilyLabel, DB.FamilyParameter):
                    label_params.add(dim.FamilyLabel)
            except Exception:
                pass
        return label_params
    else:
        raise PyRevitException('Document is not a family')

get_door_rooms(door)

Get from/to rooms associated with given door element.

Parameters:

Name Type Description Default
door FamilyInstance

door instance

 required

Returns:

Name Type Description
tuple (Room, Room)

from/to rooms
Source code in pyrevitlib/pyrevit/revit/db/query.py 
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
def get_door_rooms(door):
    """Get from/to rooms associated with given door element.

    Args:
        door (DB.FamilyInstance): door instance

    Returns:
        tuple(DB.Architecture.Room, DB.Architecture.Room): from/to rooms
    """
    door_phase = door.Document.GetElement(door.CreatedPhaseId)
    return (door.FromRoom[door_phase], door.ToRoom[door_phase])

get_doors(elements=None, doc=None, room_id=None)

Get all doors in active or given document.

Parameters:

Name Type Description Default
elements list[Element]

find rooms in given elements instead

 None
doc Document

target document; default is active document

 None
room_id ElementId

only doors associated with given room

 None

Returns:

Type Description
list[Element]

room instances
Source code in pyrevitlib/pyrevit/revit/db/query.py 
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
def get_doors(elements=None, doc=None, room_id=None):
    """Get all doors in active or given document.

    Args:
        elements (list[DB.Element]): find rooms in given elements instead
        doc (DB.Document): target document; default is active document
        room_id (DB.ElementId): only doors associated with given room

    Returns:
        (list[DB.Element]): room instances
    """
    doc = doc or DOCS.doc
    all_doors = get_elements_by_categories([DB.BuiltInCategory.OST_Doors],
                                           elements=elements,
                                           doc=doc)
    if room_id:
        room_doors = []
        for door in all_doors:
            from_room, to_room = get_door_rooms(door)
            if (from_room and from_room.Id == room_id) \
                    or (to_room and to_room.Id == room_id):
                room_doors.append(door)
        return room_doors
    else:
        return list(all_doors)

get_all_print_settings(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1445
1446
1447
def get_all_print_settings(doc=None):
    doc = doc or DOCS.doc
    return [doc.GetElement(x)for x in doc.GetPrintSettingIds()]

get_used_paper_sizes(doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1450
1451
1452
1453
def get_used_paper_sizes(doc=None):
    doc = doc or DOCS.doc
    return [x.PrintParameters.PaperSize
            for x in get_all_print_settings(doc=doc)]

find_paper_size_by_name(paper_size_name, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1456
1457
1458
1459
1460
1461
def find_paper_size_by_name(paper_size_name, doc=None):
    doc = doc or DOCS.doc
    paper_size_name = paper_size_name.lower()
    for psize in doc.PrintManager.PaperSizes:
        if psize.Name.lower() == paper_size_name:
            return psize

find_paper_sizes_by_dims(printer_name, paper_width, paper_height, doc=None)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
def find_paper_sizes_by_dims(printer_name, paper_width, paper_height, doc=None):
    # paper_width, paper_height must be in inch
    doc = doc or DOCS.doc
    paper_sizes = []
    system_paper_sizes = coreutils.get_paper_sizes(printer_name)
    mlogger.debug('looking for paper size W:%s H:%s', paper_width, paper_height)
    mlogger.debug('system paper sizes: %s -> %s',
                  printer_name, [x.PaperName for x in system_paper_sizes])
    for sys_psize in system_paper_sizes:
        sys_pname = sys_psize.PaperName
        sys_pwidth = int(sys_psize.Width / 100.00)
        sys_pheight = int(sys_psize.Height / 100.00)
        # system paper dims are in inches
        wxd = paper_width == sys_pwidth and paper_height == sys_pheight
        dxw = paper_width == sys_pheight and paper_height == sys_pwidth
        mlogger.debug('%s \"%s\" W:%s H:%s',
                      '✓' if wxd or dxw else ' ',
                      sys_pname, sys_pwidth, sys_pheight)
        if wxd or dxw:
            psize = find_paper_size_by_name(sys_pname)
            if psize:
                paper_sizes.append(psize)
                mlogger.debug('found matching paper \"\"', psize.Name)

    return paper_sizes

get_titleblock_print_settings(tblock, printer_name, doc_psettings)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
def get_titleblock_print_settings(tblock, printer_name, doc_psettings):
    doc = tblock.Document
    # find paper sizes used in print settings of this doc
    page_width_param = tblock.Parameter[DB.BuiltInParameter.SHEET_WIDTH]
    page_height_param = tblock.Parameter[DB.BuiltInParameter.SHEET_HEIGHT]
    # calculate paper size in inch
    page_width = int(round(page_width_param.AsDouble() * 12.0))
    page_height = int(round(page_height_param.AsDouble() * 12.0))
    tform = tblock.GetTotalTransform()
    is_portrait = (page_width < page_height) or (int(tform.BasisX.Y) == -1)
    paper_sizes = find_paper_sizes_by_dims(
        printer_name,
        page_width,
        page_height,
        doc=doc
        )
    # names of paper sizes matching the calculated title block size
    paper_size_names = [x.Name for x in paper_sizes]
    # find first print settings that matches any of the paper_size_names
    page_orient = \
        DB.PageOrientationType.Portrait if is_portrait \
            else DB.PageOrientationType.Landscape
    all_tblock_psettings = set()
    for doc_psetting in doc_psettings:
        try:
            pparams = doc_psetting.PrintParameters
            if pparams.PaperSize \
                    and pparams.PaperSize.Name in paper_size_names \
                    and (pparams.ZoomType == DB.ZoomType.Zoom
                         and pparams.Zoom == 100) \
                    and pparams.PageOrientation == page_orient:
                all_tblock_psettings.add(doc_psetting)
        except Exception as ex:
            mlogger.debug("incompatible psettings: %s", doc_psetting.Name)
    return sorted(all_tblock_psettings, key=lambda x: x.Name)

get_crop_region(view)

Takes crop region of a view.

Parameters:

Name Type Description Default
view View

view to get crop region from

 required

Returns:

Type Description
list[CurveLoop]

list of curve loops
Source code in pyrevitlib/pyrevit/revit/db/query.py 
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
def get_crop_region(view):
    """Takes crop region of a view.

    Args:
        view (DB.View): view to get crop region from

    Returns:
        (list[DB.CurveLoop]): list of curve loops
    """
    crsm = view.GetCropRegionShapeManager()
    if HOST_APP.is_newer_than(2015):
        crsm_valid = crsm.CanHaveShape
    else:
        crsm_valid = crsm.Valid

    if crsm_valid:
        if HOST_APP.is_newer_than(2015):
            curve_loops = list(crsm.GetCropShape())
        else:
            curve_loops = [crsm.GetCropRegionShape()]

        if curve_loops:
            return curve_loops

is_cropable_view(view)

Check if view can be cropped.

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1553
1554
1555
1556
def is_cropable_view(view):
    """Check if view can be cropped."""
    return not isinstance(view, (DB.ViewSheet, DB.TableView)) \
        and view.ViewType not in (DB.ViewType.Legend, DB.ViewType.DraftingView)

get_view_filters(view)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1559
1560
1561
1562
1563
1564
def get_view_filters(view):
    view_filters = []
    for filter_id in view.GetFilters():
        filter_element = view.Document.GetElement(filter_id)
        view_filters.append(filter_element)
    return view_filters

get_element_workset(element)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1567
1568
1569
1570
1571
def get_element_workset(element):
    doc = element.Document
    workset_table = doc.GetWorksetTable()
    if element.WorksetId != DB.WorksetId.InvalidWorksetId:
        return workset_table.GetWorkset(element.WorksetId)

get_geometry(element, include_invisible=False, compute_references=False)

Source code in pyrevitlib/pyrevit/revit/db/query.py 
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
def get_geometry(element, include_invisible=False, compute_references=False):
    geom_opts = DB.Options()
    geom_opts.IncludeNonVisibleObjects = include_invisible
    geom_opts.ComputeReferences = compute_references
    geom_objs = []
    try:
        for gobj in element.Geometry[geom_opts]:
            if isinstance(gobj, DB.GeometryInstance):
                inst_geom = gobj.GetInstanceGeometry()
                geom_objs.extend(list(inst_geom))
            else:
                geom_objs.append(gobj)
        return geom_objs
    except TypeError:
        mlogger.debug("element %s has no geometry", element.Id.IntegerValue)
        return