Revit API Docs

https://revapidocs.com/2020.htm
Admin
API documentation for Autodesk Revit covering namespaces, API changes, deprecations, and new...
Tokens:9,955
Snippets:130
Trust Score:5.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get and Set Image Instance Location

Source: https://revapidocs.com/2020.htm

Retrieve or set the location of an ImageInstance within a view using XYZ coordinates and BoxPlacement options. Ensure correct placement options are used.

```cs
ImageInstance.GetLocation(BoxPlacement)
ImageInstance.SetLocation(XYZ, BoxPlacement)
```

--------------------------------

### Get Cloud Model Information

Source: https://revapidocs.com/2020.htm

Retrieve the GUID and path for cloud-hosted models. Document.CloudModelGUID returns the model's unique identifier, and Document.GetCloudModelPath() returns its location.

```cs
Document.CloudModelGUID
Document.GetCloudModelPath()
```

--------------------------------

### MultiReferenceAnnotation Additions

Source: https://revapidocs.com/2020.htm

Enhancements to MultiReferenceAnnotation for setting and getting additional references, and for validating elements and 3D views for dimensioning.

```APIDOC
## MultiReferenceAnnotation Methods

### Description
Methods for managing additional references and validating dimensions in MultiReferenceAnnotations.

### Methods
- **MultiReferenceAnnotationOptions.SetAdditionalReferencesToDimension(IList<ElementId>)**
- **MultiReferenceAnnotationOptions.GetAdditionalReferencesToDimension()**
- **MultiReferenceAnnotation.AreElementsValidForMultiReferenceAnnotation(ElementId, ElementId)**
- **MultiReferenceAnnotationOption.ReferencesDontMatchReferenceCategory(ElementId, ElementId)**
- **MultiReferenceAnnotation.Is3DViewValidForDimension()**
```

--------------------------------

### BasePoint.Position

Source: https://revapidocs.com/2020.htm

Gets the XYZ value corresponding to the base point's position in Revit's internal coordinates.

```APIDOC
## BasePoint.Position

### Description
Gets the XYZ value corresponding to the base point's position in Revit's internal coordinates.

### Property
BasePoint.Position (Read-only)
```

--------------------------------

### Category Name Retrieval

Source: https://revapidocs.com/2020.htm

Method to get the string name of a category.

```APIDOC
## LabelUtils.GetLabelFor (BuiltInCategory)

### Description
Returns the string name of the given BuiltInCategory in the current Revit language.

### Method
LabelUtils.GetLabelFor(BuiltInCategory)
```

--------------------------------

### Localized Parameter Name Retrieval

Source: https://revapidocs.com/2020.htm

Method to get the localized string name of a built-in parameter.

```APIDOC
## LabelUtils.GetLabelFor(BuiltInParameter, Autodesk.Revit.ApplicationServices.LanguageType)

### Description
Returns the localized string name representing the built-in parameter in the input language.

### Method
LabelUtils.GetLabelFor(BuiltInParameter, Autodesk.Revit.ApplicationServices.LanguageType)
```

--------------------------------

### BasePoint.SharedPosition

Source: https://revapidocs.com/2020.htm

Gets the XYZ value corresponding to the base point's position in the transformed (shared) coordinates.

```APIDOC
## BasePoint.SharedPosition

### Description
Gets the XYZ value corresponding to the base point's position in the transformed (shared) coordinates.

### Property
BasePoint.SharedPosition (Read-only)
```

--------------------------------

### Get String Name for BuiltInCategory

Source: https://revapidocs.com/2020.htm

Retrieve the string name of a BuiltInCategory in the current Revit language using LabelUtils.GetLabelFor(BuiltInCategory). This is useful for displaying category names to users.

```python
LabelUtils.GetLabelFor (BuiltInCategory)
```

--------------------------------

### Get Localized Parameter Name

Source: https://revapidocs.com/2020.htm

Obtain the localized string name for a built-in parameter in a specified language using LabelUtils.GetLabelFor(BuiltInParameter, Autodesk.Revit.ApplicationServices.LanguageType).

```python
LabelUtils.GetLabelFor(BuiltInParameter, Autodesk.Revit.ApplicationServices.LanguageType)
```

--------------------------------

### Get Available Attached Detail Group Types

Source: https://revapidocs.com/2020.htm

Retrieve the IDs of attached detail group types that are available for a given group or group type. This helps in managing compatible detail groups.

```cs
Group.GetAvailableAttachedDetailGroupTypeIds()
GroupType.getAvailableAttachedDetailGroupTypeIds()
```

--------------------------------

### Get Number of Curves in CurveLoop

Source: https://revapidocs.com/2020.htm

Retrieve the number of curves within a CurveLoop using the CurveLoop.NumberOfCurves property. This provides a count of the individual curve segments forming the loop.

```python
CurveLoop.NumberOfCurves
```

--------------------------------

### Create an ImageInstance in a View

Source: https://revapidocs.com/2020.htm

Create an ImageInstance, representing an image placed in a view. This requires the Document, View, ElementId, and ImagePlacementOptions. Snapping is only available for PDF-based instances.

```cs
ImageInstance.Create(Document, View, ElementId, ImagePlacementOptions)
```

--------------------------------

### Image Type Options Configuration

Source: https://revapidocs.com/2020.htm

Configure options for creating or reloading an ImageType, including page number, path, resolution (in dpi), and external resource references.

```cs
ImageTypeOptions.PageNumber
ImageTypeOptions.Path
ImageTypeOptions.Resolution
ImageTypeOptions.SetExternalResourceReference()
```

--------------------------------

### Enable Cloud Worksharing

Source: https://revapidocs.com/2020.htm

Convert a cloud model into a workshared cloud model using Document.EnableCloudWorksharing(). Use Document.CanEnableCloudWorksharing() to verify if the operation is permissible.

```python
Document.EnableCloudWorksharing()
```

--------------------------------

### DockablePane UI Additions

Source: https://revapidocs.com/2020.htm

New properties to specify the minimum width and height for a DockablePane.

```APIDOC
## DockablePane UI Additions

### Properties

- **Autodesk.Revit.UI.DockablePaneState.MinimumWidth**: Specifies the minimum width for a DockablePane.
- **Autodesk.Revit.UI.DockablePaneState.MinimumHeight**: Specifies the minimum height for a DockablePane.
```

--------------------------------

### View Template Creation

Source: https://revapidocs.com/2020.htm

Methods to create view templates from existing views.

```APIDOC
## View.CreateViewTemplate()

### Description
Allows you to turn an existing view into a view template. The created view template has an automatically generated unique name.

### Method
View.CreateViewTemplate()
```

```APIDOC
## View.isViewValidForTemplateCreation()

### Description
Checks if a view is valid for creating a view template.

### Method
View.isViewValidForTemplateCreation()
```

--------------------------------

### DirectShapeType.CanCreateParts()

Source: https://revapidocs.com/2020.htm

Indicates whether it is possible to create parts from a DirectShapeType.

```APIDOC
## DirectShapeType.CanCreateParts()

### Description
Indicates whether it is possible to create parts from an instance of the DirectShapeType class.

### Method
DirectShapeType.CanCreateParts()
```

--------------------------------

### ImageInstance API Additions

Source: https://revapidocs.com/2020.htm

New class and members for representing and manipulating image instances placed in a view.

```APIDOC
## ImageInstance API Additions

### Class

- **ImageInstance**: Represents an image placed in a view.

### Methods

- **ImageInstance.Create(Document, View, ElementId, ImagePlacementOptions)**: Creates a new ImageInstance.
- **ImageInstance.GetLocation(BoxPlacement)**: Gets the location of the ImageInstance.
- **ImageInstance.SetLocation(XYZ, BoxPlacement)**: Sets the location of the ImageInstance.

### Properties

- **ImageInstance.Width**: Gets or sets the width of the ImageInstance.
- **ImageInstance.Height**: Gets or sets the height of the ImageInstance.
- **ImageInstance.EnableSnaps**: Enables or disables snapping capability for PDF-based instances.
```

--------------------------------

### Create View Template from View

Source: https://revapidocs.com/2020.htm

Convert an existing view into a view template using View.CreateViewTemplate(). The method automatically generates a unique name for the new view template. Use View.isViewValidForTemplateCreation() to check if a view can be converted.

```python
View.CreateViewTemplate()
```

```python
View.isViewValidForTemplateCreation()
```

--------------------------------

### DirectShape.CanCreateParts()

Source: https://revapidocs.com/2020.htm

Indicates whether it is possible to create parts from a DirectShape instance.

```APIDOC
## DirectShape.CanCreateParts()

### Description
Indicates whether it is possible to create parts from an instance of the DirectShape class.

### Method
DirectShape.CanCreateParts()
```

--------------------------------

### BalusterInfo.GetReferenceNameForHost()

Source: https://revapidocs.com/2020.htm

Allows access to the name string to be used as a reference to the Host in the current Revit language.

```APIDOC
## BalusterInfo.GetReferenceNameForHost()

### Description
Allows access to the name string to be used as a reference to the Host in the current Revit language.

### Method
BalusterInfo.GetReferenceNameForHost()
```

--------------------------------

### Image Instance Dimensions and Snaps

Source: https://revapidocs.com/2020.htm

Access the width and height of an ImageInstance and control its snapping capability. Snapping can only be enabled for PDF-based image instances.

```cs
ImageInstance.Width
ImageInstance.Height
ImageInstance.EnableSnaps
```

--------------------------------

### TopographySurface.Create()

Source: https://revapidocs.com/2020.htm

Creates a topography surface from a given list of triangulation facets.

```APIDOC
## Autodesk.Revit.DB.Architecture.TopographySurface.Create()

### Description
Creates a topography surface from a given list of triangulation facets.

### Method
Autodesk.Revit.DB.Architecture.TopographySurface.Create(Document, IList<XYZ> points, IList<IList<int> > facets, String)
```

--------------------------------

### Create an ImageType

Source: https://revapidocs.com/2020.htm

Create a new ImageType instance. This method supports loading specific pages from PDFs and images from external resources. Ensure Document and ImageTypeOptions are valid.

```cs
ImageType.Create(Document, ImageTypeOptions)
```

--------------------------------

### AdvancedGlazing API

Source: https://revapidocs.com/2020.htm

The Autodesk.Revit.DB.Visual.AdvancedGlazing class provides predefined properties for compile-time access to appearance asset properties of type 'advanced glazing'.

```APIDOC
## Autodesk.Revit.DB.Visual.AdvancedGlazing Class

### Description
Provides compile-time access to predefined properties for the 'advanced glazing' appearance asset.

### Properties
(Predefined properties for accessing advanced glazing appearance asset properties)
```

--------------------------------

### TaskDialog UI Additions

Source: https://revapidocs.com/2020.htm

New property to enable an animated progress bar in a TaskDialog.

```APIDOC
## TaskDialog UI Additions

### Properties

- **TaskDialog.EnableMarqueeDialogBar**: Allows the TaskDialog to include a progress bar with indeterminate start and stop.
```

--------------------------------

### PartUtils.GetSplittingElements()

Source: https://revapidocs.com/2020.htm

Identifies and returns the elements used to create the part division.

```APIDOC
## PartUtils.GetSplittingElements()

### Description
Identifies and returns the elements (ReferencePlane, Level or Grid) that were used to create the division.

### Method
PartUtils.GetSplittingElements(Document, ElementId)
```

--------------------------------

### Application API Additions

Source: https://revapidocs.com/2020.htm

New function to determine if Revit is currently in journal playback mode.

```APIDOC
## Application API Additions

### Methods

- **Application.IsJournalPlaying()**: Determines if Revit is currently in journal playback mode or not.
```

--------------------------------

### RouteAnalysisSettings API

Source: https://revapidocs.com/2020.htm

Manages project-wide settings for route calculations, currently used by PathOfTravel elements.

```APIDOC
## RouteAnalysisSettings Class

Represents a settings element containing project-wide settings for route calculations in plan views.

### Methods

*   **EnableIgnoredCategoryIds()**: Allows the API user to enable ignoring certain categories of elements during calculations.
*   **SetIgnoredCategoryIds()**: Sets the categories to be ignored during calculations.

### Properties

*   **AnalysisZoneTopOffset**: The analysis zone top, specified as an offset above the level of the plan view.
*   **AnalysisZoneBottomOffset**: The analysis zone bottom, specified as an offset above the level of the plan view.
```

--------------------------------

### Export 2D Views with CustomExporter

Source: https://revapidocs.com/2020.htm

Use the CustomExporter.Export() method to export 2D views like plans, sections, and elevations. Ensure the exporter context matches the view type (IExportContext2D for 2D views).

```csharp
CustomExporter.Export()
CustomExporter.Export(IList<ElementId>)
CustomExporter.Export2DGeometricObjectsIncludingPatternLines
CustomExporter.Export2DIncludingAnnotationObjects
CustomExporter.Export2DForceDisplayStyle
IExportContext2D.OnElementBegin2D()
IExportContext2D.OnElementEnd2D()
IExportContext2D.OnFaceEdge2D()
IExportContext2D.OnFaceSilhouette2D()
```

--------------------------------

### Cloud Model Operations

Source: https://revapidocs.com/2020.htm

Methods for saving and managing cloud models on BIM 360.

```APIDOC
## Document.SaveAsCloudModel()

### Description
Saves the current model as a cloud model in BIM 360. Only non-workshared models can be saved via this method.

### Method
Document.SaveAsCloudModel()
```

```APIDOC
## Document.SaveCloudModel()

### Description
Saves the current cloud model.

### Method
Document.SaveCloudModel()
```

```APIDOC
## Document.EnableCloudWorksharing()

### Description
Converts a cloud model into a workshared cloud model. The method Document.CanEnableCloudWorksharing() can be used to check whether this operation is valid on a given model.

### Method
Document.EnableCloudWorksharing()
```

--------------------------------

### SiteLocation.SetGeoCoordinateSystem()

Source: https://revapidocs.com/2020.htm

Sets the Geo coordinate system for the current document.

```APIDOC
## SiteLocation.SetGeoCoordinateSystem()

### Description
Sets the Geo coordinate system for the current document.

### Method
SiteLocation.SetGeoCoordinateSystem()
```

--------------------------------

### NavisworksExportOptions Additions

Source: https://revapidocs.com/2020.htm

Three new options have been added to NavisworksExportOptions to control faceting, light conversion, and linked CAD format conversion during export.

```APIDOC
## NavisworksExportOptions Properties

### Description
New properties for controlling Navisworks export settings.

### Properties
- **FacetingFactor** (double) - Controls the faceting of exported geometry.
- **ConvertLights** (bool) - Indicates whether lights should be converted during export.
- **ConvertLinkedCADFormats** (bool) - Indicates whether linked CAD formats should be converted during export.
```

--------------------------------

### ScheduleDefinition.ShowGridLines

Source: https://revapidocs.com/2020.htm

Indicates whether the schedule grid lines will be visible on a sheet.

```APIDOC
## ScheduleDefinition.ShowGridLines

### Description
Indicates if the schedule grid lines will be visible on a sheet.

### Property
ScheduleDefinition.ShowGridLines
```

--------------------------------

### Advanced Glazing Schema API

Source: https://revapidocs.com/2020.htm

Access and manipulate advanced glazing appearance assets using predefined properties in Autodesk.Revit.DB.Visual.AdvancedGlazing for compile-time safety.

```csharp
Autodesk.Revit.DB.Visual.AdvancedGlazing
```

--------------------------------

### Image Type Properties

Source: https://revapidocs.com/2020.htm

Access properties of an ImageType, including its external resource type, page number, and path type (relative or absolute).

```cs
ImageType.ExternalResourceType
ImageType.PageNumber
ImageType.PathType
```

--------------------------------

### Set Minimum Pane Size for DockablePane

Source: https://revapidocs.com/2020.htm

Specify the minimum width and height for a DockablePane using Autodesk.Revit.UI.DockablePaneState.MinimumWidth and MinimumHeight. These are set within the InitialState and default to 200 pixels.

```cs
Autodesk.Revit.UI.DockablePaneState.MinimumWidth
Autodesk.Revit.UI.DockablePaneState.MinimumHeight
```

--------------------------------

### CustomExporter.Export() Overloads

Source: https://revapidocs.com/2020.htm

The CustomExporter class now supports exporting both 3D and 2D views through its Export() methods. The method accepting an IList<ElementId> requires all views to be of the same type (all 3D or all 2D).

```APIDOC
## CustomExporter.Export()

### Description
Exports a view, which can be either 3D or 2D.

### Method
CustomExporter.Export()

### Parameters
- **view** (View) - The view to export.

## CustomExporter.Export(IList<ElementId>)

### Description
Exports a collection of views. All views in the collection must be of the same type (either all 3D or all 2D).

### Method
CustomExporter.Export(IList<ElementId>)

### Parameters
- **viewIds** (IList<ElementId>) - A collection of view IDs to export.
```

--------------------------------

### Navisworks Export Options

Source: https://revapidocs.com/2020.htm

New options for Navisworks export are available in NavisworksExportOptions. Ensure you have an updated Navisworks Exporter to utilize these.

```csharp
NavisworksExportOptions.FacetingFactor
NavisworksExportOptions.ConvertLights
NavisworksExportOptions.ConvertLinkedCADFormats
```

--------------------------------

### Reload ImageType from Options

Source: https://revapidocs.com/2020.htm

Reload an existing ImageType using new options. This is useful for updating image properties or sources. ImageTypeOptions must be provided.

```cs
ImageType.ReloadFrom(ImageTypeOptions)
```

--------------------------------

### IExportContext2D Interface

Source: https://revapidocs.com/2020.htm

The new IExportContext2D interface is used for exporting 2D views and includes methods for handling 2D elements and faces.

```APIDOC
## IExportContext2D Interface

### Description
Interface for exporting 2D views, providing methods to handle 2D elements and faces.

### Methods
- **OnElementBegin2D()**
- **OnElementEnd2D()**
- **OnFaceEdge2D()**
- **OnFaceSilhouette2D()**
```

--------------------------------

### Enable Marquee Progress Bar in TaskDialog

Source: https://revapidocs.com/2020.htm

Add an animated, indeterminate progress bar to a TaskDialog using TaskDialog.EnableMarqueeDialogBar. The animation runs until the dialog is closed.

```cs
TaskDialog.EnableMarqueeDialogBar
```

--------------------------------

### Multi-Reference Annotation - Additional References

Source: https://revapidocs.com/2020.htm

Enhance MultiReferenceAnnotations by adding support for additional references using SetAdditionalReferencesToDimension() and GetAdditionalReferencesToDimension(). Verify reference validity with AreElementsValidForMultiReferenceAnnotation() and ReferencesDontMatchReferenceCategory().

```csharp
MultiReferenceAnnotationOptions.SetAdditionalReferencesToDimension()
MultiReferenceAnnotationOptions.GetAdditionalReferencesToDimension()
MultiReferenceAnnotation.AreElementsValidForMultiReferenceAnnotation()
MultiReferenceAnnotationOption.ReferencesDontMatchReferenceCategory()
```

--------------------------------

### Create Offset CurveLoop

Source: https://revapidocs.com/2020.htm

Generate a new CurveLoop by offsetting an existing one using CurveLoop.CreateViaOffset(). This method accepts a double array for offset distances, where each distance corresponds to a curve at the same position in the loop.

```python
CurveLoop.CreateViaOffset()
```

--------------------------------

### ImageTypeOptions Class

Source: https://revapidocs.com/2020.htm

A class containing options used when creating or reloading an image.

```APIDOC
## ImageTypeOptions Class

### Methods

- **ImageTypeOptions.IsValid()**: Checks if the ImageTypeOptions are valid.
- **ImageTypeOptions.SetExternalResourceReference()**: Sets the external resource reference for the image.

### Properties

- **ImageTypeOptions.PageNumber**: Specifies the page number to load from a PDF.
- **ImageTypeOptions.Path**: Specifies the path to the image file.
- **ImageTypeOptions.Resolution**: Specifies the resolution (in dpi) for raster images.
```

--------------------------------

### FabricationPart API

Source: https://revapidocs.com/2020.htm

Retrieves geometry information for insulation or liner applied to a fabrication part.

```APIDOC
## FabricationPart Additions

### Method

*   **GetInsulationLiningGeometry()**: Returns any insulation or liner geometry for a fabrication part. Returns null if no insulation or liner is applied.
```

--------------------------------

### FabricationNetworkChangeService API

Source: https://revapidocs.com/2020.htm

Provides functionality to change the service of selected fabrication elements.

```APIDOC
## FabricationNetworkChangeService Additions

### Method

*   **ChangeService()**: Changes the service of a selection of element identifiers to the passed in service, group identifiers, and an option to restrict the placement of parts that only exist in the group identifier.
```

--------------------------------

### PartUtils.GetSplittingCurves()

Source: https://revapidocs.com/2020.htm

Identifies and returns the curves that were sketched to create the part division.

```APIDOC
## PartUtils.GetSplittingCurves()

### Description
Identifies and returns the curves that were sketched to create the part division and, optionally, also outputs the sketch plane for those curve(s).

### Method
PartUtils.GetSplittingCurves(Document, ElementId)
PartUtils.GetSplittingCurves(Document, ElementId, out SketchPlane)
```

--------------------------------

### BalusterInfo.GetReferenceNameForTopRail()

Source: https://revapidocs.com/2020.htm

Allows access to the name string to be used as a reference to the Top Rail in the current Revit language.

```APIDOC
## BalusterInfo.GetReferenceNameForTopRail()

### Description
Allows access to the name string to be used as a reference to the Top Rail in the current Revit language.

### Method
BalusterInfo.GetReferenceNameForTopRail()
```

--------------------------------

### PathOfTravel API

Source: https://revapidocs.com/2020.htm

Provides functionality to create and manage Path of Travel elements, representing the shortest navigable path between two points.

```APIDOC
## PathOfTravel Class

Represents the element that calculates the shortest navigable path between two points in a plan view.

### Methods

*   **Create()**: Creates a single PathOfTravel element given a start and end point.
*   **CreateMultiple()**: Creates multiple PathOfTravel elements given arrays of start and end points.
*   **CreateMapped()**: Creates multiple PathOfTravel elements by mapping each of a set of start points to each of a set of end points.
*   **GetCurveLoop()**: Retrieves the curve loop of the path.
*   **PathStart**: Gets the starting point of the path.
*   **PathMidpoint**: Gets the midpoint of the path.
*   **PathEnd**: Gets the ending point of the path.
```

--------------------------------

### Free-form Rebar Updates

Source: https://revapidocs.com/2020.htm

Enables free-form rebar to regenerate based on shared parameters and provides methods to manage these dependencies.

```APIDOC
## Free-form Rebar Updates

### Methods for Managing Shared Parameters

*   **RebarFreeFormAccessor.AddUpdatingSharedParameter()**: Adds a shared parameter to update free-form rebar.
*   **RebarFreeFormAccessor.RemoveUpdatingSharedParameter()**: Removes a shared parameter from updating free-form rebar.
*   **RebarFreeFormAccessor.GetUpdatingSharedParameters()**: Retrieves the list of shared parameters currently used for updating free-form rebar.

### Methods for Rebar Update Data

*   **RebarUpdateCurvesData.GetChangedSharedParameterGUIDs()**: Returns an array containing the GUIDs of shared parameters that were changed since the last regeneration.
*   **RebarUpdateCurvesData.GetRebarId()**: Returns the ElementId of the rebar being regenerated.
```

--------------------------------

### Document Additions for Cloud Models

Source: https://revapidocs.com/2020.htm

New properties to indicate if a document is a cloud model and to retrieve its cloud information.

```APIDOC
## Document Additions for Cloud Models

### Properties

- **Document.IsModelInCloud**: Indicates if the current document is located in the cloud.
- **Document.CloudModelGUID**: Returns the GUID of the model, if it is stored in the cloud.

### Methods

- **Document.GetCloudModelPath()**: Returns the cloud model path.
```

--------------------------------

### RebarConstraint API

Source: https://revapidocs.com/2020.htm

Provides utility for checking the validity of references for creating Rebar constraints.

```APIDOC
## RebarConstraint Additions

### Method

*   **IsReferenceValidForConstraint()**: Checks if the reference provided can be used in creating Rebar constraints.
```

--------------------------------

### Check for Background Calculations

Source: https://revapidocs.com/2020.htm

Identify if background calculations are in progress for a document using Document.IsBackgroundCalculationInProgress(). Certain operations like saving, printing, or element creation are restricted when calculations are active.

```python
Document.IsBackgroundCalculationInProgress()
```

--------------------------------

### CurveLoop API Additions

Source: https://revapidocs.com/2020.htm

New property and method for the CurveLoop class.

```APIDOC
## CurveLoop.NumberOfCurves

### Description
Returns the number of curves in the curve loop.

### Property
CurveLoop.NumberOfCurves
```

```APIDOC
## CurveLoop.CreateViaOffset()

### Description
Creates a new curve loop that is an offset of the existing curve loop. This method takes as input a double array of offset distances instead of one double offset distance. The size of this array must match the size of the curve loop. The curve at position _i_ will be offset with the double at position _i_ in the array.

### Method
CurveLoop.CreateViaOffset()
```

--------------------------------

### ElectricalSystem API

Source: https://revapidocs.com/2020.htm

Provides access to electrical system properties related to circuit connection type and feed through lugs.

```APIDOC
## ElectricalSystem API Additions

### Properties

*   **CircuitConnectionType**: Provides access to the circuit connection type of the electrical system.
*   **IsBasePanelFeedThroughLugsOccupied**: Provides information about whether or not the feed through lugs of the base panel is already occupied.
```

--------------------------------

### TableData.ZoomLevel

Source: https://revapidocs.com/2020.htm

Allows the user to set the zoom level of a schedule in a tabular view for the current session.

```APIDOC
## TableData.ZoomLevel

### Description
Allows the user to set the zoom level of a schedule in a tabular view. This setting is temporary and only applies to the current session.

### Property
TableData.ZoomLevel
```

--------------------------------

### Set Element Logical Filters

Source: https://revapidocs.com/2020.htm

Apply ElementFilters to a view's filter criteria using ElementLogicalFilter.SetFilters(). This provides a streamlined way to manage combined filter conditions.

```cs
ElementLogicalFilter.SetFilters()
```

--------------------------------

### Check Attached Detail Group Type Compatibility

Source: https://revapidocs.com/2020.htm

Verify if an attached detail group type's orientation matches the target view's orientation. Consider perpendicular views as compatible. Use OwnerViewId to prevent displaying groups in incorrect views.

```cs
Group.IsCompatibleAttachedDetailGroupType()
```

--------------------------------

### Group API Additions for Attached Detail Groups

Source: https://revapidocs.com/2020.htm

New methods for managing the visibility and compatibility of attached detail groups within a group.

```APIDOC
## Group API Additions for Attached Detail Groups

### Methods

- **Group.ShowAttachedDetailGroups()**: Controls visibility for an element group's attached detail groups.
- **Group.ShowAllAttachedDetailGroups()**: Controls visibility for all attached detail groups of an element group.
- **Group.HideAttachedDetailGroups()**: Hides attached detail groups for an element group.
- **Group.HideAllAttachedDetailGroups()**: Hides all attached detail groups for an element group.
- **Group.GetAvailableAttachedDetailGroupTypeIds()**: Returns the attached detail groups available for this group.
- **Group.IsCompatibleAttachedDetailGroupType()**: Checks if the orientation of the input attached detail group matches the input view's orientation.

### Properties

- **Group.IsAttached**: Provides information about whether a group is attached.
- **Group.AttachedParentId**: Provides information about to what group a group is associated.
```

--------------------------------

### Multi-Reference Annotation - 3D View Restrictions

Source: https://revapidocs.com/2020.htm

Use MultiReferenceAnnotation.Is3DViewValidForDimension() to check if a 3D view is suitable for dimensioning. LinearFixed dimensions are restricted in 3D views, and Linear dimensions require the view direction to be perpendicular to the work plane normal.

```csharp
MultiReferenceAnnotation.Is3DViewValidForDimension()
```

--------------------------------

### Save Current Cloud Model

Source: https://revapidocs.com/2020.htm

Use Document.SaveCloudModel() to save changes to the current cloud model. This method is applicable to models already stored in the cloud.

```python
Document.SaveCloudModel()
```

--------------------------------

### ImageType API Additions

Source: https://revapidocs.com/2020.htm

New members for enhanced image type creation, reloading, and property access, including support for PDF pages and external resources.

```APIDOC
## ImageType API Additions

### Methods

- **ImageType.Create(Document, ImageTypeOptions)**: Creates a new ImageType.
- **ImageType.CanReload()**: Checks if the ImageType can be reloaded.
- **ImageType.ReloadFrom(ImageTypeOptions)**: Reloads the ImageType from specified options.

### Properties

- **ImageType.ExternalResourceType**: Gets the external resource type of the image.
- **ImageType.PageNumber**: Gets the page number of the image (for PDF files).
- **ImageType.PathType**: Gets the path type (relative or absolute) of the image.
```

--------------------------------

### Check if Journal is Playing

Source: https://revapidocs.com/2020.htm

Determine if Revit is currently executing a journal file. This function is useful for controlling behavior during automated tasks or debugging.

```cs
Application.IsJournalPlaying()
```

--------------------------------

### Check if Document is in Cloud

Source: https://revapidocs.com/2020.htm

Determine if the current document is stored in the cloud. This property is a boolean indicator.

```cs
Document.IsModelInCloud
```

--------------------------------

### Enable Legacy JavaScript Binding in CEFsharp

Source: https://revapidocs.com/2020.htm

This setting is enabled during Revit's internal CEFsharp initialization to avoid version conflicts and ensure stability. It is relevant when dealing with add-ins that also use CEFsharp.

```csharp
CefSharpSettings.LegacyJavascriptBindingEnabled = true
```

--------------------------------

### Save Model to BIM 360 Cloud

Source: https://revapidocs.com/2020.htm

Use Document.SaveAsCloudModel() to save the current non-workshared model as a cloud model in BIM 360. Ensure the model is not workshared before calling this method.

```python
Document.SaveAsCloudModel()
```

--------------------------------

### ElementLogicalFilter API Additions

Source: https://revapidocs.com/2020.htm

New function for setting ElementFilters combined by an ElementLogicalFilter.

```APIDOC
## ElementLogicalFilter API Additions

### Methods

- **ElementLogicalFilter.SetFilters(ElementLogicalFilter)**: Allows setting ElementFilters that are combined by the given ElementLogicalFilter.
```

--------------------------------

### Create Parameter Value Presence Filter Rules

Source: https://revapidocs.com/2020.htm

Create filter rules to evaluate whether a parameter has a value for a specific element using FilterRule.CreateHasValueParameterRule() and FilterRule.CreateHasNoValueParameterRule(). These rules are used in parameter filters.

```python
FilterRule.CreateHasValueParameterRule()
```

```python
FilterRule.CreateHasNoValueParameterRule()
```

--------------------------------

### Image Type Options Validation

Source: https://revapidocs.com/2020.htm

Validate the settings within ImageTypeOptions before creating or reloading an image. This ensures all necessary parameters are correctly configured.

```cs
ImageTypeOptions.IsValid()
```

--------------------------------

### Parameter Hiding and Clearing

Source: https://revapidocs.com/2020.htm

Properties and methods related to hiding empty parameters and clearing parameter values.

```APIDOC
## ExternalDefinition.HideWhenNoValue

### Description
Indicates if the shared parameter should be hidden from the property palette and Element.GetOrderedParameters() when it has no value.

### Property
ExternalDefinition.HideWhenNoValue
```

```APIDOC
## ExternalDefinitionCreationOptions.HideWhenNoValue

### Description
Indicates if the shared parameter should be hidden from the property palette and Element.GetOrderedParameters() when it has no value.

### Property
ExternalDefinitionCreationOptions.HideWhenNoValue
```

```APIDOC
## SharedParameterElement.ShouldHideWhenNoValue()

### Description
Indicates if the shared parameter should be hidden from the property palette and Element.GetOrderedParameters() when it has no value.

### Method
SharedParameterElement.ShouldHideWhenNoValue()
```

```APIDOC
## Parameter.ClearValue()

### Description
Resets the value of a shared parameter which has the HideWhenNoValue flag set back to a cleared state. This method is not applicable to clear the value of any other parameter type.

### Method
Parameter.ClearValue()
```

--------------------------------

### Filter Schedules by Parameter Value Presence

Source: https://revapidocs.com/2020.htm

Filter schedules based on the presence or absence of a parameter value using ScheduleFilterType.HasValue and ScheduleFilterType.HasNoValue, in conjunction with ScheduleDefinition.CanFilterByValuePresence().

```python
ScheduleFilterType.HasValue
```

```python
ScheduleFilterType.HasNoValue
```

```python
ScheduleDefinition.CanFilterByValuePresence()
```

--------------------------------

### Check Category UI Visibility

Source: https://revapidocs.com/2020.htm

Determine if a category is visible in the Revit user interface, such as in dialogs like Visibility Graphics or View Filters, using the Category.IsVisibleInUI property.

```python
Category.IsVisibleInUI
```

--------------------------------

### Category Visibility

Source: https://revapidocs.com/2020.htm

Property to determine if a category is visible in the Revit UI.

```APIDOC
## Category.IsVisibleInUI

### Description
Returns true if the category should be visible to the user in lists of categories in the Revit user interface (dialogs such as Visibility Graphics or View Filters).

### Property
Category.IsVisibleInUI
```

--------------------------------

### StructuralConnectionHandler API

Source: https://revapidocs.com/2020.htm

Manages the overriding of type parameters for structural connections.

```APIDOC
## StructuralConnectionHandler Additions

### Property

*   **OverrideTypeParams**: Allows or disallows overriding the parameters for a connection type. When true, instance parameters are created by copying type parameters, allowing individual modification. When false, instance parameters are discarded and type parameters are used.
```

--------------------------------

### GroupType API Additions for Attached Detail Groups

Source: https://revapidocs.com/2020.htm

New methods for retrieving available attached detail group types.

```APIDOC
## GroupType API Additions for Attached Detail Groups

### Methods

- **GroupType.getAvailableAttachedDetailGroupTypeIds()**: Returns the attached detail groups available for this group type.
```

--------------------------------

### TopographyLinkType.Reload()

Source: https://revapidocs.com/2020.htm

Reloads the TopographyLinkType from its current location.

```APIDOC
## Autodesk.Revit.DB.Architecture.TopographyLinkType.Reload()

### Description
Reloads the TopographyLinkType from its current location.

### Method
Autodesk.Revit.DB.Architecture.TopographyLinkType.Reload()
```

--------------------------------

### Background Calculation Status

Source: https://revapidocs.com/2020.htm

Method to check if background calculations are in progress for a document.

```APIDOC
## Document.IsBackgroundCalculationInProgress()

### Description
Identifies if there are any background calculations in progress for this document. When a document has background calculations in progress, users cannot perform certain operations like saving, closing, exporting, printing, or synchronizing to central.

### Method
Document.IsBackgroundCalculationInProgress()
```

--------------------------------

### Control Attached Detail Group Visibility

Source: https://revapidocs.com/2020.htm

Use these methods to control the visibility of an element group's attached detail groups within a specific view. Ensure the group and view are valid before calling.

```cs
Group.ShowAttachedDetailGroups()
Group.ShowAllAttachedDetailGroups()
Group.HideAttachedDetailGroups()
Group.HideAllAttachedDetailGroups()
```

--------------------------------

### ParameterFilterElement.GetElementFilterParametersForCategory()

Source: https://revapidocs.com/2020.htm

Retrieves a list of parameters associated with rules in the filter that are combined with a FilterCategoryRule for a specific category.

```APIDOC
## ParameterFilterElement.GetElementFilterParametersForCategory()

### Description
Retrieves a list of parameters associated with all rules in the filter that are combined (using logical AND) with a FilterCategoryRule corresponding to a single categoryId.

### Method
ParameterFilterElement.GetElementFilterParametersForCategory()
```

--------------------------------

### CustomExporter 2D Export Properties

Source: https://revapidocs.com/2020.htm

New properties for CustomExporter to control the export of 2D objects, including pattern lines, annotation objects, and display styles.

```APIDOC
## CustomExporter Properties for 2D Export

### Description
These properties control the behavior of CustomExporter when exporting 2D views.

### Properties
- **Export2DGeometricObjectsIncludingPatternLines** (bool) - Indicates whether pattern lines of geometric objects should be exported in a 2D context. Defaults to false.
- **Export2DIncludingAnnotationObjects** (bool) - Indicates whether annotation objects should be exported in a 2D context. Defaults to false.
- **Export2DForceDisplayStyle** (DisplayStyle) - Forces a display style for the export. If DisplayStyle.Undefined, uses DisplayStyle.Wireframe for wireframe views and DisplayStyle.HDR for others. Defaults to DisplayStyle.Undefined.
```

--------------------------------

### Parameter Value Presence Filtering

Source: https://revapidocs.com/2020.htm

Classes and methods for filtering elements based on the presence or absence of parameter values.

```APIDOC
## ParameterValuePresenceRule, HasValueFilterRule, HasNoValueFilterRule

### Description
Define filter rules evaluating whether or not a parameter has a value for a specific element.

### Classes
ParameterValuePresenceRule
HasValueFilterRule
HasNoValueFilterRule
```

```APIDOC
## FilterRule.CreateHasValueParameterRule()
## FilterRule.CreateHasNoValueParameterRule()

### Description
Static methods to create an instance of ParameterValuePresenceRule, HasValueFilterRule, or HasNoValueFilterRule for use in a parameter filter.

### Methods
FilterRule.CreateHasValueParameterRule()
FilterRule.CreateHasNoValueParameterRule()
```

```APIDOC
## ScheduleFilterType.HasValue
## ScheduleFilterType.HasNoValue

### Description
Enumerated values for use in schedules to filter based on the presence or absence of a value assigned to a parameter.

### Enum Values
ScheduleFilterType.HasValue
ScheduleFilterType.HasNoValue
```

```APIDOC
## ScheduleDefinition.CanFilterByValuePresence()

### Description
Checks if a schedule definition can be filtered by the presence or absence of a parameter value.

### Method
ScheduleDefinition.CanFilterByValuePresence()
```

--------------------------------

### Hide Shared Parameter When No Value

Source: https://revapidocs.com/2020.htm

Configure a shared parameter to be hidden from the property palette and Element.GetOrderedParameters() when it has no value using ExternalDefinition.HideWhenNoValue. Similar options exist for ExternalDefinitionCreationOptions and SharedParameterElement.

```python
ExternalDefinition.HideWhenNoValue
```

```python
ExternalDefinitionCreationOptions.HideWhenNoValue
```

```python
SharedParameterElement.ShouldHideWhenNoValue()
```

--------------------------------

### TopographySurface.IsValidFaceSet()

Source: https://revapidocs.com/2020.htm

Checks whether the given set of triangulation data is valid.

```APIDOC
## Autodesk.Revit.DB.Architecture.TopographySurface.IsValidFaceSet()

### Description
Checks whether the given set of triangulation data is valid.

### Method
Autodesk.Revit.DB.Architecture.TopographySurface.IsValidFaceSet()
```

--------------------------------

### Check if a Group is Attached

Source: https://revapidocs.com/2020.htm

Determine if a group is attached to another group and retrieve its parent ID if applicable. This property provides information about group relationships.

```cs
Group.IsAttached
Group.AttachedParentId
```

--------------------------------

### Clear Shared Parameter Value

Source: https://revapidocs.com/2020.htm

Reset the value of a shared parameter that has the HideWhenNoValue flag set using Parameter.ClearValue(). This method is specific to shared parameters with the hide-when-no-value flag and does not apply to other parameter types.

```python
Parameter.ClearValue()
```
Tokens:
Raw