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 Beam Given its Axis, it adds a Beam element to the active Revit document
Add Column Given its Axis, it adds a structural Column 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
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

Category Components

CategoryTypes Provides a picker of a CategoryType
Category Identity Query category identity information
Category Object Styles
Category Parameters Gets a list of valid parameters for the specified category that can be used in a table view
Query Categories Get document categories list
Category SubCategories Returns a list containing the subcategories of Category
Add SubCategory Add a new subcategory to the given category

DirectShape Components

DirectShape Categories Provides a picker of a valid DirectShape category
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 DirectShapeType Given its Geometry, it reconstructs a DirectShapeType 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 Document Gets the active document
Open Documents Gets the list of all open documents
Document Links Gets Revit documents that are linked into given document
Document Identity Query document identity information
Document File
Document Worksharing
Document Cloud
Project Information Project information
Project Location Project location
Save Document Saves a document to a given file path
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

Element Components

Element Parts Geometry Extracts the parts geometry of the given element
Element Bounding Geometry Bounding geometry of given 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
Flip Element Flips or Unflips elements from Revit document
Element Geometry Get the geometry of the specified Element
Element View Geometry Get the geometry of the given Element on a view
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
Get Element Parameter Gets the parameter value of a specified Revit Element
Set Element Parameter Sets the parameter value of a specified Revit Element
Reset Element Parameter Resets the parameter value of a specified Revit Element
Query Element Parameters Get the parameters of the specified Element
Element Passport
Pin Element Pins or Unpins elements from Revit document
Element Preview Get the preview of the specified Element
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 Elements 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

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

Filter Element Evaluate if an Element pass a Filter
Exclusion Filter Filter used to exclude a set of elements
Logical And Filter Filter used to combine a set of filters that pass when any pass
Logical Or Filter Filter used to combine a set of filters that pass when any pass
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
Type Filter Filter used to match elements by their type
Parameter Filter Filter used to match elements by the value of a parameter
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
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
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

Host Components

Host Type Compound Structure Get-Set host type compound structure
C
 Construct Compound Structure Construct compound structure
C
 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

Input Components

Built-In Parameter Picker Provides a BuiltInParameter picker
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
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
ElementType 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
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 Type Picker for physical material type options
Thermal Asset Type Picker for thermal material type options
Extract Material's Assets Queries appearance, structural, and other assets from given material
Material Graphics Material Graphics Data
Analyze Appearance Asset (Generic) Analyze given Appearance asset of "Generic" schema
Create Physical Asset Create a new instance of Physical 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 new instance of 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
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 (Generic) Create a new instance of Appearance asset of "Generic" schema inside document
Deconstruct Bitmap Asset Deconstruct Bitmap Asset
Deconstruct Checker Asset Deconstruct Checker Asset
Material Identity Material Identity Data
Query Materials Get document materials list
Create Material Create a Revit material by name

Model Components

Create GroupType Given a collection of elements, it adds a GroupType to the active Revit document
Query Group Types Get document group types list
Query Grids Get all document grids
Add Model Group Given its location, it reconstructs a Model Group into the active Revit document
Group Elements Get group elements list
Add Grid Given its Axis, it adds a Grid element to the active Revit document
Add ModelLine Given a Curve, it adds a Curve element to the active Revit document
Add SketchPlane Given a Plane, it adds a SketchPlane element to the active Revit document
Level Identity Query level identity information
Query Levels Get all document levels
Add Level Given its elevation, it adds a Level to the active Revit document

Parameter Components

Built-In ParameterGroups Provides a picker of a BuiltInParameterGroup
Define Shared Parameter Given its Name, it creates a Shared Parameter definition to the active Revit document
Deconstruct ParameterValue Decompose a parameter value
ParameterKey Identity Decompose a parameter definition

Revit Primitives Components

Fill Pattern Represents a Revit document fill pattern
Line Pattern Represents a Revit document line pattern
Category Represents a Revit document category
Level Represents a Revit document level
Grid Represents a Revit document grid
Element Represents a Revit document element
Type Represents a Revit document element type
Family Represents a Revit document family
Mullion Represents a Revit curtain grid mullion element
Panel Represents a Revit curtain grid panel element
Vertex Represents a Revit vertex
Edge Represents a Revit edge
Face Represents a Revit face
Graphical Element Represents a Revit graphical element
Group Represents a Revit document group element
Host Represents a Revit document host element
Building Pad Represents a Revit document building pad element
Curtain Grid Line Represents a Revit document curtain grid line element
Curtain System Represents a Revit document curtain system element
Ceiling Represents a Revit document ceiling element
Floor Represents a Revit document floor element
Roof Represents a Revit document roof element
Wall Represents a Revit document wall element
Material Represents a Revit document material
Parameter Key Represents a Revit parameter definition
Sketch Plane Represents a Revit document sketch plane
View Represents a Revit view

Room & Area Components

Analyze Instance Space Analyze family instance space eg spatial elements surrounding the given instance

Site Components

Site Location Identity Site location identity Data
Query Site Locations Get all document site locations
Add BuildingPad Given a set of contour Curves, it adds a BuildingPad element to the active Revit document
Query Shared Sites Get all document shared sites
Add Topography (Mesh) Given a Mesh, it adds a Topography surface to the active Revit document
Add Topography (Points) Given a set of Points, it adds a Topography surface to the active Revit document

Type Components

Default Type Query default type
Duplicate Type Given a Name, it duplicates an ElementType into the active Revit document
Export Type Image Exports a ElementType preview into an image file
Type Identity Query type identity information
Type Instances Obtains all elements of the specified Type
Query Types Get document element types list
Similar Types Obtains a set of types that are similar to Type

View Components

Query View Types Get document view types list
Active Graphical View Gets the active graphical view
Export View Image Exports a view into an image file
View Identity Query view identity information
Query Views Get all document views
Add View3D Given a plane, it adds a 3D View to the active Revit document

Wall Components

Analyze Basic Wall Type Analyze given Basic Wall type
Analyze Curtain Wall Type Analyze given Curtain Wall Type
Analyze Curtain System Type Analyze given Curtain System Type
Analyze Mullion Type Analyze given mullion type
Analyze Panel Type Analyze given panel type
Analyze Stacked Wall Analyze given Stacked Wall element
Add Wall (Curve) Given a curve, it adds a Wall element to the active Revit document
Analyze Wall Analyze given Wall element
Analyze Wall Location Curve Analyze location curve of given wall instance
Analyze Wall Profile Get the vertical profile of the given wall
Analyze Curtain Wall Analyze given Curtain Wall element
Analyze Curtain System Analyze given Curtain System element
Analyze Curtain Grid Cell Analyze given curtain grid cell
Analyze Curtain Grid Analyze given curtain grid
Analyze Curtain Grid Line Analyze given curtain grid line
Analyze Mullion Analyze given mullion element
Analyze Panel Analyze given panel element
Add Wall (Profile) Given a base curve and profile curves, it adds a Wall element to the active Revit document
Query Walls Get all document walls