This guide documents the Grasshopper components that support Revit interaction. It is important to have a basic understanding of the Revit Data Hierarchy when working with Revit-aware components to create and edit Revit content.

Build Components

Add Component (Adaptive) Given a collection of Points, it adds an AdaptiveComponent element to the active Revit document
Add Ceiling Given its outline curve, it adds a Ceiling element to the active Revit document
Add Railing Given a curve, it adds a Railing element to the active Revit document
Add Roof Given its outline curve, it adds a Roof element to the active Revit document
Add Structural Beam Given its Axis, it adds a beam element to the active Revit document
Add Structural Brace Given its Axis, it adds a brace element to the active Revit document
Add Structural Column Given its Axis, it adds a structural column element to the active Revit document
Add Component (Location) Given its location, it reconstructs a Component element into the active Revit document
Add Floor Given its outline curve, it adds a Floor element to the active Revit document

Category Components

Category ObjectStyle

DirectShape Components

DirectShape Categories Provides a picker for direct shape categories
Add Brep DirectShape Given a Brep, it adds a Brep shape to the active Revit document
Add Curve DirectShape Given a Curve, it adds a Curve shape to the active Revit document
Add Geometry DirectShape Given its Geometry, it adds a DirectShape element to the active Revit document
Add DirectShape Type Given its Geometry, it reconstructs a DirectShape Type to the active Revit document
Add DirectShape Given its location, it reconstructs a DirectShape into the active Revit document
Add Mesh DirectShape Given a Mesh, it adds a Mesh shape to the active Revit document
Add Point DirectShape Given a Point, it adds a Point shape to the active Revit document

Document Components

Active Workset Gets the active workset
Workset Identity Workset properties Get-Set accessor to workset information
Query Worksets Get document construction worksets list
Query Phases Get document construction phases list
Active Design Option Gets the active Design Option
Design Option Set Identity Design Option Set identity information
Design Option Identity Design Option identity information
Query Design Option Sets Get all document design options
Query Design Options Get all document design options
Document Version Document version information
Active Document Gets the active document
Open Documents Gets the list of all open documents
Query Revit Links Gets Revit linked models into given document
Document Identity Basic information about a document identity
Document File Basic information about a document file
Document Worksharing Worksharing information about a document
Document Cloud Cloud information about a document
Project Information Project information
Save Document Saves a document to a given file path

Element Components

Release Element Release elements on Revit document
Element Workset Element Workset properties Get-Set accessor to element workset information
Element Ownership Element ownership status
Element Phasing Element Phasing properties Get-Set accessor to element phasing information
Element Parameter Get-Set accessor to element parameter values
Reset Element Parameter Resets the parameter value of a specified Revit Element
Query Element Parameters Get the parameters of the specified Element
Get Element Parameter Gets the parameter value of a specified Revit Element
Set Element Parameter Sets the parameter value of a specified Revit Element
Delete Element Deletes elements from Revit document
Element Dependents Queries for all elements that, from a logical point of view, are the children of Element
Duplicate Element Duplicates document elements
Clone Element Clone document element on several locations
Flip Element Flips or Unflips elements from Revit document
Inspect Element Inspects Element parameters
Element Location Element Get-Set location
Element Curve Element Get-Set curve
Element Material Quantities Query element material information
Element Materials Query element used materials
Element Passport
Pin Element Pins or Unpins elements from Revit document
Purge Element Purge unused elements from Revit document
Query Element Get element by ID
Query Elements Get document model elements list
Query View Elements Get elements visible in a view
Select Element Adds or remove elements from active selection
Element Name Element Name Property Get-Set accessor to Element Name property
Element Category Element Category Property Get-Set accessor to Element Category property
Element Type Element Type Property Get-Set accessor to Element Type property
Element Version Element version information
Delete Element Deletes elements from Revit document
E
Element Placement Queries element placement information
Element Identity Queries element identity information
Element Parts Geometry Extracts the parts geometry of the given element
Element Bounding Geometry Bounding geometry of given element
Element Geometry Get the geometry of the specified Element
Element View Geometry Get the geometry of the given Element on a view
Element Preview Get the preview of the specified Element

Family Components

Add LoftForm Given a list of curves, it adds a Form element to the active Revit document
Add Form Given its Geometry, it adds a Form element to the active Revit document
Construct Visibility
Deconstruct Visibility
Component Family Form
Component Family Curve
Family Identity Queries family identity information
Query Families Get document families list
Family Types Obtains a set of types that are owned by Family
Load Component Family Loads a family into the document
New Component Family Creates a new Family from a template
Component Family Opening
Save Component Family Saves the Family to a given file path
Component Family Void

Filter Components

Element Classes Provides a picker for Revit element classes
Not Equals Rule Filter used to match elements if value of a parameter are not equals to Value
Equals Rule Filter used to match elements if value of a parameter equals to Value
Greater Rule Filter used to match elements if value of a parameter greater than Value
Greater Or Equal Rule Filter used to match elements if value of a parameter greater or equal than Value
Less Rule Filter used to match elements if value of a parameter less than Value
Less Or Equal Rule Filter used to match elements if value of a parameter less or equal than Value
Text Contains Rule Filter used to match elements if value of a parameter contains the specified text
Text Begins Rule Filter used to match elements if value of a parameter begins with the specified text
Text Ends Rule Filter used to match elements if value of a parameter ends with the specified text
Category Rule Filter used to match elements on a category
Exclude Types Filter used to exclude element types
Class Filter Filter used to match elements by their API class
Category Filter Filter used to match elements by their category
Family Filter Filter used to match elements by their family
Type Filter Filter used to match elements by their type
Parameter Filter Filter used to match elements by the value of a parameter
Workset Filter Filter used to match elements by their workset
Bounding Box Filter Filter used to match elements by their BoundingBox
Intersects Element Filter Filter used to match elements that intersect to the given element
Intersects Brep Filter Filter used to match elements that intersect to the given brep
Intersects Mesh Filter Filter used to match elements that intersect to the given mesh
Level Filter Filter used to match elements associated to the given level
Design Option Filter Filter used to match elements associated to the given Design Option
Phase Status Filter Filter used to match elements associated to the given Phase status
Owner View Filter Filter used to match elements associated to the given View
Selectable In View Filter Filter used to match seletable elements into the given View
Visible In View Filter Filter used to match visible elements into the given View
Logical And Filter Filter used to combine multiple filters into one that pass when all pass
Logical Or Filter Filter used to combine multiple filters into one that pass when any pass
Intersection Filter Filter used to combine a set of filters into one that pass when all pass
Union Filter Filter used to combine a set of filters into one that pass when any pass
Exclusion Filter Filter used to exclude a set of elements
Filter Element Evaluate if an Element pass a Filter
Add Parameter Filter Create a parameter based filter
Query Filters Get document filters list
Selection Elements Selection Elements list
Add Selection Filter Create a selection filter
BoundingBox Filter Filter used to match elements by their BoundingBox

Host Components

Add Face Opening Given its outline boundary and a host element, it adds an opening to the active Revit document
Add Shaft Opening Given its outline boundary, it adds a Shaft opening to the active Revit document
Add Vertical Opening Given its outline boundary and a host element, it adds a vertical opening to the active Revit document
Add Wall Opening Given a host wall, it adds an opening to the active Revit document
Opening Boundary Profile Get the boundary profile of the given opening
Host Type Compound Structure Get-Set host type compound structure
Construct Compound Structure Construct compound structure
Construct Compound Structure Layer Construct compound structure layer
Deconstruct Compound Structure Deconstruct compound structure
Deconstruct Compound Structure Layer Deconstruct compound structure layer
Host Boundary Profile Get the boundary profile of the given host element
Element Host Obtains the host of the specified element
Host Faces Obtains a set of types that are owned by Family
Host Curtain Grids Obtains the curtain grids of the specified host element
Host Inserts Obtains a set of types that are owned by Family
Host Type Compound Structure Get host object type compound structure
Deconstruct Compound Structure Deconstructs given compound structure into its properties
Deconstruct Compound Structure Layer Deconstructs given compound structure layer into its properties

Input Components

Curtain Grid Align Type Picker for curtain grid align type options
Curtain Grid Join Condition Picker for curtain grid join condition options
Curtain Grid Layout Picker for curtain grid layout options
C
Curtain Mullion Position Picker for curtain mullion position options
Curtain Mullion System Family Picker for curtain mullion system family types
Deck Embedding Type Picker for deck embedding type of a wall compound structure layer
Model Categories Picker Provides a Model Category picker
Annotation Categories Picker Provides a Annotation Category picker
Tag Categories Picker Provides a Tag Category picker
Analytical Categories Picker Provides a Analytical Category picker
Levels Picker Provides a Level picker
Component Families Picker Provides a Family picker
Title Block Type Picker Provides a Title Block type picker
Element Type Picker Provides an Element type picker
End Cap Condition Picker for end cap condition of a wall compound structure
Layer Function Picker for layer function of a wall compound structure layer
Opening Wrapping Condition Picker for compound structure layers wrapping at openings setting
Spatial Element Categories Picker for kind of spatial elements
Spatial Boundary Location Picker for spatial element boundary location line options
Detail Level Picker for level of detail
Wall Function Picker for builtin predefined Wall functions
Wall Location Line Picker for builtin Wall location line options
Wall Structural Usage Picker for builtin Wall structural usage options
Wall System Family Picker for builtin Wall system families
Wall Wrapping Picker for builtin Wall wrapping options

Material Components

Physical/Thermal Asset Behaviour Picker material behaviour options of physical or thermal assets
Physical Asset Class Picker for physical material class options
Thermal Asset Class Picker for thermal material class options
Material Graphics Material Graphics Data
Analyze Appearance Asset (Generic) Analyze given Appearance asset of "Generic" schema
Create Physical Asset Create a Revit structural asset
Modify Physical Asset Modify an existing instance of Physical Asset
Analyze Physical Asset Analyzes given instance of Physical Asset
Create Thermal Asset Create a Revit thermal asset
Modify Thermal Asset Modify an existing instance of Thermal Asset
Analyze Thermal Asset Analyzes given instance of Thermal Asset
Modify Appearance Asset (Generic) Modify given Appearance asset of "Generic" schema
Query Appearance Assets Get document appearance assets list
Extract Material's Assets Queries appearance, structural, and other assets from given material
Replace Material's Assets Replace existing assets on the given material, with given assets
Construct Bitmap Asset Construct Bitmap Asset
Construct Checker Asset Construct Checker Asset
Create Appearance Asset Create a Revit appearance asset
Deconstruct Bitmap Asset Deconstruct Bitmap Asset
Deconstruct Checker Asset Deconstruct Checker Asset
Material Identity Material Identity Data
Query Materials Get document materials list