count

Counting functions for Revit elements.

Functions

count_unpinned_revit_links(revitlinks_elements)

Returns the number of unpinned Revit links in the document.

Parameters:

Name	Type	Description	Default
rvtlinks_elements	list	A list of Revit link elements.	required

Returns:

Name	Type	Description
int		The number of unpinned Revit links in the document.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_unpinned_revit_links(revitlinks_elements):
    """
    Returns the number of unpinned Revit links in the document.

    Args:
        rvtlinks_elements (list): A list of Revit link elements.

    Returns:
        int: The number of unpinned Revit links in the document.
    """
    return sum(
        1
        for rvt_link in revitlinks_elements
        if hasattr(rvt_link, "Pinned") and not rvt_link.Pinned
    )

count_unplaced_rooms(rooms)

Counts the number of unplaced rooms in a given list of rooms. An unplaced room is defined as a room with no location (i.e., room.Location is None).

Parameters:

Name	Type	Description	Default
rooms	list	A list of room objects. Defaults to None.	required

Returns:

Name	Type	Description
int		The number of unplaced rooms in the list.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_unplaced_rooms(rooms):
    """
    Counts the number of unplaced rooms in a given list of rooms.
    An unplaced room is defined as a room with no location (i.e., room.Location is None).

    Args:
        rooms (list, optional): A list of room objects. Defaults to None.

    Returns:
        int: The number of unplaced rooms in the list.
    """
    return sum(1 for room in rooms if room.Location is None)

count_unbounded_rooms(rooms)

Counts the number of unbounded rooms (rooms with an area of 0) in the given list of rooms.

Parameters:

Name	Type	Description	Default
rooms	list	A list of room objects. Each room object should have an 'Area' attribute.	required

Returns:

Name	Type	Description
int		The number of unbounded rooms in the list.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_unbounded_rooms(rooms):
    """
    Counts the number of unbounded rooms (rooms with an area of 0) in the given list of rooms.

    Args:
        rooms (list, optional): A list of room objects. Each room object should have an 'Area' attribute.

    Returns:
        int: The number of unbounded rooms in the list.
    """
    return sum(1 for room in rooms if room.Area == 0)

count_analytical_model_activated(document)

Returns the number of activated analytical models in the document.

Args: document (Document): A Revit document.

Returns: int: The number of elements with the analytical model activated in the document.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_analytical_model_activated(document):
    """
    Returns the number of activated analytical models in the document.

    Args:
    document (Document): A Revit document.

    Returns:
    int: The number of elements with the analytical model activated in the document.
    """
    param = DB.BuiltInParameter.STRUCTURAL_ANALYTICAL_MODEL
    provider = DB.ParameterValueProvider(DB.ElementId(param))
    evaluator = DB.FilterNumericEquals()
    rule = DB.FilterIntegerRule(provider, evaluator, 1)
    elem_param_filter = DB.ElementParameterFilter(rule)
    return (
        DB.FilteredElementCollector(document)
        .WherePasses(elem_param_filter)
        .GetElementCount()
    )

count_copied_views(views_set)

Returns the number of views in the given set that have "Copy" or "Copie" in their name.

Args: views_set (set): A set of views to check for copied views. Defaults to None.

Returns: int: The number of views in the set that have "Copy" or "Copie" in their name.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_copied_views(views_set):
    """
    Returns the number of views in the given set that have "Copy" or "Copie" in their name.

    Args:
    views_set (set): A set of views to check for copied views. Defaults to None.

    Returns:
    int: The number of views in the set that have "Copy" or "Copie" in their name.
    """
    copied_view_names = ["Copy", "Copie"]
    copied_views_count = 0
    for view in views_set:
        view_name = q.get_name(view)
        try:
            # FIXME French compatibility, make it universal
            if any(name in view_name for name in copied_view_names):
                copied_views_count += 1
        except Exception as e:
            print(e)
    return copied_views_count

count_unused_view_templates(views_list, document)

Returns the count of unused view templates in the given list of views.

Parameters:

Name	Type	Description	Default
views	list	A list of views to check for unused view templates.	required

Returns:

Name	Type	Description
int		The count of unused view templates.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_unused_view_templates(views_list, document):
    """
    Returns the count of unused view templates in the given list of views.

    Args:
        views (list): A list of views to check for unused view templates.

    Returns:
        int: The count of unused view templates.
    """
    if views_list is None:
        return 0
    applied_templates = [v.ViewTemplateId for v in views_list if hasattr(v, "ViewTemplateId")]
    view_templates_list = q.get_all_view_templates(doc=document)
    unused_view_templates = []
    for v in view_templates_list:
        if v.Id not in applied_templates:
            unused_view_templates.append(v)
    return len(unused_view_templates)

count_unused_filters_in_views(view_list, filters)

Counts the number of unused filters in the given list of views.

Parameters:

Name	Type	Description	Default
view_list	list	A list of Revit view objects to check for filter usage.	required
filters	list	A list of filter objects to check against the views.	required
Returns			required
int		The number of filters that are not used in any of the provided views.	required

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_unused_filters_in_views(view_list, filters):
    """
    Counts the number of unused filters in the given list of views.

    Args:
        view_list (list): A list of Revit view objects to check for filter usage.
        filters (list): A list of filter objects to check against the views.

        Returns:
        int: The number of filters that are not used in any of the provided views.
    """
    used_filters_set = set()
    all_filters = set()
    get_elementid_value = get_elementid_value_func()
    for flt in filters:
        all_filters.add(get_elementid_value(flt.Id))
    for v in view_list:
        if hasattr(v, "AreGraphicsOverridesAllowed") and v.AreGraphicsOverridesAllowed():
            view_filters = v.GetFilters()
            for filter_id in view_filters:
                used_filters_set.add(get_elementid_value(filter_id))
    unused_view_filters_count = len(all_filters - used_filters_set)
    return unused_view_filters_count

count_linked_dwg_files(document)

Returns the number of linked DWG files in the document.

Parameters:

Name	Type	Description	Default
document	Document	The Revit document to search for linked DWG files.	required

Returns:

Name	Type	Description
int		The number of linked DWG files in the document.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_linked_dwg_files(document):
    """
    Returns the number of linked DWG files in the document.

    Args:
        document (DB.Document): The Revit document to search for linked DWG files.

    Returns:
        int: The number of linked DWG files in the document.
    """
    dwg_collector = q.get_elements_by_class(DB.ImportInstance, doc=document)
    if not dwg_collector:
        return 0
    dwg_imported = 0
    for dwg in dwg_collector:
        if not dwg.IsLinked:
            dwg_imported += 1
    return len(dwg_collector) - dwg_imported

count_in_place_families(document)

This function collects all the in-place families in the given document and returns their count.

Args: - document: The Revit document to search for in-place families in.

Returns: - int: The count of in-place families.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_in_place_families(document):
    """
    This function collects all the in-place families in the given document and returns their count.

    Args:
    - document: The Revit document to search for in-place families in.

    Returns:
    - int: The count of in-place families.
    """
    familyinstance_collector = q.get_elements_by_class(DB.FamilyInstance, doc=document)
    in_place_family_count = sum(
        1
        for x in familyinstance_collector
        if x.Symbol and x.Symbol.Family and x.Symbol.Family.IsInPlace
    )
    return in_place_family_count

count_total_families(document)

Counts the total number of unique family names in the given Revit document.

Parameters:

Name	Type	Description	Default
document		The Revit document to count families from.	required

Returns:

Name	Type	Description
int		The total number of unique family names in the document.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_total_families(document):
    """
    Counts the total number of unique family names in the given Revit document.

    Args:
        document: The Revit document to count families from.

    Returns:
        int: The total number of unique family names in the document.
    """
    families_collection = q.get_families(document, only_editable=True)
    unique_families = []
    for fam in families_collection:
        if fam.Name not in unique_families:
            unique_families.append(fam.Name)
    if not unique_families:
        return 0
    return len(unique_families)

count_textnote_types_with_changed_width_factor(text_notes_types)

Counts the number of text note types that have a width factor different from the default value of 1.

Parameters:

Name	Type	Description	Default
text_notes_types	list	A list of text note types to check.	required

Returns:

Name	Type	Description
int		The number of text note types with a changed width factor.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_textnote_types_with_changed_width_factor(text_notes_types):
    """
    Counts the number of text note types that have a width factor different from the default value of 1.

    Args:
        text_notes_types (list): A list of text note types to check.

    Returns:
        int: The number of text note types with a changed width factor.
    """
    if text_notes_types is None:
        return 0
    changed_width_factor = 0
    for textnote in text_notes_types:
        width_factor = textnote.get_Parameter(
            DB.BuiltInParameter.TEXT_WIDTH_SCALE
        ).AsDouble()
        if width_factor != 1:
            changed_width_factor += 1
    return changed_width_factor

count_textnote_types_with_opaque_background(text_notes_types)

Counts the number of text notes with an opaque background.

Parameters:

Name	Type	Description	Default
text_notes_types	list	A list of text note elements.	required

Returns:

Name	Type	Description
int		The number of text notes with an opaque background.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_textnote_types_with_opaque_background(text_notes_types):
    """
    Counts the number of text notes with an opaque background.

    Args:
        text_notes_types (list): A list of text note elements.

    Returns:
        int: The number of text notes with an opaque background.
    """
    if text_notes_types is None:
        return 0
    text_opaque_background = 0
    for textnote in text_notes_types:
        text_background = textnote.get_Parameter(
            DB.BuiltInParameter.TEXT_BACKGROUND
        ).AsInteger()
        if text_background == 0:
            text_opaque_background += 1
    return text_opaque_background

count_text_notes_with_all_caps(text_notes)

Counts the number of text notes that have all capital letters.

Parameters:

Name	Type	Description	Default
text_notes	list	A list of text note objects.	required

Returns:

Name	Type	Description
int		The number of text notes with all capital letters.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_text_notes_with_all_caps(text_notes):
    """
    Counts the number of text notes that have all capital letters.

    Args:
        text_notes (list): A list of text note objects.

    Returns:
        int: The number of text notes with all capital letters.
    """
    if text_notes is None:
        return 0
    caps_count = 0
    for text_note in text_notes:
        caps_status = text_note.GetFormattedText().GetAllCapsStatus()
        if caps_status:
            caps_count += 1
    return caps_count

count_unnamed_reference_planes(reference_planes)

Returns the count of unnamed reference planes in the given document.

Parameters:

Name	Type	Description	Default
document	Document	The document to search for reference planes. Defaults to the active document.	required

Returns:

Name	Type	Description
int		The count of unnamed reference planes.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_unnamed_reference_planes(reference_planes):
    """
    Returns the count of unnamed reference planes in the given document.

    Args:
        document (DB.Document): The document to search for reference planes. Defaults to the active document.

    Returns:
        int: The count of unnamed reference planes.
    """
    if reference_planes is None:
        return 0
    unnamed_ref_planes_count = 0
    # Default reference plane label, not the most elegant solution
    reference_plane_default_label = DB.LabelUtils.GetLabelFor(
        DB.BuiltInCategory.OST_CLines
    ).replace("s", "")
    for ref_plane in reference_planes:
        if ref_plane.Name == reference_plane_default_label:
            unnamed_ref_planes_count += 1
    return unnamed_ref_planes_count

count_dimension_overrides(dimensions)

Counts the number of dimension overrides in a list of dimensions. This function iterates through a list of dimensions and counts how many of them have a value override. It also checks for overrides in dimension segments if they exist.

Parameters:

Name	Type	Description	Default
dimensions	list	A list of dimension objects to check for overrides.	required

Returns:

Name	Type	Description
int		The total count of dimension overrides found in the list of dimensions.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_dimension_overrides(dimensions):
    """
    Counts the number of dimension overrides in a list of dimensions.
    This function iterates through a list of dimensions and counts how many of them
    have a value override. It also checks for overrides in dimension segments if they exist.

    Args:
        dimensions (list): A list of dimension objects to check for overrides.

    Returns:
        int: The total count of dimension overrides found in the list of dimensions.
    """
    if dimensions is None:
        return 0
    dim_overrides_count = 0
    for d in dimensions:
        if d.ValueOverride is not None:
            dim_overrides_count += 1
        if d.Segments:
            for seg in d.Segments:
                if seg.ValueOverride:
                    dim_overrides_count += 1
    return dim_overrides_count

count_revision_clouds(document)

Returns the number of revision clouds in the given document.

Parameters:

Name	Type	Description	Default
document	Document	The document to search for revision clouds in. Defaults to the active document.	required

Returns:

Name	Type	Description
int		The number of revision clouds in the document.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_revision_clouds(document):
    """
    Returns the number of revision clouds in the given document.

    Args:
        document (DB.Document): The document to search for revision clouds in. Defaults to the active document.

    Returns:
        int: The number of revision clouds in the document.
    """
    return (
        DB.FilteredElementCollector(document)
        .OfCategory(DB.BuiltInCategory.OST_RevisionClouds)
        .WhereElementIsNotElementType()
        .GetElementCount()
    )

count_groups(doc)

Counts the instances and types of model and detail groups in a Revit document, excluding array members.

Parameters:

Name	Type	Description	Default
doc	Document	The Revit document to process.	required

Returns:

Name	Type	Description
tuple		A tuple containing four integers: - model_group_instances_count (int): The count of model group instances. - model_group_types_count (int): The count of model group types. - detail_group_instances_count (int): The count of detail group instances. - detail_group_types_count (int): The count of detail group types.

Source code in pyrevitlib/pyrevit/revit/db/count.py

def count_groups(doc):
    """
    Counts the instances and types of model and detail groups in a Revit document, excluding array members.

    Args:
        doc (DB.Document): The Revit document to process.

    Returns:
        tuple: A tuple containing four integers:
            - model_group_instances_count (int): The count of model group instances.
            - model_group_types_count (int): The count of model group types.
            - detail_group_instances_count (int): The count of detail group instances.
            - detail_group_types_count (int): The count of detail group types.
    """
    arrays_members_collector = DB.FilteredElementCollector(doc).OfCategory(DB.BuiltInCategory.OST_IOSArrays).ToElements()
    arraysmembers = set()
    for array in arrays_members_collector:
        if array.OwnerViewId != DB.ElementId.InvalidElementId:
            arraysmembers.update(array.GetOriginalMemberIds())
            arraysmembers.update(array.GetCopiedMemberIds())

    arrays_grouptype_members = set(doc.GetElement(array).GetTypeId() for array in arraysmembers)


    model_groups = DB.FilteredElementCollector(doc).OfCategory(DB.BuiltInCategory.OST_IOSModelGroups).ToElements()
    model_group_instances_count = 0
    model_group_types_count = 0
    for model_group in model_groups:
        if type(model_group) is DB.GroupType and model_group.Id not in arrays_grouptype_members:
            model_group_types_count += 1
        elif type(model_group) is DB.Group and model_group.Id not in arraysmembers:
            model_group_instances_count += 1

    detail_groups = DB.FilteredElementCollector(doc).OfCategory(DB.BuiltInCategory.OST_IOSDetailGroups).ToElements()
    detail_group_instances_count = 0
    detail_group_types_count = 0
    for detail_group in detail_groups:
        if type(detail_group) is DB.GroupType and detail_group.Id not in arrays_grouptype_members:
            detail_group_types_count += 1
        elif type(detail_group) is DB.Group and detail_group.Id not in arraysmembers:
            detail_group_instances_count += 1
    return model_group_instances_count, model_group_types_count, detail_group_instances_count, detail_group_types_count