Sample Code Revit Batch Processor 1.1.11 documentation
Gets all annotation symbol types, area tag types, room tag types in the model
doc (Autodesk.Revit.DB.Document) – Current Revit model document.
list of types
list
Gets all arrow head ids used in annotation symbol types, area tag types, room tag types in the model.
doc (Autodesk.Revit.DB.Document) – Current Revit model document.
List of element ids representing arrow head symbols
list of Autodesk.Revit.DB.ElementId
Copy annotation from one view to another.
doc (Autodesk.Revit.DB.Document) – Revit Document
source_dims_by_view_name (dict) – Dictionary containing the source annotations by target view name. ( not all annotations from the active view may want to be copied to all views )
active_view (Autodesk.Revit.DB.View) – The active view containing all source annotations
views_by_name_selected (dict) – Dictionary containing the selected views by name
callback_progress (ProgressBase) – Progress callback
Result object
list of built in parameters attached to
text
independent tags
Annotation symbols
containing arrow head ids
parameter containing the arrowhead id in text types
list of built in parameters attached to spot dims containing arrow head ids and symbols used
list of built in parameters attached to stair path types containing arrow head ids
Gets all arrow head symbol ids used in dim types in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :param type_getter: Function getting dimension types in the model. :type type_getter: func(doc) returns dim types. :param parameter_list: Names of parameters to be checked on dim types. :type parameter_list: list of str :return: List of element ids representing arrow head symbols :rtype: list of Autodesk.Revit.DB.ElementId
Gets all arrow head types in the model. TODO: This uses a plain english name comparison to get arrow head types…may not work in non english versions of Revit! :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element types representing arrow heads. :rtype: list of Autodesk.Revit.DB.ElementType
Gets all arrow type ids in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing arrow types :rtype: list of Autodesk.Revit.DB.ElementId
Gets all dimension types in a model :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of Dimension Types :rtype: Autodesk.Revit.DB.FilteredElementCollector of DimensionType
Gets all dimension type ids in a model :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing Dimension Types :rtype: list of Autodesk.Revit.DB.ElementId
Gets all dimension elements placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of Dimensions :rtype: Autodesk.Revit.DB.FilteredElementCollector of Dimension
Gets all family symbol ids used as centre line symbol from all dim styles in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing family symbols :rtype: list of Autodesk.Revit.DB.ElementId
Gets all arrow head symbol ids used in dim types in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing arrow head symbols :rtype: list of Autodesk.Revit.DB.ElementId
This will return a filtered element collector of all GenericAnnotation types in the model.
doc (Autodesk.Revit.DB.Document) – Current Revit model document.
_description_
Autodesk.Revit.DB.FilteredElementCollector
This will return a list of all GenericAnnotation types (symbols) id’s in the model excluding shared families.
doc (Autodesk.Revit.DB.Document) – Current Revit model document.
_description_
list of Autodesk.Revit.DB.ElementId
Gets all multi reference annotation types in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of MultiReferenceAnnotationType :rtype: Autodesk.Revit.DB.FilteredElementCollector of MultiReferenceAnnotationType
Gets all multi reference annotation type ids in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing multi reference Annotation Types :rtype: list of Autodesk.Revit.DB.ElementId
Gets all multi reference annotation elements in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of MultiReferenceAnnotation :rtype: Autodesk.Revit.DB.FilteredElementCollector of MultiReferenceAnnotation
Gets all multi reference annotation types using get similar types in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: list in format [[multi refType, [element ids of similar multi ref types, …]]] :rtype: List [[Autodesk.Revit.DB.ElementType, Autodesk.Revit.DB.ElementId, Autodesk.Revit.DB.ElementId,…],]
Gets all ids of text types used by elements in the model, includes types used in schedules (appearance)! Used: at least one instance of this type is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing used text types :rtype: list of Autodesk.Revit.DB.ElementId
Gets all used dimension type Ids in the model. Used: at least one instance using this type is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing Dimension Types :rtype: list of Autodesk.Revit.DB.ElementId
Gets all dimension styles used in multi ref annotation types. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :param multi_reference_anno_types: list in format [[multi refType, [element ids of similar multi ref types, …]]] :type multi_reference_anno_types: List [[Autodesk.Revit.DB.ElementType, [Autodesk.Revit.DB.ElementId, Autodesk.Revit.DB.ElementId,…],]] :return: List of element ids representing dimension style :rtype: list of Autodesk.Revit.DB.ElementId
Gets all ids of multi reference types used by elements in the model. Used: at least one instance using this type is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing multi reference Annotation Types :rtype: list of Autodesk.Revit.DB.ElementId
Returns all used arrow types in the model. Used in types of dimension, text, independent tags, spot dims, annotation symbols (incl room and area tags), stairs path :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing arrow head symbols :rtype: list of Autodesk.Revit.DB.ElementId
Gets ID of all unused text types in the model. Unused: Not one instance of this type is placed in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing unused text types :rtype: list of Autodesk.Revit.DB.ElementId
Gets ID of all unused dim types in the model. Includes checking multi ref dims for used dim types. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing dimension types :rtype: list of Autodesk.Revit.DB.ElementId
Gets IDs of all unused multi ref dimension types in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing multi ref dimension types :rtype: list of Autodesk.Revit.DB.ElementId
Gets all unused arrow type ids in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing arrow types :rtype: list of Autodesk.Revit.DB.ElementId
Gets all family symbol ids not used as symbol in any spot elevation or spot coordinate type definition. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing family symbols not used in spot elevation or spot coordinate type definition. :rtype: list of Autodesk.Revit.DB.ElementId
Gets all unused family and family symbol ids of category BuiltInCategory.OST_SpotElevSymbols. This method can be used to safely delete unused families. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing family and family symbols not used in spot elevation or spot coordinate type definition. :rtype: list of Autodesk.Revit.DB.ElementId
Returns all used generic annotation symbol ids ( used in model as well as dimension types) :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: _description_ :rtype: list of Autodesk.Revit.DB.ElementId
Returns all unused annotation symbol ids ( unused in model as well as dimension types) :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: _description_ :rtype: list of Autodesk.Revit.DB.ElementId
returns symbol(type) ids and family ids (when no type is in use) of in generic anno families which can be purged :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: _description_ :rtype: list of Autodesk.Revit.DB.ElementId
Gets all spot Dim types in the model
doc (Autodesk.Revit.DB.Document) – Current Revit model document.
A filtered element collector of spot dimension types
Autodesk.Revit.DB.FilteredElementCollector of spot dimension types
Gets all family symbol ids used as a symbol from all spot elevation type definitions and spot coordinate type definitions. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing family symbols :rtype: list of Autodesk.Revit.DB.ElementId
Gets all family symbols of category Spot Elevation Symbol in model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector :rtype: Autodesk.Revit.DB.FilteredElementCollector
Gets all family symbol ids of category Spot Elevation Symbol in model :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing family symbols :rtype: list of Autodesk.Revit.DB.ElementId
returns all arrow head ids used in text types in a model
Gets all stairs path types in the model/ :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of stair path types :rtype: Autodesk.Revit.DB.FilteredElementCollector of stair path types
Gets all arrow head symbol ids used in stairs path types in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing arrow head symbols :rtype: list of Autodesk.Revit.DB.ElementId
Gets all text types in the model :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of text element types :rtype: Autodesk.Revit.DB.FilteredElementCollector of text element types
Gets all text type ids in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing text types :rtype: list of Autodesk.Revit.DB.ElementId
Gets all text annotation elements in the model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: A filtered element collector of text elements :rtype: Autodesk.Revit.DB.FilteredElementCollector of text elements
Gets all arrow head ids used in text types in a model. :param doc: Current Revit model document. :type doc: Autodesk.Revit.DB.Document :return: List of element ids representing arrow head symbols :rtype: list of Autodesk.Revit.DB.ElementId